tests.yml

name: tests

on:
  push:
    branches:
      - master
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
  merge_group:
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  # disabled because currently doesn't work in merge queue
  # changes:
  #   permissions:
  #     pull-requests: read
  #   uses: ./.github/workflows/reusable-check-changed-files.yml

  set-image:
    # GitHub Actions allows using 'env' in a container context.
    # However, env variables don't work for forks: https://github.com/orgs/community/discussions/44322
    # This workaround sets the container image for each job using 'set-image' job output.
    runs-on: ubuntu-latest
    outputs:
      IMAGE: ${{ steps.set_image.outputs.IMAGE }}
      RUNNER: ${{ steps.set_runner.outputs.RUNNER }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - id: set_image
        run: cat .github/env >> $GITHUB_OUTPUT
      # By default we use spot machines that can be terminated at any time.
      # Merge queues use persistent runners to avoid kicking off from queue when the runner is terminated.
      - id: set_runner
        run: |
          # Run merge queues on persistent runners
          if [[ $GITHUB_REF_NAME == *"gh-readonly-queue"* ]]; then
            echo "RUNNER=arc-runners-polkadot-sdk-beefy-persistent" >> $GITHUB_OUTPUT
          else
            echo "RUNNER=arc-runners-polkadot-sdk-beefy" >> $GITHUB_OUTPUT
          fi

  # This job runs all benchmarks defined in the `/bin/node/runtime` once to check that there are no errors.
  quick-benchmarks:
    needs: [set-image]
    # if: ${{ needs.changes.outputs.rust }}
    runs-on: ${{ needs.set-image.outputs.RUNNER }}
    timeout-minutes: 60
    container:
      image: ${{ needs.set-image.outputs.IMAGE }}
    env:
      RUSTFLAGS: "-C debug-assertions -D warnings"
      RUST_BACKTRACE: "full"
      WASM_BUILD_NO_COLOR: 1
      WASM_BUILD_RUSTFLAGS: "-C debug-assertions -D warnings"
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: script
        run: forklift cargo run --locked --release -p staging-node-cli --bin substrate-node --features runtime-benchmarks -- benchmark pallet --chain dev --pallet "*" --extrinsic "*" --steps 2 --repeat 1 --quiet

  # cf https://github.com/paritytech/polkadot-sdk/issues/1652
  test-syscalls:
    needs: [set-image]
    # if: ${{ needs.changes.outputs.rust }}
    runs-on: ${{ needs.set-image.outputs.RUNNER }}
    timeout-minutes: 60
    container:
      image: ${{ needs.set-image.outputs.IMAGE }}
    continue-on-error: true # this rarely triggers in practice
    env:
      SKIP_WASM_BUILD: 1
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: script
        id: test
        run: |
          forklift cargo build --locked --profile production --target x86_64-unknown-linux-musl --bin polkadot-execute-worker --bin polkadot-prepare-worker
          cd polkadot/scripts/list-syscalls
          ./list-syscalls.rb ../../../target/x86_64-unknown-linux-musl/production/polkadot-execute-worker --only-used-syscalls | diff -u execute-worker-syscalls -
          ./list-syscalls.rb ../../../target/x86_64-unknown-linux-musl/production/polkadot-prepare-worker --only-used-syscalls | diff -u prepare-worker-syscalls -
      - name: on_failure
        if: failure() && steps.test.outcome == 'failure'
        run: |
          echo "The x86_64 syscalls used by the worker binaries have changed. Please review if this is expected and update polkadot/scripts/list-syscalls/*-worker-syscalls as needed." >> $GITHUB_STEP_SUMMARY

  cargo-check-all-benches:
    needs: [set-image]
    # if: ${{ needs.changes.outputs.rust }}
    runs-on: ${{ needs.set-image.outputs.RUNNER }}
    timeout-minutes: 60
    container:
      image: ${{ needs.set-image.outputs.IMAGE }}
    env:
      SKIP_WASM_BUILD: 1
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: script
        run: forklift cargo check --all --benches