pr-differences-mutants.yml

name: PR Differences Mutants

on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize
      - ready_for_review
    paths:
      - "**.rs"

concurrency:
  group: pr-differences-${{ github.head_ref || github.ref || github.run_id }}
  # Always cancel duplicate jobs
  cancel-in-progress: true

jobs:
  # Check and output whether to run big (`stacks-node`/`stackslib`) or small (others) packages with or without shards
  check-big-packages-and-shards:
    name: Check Packages and Shards

    runs-on: ubuntu-latest
    
    outputs:
      run_big_packages: ${{ steps.check_packages_and_shards.outputs.run_big_packages }}
      big_packages_with_shards: ${{ steps.check_packages_and_shards.outputs.big_packages_with_shards }}
      run_small_packages: ${{ steps.check_packages_and_shards.outputs.run_small_packages }}
      small_packages_with_shards: ${{ steps.check_packages_and_shards.outputs.small_packages_with_shards }}

    steps:
      - id: check_packages_and_shards
        uses: stacks-network/actions/stacks-core/mutation-testing/check-packages-and-shards@feat/mutation-testing

  # Mutation testing - Execute on PR on small packages that have functions modified (normal run, no shards)
  pr-differences-mutants-small-normal:
    name: Mutation Testing - Normal, Small

    needs: check-big-packages-and-shards

    if: ${{ needs.check-big-packages-and-shards.outputs.run_small_packages == 'true' && needs.check-big-packages-and-shards.outputs.small_packages_with_shards == 'false' }}

    runs-on: ubuntu-latest

    steps:
      - name: Run mutants on diffs
        uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
        with:
          package-dimension: "small"

  # Mutation testing - Execute on PR on small packages that have functions modified (run with strategy matrix shards)
  pr-differences-mutants-small-shards:
    name: Mutation Testing - Shards, Small

    needs: check-big-packages-and-shards

    if: ${{ needs.check-big-packages-and-shards.outputs.run_small_packages == 'true' && needs.check-big-packages-and-shards.outputs.small_packages_with_shards == 'true' }}

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        shard: [0, 1, 2, 3]

    steps:
      - name: Run mutants on diffs
        uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
        with:
          shard: ${{ matrix.shard }}
          package-dimension: "small"

  # Mutation testing - Execute on PR on big packages that have functions modified (normal run, no shards)
  pr-differences-mutants-big-normal:
    name: Mutation Testing - Normal, Big

    needs: check-big-packages-and-shards

    if: ${{ needs.check-big-packages-and-shards.outputs.run_big_packages == 'true' && needs.check-big-packages-and-shards.outputs.big_packages_with_shards == 'false' }}

    runs-on: ubuntu-latest

    steps:
      - name: Run Run mutants on diffs
        env:
          BITCOIND_TEST: 1
          RUST_BACKTRACE: full
        uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
        with:
          package-dimension: "big"

  # Mutation testing - Execute on PR on big packages that have functions modified (run with strategy matrix shards)
  pr-differences-mutants-big-shards:
    name: Mutation Testing - Shards, Big

    needs: check-big-packages-and-shards

    if: ${{ needs.check-big-packages-and-shards.outputs.run_big_packages == 'true' && needs.check-big-packages-and-shards.outputs.big_packages_with_shards == 'true' }}

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        shard: [0, 1, 2, 3, 4, 5, 6, 7]

    steps:
      - name: Run mutants on diffs
        env:
          BITCOIND_TEST: 1
          RUST_BACKTRACE: full
        uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
        with:
          shard: ${{ matrix.shard }}
          package-dimension: "big"

  # Output the mutants and fail the workflow if there are missed/timeout/unviable mutants
  output-mutants:
    name: Output Mutants

    runs-on: ubuntu-latest

    if: always()
    needs:
      [
        check-big-packages-and-shards,
        pr-differences-mutants-small-normal,
        pr-differences-mutants-small-shards,
        pr-differences-mutants-big-normal,
        pr-differences-mutants-big-shards,
      ]

    steps:
      - name: Output Mutants
        uses: stacks-network/actions/stacks-core/mutation-testing/output-pr-mutants@feat/mutation-testing
        with:
          big_packages: ${{ needs.check-big-packages-and-shards.outputs.run_big_packages }}
          shards_for_big_packages: ${{ needs.check-big-packages-and-shards.outputs.big_packages_with_shards }}
          small_packages: ${{ needs.check-big-packages-and-shards.outputs.run_small_packages }}
          shards_for_small_packages: ${{ needs.check-big-packages-and-shards.outputs.small_packages_with_shards }}