---
title: PHPUnit Integration with CI Insights
description: Report your test results from PHPUnit tests to CI Insights
---

import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx"
import GhaMergifyCiQuarantineSetup from "./_gha_mergify_ci_quarantine_setup.mdx"
import MergifyCIUploadStep from "../../../../components/MergifyCIUploadStep.astro"
import MergifyCIUploadStepMatrix from "../../../../components/MergifyCIUploadStepMatrix.astro"
import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astro"

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

## Generate a JUnit Report with PHPUnit

PHPUnit has built-in support for JUnit XML reports. You can configure PHPUnit
to output JUnit reports using command-line options or configuration files.

### Using Command Line Options

```bash
./vendor/bin/phpunit --log-junit junit.xml
```

### Using PHPUnit Configuration

Add the logging configuration to your `phpunit.xml` or `phpunit.xml.dist`:

```xml
<?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:

```bash
./vendor/bin/phpunit
```

### Using Composer Scripts

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

```json
{
    "scripts": {
        "test": "phpunit --log-junit junit.xml"
    }
}
```

Then run:

```bash
composer test
```

## Update Your GitHub Actions Workflow

<CIInsightsSetupNote />

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:

```yaml
- name: Run PHPUnit Tests and Generate JUnit Report
  continue-on-error: true
  run: ./vendor/bin/phpunit --log-junit junit.xml
```

<MergifyCIUploadStep reportPath="junit.xml" />
<MergifyCIUploadStepMatrix reportPath="junit.xml" />

<GhaMergifyCiQuarantineSetup />

## Verify and Review in CI Insights

After pushing these changes:

1. Your GitHub Actions workflow will execute your PHPUnit 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](https://dashboard.mergify.com/ci-insights/jobs).

## Troubleshooting Tips

<ul>
  <li>
    PHPUnit Configuration: Ensure PHPUnit is properly installed via Composer and the logging configuration is correct.
  </li>

  <CommonTroubleshootingTips />
</ul>