# Kotest You can automatically [detect and manage flaky tests](https://docs.trunk.io/flaky-tests/detection) in your Kotest projects by integrating with Trunk. This document explains how to configure Kotest 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](#next-step) 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](https://docs.trunk.io/flaky-tests/get-started/ci-providers). ### Generating Reports Steps for generating JUnit XML reports for Kotest depend on the build system you use for your project: {% tabs %} {% tab title="Gradle" %} Tests run with Gradle will generate Trunk-compatible JUnit XML reports by default. You can further [configure reporting behavior](https://docs.gradle.org/8.10.2/userguide/java_testing.html#test_reporting) in your `build.gradle.kts` or `build.gradle`. {% endtab %} {% tab title="Maven" %} Kotest projects using Maven require the following to be added to a project's `pom.xml` so JUnit XML reports can be generated: * the `maven-surefire-plugin` must be added to the `plugins` section of `pom.xml` {% code title="pom.xml" %} ```xml org.apache.maven.plugins maven-surefire-plugin 3.2.2 ``` {% endcode %} * the `kotest-extensions-junitxml` must be added to the `dependencies` section of `pom.xml` {% code title="pom.xml" %} ```xml io.kotest kotest-extensions-junitxml-jvm 5.9.0 test ``` {% endcode %} {% endtab %} {% endtabs %} #### Report File Path You can configure the path for generated JUnit XML files: {% tabs %} {% tab title="Gradle" %} By default, Kotlin projects will produce a directory with JUnit XML reports under `./app/build/test-results/test`. You can locate these files with the glob `"./app/build/test-results/test/*.xml"`. If you wish to override the default test result path, you can do so in the `build.gradle.kts` or `build.gradle` files: {% code title="build.gradle.kts (Kotlin) or build.gradle (Groovy)" %} ```kotlin java.testResultsDir = layout.buildDirectory.dir("junit-reports") ``` {% endcode %} {% endtab %} {% tab title="Maven" %} You can change the report file path by configuring the `reportsDirectory` in your `maven-surefire-plugin` in your `pom.xml` file: {% code title="pom.xml" %} ```xml org.apache.maven.plugins maven-surefire-plugin 3.2.2 ${project.build.directory}/junit/ ``` {% endcode %} The example above will output JUnit XML reports that can be located with the `/target/junit/*.xml` glob. {% endtab %} {% endtabs %} #### Disable Retries You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests. You should disable retries for accurate detection and use the [Quarantining](https://docs.trunk.io/flaky-tests/quarantining) feature to stop flaky tests from failing your CI jobs. {% tabs %} {% tab title="Gradle" %} If you've enabled retries using a plugin like the [test-retry-gradle-plugin](https://github.com/gradle/test-retry-gradle-plugin), disable it when running tests for Trunk Flaky Tests. {% endtab %} {% tab title="Maven" %} Maven uses the `maven-surefire-plugin` to run tests, which allows you to control the test retry behavior. You can disable retries by specifying 0 retries: ``` mvn -Dsurefire.rerunFailingTestsCount=0 test ``` {% endtab %} {% endtabs %} ### Try It Locally #### The Validate Command You can validate your test reports using the [Trunk Analytics CLI](https://docs.trunk.io/flaky-tests/uploader). If you don't have it installed already, you can install and run the `validate` command like this: {% tabs %} {% tab title="Linux (x64)" %} ```bash SKU="trunk-analytics-cli-x86_64-unknown-linux.tar.gz" curl -fL --retry 3 \ "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \ | tar -xz chmod +x trunk-analytics-cli ./trunk-analytics-cli validate --junit-paths "./app/junit-reports/*.xml" ``` {% endtab %} {% tab title="Linux (arm64)" %} ```bash SKU="trunk-analytics-cli-aarch64-unknown-linux.tar.gz" curl -fL --retry 3 \ "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \ | tar -xz chmod +x trunk-analytics-cli ./trunk-analytics-cli validate --junit-paths "./app/junit-reports/*.xml" ``` {% endtab %} {% tab title="macOS (arm64)" %} ```bash SKU="trunk-analytics-cli-aarch64-apple-darwin.tar.gz" curl -fL --retry 3 \ "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \ | tar -xz chmod +x trunk-analytics-cli ./trunk-analytics-cli validate --junit-paths "./app/junit-reports/*.xml" ``` {% endtab %} {% tab title="macOS (x64)" %} ```bash SKU="trunk-analytics-cli-x86_64-apple-darwin.tar.gz" curl -fL --retry 3 \ "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \ | tar -xz chmod +x trunk-analytics-cli ./trunk-analytics-cli validate --junit-paths "./app/junit-reports/*.xml" ``` {% endtab %} {% endtabs %} Make sure to specify the path to your JUnit XML test reports. **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: ```sh ./trunk-analytics-cli upload --junit-paths "./app/junit-reports/*.xml" \ --org-url-slug \ --token ``` You can find your Trunk organization slug and token in the settings or by following these [instructions](https://docs.trunk.io/flaky-tests/get-started/ci-providers/otherci#id-1.-store-a-trunk_token-secret-in-your-ci-system). After your upload, you can verify that Trunk has received and processed it successfully in the **Uploads** tab. Warnings will be displayed if the report has issues.
### Next Steps Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:
Atlassian Bambooatlassian-bamboo
Azure DevOps Pipelinesazure-devops-pipelinesazure.png
BitBucket Pipelinesbitbucket-pipelinesbitbucket.png
BuildKitebuildkitebuildkite.png
CircleCIcirclecicircle-ci.png
Drone CIdronecidrone.png
GitHub Actionsgithub-actionsgithub.png
GitLabgitlabgitlab.png
Jenkinsjenkinsjenkins.png
Semaphoresemaphorecisemaphore.png
TeamCityhttps://github.com/trunk-io/docs/blob/main/.gitbook/includes/broken-reference/README.mdteamcity.png
Travis CItraviscitravis.png
Other CI Providersotherciother.png
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.trunk.io/flaky-tests/get-started/frameworks/kotest.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.