Configuration

cargo-nextest supports repository-specific configuration at the location .config/nextest.toml from the Cargo workspace root. The location of the configuration file can be overridden with the --config-file option.

The default configuration shipped with cargo-nextest is:

{{#include ../../../nextest-runner/default-config.toml}}

Profiles

With cargo-nextest, local and CI runs often need to use different settings. For example, CI test runs should not be cancelled as soon as the first test failure is seen.

cargo-nextest supports multiple profiles, where each profile is a set of options for cargo-nextest. Profiles are selected on the command line with the -P or --profile option. Most individual configuration settings can also be overridden at the command line.

Here is a recommended profile for CI runs:

[profile.ci]
# Detect flaky tests in CI by retrying tests twice.
retries = 2
# Print out output for failing tests as soon as they fail, and also at the end
# of the run (for easy scrollability).
failure-output = "immediate-final"
# Do not cancel the test run on the first failure.
fail-fast = false

After checking the profile into .config/nextest.toml, use cargo nextest --profile ci in your CI runs.

Hierarchical configuration

Configuration is resolved in the following order:

1. Command-line arguments. For example, if --retries=3 is specified on the command line, failing tests are retried up to 3 times.
2. Profile-specific configuration. For example, if --profile ci is selected in the example above, failing tests are retried up to 2 times.
3. Repository-specific configuration for the default profile. For example, if the repository-specific configuration looks like:

    [profile.default]
    retries = 5

   then failing tests are retried up to 5 times.
4. The default configuration listed above, which is that tests are never retried.