Struct nextest_runner::config::NextestConfig

pub struct NextestConfig { /* fields omitted */ }

Overall configuration for nextest.

This is the root data structure for nextest configuration. Most runner-specific configuration is managed through profiles, obtained through the profile method.

Implementations

impl NextestConfig

pub const CONFIG_PATH: &'static str

The default location of the config within the path: .config/nextest.toml, used to read the config from the given directory.

pub const DEFAULT_CONFIG: &'static str

Contains the default config as a TOML file.

The default rules included with this copy of nextest-runner are:

# This is the default config used by nextest. It is embedded in the binary at build time.
# It may be used as a template for .config/nextest.toml.

[store]
# The directory under the workspace root at which nextest-related files are written.
# Profile-specific storage is currently written to dir/<profile-name>.
dir = "target/nextest"

# This section defines the default nextest profile. Custom profiles are layered on top of the
# default profile.
[profile.default]
# "retries" defines the number of times a test should be retried. If set to a non-zero value, tests that
# succeed on a subsequent attempt will be marked as non-flaky. Can be overridden through the `--retries`
# option.
retries = 0

# Show these test statuses in the output.
#
# The possible values this can take are:
# * none: no output
# * fail: show failed (including exec-failed) tests
# * retry: show flaky and retried tests
# * slow: show slow tests
# * pass: show passed tests
# * skip: show skipped tests (most useful for CI)
# * all: all of the above
#
# Each value includes all the values above it; for example, "slow" includes failed and retried
# tests.
#
# Can be overridden through the `--status-level` flag.
status-level = "pass"

# "failure-output" defines when test failures are output to standard output. Accepted values are
# * "immediate": output failures as soon as they happen
# * "final": output failures at the end of the test run
# * "immediate-final": output failures as soon as they happen and at the end of the test run
# * "never": don't output failures at all
#
# For large test suites and CI it is generally useful to use "immediate-final".
#
# Can be overridden through the `--failure-output` option.
failure-output = "immediate"

# "success-output" controls output on success. This should generally be set to "never".
success-output = "never"

# Cancel the test run on the first failure. For CI runs, consider setting this to false.
fail-fast = true

# Treat a test that takes longer than this as slow, and print a message.
slow-timeout = "60s"

[profile.default.junit]
# Output a JUnit report into the given file inside 'store.dir/<profile-name>'. If unspecified, JUnit
# is not written out.
# path = "junit.xml"

# The name of the top-level "report" element in JUnit report. If aggregating reports across different
# test runs, it may be useful to provide separate names for each report.
report-name = "nextest-run"

Repository-specific configuration is layered on top of the default config.

pub const ENVIRONMENT_PREFIX: &'static str

Environment configuration uses this prefix, plus a _.

pub const DEFAULT_PROFILE: &'static str

The name of the default profile.

pub fn from_sources(
    workspace_root: impl Into<Utf8PathBuf>,
    config_file: Option<&Utf8Path>
) -> Result<Self, ConfigParseError>

Reads the nextest config from the given file, or if not specified from .config/nextest.toml in the given directory.

If the file isn’t specified and the directory doesn’t have .config/nextest.toml, uses the default config options.

pub fn default_config(workspace_root: impl Into<Utf8PathBuf>) -> Self

Returns the default nextest config.

pub fn profile(
    &self,
    name: impl AsRef<str>
) -> Result<NextestProfile<'_>, ProfileNotFound>

Returns the profile with the given name, or an error if a profile was specified but not found.

Trait Implementations

impl Clone for NextestConfig

fn clone(&self) -> NextestConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NextestConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.