tests-linux-stable-coverage.yml

# GHA for test-linux-stable-int, test-linux-stable, test-linux-stable-oldkernel
name: tests linux stable coverage

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

jobs:

  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.
    if: contains(github.event.label.name, 'GHA-coverage') || contains(github.event.pull_request.labels.*.name, 'GHA-coverage')
    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
      - 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

  #
  #
  #
  test-linux-stable-coverage:
    needs: [set-image]
    runs-on: ${{ needs.set-image.outputs.RUNNER }}
    timeout-minutes: 120
    container:
      image: ${{ needs.set-image.outputs.IMAGE }}
    env:
      RUST_TOOLCHAIN: stable
      # Enable debug assertions since we are running optimized builds for testing
      # but still want to have debug assertions.
      #
      # -Cinstrument-coverage slows everything down but it is necessary for code coverage
      # https://doc.rust-lang.org/rustc/instrument-coverage.html
      RUSTFLAGS: "-Cdebug-assertions=y -Dwarnings -Cinstrument-coverage"
      LLVM_PROFILE_FILE: "/__w/polkadot-sdk/polkadot-sdk/target/coverage/cargo-test-${{ matrix.ci_node_index }}-%p-%m.profraw"
    strategy:
      fail-fast: false
      matrix:
        ci_node_index: [1, 2, 3, 4, 5]
        ci_node_total: [5]
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - run: rustup component add llvm-tools-preview
      - run: cargo install cargo-llvm-cov

      - run: mkdir -p target/coverage

      # Some tests are excluded because they run very slowly or fail with -Cinstrument-coverage
      - name: run tests
        run: >
          time cargo llvm-cov nextest
          --no-report --release
          --workspace
          --locked --no-fail-fast
          --features try-runtime,ci-only-tests,experimental,riscv
          --filter-expr "
          !test(/.*benchmark.*/)
          - test(/recovers_from_only_chunks_if_pov_large::case_1/)
          - test(/participation_requests_reprioritized_for_newly_included/)
          - test(/availability_is_recovered_from_chunks_if_no_group_provided::case_1/)
          - test(/rejects_missing_inherent_digest/)
          - test(/availability_is_recovered_from_chunks_even_if_backing_group_supplied_if_chunks_only::case_1/)
          - test(/availability_is_recovered_from_chunks_if_no_group_provided::case_2/)
          - test(/all_security_features_work/)
          - test(/nonexistent_cache_dir/)
          - test(/recovers_from_only_chunks_if_pov_large::case_3/)
          - test(/recovers_from_only_chunks_if_pov_large::case_2/)
          - test(/authoring_blocks/)
          - test(/rejects_missing_seals/)
          - test(/generate_chain_spec/)
          - test(/get_preset/)
          - test(/list_presets/)
          - test(/tests::receive_rate_limit_is_enforced/)
          - test(/polkadot-availability-recovery/)
          "
          --partition count:${{ matrix.ci_node_index }}/${{ matrix.ci_node_total }}

      - name: generate report
        run: cargo llvm-cov report --release --codecov --output-path coverage-${{ matrix.ci_node_index }}.lcov
      - name: upload report
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report-${{ matrix.ci_node_index }}.lcov
          path: coverage-${{ matrix.ci_node_index }}.lcov

  #
  #
  # Upload to codecov
  upload-reports:
    needs: [test-linux-stable-coverage]
    runs-on: ubuntu-latest
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v4
        with:
          path: reports
          pattern: coverage-report-*
          merge-multiple: true
      - run: ls -al reports/
      - name: Upload to Codecov
        uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          verbose: true
          directory: reports
          root_dir: /__w/polkadot-sdk/polkadot-sdk/
  
  #
  #
  #
  remove-label:
    runs-on: ubuntu-latest
    needs: [upload-reports]
    if: github.event_name == 'pull_request'    
    steps:
      - uses: actions/checkout@v2
      - uses: actions-ecosystem/action-remove-labels@v1
        with:
          labels: GHA-coverage