Struct NuTester 

pub struct NuTester { /* private fields */ }

Helper for running Nushell code in tests.

NuTester owns an EngineState and Stack that are reused across invocations. Configuration methods update the engine state before execution.

Implementations

impl NuTester

pub fn new() -> Self

Create a default tester with the standard engine state.

Prefer test() for a shorter entry point that avoids naming NuTester.

pub fn cwd(self, cwd: impl Into<PathBuf>) -> Self

Set the working directory used for evaluation.

Relative paths are resolved from the repository root and canonicalized.

pub fn locale(self, locale: impl Into<String>) -> Self

Set the locale used by tests via NU_TEST_LOCALE_OVERRIDE.

pub fn locale_en(self) -> Self

Set the locale to en_US.utf8.

pub fn inherit_path(self) -> Self

Inherit the PATH environment variable from the running process.

This is useful for tests that spawn external commands and should resolve binaries the same way as the parent test process.

Panics if PATH is not set in the current process environment.

pub fn inherit_env_if_set(self, key: impl AsRef<str>) -> Self

Inherit an environment variable from the running process, but only if it is set.

This is useful for optional variables whose absence should not cause a panic.

pub fn inherit_rust_toolchain_env(self) -> Self

Inherit Rust toolchain related environment variables from the running process, but only when they are set.

This helps tests that spawn cargo, rustc, or rustup behave more like the parent process, especially when the active toolchain or install location is configured through environment variables.

The following variables are inherited when present:

• PATH
• CARGO_HOME
• RUSTUP_HOME
• RUSTUP_TOOLCHAIN
• RUSTUP_DIST_SERVER
• RUSTUP_UPDATE_ROOT

Proxy variables are also inherited when present since rustup may need them to download or resolve toolchain metadata:

• HTTP_PROXY, HTTPS_PROXY, NO_PROXY
• http_proxy, https_proxy, no_proxy

This does not guarantee identical behavior to an interactive shell since the current working directory can still affect rustup toolchain resolution.

pub fn add_nu_to_path(self) -> Self

Adds the “nu” binary for testing to the path.

Calling inherit_path after this methods removes the path entry.

pub fn env(self, key: impl Into<String>, val: impl Into<String>) -> Self

Add a custom environment variable to the engine state.

pub fn run<T: FromValue>(&mut self, code: impl AsRef<str>) -> Result<T>

Run Nushell code and extract the value into T.

Parsing, compilation, or evaluation failures are returned as TestError.

pub fn run_with_data<T: FromValue>( &mut self, code: impl AsRef<str>, data: impl IntoValue, ) -> Result<T>

Run Nushell code with input data and extract the value into T.

The input value is converted into PipelineData using IntoValue.

pub fn run_raw( &mut self, code: impl AsRef<str>, ) -> Result<PipelineExecutionData>

Run Nushell code and return the raw PipelineExecutionData.

pub fn run_raw_with_data( &mut self, code: impl AsRef<str>, data: PipelineData, ) -> Result<PipelineExecutionData>

Run Nushell code with input data and return the raw execution results.

This parses, compiles, and evaluates the code against the current engine state.

pub fn parse_and_compile( &self, code: impl AsRef<str>, ) -> Result<(StateDelta, Arc<Block>)>

pub fn examples(&self, command: impl Command + 'static) -> Result

Test examples of a command.

Trait Implementations

impl Clone for NuTester

fn clone(&self) -> NuTester

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for NuTester

fn default() -> Self

Create a default tester.

Prefer test() for a shorter entry point that avoids naming NuTester.