rust.yml

name: Rust tests

on:
  push:
    branches: [ master, dev ]
  pull_request:
    branches: [ '**' ]

env:
  CARGO_TERM_COLOR: always

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ ubuntu-latest, windows-latest, macos-latest ]

    steps:
    - name: Install minimal stable
      uses: dtolnay/rust-toolchain@stable
    - uses: actions/checkout@v4
    - uses: Swatinem/rust-cache@v2
    - name: Install Protoc
      uses: arduino/setup-protoc@v3
      with:
        repo-token: ${{ secrets.GITHUB_TOKEN }}
    - name: Install nextest
      uses: taiki-e/install-action@nextest
    - name: Build
      run: cargo build --tests --workspace
    - name: Run tests
      # Profile "ci" is configured in .config/nextest.toml
      run: cargo nextest run --workspace --profile ci
    - name: Upload test report
      uses: actions/upload-artifact@v4
      with:
        name: junit-${{ matrix.os }}.xml
        path: target/nextest/ci/junit.xml

  # After tests are run, this hacky script will process the JUnit output of nextest
  # and will create a GH Issue if there is a test marked as flaky,
  # Failure of updating an issue is ignored because it fails for external contributors.
  process-results:
    runs-on: ubuntu-latest
    needs: test
    permissions:
      contents: read
      issues: write
    strategy:
      matrix:
        os: [ ubuntu-latest, windows-latest, macos-latest  ]
    steps:
      - name: Download test report
        uses: actions/download-artifact@v4
        with:
          name: junit-${{ matrix.os }}.xml
      - name: Process test report
        id: process-test-report
        run: |
          pip install yq
          xq '.. | select(type == "object") | select(has("flakyFailure"))' junit.xml > flaky_tests.json
          echo has_flaky_tests=$(jq '. | has("flakyFailure")' flaky_tests.json) >> $GITHUB_OUTPUT
      - name: Get flaky test details
        id: get-flaky-tests
        if: ${{ steps.process-test-report.outputs.has_flaky_tests == 'true' }}
        run: |
          echo "Flaky tests found"
          echo test=$(jq '.["@name"]' flaky_tests.json -r ) >> $GITHUB_OUTPUT
          delimiter="###r###"
          echo "content<<$delimiter" >> $GITHUB_OUTPUT
          echo "$(jq '[.flakyFailure] | flatten | .[0]["system-err"]' flaky_tests.json -r)" >> $GITHUB_OUTPUT
          echo $delimiter >> $GITHUB_OUTPUT
      - name: pull issue template
        if: ${{ steps.process-test-report.outputs.has_flaky_tests == 'true' }}
        uses: actions/checkout@v4
        with:
          sparse-checkout: |
            .github/ISSUE_TEMPLATE/flaky_test.md
          sparse-checkout-cone-mode: false
      - name: Create issue for flaky tests
        continue-on-error: true
        id: create-issue
        if: ${{ steps.process-test-report.outputs.has_flaky_tests == 'true' }}
        uses: JasonEtco/create-an-issue@v2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          TEST_NAME: ${{ steps.get-flaky-tests.outputs.test }}
          SYSTEM_ERROR: ${{ steps.get-flaky-tests.outputs.content }}
          REPOSITORY: ${{ github.repository }}
          RUN_ID: ${{ github.run_id }}
          JOB_ID: ${{ github.job }}
          SHA: ${{ github.sha }}
          WORKFLOW: ${{ github.workflow }}
          JOB: ${{ github.job }}
          BRANCH: ${{ github.ref }}
          OS: ${{ matrix.os }}
          PR: "#${{ github.event.pull_request.number }}"
        with:
          filename: .github/ISSUE_TEMPLATE/flaky_test.md
          update_existing: true