test.yml

name: 'Test'
on:
  pull_request:
    branches: [ "master" ]
  workflow_dispatch:
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  code-quality:
    name: "Code Quality"
    runs-on: ubuntu-latest
    steps:
      - name: 'Check out code'
        uses: actions/checkout@v7
        with:
          # Check out pull request HEAD instead of merge commit.
          ref: ${{ github.event.pull_request.head.sha }}
          submodules: recursive

      - name: Install yq
        run: .github/scripts/install-yq.sh

      - name: 'Read nightly channel from rust-toolchain.toml'
        id: toolchain-meta
        run: |
          set -euo pipefail
          CHANNEL=$(yq -r '.toolchain.channel' rust-toolchain.toml)
          if [ -z "$CHANNEL" ] || [ "$CHANNEL" = "null" ]; then
            echo "::error::Could not read toolchain.channel from rust-toolchain.toml"
            exit 1
          fi
          echo "channel=$CHANNEL" >> "$GITHUB_OUTPUT"

      - name: "Set up nightly Rust" # https://github.com/rust-lang/rustup/issues/3409
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ steps.toolchain-meta.outputs.channel }}

      - name: 'Build stable-mir-json' # rustfmt documentation claims it is unstable on code that doesn't build
        run: |
          cargo build -vv

      - name: "Check `cargo clippy`"
        run: |
          rustup component add clippy
          cargo clippy -- -Dwarnings

      - name: "Check `cargo fmt`"
        run: |
          rustup component add rustfmt
          cargo fmt --check

      - name: 'Install Nix'
        uses: cachix/install-nix-action@v31.11.0
        with:
          install_url: https://releases.nixos.org/nix/nix-2.30.1/install
          extra_nix_config: |
            substituters = https://cache.nixos.org
            trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

      - name: "Check `nixfmt`"
        run: |
          NIX_FILES=$(bash -O globstar -c 'ls **/*.nix')
          nix shell nixpkgs#nixfmt-rfc-style --command nixfmt --check ${NIX_FILES}

  integration-tests:
    needs: code-quality
    name: "Integration Tests"
    runs-on: ubuntu-latest
    steps:
      - name: 'Check out code'
        uses: actions/checkout@v7
        with:
          # Check out pull request HEAD instead of merge commit.
          ref: ${{ github.event.pull_request.head.sha }}
          submodules: recursive

      - name: Install yq
        run: .github/scripts/install-yq.sh

      - name: 'Read nightly channel from rust-toolchain.toml'
        id: toolchain-meta
        run: |
          set -euo pipefail
          CHANNEL=$(yq -r '.toolchain.channel' rust-toolchain.toml)
          if [ -z "$CHANNEL" ] || [ "$CHANNEL" = "null" ]; then
            echo "::error::Could not read toolchain.channel from rust-toolchain.toml"
            exit 1
          fi
          echo "channel=$CHANNEL" >> "$GITHUB_OUTPUT"

      - name: "Set up nightly Rust" # https://github.com/rust-lang/rustup/issues/3409
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ steps.toolchain-meta.outputs.channel }}

      - name: 'Build stable-mir-json'
        run: | # Warning check should be redundant since code-quality runs first
          RUSTFLAGS='--deny warnings' cargo build -vv

      - name: 'Install a good-enough jq version'
        uses: dcarbone/install-jq-action@v4
        with:
          version: 1.7.1
          force: true

      - name: 'Run smir integration tests'
        run: |
          which jq
          jq --version
          make integration-test

  ui-tests:
    needs: code-quality
    name: "UI Tests"
    runs-on: ubuntu-latest
    steps:
      - name: 'Check out code'
        uses: actions/checkout@v7
        with:
          # Check out pull request HEAD instead of merge commit.
          ref: ${{ github.event.pull_request.head.sha }}
          submodules: recursive

      - name: Install yq
        run: .github/scripts/install-yq.sh

      - name: 'Read nightly channel from rust-toolchain.toml'
        id: toolchain-meta
        run: |
          set -euo pipefail
          CHANNEL=$(yq -r '.toolchain.channel' rust-toolchain.toml)
          if [ -z "$CHANNEL" ] || [ "$CHANNEL" = "null" ]; then
            echo "::error::Could not read toolchain.channel from rust-toolchain.toml"
            exit 1
          fi
          echo "channel=$CHANNEL" >> "$GITHUB_OUTPUT"

      - name: "Set up nightly Rust" # https://github.com/rust-lang/rustup/issues/3409
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ steps.toolchain-meta.outputs.channel }}

      - name: 'Derive rustc commit and check out Rust repo'
        id: rustc-meta
        run: |
          set -euo pipefail
          COMMIT=$(rustc -vV | grep 'commit-hash' | cut -d' ' -f2)
          if [ -z "$COMMIT" ]; then
            echo "::error::Could not determine rustc commit-hash from 'rustc -vV'"
            exit 1
          fi
          echo "rustc-commit=$COMMIT" >> "$GITHUB_OUTPUT"

      - name: 'Check out Rust repo'
        uses: actions/checkout@v7
        with:
          repository: rust-lang/rust
          ref: ${{ steps.rustc-meta.outputs.rustc-commit }}
          path: rust
          fetch-depth: 1

      - name: 'Build stable-mir-json'
        run: | # Warning check should be redundant since code-quality runs first
          RUSTFLAGS='--deny warnings' cargo build -vv

      - name: 'Run smir UI tests'
        run: |
          RUST_DIR_ROOT='rust' VERBOSE=1 make test-ui

  nix:
    needs: code-quality
    name: 'Nix Tests'
    strategy:
      fail-fast: false
      matrix:
        runner: [normal, MacM1]  # MacM1 / normal are self-hosted,
    runs-on: ${{ matrix.runner }}
    timeout-minutes: 20
    steps:
      - name: 'Check out code'
        uses: actions/checkout@v7
        with:
          # Check out pull request HEAD instead of merge commit.
          ref: ${{ github.event.pull_request.head.sha }}
          submodules: recursive

      - name: 'Install Nix'
        if: ${{ matrix.runner != 'MacM1' }}
        uses: cachix/install-nix-action@v31.11.0
        with:
          install_url: https://releases.nixos.org/nix/nix-2.30.1/install
          extra_nix_config: |
            substituters = https://cache.nixos.org
            trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

      - name: 'Build and test'
        run: |
          set -euxo pipefail
          nix --version
          nix flake check # build and run integration & unit tests