|
| 1 | +name: Test |
| 2 | + |
| 3 | +on: |
| 4 | + push: |
| 5 | + branches: [main] |
| 6 | + pull_request: |
| 7 | + branches: [main] |
| 8 | + schedule: |
| 9 | + # runs at 05:00 UTC on the 1st and 15th of each month. |
| 10 | + - cron: "0 5 1,15 * *" |
| 11 | + |
| 12 | +concurrency: |
| 13 | + group: ${{ github.workflow }}-${{ github.ref }} |
| 14 | + cancel-in-progress: true |
| 15 | + |
| 16 | +defaults: |
| 17 | + run: |
| 18 | + # to fail on error in multiline statements (-e), in pipes (-o pipefail), and on unset variables (-u). |
| 19 | + shell: bash -euo pipefail {0} |
| 20 | + |
| 21 | +jobs: |
| 22 | + # Get the test environment from hatch as defined in pyproject.toml. |
| 23 | + # This ensures that the pyproject.toml is the single point of truth for test definitions and the same tests are |
| 24 | + # run locally and on continuous integration. |
| 25 | + # Check [[tool.hatch.envs.hatch-test.matrix]] in pyproject.toml and https://hatch.pypa.io/latest/environment/ |
| 26 | + get-environments: |
| 27 | + runs-on: ubuntu-latest |
| 28 | + outputs: |
| 29 | + envs: ${{ steps.get-envs.outputs.envs }} |
| 30 | + steps: |
| 31 | + - name: Clone repository code into the GitHub Actions runner |
| 32 | + uses: actions/checkout@v4 |
| 33 | + with: |
| 34 | + filter: blob:none |
| 35 | + fetch-depth: 0 |
| 36 | + - name: Install uv |
| 37 | + uses: astral-sh/setup-uv@v5 |
| 38 | + - name: Get test environments |
| 39 | + id: get-envs |
| 40 | + run: | |
| 41 | + ENVS_JSON=$(uvx hatch env show --json | jq -c 'to_entries |
| 42 | + | map( |
| 43 | + select(.key | startswith("hatch-test")) |
| 44 | + | { |
| 45 | + name: .key, |
| 46 | + label: (if (.key | contains("pre")) then .key + " (PRE-RELEASE DEPENDENCIES)" else .key end), |
| 47 | + python: .value.python |
| 48 | + } |
| 49 | + )') |
| 50 | + echo "envs=${ENVS_JSON}" | tee $GITHUB_OUTPUT |
| 51 | +
|
| 52 | + # Run tests through hatch. Spawns a separate runner for each environment defined in the hatch matrix obtained above. |
| 53 | + test: |
| 54 | + needs: get-environments |
| 55 | + |
| 56 | + strategy: |
| 57 | + fail-fast: false |
| 58 | + matrix: |
| 59 | + os: [ubuntu-latest] |
| 60 | + env: ${{ fromJSON(needs.get-environments.outputs.envs) }} |
| 61 | + |
| 62 | + name: ${{ matrix.env.label }} |
| 63 | + runs-on: ${{ matrix.os }} |
| 64 | + |
| 65 | + steps: |
| 66 | + - uses: actions/checkout@v4 |
| 67 | + with: |
| 68 | + filter: blob:none |
| 69 | + fetch-depth: 0 |
| 70 | + - name: Install uv |
| 71 | + uses: astral-sh/setup-uv@v5 |
| 72 | + with: |
| 73 | + python-version: ${{ matrix.env.python }} |
| 74 | + cache-dependency-glob: pyproject.toml |
| 75 | + - name: create hatch environment |
| 76 | + run: uvx hatch env create ${{ matrix.env.name }} |
| 77 | + - name: run tests using hatch |
| 78 | + env: |
| 79 | + MPLBACKEND: agg |
| 80 | + PLATFORM: ${{ matrix.os }} |
| 81 | + DISPLAY: :42 |
| 82 | + run: uvx hatch run ${{ matrix.env.name }}:run_cov |
| 83 | + - name: Upload coverage reports to Codecov |
| 84 | + uses: codecov/codecov-action@v5 |
| 85 | + with: |
| 86 | + token: ${{ secrets.CODECOV_TOKEN }} |
| 87 | + |
| 88 | + # Check that all tests defined above pass. This makes it easy to set a single "required" test in branch |
| 89 | + # protection instead of having to update it frequently. See https://github.com/re-actors/alls-green#why. |
| 90 | + check: |
| 91 | + name: Tests pass in all hatch environments |
| 92 | + if: always() |
| 93 | + needs: |
| 94 | + - get-environments |
| 95 | + - test |
| 96 | + runs-on: ubuntu-latest |
| 97 | + steps: |
| 98 | + - uses: re-actors/alls-green@release/v1 |
| 99 | + with: |
| 100 | + jobs: ${{ toJSON(needs) }} |
0 commit comments