View as Markdown

Behave Integration with Mergify

Report your test results from Behave to Mergify


This guide shows how to generate JUnit reports from your Behave scenarios and upload them to Test Engine from your CI workflow.

Generate a JUnit report with Behave

Section titled Generate a JUnit report with Behave

Behave writes JUnit XML itself, one file per feature file, next to its console output. Turn it on from the command line:

Terminal windowbash
behave --junit --junit-directory test-reports

Or once in your Behave configuration file, such as behave.ini, so a plain behave writes the reports:

behave.iniini
[behave]
junit = true
junit_directory = test-reports

Each feature file gets a report named after its path: features/sub/checkout.feature becomes test-reports/TESTS-sub.checkout.xml.

Run the scenarios in a step with an id, and let the upload step decide the job’s result:

yaml
- name: Run Behave Scenarios
id: tests
continue-on-error: true
run: behave --junit --junit-directory test-reports
yaml
- 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: test-reports/*.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: test-reports/*.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 an id (such as tests) to your test runner step and update the steps.<id>.outcome reference 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:

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

Your upload step should look like:

yaml
- 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: test-reports/*.xml
test_step_outcome: ${{ steps.tests.outcome }}

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:

yaml
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 → Developer → OIDC 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.

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:

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

yaml
steps:
- label: "Run tests"
command: <your test command>
plugins:
- mergifyio/mergify-ci#v15:
action: junit-process
report_path: test-reports/*.xml

Key Points:

  • The plugin runs in the post-command hook, so it uploads results after your tests finish, even if they fail.
  • report_path: test-reports/*.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:

yaml
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: test-reports/*.xml

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

Install the Mergify CLI in your pipeline and export MERGIFY_TOKEN. Run mergify ci junit-process after your tests:

Terminal windowbash
set -o pipefail
exit_code=0
behave --junit --junit-directory test-reports || exit_code=$?
mergify ci junit-process \
--test-exit-code "$exit_code" \
test-reports/*.xml

Key Points:

  • MERGIFY_TOKEN: Export this environment variable with your Mergify application key so junit-process can authenticate to the API. On GitHub Actions, a job granted id-token: write needs 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 for set -o pipefail: on Jenkins, whose sh steps often run dash, 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-process exits last, so its status becomes the step's. Quarantine depends on that: it exits 0 when every failure it found is quarantined, and 1 when 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.

Each scenario is a test in Test Engine, named by its feature file’s path under features/ (dotted), its feature and its own name: the scenario Add an item of the feature Cart in features/cart.feature is reported as cart.Cart.Add an item. Renaming a scenario, its feature or its file starts a new history for it.

Each row of a scenario outline’s examples is a test of its own, named after its position in the examples tables rather than its values: cart.Cart.Add many -- @1.2. Inserting a row above it, or reordering the rows, moves those names onto other rows.

Scenarios left out by --tags are reported as skipped.

Verify and review in Test Engine

Section titled Verify and review in Test Engine

After pushing these changes:

  1. Your CI workflow runs your Behave scenarios.
  2. Behave writes a report per feature file under test-reports/.
  3. Mergify uploads the reports to Test Engine.

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

  • No reports: junit_directory alone does not turn the reports on. Set junit = true as well, or pass --junit.

  • 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_TOKEN uses 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?