RSpec

A guide for generating Trunk-compatible test reports for RSpec using Trunk's RSpec plugin

You can automatically detect and manage flaky tests in your projects running RSpec by integrating with Trunk. This document explains how to use Trunk's RSpec plugin to upload test results to Trunk.

Checklist

By the end of this guide, you should achieve the following before proceeding to the next steps to configure your CI provider.

• Set up and installed Trunk's RSpec plugin

• Disable retries for better detection accuracy

• Test uploads locally

Using the plugin is the best way to accurately detect flaky RSpec tests.

You can also manually generate and upload test results in RSpec, however, manual RSpec uploads are not recommended.

Installing the plugin

Trunk detects flaky tests by analyzing test reports automatically uploaded from your CI jobs. You can do this for your Rspec tests using Trunk's RSpec plugin.

To install the plugin in your project, add the rspec_trunk_flaky_tests gem to your Gemfile:

Gemfile

gem "rspec_trunk_flaky_tests"

Install the plugin:

bundle install

Then, load the plugin in spec_helper.rb:

spec/spec_helper.rb

require "trunk_spec_helper"

Disable Retries

You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests.

If you have a step in CI to rerun failed tests with the --only-failures option, or you're using a package like rspec-retry, remember to disable them.

Try It Locally

Test Upload

Before modifying your CI jobs to automatically upload test results to Trunk, try uploading a single test run manually.

You make an upload to Trunk using the following command:

TRUNK_ORG_URL_SLUG=<TRUNK_ORG_URL_SLUG> \
TRUNK_API_TOKEN=<TRUNK_ORG_TOKEN> \
bundle exec rspec

You can find your Trunk organization URL slug and token in the Settings or by following these instructions.

After your upload, you can verify that Trunk has received and processed it successfully in the Uploads tab. Warnings will be displayed if the test report uploaded by the plugin has issues.

Next Steps

Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:

Azure DevOps Pipelines

BitBucket Pipelines

BuildKite

CircleCI

Drone CI

GitHub Actions

Gitlab

Jenkins

Semaphore

TeamCity

Travis CI

Other CI Providers