Module config

Source
Expand description

Configuration support for nextest.

§Multi-pass parsing

Nextest’s configuration parsing happens in several passes, similar to a typical compiler.

  • The first pass verifies that the configuration looks fine and is done very early in the process. A successful first phase parse is represented by EarlyProfile.
  • The second pass applies the host and target platforms to the configuration, resulting in an EvaluatableProfile.
  • The final pass resolves actual per-test settings, via TestSettings.

Multi-pass parsing allows for profile parsing errors to be returned as early as possible – before the host and target platforms are known. Returning errors early leads to a better user experience.

Structs§

ArchiveConfig
Configuration for archives.
ArchiveInclude
Type for the archive-include key.
CompiledDefaultFilter
A compiled form of the default filter for a profile.
ConfigIdentifier
An identifier used in configuration.
CustomTestGroup
Represents a custom test group.
DefaultConfigWarnings
Default implementation of ConfigWarnings that logs warnings using the tracing crate.
EarlyProfile
A nextest profile that can be obtained without identifying the host and target platforms.
EvaluatableProfile
A configuration profile for nextest. Contains most configuration used by the nextest runner.
JunitConfig
Global JUnit configuration stored within a profile.
LeakTimeout
Controls leak timeout behavior.
ListSettings
Settings for a test binary.
NextestConfig
Overall configuration for nextest.
NextestVersionConfig
Nextest version configuration.
ScriptCommand
The script command to run.
ScriptConfig
The scripts defined in nextest configuration.
ScriptId
The name of a configuration script.
ScriptInfo
Basic information about a script, used during error checking.
SetupScriptConfig
Deserialized form of setup script configuration before compilation.
SetupScriptJunitConfig
A JUnit override configuration.
SetupScripts
Data about setup scripts, returned by an EvaluatableProfile.
SlowTimeout
Type for the slow-timeout config key.
TestGroupConfig
Configuration for a test group.
TestPriority
A test priority: a number between -100 and 100.
TestSettings
Settings for individual tests.
ToolConfigFile
A tool-specific config file.
VersionOnlyConfig
A “version-only” form of the nextest configuration.
WrapperScriptConfig
Deserialized form of wrapper script configuration before compilation.

Enums§

ArchiveIncludeOnMissing
What to do when an archive-include path is missing.
CompiledDefaultFilterSection
Within CompiledDefaultFilter, the part of the config that the default filter comes from.
ConfigExperimental
Experimental configuration features.
LeakTimeoutResult
The result of controlling leak timeout behavior.
MaxFail
Type for the max-fail flag and fail-fast configuration.
NextestVersionEval
The result of checking whether a NextestVersionConfig satisfies a requirement.
NextestVersionReq
Specification for a nextest version. Part of NextestVersionConfig.
ProfileScriptType
A script type as configured in [[profile.*.scripts]].
RecursionDepth
Recursion depth.
RetryPolicy
Type for the retry config key.
ScriptCommandRelativeTo
The directory to interpret a ScriptCommand as relative to, in case it is a relative path.
ScriptType
The script type as configured in the [scripts] table.
TestGroup
Represents the test group a test is in.
TestThreads
Type for the test-threads config key.
ThreadsRequired
Type for the threads-required config key.
WrapperScriptTargetRunner
Interaction of wrapper script with a configured target runner.

Traits§

ConfigWarnings
Trait for handling configuration warnings.

Functions§

get_num_cpus
Gets the number of available CPUs and caches the value.