test.yml

# This workflow will install Python dependencies, run tests and lint
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Test

on:
  push:
    branches:
      - stable
      - dev
  pull_request:
    branches:
      - stable
      - dev
  merge_group:
  workflow_dispatch:
  workflow_call:
    inputs:
      ref:
        description: "Git ref to checkout"
        required: false
        type: string

permissions:
  contents: read

# Keep urllib3-future from hijacking the urllib3 namespace (see pyproject.toml).
env:
  URLLIB3_NO_OVERRIDE: "1"

concurrency:
  group: test-${{ github.event_name }}-${{ github.event.pull_request.number || inputs.ref || github.ref }}
  # Not merge_group: a cancelled run reports no check, hanging the queue entry until timeout.
  cancel-in-progress: ${{ github.event_name == 'pull_request' || github.event_name == 'push' }}

jobs:
  changes:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: read
    outputs:
      mode: ${{ steps.scope.outputs.mode }}
      test_paths: ${{ steps.scope.outputs.test_paths }}
      cov_paths: ${{ steps.scope.outputs.cov_paths }}
    steps:
      - name: Check out code from GitHub
        uses: actions/checkout@v7
        with:
          ref: ${{ inputs.ref || github.ref }}
      # On PRs, run only the tests affected by the changed files: a PR touching a
      # single provider runs just that provider's tests. A change to shared code
      # (incl. translations under music_assistant/), dependencies or the CI itself
      # runs the full suite, as do pushes, merge groups, manual runs and
      # reusable-workflow calls.
      # PRs that only touch docs or other non-code files run nothing.
      - name: Determine test scope
        id: scope
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          if [ "${{ github.event_name }}" != "pull_request" ]; then
            {
              echo "mode=full"
              echo "test_paths="
              echo "cov_paths="
            } >> "$GITHUB_OUTPUT"
            exit 0
          fi
          # Emit both the new and (for renames) the previous path so a file moved
          # between providers runs the source provider's tests too.
          gh api --paginate \
            "repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files" \
            --jq '.[] | .filename, (.previous_filename // empty)' | python3 scripts/ci_test_scope.py

  provider-scope:
    # Advisory only (never fails the build): emit warning annotations when a PR that touches a
    # provider also changes unrelated shared code, suggesting those changes move to their own PR.
    if: ${{ github.event_name == 'pull_request' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: read
    steps:
      - name: Check out code from GitHub
        uses: actions/checkout@v7
        with:
          ref: ${{ inputs.ref || github.ref }}
      - name: Warn on out-of-scope provider changes
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          gh api --paginate \
            "repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files" \
            --jq '.[] | .filename, (.previous_filename // empty)' | python3 scripts/check_provider_scope.py

  lint:
    runs-on: ubuntu-latest

    steps:
      - name: Check out code from GitHub
        uses: actions/checkout@v7
        with:
          ref: ${{ inputs.ref || github.ref }}
      - name: Set up Python
        uses: actions/setup-python@v7.0.0
        with:
          python-version-file: ".python-version"
          check-latest: true
      - name: Install uv
        run: pip install uv
      - name: Cache uv packages
        uses: actions/cache@v6
        with:
          path: ~/.cache/uv
          key: uv-${{ runner.os }}-${{ hashFiles('.python-version') }}-${{ hashFiles('requirements_all.txt', 'pyproject.toml') }}
      - name: Install dependencies
        # --index-strategy: allow PyPI packages when also using the PyTorch extra index
        # https://docs.astral.sh/uv/pip/compatibility/#packages-that-exist-on-multiple-indexes
        run: uv pip install --system --index-strategy unsafe-best-match . .[test] -r requirements_all.txt
      - name: Lint/test with pre-commit
        run: SKIP=no-commit-to-branch pre-commit run --all-files

  test:
    needs: changes
    if: ${{ needs.changes.outputs.mode != 'skip' }}
    runs-on: ubuntu-latest
    # Same base as the production image (Dockerfile.base), so apt ffmpeg is the same
    # 7.1.x line we ship; ubuntu-latest's apt only has 6.1. Keep the Python tag in
    # sync with .python-version.
    container: python:3.14-slim-trixie
    # Backstop: a hung test process should fail in minutes, not sit at the 6h job cap.
    timeout-minutes: 30

    steps:
      # Cache apt .deb files to speed up ffmpeg installation (in home to avoid permission issues).
      - name: Cache apt packages
        uses: actions/cache@v6
        with:
          path: ~/.cache/apt-packages
          key: apt-ffmpeg-${{ runner.os }}-trixie
      # git must be present before checkout, or it degrades to a REST tarball download;
      # build-essential + libssl-dev are needed to build aiolibdatachannel from its git
      # source; curl + gpg are needed by the codecov action
      - name: Install ffmpeg and build tools
        run: |
          # Restore cached .deb files to apt cache (if any)
          cp ~/.cache/apt-packages/*.deb /var/cache/apt/archives/ 2>/dev/null || true
          apt-get update && apt-get install -y ffmpeg git build-essential libssl-dev curl gpg
          # Save .deb files for next run
          mkdir -p ~/.cache/apt-packages && cp /var/cache/apt/archives/*.deb ~/.cache/apt-packages/ 2>/dev/null || true
      - name: Check out code from GitHub
        uses: actions/checkout@v7
        with:
          ref: ${{ inputs.ref || github.ref }}
      - name: Install uv
        run: pip install uv
      - name: Cache uv packages
        uses: actions/cache@v6
        with:
          path: ~/.cache/uv
          key: uv-${{ runner.os }}-${{ hashFiles('.python-version') }}-${{ hashFiles('requirements_all.txt', 'pyproject.toml') }}
      - name: Install dependencies
        # --index-strategy: allow PyPI packages when also using the PyTorch extra index
        # https://docs.astral.sh/uv/pip/compatibility/#packages-that-exist-on-multiple-indexes
        run: uv pip install --system --index-strategy unsafe-best-match . .[test] -r requirements_all.txt
      - name: Pytest
        # mode=partial runs only the changed providers' tests with coverage scoped to
        # those provider packages; mode=full runs everything with full coverage.
        # --dist loadfile keeps each test file on one xdist worker: snapshot updates
        # never race on an .ambr file and module-scoped fixtures are reused.
        # --max-worker-restart=0: with loadfile, replacing a worker that died on a native
        # crash leaves the controller blocked on its event queue forever, so the job only
        # ends at its 30m cap with no summary. Shutting down instead fails in seconds and
        # names the crashing test; a crashed worker invalidates the run either way.
        env:
          MODE: ${{ needs.changes.outputs.mode }}
          TEST_PATHS: ${{ needs.changes.outputs.test_paths }}
          COV_PATHS: ${{ needs.changes.outputs.cov_paths }}
          # aiolibdatachannel's _native.so doesn't link libstdc++ itself; the production
          # image resolves it via its jemalloc LD_PRELOAD, here we preload it directly
          LD_PRELOAD: libstdc++.so.6
        run: |
          if [ "$MODE" = "partial" ]; then
            targets="$TEST_PATHS"
            cov=""
            for src in $COV_PATHS; do cov="$cov --cov=$src"; done
          else
            targets="tests/"
            cov="--cov=music_assistant"
          fi
          # the container runs as root, which bypasses file permission bits and breaks
          # tests exercising permission-denied paths; run pytest as an unprivileged user
          useradd -m tester
          chown -R tester:tester .
          # -p numpy: pre-import numpy before pytest-cov starts coverage. Scoping
          # --cov to a submodule (partial mode) makes coverage import the parent
          # music_assistant package inside its sys_modules_saved() block, which then
          # evicts numpy from sys.modules. Re-importing numpy reinitialises its C
          # extension and creates a second _NoValue sentinel, breaking ndarray
          # reductions (sum/mean) on py3.14. Loading numpy as an early plugin keeps
          # it in the saved snapshot so it is never evicted.
          setpriv --reuid=tester --regid=tester --init-groups \
            env HOME=/home/tester \
            pytest -p numpy -n auto --dist loadfile --max-worker-restart=0 --durations 10 $cov --cov-report=term-missing --cov-report=xml $targets
      - name: Upload coverage to Codecov
        if: ${{ !github.event.pull_request.head.repo.fork }}
        uses: codecov/codecov-action@v7
        with:
          files: ./coverage.xml
          flags: ${{ needs.changes.outputs.mode }}
          fail_ci_if_error: false
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}