Pest Integration with CI Insights

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

Pest is built on top of PHPUnit and supports JUnit XML reports through PHPUnit’s logging capabilities. You can configure Pest to output JUnit reports using command-line options or configuration files.

./vendor/bin/pest --log-junit junit.xml

Add the logging configuration to your phpunit.xml or phpunit.xml.dist (Pest uses PHPUnit’s configuration):

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
         bootstrap="vendor/autoload.php">
    <testsuites>
        <testsuite name="Test Suite">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
    <logging>
        <junit outputFile="junit.xml"/>
    </logging>
</phpunit>

Then run:

./vendor/bin/pest

You can also add a script to your composer.json:

{
    "scripts": {
        "test": "pest --log-junit junit.xml"
    }
}

Then run:

composer test

You can also configure logging in your Pest.php file:

<?php

use Pest\TestSuite;

TestSuite::getInstance()->log('junit', 'junit.xml');

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 Pest Tests and Generate JUnit Report
  continue-on-error: true
  run: ./vendor/bin/pest --log-junit 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 Pest 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.

• Pest Configuration: Ensure Pest is properly installed via Composer and the logging configuration is correct in your PHPUnit configuration file.

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