MSTest Integration with CI Insights

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

MSTest can generate JUnit-compatible XML reports using the built-in logger or third-party tools. The dotnet test command supports various loggers including JUnit format.

Install the JUnit test logger:

dotnet add package JunitXml.TestLogger

Run tests with JUnit output:

dotnet test --logger "junit;LogFilePath=junit.xml"

You can also generate TRX files and convert them to JUnit:

dotnet test --logger trx --results-directory ./TestResults

Then use a tool like trx2junit to convert:

dotnet tool install -g trx2junit
trx2junit ./TestResults/*.trx

Add the JUnit logger package to your test project:

<PackageReference Include="JunitXml.TestLogger" Version="6.1.0" />

Then run:

dotnet test --logger junit

You can combine multiple loggers:

dotnet test --logger "console;verbosity=detailed" --logger "junit;LogFilePath=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 MSTest Tests and Generate JUnit Report
  continue-on-error: true
  run: dotnet test --logger "junit;LogFilePath=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 MSTest 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.

• Logger Package: Ensure the JunitXml.TestLogger package is added to your test project.
• .NET Version: Make sure you’re using a compatible version of .NET that supports the test loggers.
• 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.