ci: Fix macOS workflow #2338
Merged
ci: Fix macOS workflow #2338
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `distutils` python package has been removed in Python 3.12. It is however required by `node-gyp` which we use to compile some native dependencies. Installing the `setuptools` python package is enough to fix the problem until we upgrade `node-gyp` to v10+.
When one of the commands from the test setup script runs into an error (e.g. because the docker container running `cozy-stack` is not fully up and running), the script itself should return an error code so that it can be run in a Bash loop until it succeeds (very useful when run on the CI as we don't really know when the container is ready to receive commands).
Xvfb is not available in macOS images on Github Actions so the step does not work and tests seem to run fine without it anyway.
This version seems to fix DNS lookup errors we're experiencing when trying to make requests to cozy.localhost in Realtime tests. See nodejs/node@ddd9c70
The `admin-host` port is forced in the `cozy-app-dev` image to `127.0.0.1`, an IPv4 address, while the default value used in `cozy-stack` commands is `::`, an IPv6 address. This causes setup requests to fail on the CI (not sure why it doesn't on a local dev machine though). Passing the `--admin-host` option to `cozy-stack` commands in the setup script fixes the issue.
For our test suite to properly run on macOS, we need the `cozy-stack` server upon which requests are made to use a case and UTF-8 sensitive filesystem such as Ext. These filesystems cannot be created on macOS so we need a linux VM to run `cozy-stack` into. We were using `podman-machine` to start that VM on the CI until now but it does not seem to work anymore so we're switching to a new Github action, `douglascamata/setup-docker-macos-action`, which does the heavy lifting of creating a linux VM with all the necessary tools and connections to run docker containers on it. We can then use our docker-compose file to run `cozy-app-dev` easily.
The `ScribeMD/docke-cache` Github action we use to cache the `cozy-app-dev` docker image does not properly run on Github Actions' macOS images as it expects Bash to be available at `/usr/bin/bash` but Bash is not available by default and Homebrew installs it in a different path as `/usr/bin` is read-only. To make this action work for us, we forked it to add a `bash` input that accepts a string specifying the Bash path to use. We'll use our fork until we can get the upstream project to be fixed.
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The macOS Github Actions workflow needed some love to execute properly
after some probable changes in the underlying macOS image.
Please make sure the following boxes are checked: