Skip to content

github-actions.md

Latest commit

 

History

History
342 lines (265 loc) · 12.6 KB

github-actions.md

File metadata and controls

342 lines (265 loc) · 12.6 KB
description Configure Flaky Tests detection using a GitHub Action

GitHub Actions

Trunk Flaky Tests integrates with your CI by adding a step in your GitHub Action workflow to upload tests with the Trunk Analytics CLI.

Before you start these steps, see the Test Frameworks docs for instructions on producing Trunk-compatible reports for your test framework.

Checklist

By the end of this guide, you should achieve the following.

  • Get your Trunk organization slug and token
  • Set your slug and token as secrets in GitHub Actions
  • Configure GitHub Actions to upload to Trunk
  • Validate your uploads in Trunk

After completing these checklist items, you'll be integrated with Trunk.

Trunk Organization Slug and Token

Before setting up uploads to Trunk, you must sign in to app.trunk.io and obtain your Trunk organization slug and token.

Trunk Slug

You can find your organization slug under Settings > Organization > Manage > Organization Name > Slug. You'll save this as a variable in CI in a later step.

Trunk Token

You can find your token under Settings > Organization > Manage > Organization API Token > View Organization API Token > View. Since this is a secret, do not leak it publicly. Ensure you get your organization token, not your project/repo token.

Add Your Trunk Token and Organization Slug as Secrets

Store the Trunk slug and API token obtained in the previous step in your repo as GitHub secrets named TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.

Upload to Trunk

Add an Upload Test Results step after running tests in each of your CI jobs that run tests. This should minimally include all jobs that run on pull requests, as well as jobs that run on your main or stable branches, for example, main, master, or develop.

{% hint style="danger" %} It is important to upload test results from CI runs on stable branches, such as main, master, or develop. This will give you a stronger signal about the health of your code and tests.

Trunk can also detect test flakes on PR and merge branches. To best detect flaky tests, it is recommended to upload test results from stable, PR, and merge branch CI runs.

Learn more about detection {% endhint %}

Example GitHub Actions Workflow

The following is an example of a GitHub Actions workflow step to upload test results after your tests using Trunk's Analytics Uploader Action.

To find out how to produce the report files the uploader needs, see the instructions for your test framework in the Test Frameworks docs.

{% tabs %} {% tab title="JUnit XML" %}

jobs:
  test:
    name: Upload Tests
    runs-on: ubuntu-latest

    steps:
      - name: Run Tests
        run: ...

      - name: Upload Test Results to Trunk.io
        if: ${{ !cancelled() }} # Upload the results even if the tests fail
        continue-on-error: true # don't fail this job if the upload fails
        uses: trunk-io/analytics-uploader@v1
        with:
          junit-paths: **/junit.xml        
          org-slug: <TRUNK_ORG_SLUG>
          token: ${{ secrets.TRUNK_TOKEN }}

{% endtab %}

{% tab title="XCResult Path" %}

jobs:
  test:
    name: Upload Tests
    runs-on: ubuntu-latest

    steps:
      - name: Run Tests
        run: ...

      - name: Upload Test Results to Trunk.io
        if: ${{ !cancelled() }} # Upload the results even if the tests fail
        continue-on-error: true # don't fail this job if the upload fails
        uses: trunk-io/analytics-uploader@v1
        with:
          xcresult-path: ./test-results.xcresult        
          org-slug: <TRUNK_ORG_SLUG>
          token: ${{ secrets.TRUNK_TOKEN }}

{% endtab %}

{% tab title="Bazel BEP JSON" %}

jobs:
  test:
    name: Upload Tests
    runs-on: ubuntu-latest

    steps:
      - name: Run Tests
        run: ...

      - name: Upload Test Results to Trunk.io
        if: ${{ !cancelled() }} # Upload the results even if the tests fail
        continue-on-error: true # don't fail this job if the upload fails
        uses: trunk-io/analytics-uploader@v1
        with:
          bazel-bep-path: ./build_events.json        
          org-slug: <TRUNK_ORG_SLUG>
          token: ${{ secrets.TRUNK_TOKEN }}

{% endtab %}

{% tab title="RSpec plugin" %}

jobs:
  test:
    name: Run and Upload Tests
    runs-on: ubuntu-latest

    steps:
      - name: Run Tests and Upload Results to Trunk.io
        run: TRUNK_ORG_URL_SLUG=${{ secrets.TRUNK_ORG_SLUG }} TRUNK_API_TOKEN=${{ secrets.TRUNK_TOKEN }} bundle exec rspec

{% endtab %} {% endtabs %}

See the GitHub Actions Reference page for all available CLI arguments and usage.

Enable quarantining

You can quarantine flaky tests by wrapping the test command or as a follow-up step.

{% tabs %} {% tab title="GitHub Actions Workflow" %} {% hint style="warning" %} Using the Trunk Analytics Uploader Action in your GitHub Actions Workflow files, may need modifications to your workflow files to support quarantining.

If you upload your test results as a second step after you run your tests, you need to add continue-on-error: true on your test step so your CI job will continue even on failures. {% endhint %}

Here's an example file.

name: Run Tests And Upload Results
on:
  workflow_dispatch:
jobs:
  upload-test-results:
    runs-on: ubuntu-latest
    timeout-minutes: 60
    steps:   
    - name: Run Tests
      id: unit_tests
      shell: bash
      run: <COMMAND TO RUN TESTS> # command to run tests goes here
      continue-on-error: true # allow CI job to continue to upload step on errors
        
    - name: Upload test results
      if: always()
      uses: trunk-io/analytics-uploader@v1
      with:
        junit-paths: <TEST OUTPUT PATH>
        org-slug: my-trunk-org-slug
        token: ${{ secrets.TRUNK_TOKEN }}

If you want to run the test command and upload in a single step, the test command must be run via the Analytics Uploader through the run: <COMMAND TO RUN TESTS> parameter.

This will override the response code of the test command. Make sure to set continue-on-error: false so un-quarantined tests are blocking.

name: Run Tests And Upload Results
on:
  workflow_dispatch:
jobs:
  upload-test-results:
    runs-on: ubuntu-latest
    timeout-minutes: 60
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Run tests and upload results
        uses: trunk-io/analytics-uploader@v1
        with:
          junit-paths: <TEST OUTPUT PATH>
          run: <COMMAND TO RUN TESTS> # command to run tests goes here
          org-slug: my-trunk-org-slug
          token: ${{ secrets.TRUNK_TOKEN }}

{% endtab %}

{% tab title="Using The Trunk Analytics CLI Directly" %} Using Flaky Tests as a separate step

{% hint style="warning" %} If you upload your test results as a second step after you run your tests, you need to make sure your test step continues on errors so the upload step that's run after can quarantine failed tests.

When quarantining is enabled, the trunk-analytics-cli upload command will return an error if there are unquarantined failures and return a status code 0 if all tests are quarantined. {% endhint %}

<run my tests> || true # doesn't fail job on failure
|
    ./trunk-analytics-cli upload \
        --org-url-slug $TRUNK_ORG_SLUG \
        --token $TRUNK_TOKEN \
        --junit-paths $JUNIT_PATH

Using Flaky Tests as a single step

You can also wrap the test command with the Trunk Analytics CLI. When wrapping the command with the Trunk Analytics CLI, if there are unquarantined tests, the command will return an error. If there are no unquarantined tests, the command will return a status code 0.

{% code overflow="wrap" %}

./trunk-analytics-cli test \
    --org-url-slug <TRUNK_ORG_SLUG> \
    --token $TRUNK_TOKEN \
    --junit-paths $JUNIT_PATH \
    --allow-empty-test-results \
    <Test Command>

{% endcode %} {% endtab %} {% endtabs %}

Stale files

Ensure you report every test run in CI and clean up stale files produced by your test framework. If you're reusing test runners and using a glob like **/junit.xml to upload tests, stale files not cleaned up will be included in the current test run, throwing off detection of flakiness. You should clean up all your results files after every upload step.

Getting Direct Links to Job Logs

{% hint style="info" %} Direct Links to Job Logs is an optional configuration, and relies on a third-party actions dependency. {% endhint %}

By default, Trunk Flaky Tests links to your overall workflow run when you click "Logs" on a test failure. However, GitHub Actions makes it difficult to get a direct link to the specific job where the test ran.

If you want direct links to individual job logs instead of the workflow run, you can manually set the JOB_URL environment variable using a third-party action to extract the job ID.

Setup

  1. Add the job ID extraction step to your workflow using a community action:
jobs:  
  run_tests:
    runs-on: ubuntu-latest
    name: Run Tests  # This name is important - use it in the next step
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      # Extract the job ID
      - name: Get Job ID
        id: get-job-id
        uses: ayachensiyuan/get-action-job-id@v1.6
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          job-name: Run Tests  # Must match the job 'name' above
  1. Pass the job URL when uploading test results:
      - name: Run Tests
        id: unit_tests
        run: <COMMAND TO RUN TESTS>
        continue-on-error: true
        
      - name: Upload test results
        if: always()
        uses: trunk-io/analytics-uploader@v1
        with:
          junit-paths: <TEST OUTPUT PATH>
          org-slug: my-trunk-org-slug
          token: ${{ secrets.TRUNK_TOKEN }}
        env:
          JOB_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/job/${{ steps.get-job-id.outputs.jobId }}

Complete Example

Here's a full workflow example with direct job linking:

name: Run Tests And Upload Results
on:
  push:
  pull_request:

jobs:  
  test-suite:
    runs-on: ubuntu-latest
    name: Test Suite
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Get Job ID
        id: get-job-id
        uses: ayachensiyuan/get-action-job-id@v1.6
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          job-name: Test Suite
        
      - name: Run Tests
        run: npm test
        continue-on-error: true
        
      - name: Upload test results
        if: always()
        uses: trunk-io/analytics-uploader@v1
        with:
          junit-paths: junit.xml
          org-slug: my-trunk-org-slug
          token: ${{ secrets.TRUNK_TOKEN }}
        env:
          JOB_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/job/${{ steps.get-job-id.outputs.jobId }}

How It Works

  • The ayachensiyuan/get-action-job-id action extracts the GitHub Actions job ID
  • We construct the full job URL using: https://github.com/{repo}/actions/runs/{run_id}/job/{job_id}
  • This URL is passed to Trunk via the JOB_URL environment variable
  • When you click "Logs" on a test failure in Trunk, you'll go directly to that job's logs instead of the workflow overview

Notes

  • The job-name parameter must exactly match your job's name field
  • The GITHUB_TOKEN must have appropriate permissions to read workflow job information
  • If the job ID extraction fails, Trunk will fall back to linking to the workflow run