ci.yml

name: CI

on:
  push:
    branches: [ main, develop, CI/CD ]
    tags-ignore: [ 'v*' ]
  pull_request:
    branches: [ main, develop ]

env:
  CARGO_TERM_COLOR: always
  # Treat *all* compiler warnings as errors across CI (tests/build/bench), including deprecated API usage.
  # This is intentionally stricter than clippy alone; contributors must keep the codebase warning-free.
  RUSTFLAGS: "-D warnings"

jobs:
  check:
    name: Compile Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Docs guard (single canonical contributor guide)
        shell: bash
        run: |
          set -euo pipefail
          test -f CONTRIBUTING.md

          if [[ -f CONTRIBUTION.md ]]; then
            lines="$(wc -l < CONTRIBUTION.md | tr -d ' ')"
            if [[ "$lines" -gt 20 ]]; then
              echo "CONTRIBUTION.md must remain a short redirect stub (<= 20 lines)."
              exit 1
            fi
            grep -qi "deprecated" CONTRIBUTION.md
            grep -q "CONTRIBUTING.md" CONTRIBUTION.md
          fi

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Rust Cache
        uses: Swatinem/rust-cache@v2

      - name: Cargo Check
        run: cargo check --workspace --all-features

  test:
    name: Test (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    needs: check
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Rust Cache
        uses: Swatinem/rust-cache@v2

      - name: Run Tests
        run: cargo test --workspace --all-features

  vscode-extension:
    name: VS Code Extension (E2E)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Rust Cache
        uses: Swatinem/rust-cache@v2

      - name: Build soroban-debug (backend)
        run: cargo build --bin soroban-debug

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: extensions/vscode/package-lock.json

      - name: Install extension dependencies
        run: npm --prefix extensions/vscode ci

      - name: Run extension tests (includes DAP E2E)
        run: npm --prefix extensions/vscode test

  lint:
    name: Lint (Clippy & Format)
    runs-on: ubuntu-latest
    needs: check
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy, rustfmt

      - name: Rust Cache
        uses: Swatinem/rust-cache@v2

      - name: Check Formatting
        run: cargo fmt --all -- --check

      - name: Run Clippy (deny warnings)
        run: cargo clippy --workspace --all-targets --all-features -- -D warnings

  bench:
    name: Benchmark Regression Check
    runs-on: ubuntu-latest
    needs: check
    env:
      BENCH_WARN_PCT: 10
      BENCH_FAIL_PCT: 20
      # Criterion sampling knobs (tune if CI is too noisy/slow)
      BENCH_SAMPLE_SIZE: 20
      BENCH_MEASUREMENT_TIME: 5
      BENCH_WARMUP_TIME: 2
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # Needed to benchmark origin/main in a detached worktree

      - uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable

      - uses: Swatinem/rust-cache@v2

      - name: Restore benchmark baseline (from default branch)
        if: github.event_name == 'pull_request'
        uses: actions/cache/restore@v4
        with:
          path: .bench/baseline.json
          key: bench-baseline-${{ runner.os }}-${{ github.sha }}
          restore-keys: |
            bench-baseline-${{ runner.os }}-

      - name: Verify benchmark script isolation behavior
        shell: bash
        run: bash scripts/test_benchmark_regressions.sh

      - name: Run benchmark regression check
        shell: bash
        run: bash scripts/check_benchmark_regressions.sh
      - name: Run benchmarks (current)
        run: cargo bench --benches -- --noplot --sample-size $BENCH_SAMPLE_SIZE --measurement-time $BENCH_MEASUREMENT_TIME --warm-up-time $BENCH_WARMUP_TIME

      - name: Record current results (JSON)
        run: cargo run --quiet --bin bench-regression -- record --criterion target/criterion --out .bench/current.json

      - name: Compare against baseline (pass/warn/fail)
        if: github.event_name == 'pull_request'
        shell: bash
        run: |
          set -e
          report="$(cargo run --quiet --bin bench-regression -- compare \
            --baseline .bench/baseline.json \
            --current .bench/current.json \
            --warn-pct "$BENCH_WARN_PCT" \
            --fail-pct "$BENCH_FAIL_PCT" \
            --annotate-top 20 \
            --max-rows 50 \
            --require-baseline false)"
          echo "$report"
          echo "$report" >> "$GITHUB_STEP_SUMMARY"

      - name: Update baseline on main
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          mkdir -p .bench
          cp .bench/current.json .bench/baseline.json

      - name: Save baseline cache (main only)
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: actions/cache/save@v4
        with:
          path: .bench/baseline.json
          key: bench-baseline-${{ runner.os }}-${{ github.sha }}

      - name: Upload baseline artifact (main only)
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: actions/upload-artifact@v4
        with:
          name: bench-baseline-${{ runner.os }}
          path: .bench/baseline.json

  check-manpages:
    name: Check man page sync
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable

      - name: Cache Cargo registry
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-manpages-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-manpages-

      - name: Check man pages are up to date
        run: make check-man

  coverage:
    name: Code Coverage
    runs-on: ubuntu-latest
    needs: check
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      
      - name: Rust Cache
        uses: Swatinem/rust-cache@v2
      
      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov
      
      - name: Generate coverage report
        run: cargo llvm-cov --workspace --all-features --lcov --output-path lcov.info
      
      - name: Check coverage threshold
        id: coverage
        run: |
          # Generate summary and extract coverage percentage
          summary=$(cargo llvm-cov --workspace --all-features --summary-only 2>&1)
          echo "$summary"
          
          # Extract coverage percentage from the summary (look for "TOTAL" line)
          # Column 4 is the line coverage % in cargo llvm-cov --summary-only output
          coverage=$(echo "$summary" | grep -iE "^\s*TOTAL" | awk '{print $4}' | sed 's/%//' || echo "0")
          
          if [ -z "$coverage" ] || [ "$coverage" = "0" ]; then
            echo "Warning: Could not extract coverage percentage, continuing..."
            coverage="0"
          fi
          
          echo "Current coverage: ${coverage}%"
          echo "Required threshold: 50%"
          echo "coverage=${coverage}" >> $GITHUB_OUTPUT
          
          # Compare coverage (using awk for floating point comparison)
          meets_threshold=$(awk -v cov="$coverage" -v thresh="50" 'BEGIN {print (cov >= thresh)}')
          
          if [ "$meets_threshold" = "0" ]; then
            echo "Coverage ${coverage}% is below the required 50% threshold"
            exit 1
          else
            echo "Coverage ${coverage}% meets the required 50% threshold"
          fi
      
      - name: Upload to Codecov
        uses: codecov/codecov-action@v4
        with:
          file: ./lcov.info
          flags: unittests
          name: codecov-umbrella
          fail_ci_if_error: false
      
      - name: Comment PR
        if: github.event_name == 'pull_request'
        uses: marocchino/sticky-pull-request-comment@v2
        with:
          recreate: true
          message: |
            ## Code Coverage Report
            
            **Coverage: ${{ steps.coverage.outputs.coverage }}%** (Required: 50%)
            
            View the full coverage report on [Codecov](https://codecov.io/gh/${{ github.repository }}/commit/${{ github.sha }}).
            
            Coverage details are available in the [CI logs](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}).