Struct nu_plugin_test_support::PluginTest

pub struct PluginTest { /* private fields */ }

An object through which plugins can be tested.

Implementations

impl PluginTest

pub fn new( name: &str, plugin: Arc<impl Plugin + Send + 'static> ) -> Result<PluginTest, ShellError>

Create a new test for the given plugin named name.

Example

PluginTest::new("my_plugin", MyPlugin.into())

pub fn engine_state(&self) -> &EngineState

Get the EngineState.

pub fn engine_state_mut(&mut self) -> &mut EngineState

Get a mutable reference to the EngineState.

pub fn add_decl( &mut self, decl: Box<dyn Command> ) -> Result<&mut Self, ShellError>

Make additional command declarations available for use by tests.

This can be used to pull in commands from nu-cmd-lang for example, as required.

pub fn eval_with( &mut self, nu_source: &str, input: PipelineData ) -> Result<PipelineData, ShellError>

Evaluate some Nushell source code with the plugin commands in scope with the given input to the pipeline.

Example

let result = PluginTest::new("my_plugin", MyPlugin.into())?
    .eval_with(
        "my-command",
        vec![Value::test_int(42)].into_pipeline_data(None)
    )?
    .into_value(Span::test_data());
assert_eq!(Value::test_string("42"), result);

pub fn eval(&mut self, nu_source: &str) -> Result<PipelineData, ShellError>

Evaluate some Nushell source code with the plugin commands in scope.

Example

let result = PluginTest::new("my_plugin", MyPlugin.into())?
    .eval("42 | my-command")?
    .into_value(Span::test_data());
assert_eq!(Value::test_string("42"), result);

pub fn test_examples( &mut self, examples: &[Example<'_>] ) -> Result<(), ShellError>

Test a list of plugin examples. Prints an error for each failing example.

See [.test_command_examples()] for easier usage of this method on a command’s examples.

Example

PluginTest::new("my_plugin", MyPlugin.into())?
    .test_examples(&[
        Example {
            example: "my-command",
            description: "Run my-command",
            result: Some(Value::test_string("my-command output")),
        },
    ])

pub fn test_command_examples( &mut self, command: &impl PluginCommand ) -> Result<(), ShellError>

Test examples from a command.

Example

PluginTest::new("my_plugin", MyPlugin.into())?
    .test_command_examples(&MyCommand)

pub fn custom_value_to_base_value( &self, val: &dyn CustomValue, span: Span ) -> Result<Value, ShellError>

This implements custom value comparison with plugin.custom_value_to_base_value() to behave as similarly as possible to comparison in the engine.