GitLab

Configure Flaky Tests using GitLab CI

Getting Started

You can use the Flaky Tests CLI within your GitLab Pipelines to upload your test results.

The Trunk Flaky Tests CLI currently only supports x86_64 and arm64 for both Linux and macOS. If you have another use case, please get in touch with support at https://slack.trunk.io. For the best results, you'll need to validate that your test invocation doesn't use cached test results and doesn't automatically retry failing tests.

Create workflow

Create a GitLab pipeline that runs the tests you want to monitor. In order for us to use the results, these tests must produces a test report in JUnit XML format.

Find Organization Slug and Token

Next you will need your Trunk organization slug and token. Navigate to app.trunk.io. Once logged in navigate to Settings -> Manage -> Organization. Copy your organization slug. You can find your Trunk token by navigating to Settings → Manage Organization → Organization API Token and clicking "View." Copy this token.

Create GitLab CI/CD Pipeline Variables

Create a GitLab Variable for your TRUNK_API_TOKEN by navigating to your GitLab project's Settings > CI/CD > Variables. You will use this variable in the next steps to upload test results to Flaky Tests.

Add Analytics CLI to Testing Workflow

You can upload test results to Flaky Tests with the trunk-analytics-cli by running it in a stage after your tests are complete. There are four different OS/arch builds of the CLI in the latest release. Pick the one you need for your testing platform and be sure to download the release on every CI run. Do not bake the CLI into a container or VM. This ensures your CI runs are always using the latest build.

upload.yaml
image: node:latest

stages:          # List of stages for jobs, and their order of execution
  - test
  - flaky-tests

unit-test-job:   # This job runs the tests
  stage: test    
  script:
    - npm install 
    - npm test --config=javascript/tests/jest/jest.config.json javascript/tests/jest/**/*.js

upload_test_results: # This job uploads tests results run in the last stage
  stage: flaky-tests
  script:
    - curl -fsSL --retry 3 "https://github.com/trunk-io/analytics-cli/releases/latest/download/trunk-analytics-cli-x86_64-unknown-linux.tar.gz" | tar -xvz > ./trunk-analytics-cli
    - ./trunk-analytics-cli upload --junit-paths "tests/jest/jest_junit_test.xml" --org-url-slug <TRUNK_ORG_SLUG> --token $TRUNK_API_TOKEN

The trunk-analytics-cli tool has several important arguments;

  • --junit-pathsis a comma separated list of paths.

  • --org-url-slug is an identifier for the Trunk account you are using. This is the Organization Slug you copied from your Trunk settings above set as a GitLab Variable.

  • --token is the Trunk API token you added as a GitLab Variable above.

If you're interested in better understanding this binary or want to contribute to it, you can find the open source repo here.

Last updated