Skip to content

gitlab.md

Latest commit

 

History

History
151 lines (104 loc) · 6.27 KB

gitlab.md

File metadata and controls

151 lines (104 loc) · 6.27 KB
description Configure Flaky Tests using GitLab CI

GitLab

Trunk Flaky Tests integrates with your CI by adding a step in your GitLab CI/CD pipelines to upload tests with the Trunk Analytics CLI.

{% include "../../../.gitbook/includes/not-using-github-for-source....md" %}

Before you start on these steps, see the Test Frameworks docs for instructions on producing a Trunk-compatible output 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 a variable in CI
  • Configure your CI 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 the Trunk Token as a Secret

Store the Trunk slug and API token obtained in the previous step in your GitLab CI/CD pipelines as new GitLab Variables 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 be minimally all jobs that run on pull requests, as well as from 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 GitLab Pipeline

The following is an example of a GitLab pipeline step to upload test results after your tests run. Note: you must either run trunk from the repo root when uploading test results or pass a --repo-root argument.

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

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="XML" %}

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: ...

upload_test_results: # This job uploads tests results run in the last stage to Trunk.io
  stage: flaky-tests
  script:
    - curl -fL --retry 3 "https://github.com/trunk-io/analytics-cli/releases/latest/download/trunk-analytics-cli-x86_64-unknown-linux.tar.gz" | tar -xz && chmod +x trunk-analytics-cli
    - ./trunk-analytics-cli upload --junit-paths "<XML_GLOB_PATH>" --org-url-slug <TRUNK_ORG_SLUG> --token $TRUNK_TOKEN

{% endtab %}

{% tab title="Bazel" %}

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: ...

upload_test_results: # This job uploads tests results run in the last stage to Trunk.io
  stage: flaky-tests
  script:
    - curl -fL --retry 3 "https://github.com/trunk-io/analytics-cli/releases/latest/download/trunk-analytics-cli-x86_64-unknown-linux.tar.gz" | tar -xz && chmod +x trunk-analytics-cli
    - ./trunk-analytics-cli upload --bazel-bep-path <BEP_JSON_PATH> --org-url-slug <TRUNK_ORG_SLUG> --token $TRUNK_TOKEN

{% endtab %}

{% tab title="XCode" %}

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: ...

upload_test_results: # This job uploads tests results run in the last stage to Trunk.io
  stage: flaky-tests
  script:
    - curl -fL --retry 3 "https://github.com/trunk-io/analytics-cli/releases/latest/download/trunk-analytics-cli-x86_64-unknown-linux.tar.gz" | tar -xz && chmod +x trunk-analytics-cli
    - ./trunk-analytics-cli upload --xcresult-path <XCRESULT_PATH> --org-url-slug <TRUNK_ORG_SLUG> --token $TRUNK_TOKEN

{% endtab %}

{% tab title="RSpec plugin" %}

image: node:latest

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

unit_test_job:   # This job runs the tests and uploads the results to Trunk.io
  stage: test    
  script:
    - TRUNK_ORG_URL_SLUG=$TRUNK_ORG_SLUG TRUNK_API_TOKEN=$TRUNK_TOKEN bundle exec rspec

{% endtab %} {% endtabs %}

{% hint style="info" %} The examples above use the Linux x64 binary. If your CI runs on a different platform, see the Trunk Analytics CLI page for all available platform downloads. {% endhint %}

See the uploader.md for all available command line arguments and usage.

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.

{% hint style="success" %} Have questions?

Join us and 1500+ fellow engineers on Slack to get help with Trunk. {% endhint %}