ci.yml

name: CI

on:
  push:
    branches: [main]
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

env:
  PYTHON_VERSION: "3.12"

jobs:
  lint:
    name: Format and lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install ruff
        run: pipx install ruff==0.16.3

      - name: Check formatting
        run: ruff format --check .

      - name: Lint
        run: ruff check --output-format=github .

      - uses: pnpm/action-setup@v6

      - uses: actions/setup-node@v7
        with:
          node-version: 22
          cache: pnpm

      - name: Install the formatter
        run: pnpm install --frozen-lockfile --ignore-scripts

      - name: Check that every JSON file is formatted
        run: pnpm run format:check

      - name: Lint the workflows
        uses: raven-actions/actionlint@v2

      - name: Lint the shell scripts
        run: |
          sudo apt-get update
          sudo apt-get install -y shellcheck
          shellcheck --severity=style --shell=bash scripts/*.sh

  types:
    name: Types
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install the type checker
        run: pipx install mypy==1.14.1

      # Strict, with every optional error class the version offers. This is address
      # arithmetic end to end, so a bank or an offset crossing a boundary it should
      # not is exactly what a checker is for. Settings live in pyproject.toml so a
      # local run and this one agree.
      - name: Every annotation has to hold
        run: mypy

  test:
    name: Tests on Python ${{ matrix.python }}
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python: ["3.12", "3.13", "3.14"]
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: ${{ matrix.python }}

      - name: Install coverage
        run: python -m pip install --disable-pip-version-check coverage==7.6.10

      - name: Run every test file, under coverage
        run: |
          python -m coverage erase
          status=0
          while IFS= read -r file; do
            echo "::group::${file}"
            python -m coverage run -a "${file}" || status=1
            echo "::endgroup::"
          done < <(find mapper conformance -name '*.test.py' | sort)
          exit "${status}"
        shell: bash

      - name: Coverage must be total
        run: python -m coverage report

      # No document is redistributable, so none is here and this checks nothing
      # on a runner. It says so rather than reporting a pass: the value is that
      # somebody running it with the manual on disk gets a real answer, and that
      # a run without it cannot be mistaken for one.
      - name: Every quoted sentence, against the document it came from
        run: python -m conformance.quotes

  speed:
    name: Throughput
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: The map must still answer faster than the floor
        run: python -m conformance.speed

  conformance:
    name: Corpus
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Replay every header combination the corpus recorded
        run: python -m conformance.corpus

  cartridges:
    name: Cartridges
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Read every cartridge present
        run: |
          status=0
          python -m conformance.against_cartridges || status="$?"
          if [ "${status}" -eq 2 ]; then
            echo "::notice title=Cartridges::No cartridge is present on a hosted runner, so this sweep was skipped rather than passed. It reads the header of every retail cartridge in the library and holds each one to the recorded corpus. Run it locally with a library you own, or point SNES_CARTRIDGE_DIR at one."
            exit 0
          fi
          exit "${status}"
        shell: bash