Struct TestCommand

pub struct TestCommand {
    saved_cwd: PathBuf,
    project: TestProject,
    cmd: Command,
    current_dir_lock: Option<MutexGuard<'static, RawMutex, ()>>,
    stdin_fun: Option<Box<dyn FnOnce(ChildStdin)>>,
    redact_output: bool,
}

A simple wrapper around a Command with some conveniences.

Fields

saved_cwd: PathBuf

project: TestProject

The project used to launch this command.

cmd: Command

The actual command we use to control the process.

current_dir_lock: Option<MutexGuard<'static, RawMutex, ()>>

stdin_fun: Option<Box<dyn FnOnce(ChildStdin)>>

redact_output: bool

If true, command output is redacted.

Implementations

impl TestCommand

pub fn cmd(&mut self) -> &mut Command

Returns a mutable reference to the underlying command.

pub fn set_cmd(&mut self, cmd: Command) -> &mut Self

Replaces the underlying command.

pub fn forge_fuse(&mut self) -> &mut Self

Resets the command to the default forge command.

pub fn cast_fuse(&mut self) -> &mut Self

Resets the command to the default cast command.

pub fn set_current_dir(&mut self, p: impl AsRef<Path>)

Sets the current working directory.

pub fn arg<A: AsRef<OsStr>>(&mut self, arg: A) -> &mut Self

Add an argument to pass to the command.

pub fn args<I, A>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = A>, A: AsRef<OsStr>,

Add any number of arguments to the command.

pub fn stdin(&mut self, fun: impl FnOnce(ChildStdin) + 'static) -> &mut Self

pub fn root_arg(&mut self) -> &mut Self

Convenience function to add --root project.root() argument

pub fn env(&mut self, k: impl AsRef<OsStr>, v: impl AsRef<OsStr>)

Set the environment variable k to value v for the command.

pub fn envs<I, K, V>(&mut self, envs: I)

where I: IntoIterator<Item = (K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>,

Set the environment variable k to value v for the command.

pub fn unset_env(&mut self, k: impl AsRef<OsStr>)

Unsets the environment variable k for the command.

pub fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Self

Set the working directory for this command.

Note that this does not need to be called normally, since the creation of this TestCommand causes its working directory to be set to the test’s directory automatically.

pub fn config(&mut self) -> Config

Returns the Config as spit out by forge config

pub fn git_init(&self)

Runs git init inside the project’s dir

pub fn git_add(&self)

Runs git add . inside the project’s dir

pub fn git_commit(&self, msg: &str)

Runs git commit . inside the project’s dir

pub fn assert(&mut self) -> OutputAssert

Runs the command, returning a [snapbox] object to assert the command output.

pub fn assert_success(&mut self) -> OutputAssert

Runs the command and asserts that it resulted in success.

pub fn assert_json_stdout(&mut self, expected: impl IntoData)

Runs the command and asserts that it resulted in success, with expected JSON data.

pub fn assert_empty_stdout(&mut self)

Runs the command and asserts that it succeeded nothing was printed to stdout.

pub fn assert_failure(&mut self) -> OutputAssert

Runs the command and asserts that it failed.

pub fn assert_code(&mut self, expected: i32) -> OutputAssert

Runs the command and asserts that the exit code is expected.

pub fn assert_empty_stderr(&mut self)

Runs the command and asserts that it failed nothing was printed to stderr.

pub fn assert_file(&mut self, data: impl IntoData)

Runs the command with a temporary file argument and asserts that the contents of the file match the given data.

pub fn assert_file_with( &mut self, f: impl FnOnce(&mut Self, &Path), data: impl IntoData, )

Creates a temporary file, passes it to f, then asserts that the contents of the file match the given data.

pub fn with_no_redact(&mut self) -> &mut Self

Does not apply [snapbox] redactions to the command output.

pub fn execute(&mut self) -> Output

Executes command, applies stdin function and returns output

pub fn try_execute(&mut self) -> Result<Output>

Trait Implementations

impl Drop for TestCommand

fn drop(&mut self)

Executes the destructor for this type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 296 bytes