Dart Test

A guide for generating Trunk-compatible test reports for Dart tests

You can automatically detect and manage flaky tests in your Dart projects by integrating with Trunk. This document explains how to configure Dart to output JUnit XML reports that can be uploaded to Trunk for analysis.

Checklist

By the end of this guide, you should achieve the following before proceeding to the next steps to configure your CI provider.

Generate a compatible test report
Configure the report file path or glob
Disable retries for better detection accuracy
Test uploads locally

After correctly generating reports following the above steps, you'll be ready to move on to the next steps to configure uploads in CI.

Generating Reports

Before you can upload to Trunk, you need to output a Trunk-compatible report. Dart supports JUnit outputs by using the tojunit library. You can install the tojunit library using the following command:

dart pub global activate junitreport

Then, you can convert test reports to a JUnit format by piping it to tojunitand piping the output to a file like this:

dart test <TEST_PATH> --reporter json | tojunit > junit.xml

Report File Path

The JUnit report is written to the location specified by the tojunit > pipe. In the example above, the test results will be written to ./junit.xml.

Disable Retries

You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests.

Dart provides retries through the retry class annotations. Disable retry, use Trunk to detect flaky tests, and use Quarantining to isolate flaky tests dynamically at run time.

Try It Locally

The Validate Command

You can validate your test reports using the Trunk CLI. If you don't have it installed already, you can install and run the validate command like this:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests validate --junit-paths "./junit.xml"

This will not upload anything to Trunk. To improve detection accuracy, you should address all errors and warnings before proceeding to the next steps.

Test Upload

Before modifying your CI jobs to automatically upload test results to Trunk, try uploading a single test run manually.

You make an upload to Trunk using the following command:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests upload --junit-paths "./junit.xml" \
    --org-url-slug <TRUNK_ORG_SLUG> \
    --token <TRUNK_ORG_TOKEN>