TestNG Integration with CI Insights

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

TestNG can generate JUnit-compatible XML reports. You need to configure your build tool to enable JUnit report generation alongside the default TestNG reports.

Configure the Surefire plugin in your pom.xml to generate JUnit reports:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.5.3</version>
    <configuration>
        <properties>
            <property>
                <name>usedefaultlisteners</name>
                <value>false</value>
            </property>
            <property>
                <name>listener</name>
                <value>org.testng.reporters.JUnitReportReporter</value>
            </property>
        </properties>
        <reportsDirectory>${project.build.directory}/surefire-reports</reportsDirectory>
    </configuration>
</plugin>

Run tests with:

mvn test

Configure the test task in your build.gradle:

test {
    useTestNG()
    reports {
        junitXml.enabled = true
        junitXml.destination = file("$buildDir/test-results/test")
    }
}

Run tests with:

./gradlew test

You can also run TestNG directly with JUnit listener:

java -cp "your-classpath" org.testng.TestNG -listener org.testng.reporters.JUnitReportReporter testng.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 TestNG Tests and Generate JUnit Report
  continue-on-error: true
  run: mvn test

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

Key Points:

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

For Gradle projects:

- name: Run TestNG Tests and Generate JUnit Report
  continue-on-error: true
  run: ./gradlew test

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

Key Points:

• if: success() || failure(): Runs the upload step even if tests fail, ensuring CI Insights has the full report.
• report_path: build/test-results/test/*.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: build/test-results/test/*.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 TestNG tests.
2. JUnit-compatible XML reports are generated.
3. The Mergify CI action uploads the reports to CI Insights.

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

• JUnit Listener: Ensure the JUnitReportReporter listener is properly configured in your TestNG 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.