main.yml

name: Main-CI-Flow

on:
  pull_request:
    types:
      - opened
      - reopened
      - edited
      - synchronize
  workflow_dispatch:

env:
  CI: 1
  RUSTFLAGS: "-D warnings"
  RUSTDOCFLAGS: "-D warnings"

# Cancel existing CI runs on this same PR when new commits are pushed.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # https://graphite.com/docs/stacking-and-ci
  optimize_ci:
    runs-on: ubuntu-24.04
    timeout-minutes: 60
    outputs:
      skip: ${{ steps.check_skip.outputs.skip || steps.manual_run.outputs.skip }}
    steps:
      - name: Optimize CI
        id: check_skip
        if: github.event_name == 'pull_request'
        uses: withgraphite/graphite-ci-action@v0.0.9
        with:
          graphite_token: ${{ secrets.GRAPHITE_CI_OPTIMIZER_TOKEN }}
      - name: Don't skip for manual runs
        id: manual_run
        if: github.event_name == 'workflow_dispatch'
        run: echo "skip=false" >> $GITHUB_OUTPUT

  code_style:
    runs-on: namespace-profile-medium-ubuntu-24-04-amd64
    needs: optimize_ci
    if: needs.optimize_ci.outputs.skip == 'false'
    timeout-minutes: 30
    steps:
      # Environment setup.
      - uses: actions/checkout@v6
        with:
          # Fetch the entire history. Required to checkout the merge target commit, so the diff can
          # be computed.
          fetch-depth: 0

      # Install rust components + lld.
      - uses: ./.github/actions/bootstrap
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

      # Setup pypy and link to the location expected by .cargo/config.toml.
      - uses: actions/setup-python@v5
        id: setup-pypy
        with:
          python-version: "pypy3.9"
      - run: ln -s '${{ steps.setup-pypy.outputs.python-path }}' /usr/local/bin/pypy3.9
      - env:
          LD_LIBRARY_PATH: ${{ env.Python3_ROOT_DIR }}/bin
        run: echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}" >> $GITHUB_ENV
      - run: pip install -r scripts/requirements.txt


      # Check Cargo.lock is up to date.
      - name: "Check Cargo.lock"
        run: cargo metadata --locked --format-version=1 > /dev/null

      # Run code style checks.
      - name: "Run TODO style"
        run: scripts/named_todos.py --commit_id ${{ github.event.pull_request.base.sha || 'origin/main' }}
      - name: "Run clippy"
        run: scripts/run_tests.py --command clippy --changes_only --commit_id ${{ github.event.pull_request.base.sha || 'origin/main' }}
      - name: "Run cargo doc"
        run: scripts/run_tests.py --command doc --changes_only --commit_id ${{ github.event.pull_request.base.sha || 'origin/main' }}
      - name: "Run python code style"
        run: scripts/py_code_style.py

      - name: "Run rustfmt"
        run: scripts/rust_fmt.sh --check

      - name: "Run taplo"
        run: scripts/taplo.sh
      - name: Run Machete (detect unused dependencies)
        run: cargo machete

  run-workspace-tests:
    runs-on: namespace-profile-medium-ubuntu-24-04-amd64
    needs: optimize_ci
    if: needs.optimize_ci.outputs.skip == 'false'
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v6
      - uses: ./.github/actions/bootstrap
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
      - run: cargo test -p workspace_tests

  run-tests:
    runs-on: namespace-profile-xlarge-ubuntu-24-04-amd64
    needs: optimize_ci
    if: needs.optimize_ci.outputs.skip == 'false'
    timeout-minutes: 45
    steps:
      - uses: actions/checkout@v6
        with:
          # Fetch the entire history.
          fetch-depth: 0
      - uses: ./.github/actions/bootstrap
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

      # Setup pypy and link to the location expected by .cargo/config.toml.
      - uses: actions/setup-python@v5
        id: setup-pypy
        with:
          python-version: "pypy3.9"
      - run: ln -s '${{ steps.setup-pypy.outputs.python-path }}' /usr/local/bin/pypy3.9
      - env:
          LD_LIBRARY_PATH: ${{ env.Python3_ROOT_DIR }}/bin
        run: echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}" >> $GITHUB_ENV
      - run: pip install -r scripts/requirements.txt

      # Auth with GCS for tests to download artifacts.
      - id: auth
        uses: "google-github-actions/auth@v2"
        with:
          credentials_json: ${{ secrets.SYSTEST_BLOBS_READ_ACCESS_KEY }}
      - uses: "google-github-actions/setup-gcloud@v2"

      - name: Clone starknet-specs for spec tests
        run: scripts/prepare_starknet_specs.sh /tmp/starknet-specs

      - name: "Run tests"
        run: |
          scripts/run_tests.py --command test --changes_only --include_dependencies --commit_id ${{ github.event.pull_request.base.sha || 'origin/main' }}
        env:
          SEED: 0
          STARKNET_SPECS_DIR: /tmp/starknet-specs
      - run: sccache --show-stats

  run-integration-tests:
    runs-on: namespace-profile-large-ubuntu-24-04-amd64
    needs: optimize_ci
    if: needs.optimize_ci.outputs.skip == 'false'
    timeout-minutes: 45
    steps:
      - uses: actions/checkout@v6
        with:
          # Fetch the entire history.
          fetch-depth: 0
      - uses: ./.github/actions/bootstrap
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

      # Setup pypy and link to the location expected by .cargo/config.toml.
      - uses: actions/setup-python@v5
        id: setup-pypy
        with:
          python-version: "pypy3.9"
      - run: ln -s '${{ steps.setup-pypy.outputs.python-path }}' /usr/local/bin/pypy3.9
      - env:
          LD_LIBRARY_PATH: ${{ env.Python3_ROOT_DIR }}/bin
        run: echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}" >> $GITHUB_ENV
      - run: pip install -r scripts/requirements.txt

      - name: "Run integration tests"
        run: |
          scripts/run_tests.py --command integration --changes_only --include_dependencies --commit_id ${{ github.event.pull_request.base.sha || 'origin/main' }}
        env:
          SEED: 0

  # TODO(dan): Once all cargo-deny issues are resolved, consider merging this into code_style job.
  cargo-deny:
    runs-on: namespace-profile-medium-ubuntu-24-04-amd64
    needs: optimize_ci
    if: needs.optimize_ci.outputs.skip == 'false'
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v6
      - uses: ./.github/actions/bootstrap
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
      - name: Run cargo-deny (security/license check)
        continue-on-error: true  # Warning only until all issues are resolved
        run: cargo deny check