Struct ui_test::Config

pub struct Config {

    pub host: Option<String>,
    pub target: Option<String>,
    pub root_dir: PathBuf,
    pub program: CommandBuilder,
    pub output_conflict_handling: OutputConflictHandling,
    pub bless_command: Option<String>,
    pub out_dir: PathBuf,
    pub skip_files: Vec<String>,
    pub filter_files: Vec<String>,
    pub threads: Option<NonZeroUsize>,
    pub list: bool,
    pub run_only_ignored: bool,
    pub filter_exact: bool,
    pub comment_defaults: Comments,
    pub comment_start: &'static str,
    pub custom_comments: BTreeMap<&'static str, fn(_: &mut CommentParser<&mut Revisioned>, args: Spanned<&str>, span: Span)>,
    pub diagnostic_extractor: fn(_: &Path, _: &[u8]) -> Diagnostics,
    pub abort_check: Arc<AtomicBool>,
}

Central datastructure containing all information to run the tests.

Fields

host: Option<String>

Host triple; usually will be auto-detected.

target: Option<String>

None to run on the host, otherwise a target triple

root_dir: PathBuf

The folder in which to start searching for .rs files

program: CommandBuilder

The binary to actually execute.

output_conflict_handling: OutputConflictHandling

What to do in case the stdout/stderr output differs from the expected one.

bless_command: Option<String>

The recommended command to bless failing tests.

out_dir: PathBuf

Where to dump files like the binaries compiled from tests. Defaults to target/ui in the current directory.

skip_files: Vec<String>

Skip test files whose names contain any of these entries.

filter_files: Vec<String>

Only test files whose names contain any of these entries.

threads: Option<NonZeroUsize>

Override the number of threads to use.

list: bool

Nextest emulation: only list the test itself, not its components.

run_only_ignored: bool

Only run the tests that are ignored.

filter_exact: bool

Filters must match exactly instead of just checking for substrings.

comment_defaults: Comments

The default settings settable via @ comments

comment_start: &'static str

The symbol(s) that signify the start of a comment.

custom_comments: BTreeMap<&'static str, fn(_: &mut CommentParser<&mut Revisioned>, args: Spanned<&str>, span: Span)>

Custom comment parsers

diagnostic_extractor: fn(_: &Path, _: &[u8]) -> Diagnostics

Custom diagnostic extractor (invoked on the output of tests)

abort_check: Arc<AtomicBool>

An atomic bool that can be set to true to abort all tests. Will not cancel child processes, but if set from a Ctrl+C handler, the pressing of Ctrl+C will already have cancelled child processes.

Implementations

impl Config

pub fn dummy() -> Self

Create a blank configuration that doesn’t do anything interesting

pub fn rustc(root_dir: impl Into<PathBuf>) -> Self

Create a configuration for testing the output of running rustc on the test files.

pub fn cargo(root_dir: impl Into<PathBuf>) -> Self

Create a configuration for testing the output of running cargo on the test Cargo.toml files.

pub fn with_args(&mut self, args: &Args)

Populate the config with the values from parsed command line arguments.

pub fn path_filter( &mut self, path: &Path, replacement: &'static (impl AsRef<[u8]> + ?Sized), )

Replace all occurrences of a path in stderr/stdout with a byte string.

pub fn path_stderr_filter( &mut self, path: &Path, replacement: &'static (impl AsRef<[u8]> + ?Sized), )

Replace all occurrences of a path in stderr with a byte string.

pub fn path_stdout_filter( &mut self, path: &Path, replacement: &'static (impl AsRef<[u8]> + ?Sized), )

Replace all occurrences of a path in stdout with a byte string.

pub fn filter( &mut self, pattern: &str, replacement: &'static (impl AsRef<[u8]> + ?Sized), )

Replace all occurrences of a regex pattern in stderr/stdout with a byte string.

pub fn stderr_filter( &mut self, pattern: &str, replacement: &'static (impl AsRef<[u8]> + ?Sized), )

Replace all occurrences of a regex pattern in stderr with a byte string.

pub fn stdout_filter( &mut self, pattern: &str, replacement: &'static (impl AsRef<[u8]> + ?Sized), )

Replace all occurrences of a regex pattern in stdout with a byte string.

pub fn fill_host_and_target(&mut self) -> Result<()>

Make sure we have the host and target triples.

pub fn host_matches_target(&self) -> bool

Check whether the host is the specified string

pub fn test_file_conditions(&self, comments: &Comments, revision: &str) -> bool

Returns whether according to the in-file conditions, this file should be run.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.