RSpec Integration with CI Insights

This guide shows how to generate JUnit reports from your RSpec tests and upload them to CI Insights using a GitHub Actions workflow.

RSpec supports JUnit XML output through the built-in JUnit formatter. You can configure RSpec to output JUnit reports using command-line options or configuration files.

bundle exec rspec --format RspecJunitFormatter --out junit.xml

First, add the JUnit formatter gem to your Gemfile:

# Gemfile
group :test do
  gem 'rspec-junit-formatter'
end

Then run:

bundle install

Add the formatter to your .rspec file:

--format RspecJunitFormatter
--out junit.xml

Or configure it in your spec_helper.rb:

# spec/spec_helper.rb
RSpec.configure do |config|
  config.add_formatter('RspecJunitFormatter', 'junit.xml')
end

You can use multiple formatters simultaneously:

bundle exec rspec --format documentation --format RspecJunitFormatter --out junit.xml

You can also create a Rake task in your Rakefile:

require 'rspec/core/rake_task'

RSpec::Core::RakeTask.new(:spec_junit) do |t|
  t.rspec_opts = '--format RspecJunitFormatter --out junit.xml'
end

Then run:

bundle exec rake spec_junit

After generating the JUnit report, add a step to upload the results to CI Insights using the mergifyio/gha-mergify-ci action.

For example, in your workflow file:

- name: Run RSpec Tests and Generate JUnit Report
  continue-on-error: true
  run: bundle exec rspec --format RspecJunitFormatter --out junit.xml

- name: Mergify CI Upload
  if: success() || failure()
  uses: mergifyio/gha-mergify-ci@v8
  with:
    token: ${{ secrets.MERGIFY_TOKEN }}
    report_path: junit.xml

Key Points:

• if: success() || failure(): Runs the upload step even if tests fail, ensuring CI Insights has the full report.
• report_path: junit.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your CI job.

If you use a job matrix in your workflow (e.g., to test across multiple versions), ensure you set the job_name input (or MERGIFY_JOB_NAME environment variable) so CI Insights can properly distinguish reports for each matrix job.

For example, with:

jobs:
  example_matrix:
    strategy:
      matrix:
        version: [10, 12, 14]

Your upload step should look like:

- name: Mergify CI Upload
  if: success() || failure()
  uses: mergifyio/gha-mergify-ci@v8
  with:
    job_name: example_matrix (${{ matrix.version }})
    token: ${{ secrets.MERGIFY_TOKEN }}
    report_path: junit.xml

In order to benefit from CI Insights Quarantine, you need to add continue-on-error: true in your GitHb Actions step that execute your tests and generates the JUnit file. The step running the gha-mergify-ci action will determine the success or failure conclusion, considering quarantined tests.

After pushing these changes:

1. Your GitHub Actions workflow will execute your RSpec tests.
2. A JUnit report (junit.xml) is generated.
3. The Mergify CI action uploads the report to CI Insights.

You can then review your test results, including any failures or flaky tests, directly in the CI Insights dashboard.

• Gem Installation: Ensure the rspec-junit-formatter gem is properly installed and included in your Gemfile.
• RSpec Configuration: Verify that the formatter is correctly configured in your RSpec setup.
• The CLI provides information about the upload. Check the logs in GitHub Actions.
• File Paths: Double-check that the output file matches the path used in report_path.
• Permissions: Make sure the MERGIFY_TOKEN is valid and setup in your GitHub Actions secrets as explained in the docs.
• Workflow Conditions: If your step is not running, confirm the if condition is actually triggered in your job.