pytest.yaml

name: Test

on:
  # To debug the workflow, uncomment this entry AND comment pull_request_target
  # pull_request:
  #   branches: [ main ]
  pull_request_target:
    branches: [ main, "migrate**" ]
    types: [ labeled, opened, reopened, synchronize ]
  schedule:
  - cron: "0 5 * * *"  # = 06:00 CET = 07:00 CEST

# Cancel previous runs that have not completed
concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash

env:
  gams-version: 43.4.1
  label: "safe to test"
  python-version: "3.13"

jobs:
  check:
    name: Check permissions, identify ref to test
    runs-on: ubuntu-latest
    steps:
    - if: >
        !(
          github.event_name == 'schedule'
          || github.repository == github.event.pull_request.head.repo.full_name
          || contains(github.event.pull_request.labels.*.name, env.label)
        )
      run: |
        echo "Pytest workflow will not run for branch in fork without label \`${{ env.label }}\`." >>$GITHUB_STEP_SUMMARY
        exit 1

    - name: Identify ref to check out
      id: ref
      run: echo "ref=${{ github.event_name != 'pull_request_target' && github.ref || github.event.pull_request.head.sha }}" >> $GITHUB_OUTPUT

    outputs:
      ref: ${{ steps.ref.outputs.ref }}

  warm-lfs-cache:
    name: Warm Git LFS cache
    needs: check

    strategy:
      matrix:
        os: [ macos-13, macos-latest, ubuntu-latest, windows-latest ]
    runs-on: ${{ matrix.os }}
    steps:
    - uses: francisbilham11/action-cached-lfs-checkout@v3
      with:
        ref: ${{ needs.check.outputs.ref }}

  pytest:
    needs: warm-lfs-cache

    strategy:
      matrix:
        os:
        - macos-13
        - macos-latest
        - ubuntu-latest
        - windows-latest
        version:
        # In each group:
        # - Versions of ixmp and message_ix to test.
        # - Latest supported Python version for those or other dependencies.
        # Minimum version given in pyproject.toml + earlier version of Python
        - { upstream: v3.6.0, python: "3.11" }  # 2022-08-18
        - { upstream: v3.7.0, python: "3.11" }  # 2023-05-17
        - { upstream: v3.8.0, python: "3.12" }  # 2024-01-12
        # Latest released version + latest released Python
        - { upstream: v3.9.0, python: "3.13" }  # 2024-06-04
        # Development version + latest released Python
        - { upstream: main,   python: "3.13" }

        exclude:
        # Specific version combinations that are invalid / not to be used
        # These versions of ixmp are not able locate the arm64 GAMS API binaries
        - { os: macos-latest, version: { upstream: v3.6.0 }}
        - { os: macos-latest, version: { upstream: v3.7.0 }}
        - { os: macos-latest, version: { upstream: v3.8.0 }}
        - { os: macos-latest, version: { upstream: v3.9.0 }}
        # Redundant with macos-latest
        - { os: macos-13, version: { upstream: main }}

      fail-fast: false

    runs-on: ${{ matrix.os }}
    name: ${{ matrix.os }}-py${{ matrix.version.python }}-upstream-${{ matrix.version.upstream }}

    steps:
    - name: Cache test data
      uses: actions/cache@v4
      with:
        path: message-local-data
        key: ${{ matrix.os }}

    - name: Check out message-ix-models
      uses: francisbilham11/action-cached-lfs-checkout@v3
      with:
        ref: ${{ needs.check.outputs.ref }}

    - name: Set up uv, Python
      uses: astral-sh/setup-uv@v5
      with:
        cache-dependency-glob: "**/pyproject.toml"
        python-version: ${{ matrix.version.python }}

    - uses: iiasa/actions/setup-gams@main
      with:
        version: ${{ env.gams-version }}
        license: ${{ secrets.GAMS_LICENSE }}

    - uses: ts-graphviz/setup-graphviz@v2
      # Work around ts-graphviz/setup-graphviz#630
      if: matrix.os != 'macos-13'

    - name: Determine extra dependencies
      id: dependencies
      run : |
        from os import environ
        from pathlib import Path

        v, result = "${{ matrix.version.upstream }}".replace("main", "vmain"), []
        for condition, dependency in (
            (v <= "v3.6.0", "dask < 2024.3.0"),  # dask[dataframe] >= 2024.3.0 requires dask-expr and in turn pandas >= 2.0 (#156)
            (v <= "v3.6.0", "pandas < 2.0"),
            (v >= "v3.7.0", "dask[dataframe] < 2024.11.0"),  # dask >= 2024.11.0 changes handling of dict (will be addressed in #225)
            (v <= "v3.7.0", "genno < 1.25"),  # Upstream versions < 3.8.0 import genno.computations, removed in 1.25.0 (#156)
            (v < "v3.9.0", "pytest == 8.0.0"),  # Upstream versions < 3.9.0 use a hook argument removed in pytest 8.1.0 (#155)
        ):
            result.extend([f'"{dependency}"'] if condition else [])

        Path(environ["GITHUB_OUTPUT"]).write_text(f"value={' '.join(result)}\n")
      shell: python

    - name: Install packages and dependencies
      # By default, install:
      # - ixmp, message_ix: from GitHub branches/tags per matrix.version.upstream (above)
      # - other dependencies: from PyPI.
      #
      # To test against unreleased code (on `main`, or other branches for open PRs),
      # temporarily edit or add lines below as needed. DO NOT merge such changes to `main`.
      run: |
        uv pip install --upgrade \
          ${{ steps.dependencies.outputs.value }} \
          "ixmp @ git+https://github.com/iiasa/ixmp.git@${{ matrix.version.upstream }}" \
          "message-ix @ git+https://github.com/iiasa/message_ix.git@${{ matrix.version.upstream }}" \
          .[docs,tests]

    - name: Configure local data path
      run: |
        mkdir -p message-local-data/cache
        mix-models config set "message local data" "$(realpath message-local-data)"
        mix-models config show

    - name: Run test suite using pytest
      run: |
        pytest message_ix_models \
          -m "not (ece_db or snapshot)" \
          --color=yes --durations=20 -rA --verbose \
          --cov-report=term-missing --cov-report=xml \
          --numprocesses=auto \
          --local-cache --jvmargs="-Xmx6G"

    - name: Upload test coverage to Codecov.io
      uses: codecov/codecov-action@v5
      with:
        token: ${{ secrets.CODECOV_TOKEN }}  # Required

  pre-commit:
    name: Code quality
    needs: check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
      with:
        ref: ${{ needs.check.output.ref }}
    - uses: astral-sh/setup-uv@v5
      with:
        cache-dependency-glob: "**/pyproject.toml"
        python-version: ${{ env.python-version }}
    - uses: actions/cache@v4
      with:
        path: ~/.cache/pre-commit
        key: pre-commit|${{ env.UV_PYTHON }}|${{ hashFiles('.pre-commit-config.yaml') }}
        lookup-only: ${{ github.event_name == 'schedule' }}  # Set 'true' to recreate cache
    - run: uvx pre-commit run --all-files --color=always --show-diff-on-failure