Rust Integration with Mergify
Report your test results from Rust tests to Mergify
This guide shows how to generate JUnit reports from your Rust tests and upload them to Test Engine using your CI workflow.
Generate a JUnit report with Rust tests
Section titled Generate a JUnit report with Rust testsRust’s built-in test framework doesn’t output JUnit XML reports. You can either
run your tests through cargo-nextest, which writes JUnit XML itself, or keep
cargo test and convert its output with cargo2junit.
Using cargo-nextest
Section titled Using cargo-nextestcargo-nextest is a test runner that writes JUnit XML natively. It has no
command-line flag for it: you enable JUnit output per profile in your
.config/nextest.toml.
cargo install cargo-nextestAdd a junit section to the profile you use in CI:
[profile.ci.junit]path = "junit.xml"Then run that profile:
cargo nextest run --profile ciThe path is relative to the profile’s output directory, so this writes
target/nextest/ci/junit.xml.
Using cargo2junit
Section titled Using cargo2junitcargo2junit converts cargo’s JSON test output into JUnit XML.
cargo install cargo2junitIt reads that JSON on standard input, so cargo test has to be asked for JSON
rather than its usual human-readable output. That option is nightly-only, but
RUSTC_BOOTSTRAP=1 unlocks it on a stable toolchain:
set -o pipefailRUSTC_BOOTSTRAP=1 cargo test -- -Z unstable-options --format json --report-time | cargo2junit > junit.xmlA pipeline exits with the status of its last command unless the shell sets
pipefail, so without that line you get cargo2junit’s status rather than
that of the test run it converted.
Update your CI workflow
Section titled Update your CI workflowGitHub Actions
Section titled GitHub ActionsRun the tests in a step with an id, and let the upload step decide the
job’s result:
- name: Install cargo-nextest uses: taiki-e/install-action@nextest
- name: Run Rust Tests and Generate JUnit Report id: tests continue-on-error: true run: cargo nextest run --profile ci- name: Mergify CI Upload if: (success() || failure()) && (!github.event.pull_request || github.event.pull_request.head.repo.full_name == github.repository) uses: mergifyio/gha-mergify-ci@v30 with: report_path: target/nextest/ci/junit.xml test_step_outcome: ${{ steps.tests.outcome }}Key Points:
-
if: (success() || failure()) && (!github.event.pull_request || github.event.pull_request.head.repo.full_name == github.repository): Runs the upload step even if tests fail, so Test Engine gets the full report, and skips it on pull requests from forks, which get no ID token. -
report_path: target/nextest/ci/junit.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your CI job. -
test_step_outcome: ${{ steps.tests.outcome }}: Passes the test runner step's outcome so Mergify can detect silent failures where the runner crashed but the JUnit report appears clean. Add anid(such astests) to your test runner step and update thesteps.<id>.outcomereference to match.
If you use a job matrix in your workflow (e.g., to test across multiple versions), every leg
reports the same job name, because GitHub Actions gives them all one GITHUB_JOB. Set
the job_name input so Test Engine can tell the reports apart:
jobs: example_matrix: strategy: matrix: version: [10, 12, 14]Your upload step should look like:
- name: Mergify CI Upload if: (success() || failure()) && (!github.event.pull_request || github.event.pull_request.head.repo.full_name == github.repository) uses: mergifyio/gha-mergify-ci@v30 with: job_name: example_matrix (${{ matrix.version }}) report_path: target/nextest/ci/junit.xml test_step_outcome: ${{ steps.tests.outcome }}Alternative approach using cargo2junit, which writes wherever you redirect it:
- name: Install cargo2junit run: cargo install cargo2junit
- name: Run Rust Tests and Generate JUnit Report id: tests continue-on-error: true run: | set -o pipefail RUSTC_BOOTSTRAP=1 cargo test -- -Z unstable-options --format json --report-time | cargo2junit > junit.xmlKeep set -o pipefail here too: a run: block that omits it reports
cargo2junit’s status, so a test run that failed or panicked can still be
recorded as a success. The upload step below sends that outcome as
test_step_outcome, which is how Mergify catches a crash that left a clean
report behind.
- name: Mergify CI Upload if: (success() || failure()) && (!github.event.pull_request || github.event.pull_request.head.repo.full_name == github.repository) uses: mergifyio/gha-mergify-ci@v30 with: report_path: junit.xml test_step_outcome: ${{ steps.tests.outcome }}Key Points:
-
if: (success() || failure()) && (!github.event.pull_request || github.event.pull_request.head.repo.full_name == github.repository): Runs the upload step even if tests fail, so Test Engine gets the full report, and skips it on pull requests from forks, which get no ID token. -
report_path: junit.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your CI job. -
test_step_outcome: ${{ steps.tests.outcome }}: Passes the test runner step's outcome so Mergify can detect silent failures where the runner crashed but the JUnit report appears clean. Add anid(such astests) to your test runner step and update thesteps.<id>.outcomereference to match.
To benefit from Test Engine quarantine, you need to add continue-on-error: true
in your GitHub Actions step that executes your tests and generates the JUnit file.
The step running the gha-mergify-ci action then decides whether the job passes or fails,
taking quarantined tests into account.
You should also pass test_step_outcome: ${{ steps.tests.outcome }} to the step that runs
mergifyio/gha-mergify-ci (where tests is the id of your test runner step) to detect
silent failures where the test runner crashed but the JUnit report appears clean. Without
this input, a crash that produces a partial or empty report could be mistakenly treated as a
success.
With continue-on-error: true, the job’s result comes from the upload step,
which pull requests from forks skip: add the step that fails the job when the
tests failed and nothing was uploaded, as shown in
pull requests from forks.
Let your CI reach Mergify Preview
Section titled Let your CI reach Mergify
Grant id-token: write to the job, or to the whole workflow. The job then trades its
GitHub-signed ID token for a Mergify token, and no MERGIFY_TOKEN is stored:
permissions: id-token: write # lets the job ask GitHub for an ID token contents: read # actions/checkout needs it
A permissions block sets every permission it does not list to none: list
the ones your other steps need too.
Mergify refuses the ID token until a trust policy of your organization matches the job. A
GitHub organization Owner or a CI Admin writes one under
Settings → Security & Access → CI Authentication → Trust Policies on the
dashboard. OIDC Authentication
covers trust policies, pull requests from forks and refused exchanges. If your workflows store
MERGIFY_TOKEN today,
move them off it.
Use an application key instead
Section titled Use an application key instead
Other CIs authenticate with a ci
application key, and so do the GitHub Actions jobs OIDC
leaves out: runs for pull requests from forks when your organization sends them secrets, and jobs
that send scopes from the base branch (pull_request_target,
workflow_run, issue_comment). Store the key as the
MERGIFY_TOKEN repository secret and set it on the job:
env: MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}
A MERGIFY_TOKEN that is set wins over the ID token. For pull requests from forks,
set it on those runs only and drop the fork condition from the upload step, as
Jobs that keep a key shows. Store the key in
your
Dependabot secrets too, since runs for Dependabot pull requests read only those.
Buildkite
Section titled Buildkitesteps: - label: "Run tests" command: <your test command> plugins: - mergifyio/mergify-ci#v15: action: junit-process report_path: target/nextest/ci/junit.xmlKey Points:
-
The plugin runs in the
post-commandhook, so it uploads results after your tests finish, even if they fail. -
report_path: target/nextest/ci/junit.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your test configuration. - Silent failure detection is automatic: the plugin reads the step's exit code to detect cases where the test runner crashed but the JUnit report appears clean.
If you use a build matrix in your pipeline, each variation reports its own step label as its job
name, so the variations are already distinct. Set the job_name plugin property when the
label is not the name you want Test Engine to file the reports under:
steps: - label: "Flaky detection ({{matrix}})" matrix: - "3.10" - "3.11" - "3.12" command: <your test command> plugins: - mergifyio/mergify-ci#v15: action: junit-process job_name: "Tests ({{matrix}})" report_path: target/nextest/ci/junit.xmlWhen using the Buildkite plugin for Test Engine quarantine, the plugin automatically detects test failures using the step’s exit code. No extra configuration is needed.
The mergifyio/mergify-ci plugin runs in the post-command hook and reads
BUILDKITE_COMMAND_EXIT_STATUS to detect silent failures where the test runner
crashed but the JUnit report appears clean.
Any CI (Mergify CLI)
Section titled Any CI (Mergify CLI)
Install the Mergify CLI in your pipeline and export
MERGIFY_TOKEN. Run
mergify ci junit-process after your tests:
set -o pipefailexit_code=0cargo nextest run --profile ci || exit_code=$?mergify ci junit-process \ --test-exit-code "$exit_code" \ target/nextest/ci/junit.xmlKey Points:
-
MERGIFY_TOKEN: Export this environment variable with your Mergify application key sojunit-processcan authenticate to the API. On GitHub Actions, a job grantedid-token: writeneeds none: it trades its ID token for a Mergify token, as OIDC Authentication explains. -
|| exit_code=$?: CI shells run with-e, so a failing test command on its own line would end the script before the upload. This form keeps going and records the code. The script needs bash forset -o pipefail: on Jenkins, whoseshsteps often rundash, start it with#!/bin/bash. -
--test-exit-code "$exit_code": Passes the test runner's exit code so Mergify can detect silent failures where the runner crashed but the JUnit report appears clean. -
junit-processexits last, so its status becomes the step's. Quarantine depends on that: it exits0when every failure it found is quarantined, and1when one is not. Re-exiting with the test runner's own code would fail the step whatever quarantine decided. -
The branch quarantine is evaluated against is detected from your CI provider: the pull
request's base branch, falling back to the branch built. Pass
--tests-target-branch <branch>to override it, or to name one where your provider reports neither — with no branch to look tests up on, quarantine is off for the run and every failure blocks.
Verify and review in Test Engine
Section titled Verify and review in Test EngineAfter pushing these changes:
- Your CI workflow runs your Rust tests.
cargo-nextestwritestarget/nextest/ci/junit.xml, orcargo2junitwrites the file you redirect it to.- Mergify uploads the report to Test Engine.
You can then review your test results, including any failures or flaky tests, directly in the Test Engine dashboard.
Troubleshooting tips
Section titled Troubleshooting tips- Tool installation: Ensure
cargo-nextestorcargo2junitis properly installed before running tests. - Output format: Verify that the chosen tool generates valid JUnit XML format.
- 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. Authentication: The upload step’s log says why Mergify refused the job’s ID token, as OIDC troubleshooting details. A job that sets
MERGIFY_TOKENuses that key instead: check that it is valid and granted CI Reporting, or move the job off it.- Workflow conditions: If your step is not running, confirm the if condition is actually triggered in your job.
Was this page helpful?
Thanks for your feedback!