Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 3.3 KB

travisci.md

File metadata and controls

59 lines (35 loc) · 3.3 KB
description
Configure Flaky Tests using Travis CI

Travis CI

Introduction

Trunk Flaky Tests integrates with your CI by adding an Upload Test Results step in each of your Travis CI jobs via the Trunk Uploader CLI.

Before you start on these steps, see the Test Frameworks docs for instructions on producing JUnit XML output for your test runner, supported by virtually all test frameworks, which is what Trunk ingests.

1. Store a TRUNK_TOKEN secret in your CI system

In app.trunk.io, navigate to:

Settings > Organization > Manage > Organization API Token > View Organization API Token > View

Store your API Token a secret named TRUNK_TOKEN in your Travis CI project settings. Make sure you are getting your organization token, not your project/repo token.

2. Grab your Organization Slug

To upload test results to Trunk, you'll need to pass a Trunk Organization Slug to the upload command. To get your organization slug, In app.trunk.io, navigate to:

Settings > Organization > Manage > Organization Name > Slug

Your Trunk Organization Slug can just be pasted directly into your CI workflow; it's not a secret. In the example workflow in the next step, replace TRUNK_ORG_SLUG with your actual organization slug.

3. Modify Travis CI workflows to upload test results

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.

{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}

Example Travis CI Workflow

The following is an example of a Travis CI workflow 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 JUnit XML files the uploader needs, see the instructions for your test framework in the frameworks docs.

Note that TravisCI requires a recent version of Linux to use the current NodeJS runtimes. You may need to set the dist to jammy or later. See this forum note for more details.

language: node_js
dist: jammy
node_js:
  - 20
script:
  - curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x ./trunk
  - ./trunk flakytests upload --junit-paths "**/report.xml" --org-url-slug <TRUNK_ORG_SLUG> --token $TRUNK_TOKEN

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.

{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}