nu-protocol 0.112.1

Nushell's internal protocols, including its abstract syntax tree
Documentation
use super::{PluginRegistryFile, PluginRegistryItem, PluginRegistryItemData};
use crate::{
    Category, PluginExample, PluginMetadata, PluginSignature, ShellError, Signature, SyntaxShape,
    Type, Value,
};
use pretty_assertions::assert_eq;
use std::io::Cursor;

fn foo_plugin() -> PluginRegistryItem {
    PluginRegistryItem {
        name: "foo".into(),
        filename: "/path/to/nu_plugin_foo".into(),
        shell: None,
        data: PluginRegistryItemData::Valid {
            metadata: PluginMetadata {
                version: Some("0.1.0".into()),
            },
            commands: vec![PluginSignature {
                sig: Signature::new("foo")
                    .input_output_type(Type::Int, Type::List(Box::new(Type::Int)))
                    .category(Category::Experimental),
                examples: vec![PluginExample {
                    example: "16 | foo".into(),
                    description: "powers of two up to 16".into(),
                    result: Some(Value::test_list(vec![
                        Value::test_int(2),
                        Value::test_int(4),
                        Value::test_int(8),
                        Value::test_int(16),
                    ])),
                }],
            }],
        },
    }
}

fn bar_plugin() -> PluginRegistryItem {
    PluginRegistryItem {
        name: "bar".into(),
        filename: "/path/to/nu_plugin_bar".into(),
        shell: None,
        data: PluginRegistryItemData::Valid {
            metadata: PluginMetadata {
                version: Some("0.2.0".into()),
            },
            commands: vec![PluginSignature {
                sig: Signature::new("bar")
                    .description("overwrites files with random data")
                    .switch("force", "Ignore errors.", Some('f'))
                    .required(
                        "path",
                        SyntaxShape::Filepath,
                        "File to overwrite with random data.",
                    )
                    .category(Category::Experimental),
                examples: vec![],
            }],
        },
    }
}

#[test]
fn roundtrip() -> Result<(), ShellError> {
    let mut plugin_registry_file = PluginRegistryFile {
        nushell_version: env!("CARGO_PKG_VERSION").to_owned(),
        plugins: vec![foo_plugin(), bar_plugin()],
    };

    let mut output = vec![];

    plugin_registry_file.write_to(&mut output, None)?;

    let read_file = PluginRegistryFile::read_from(Cursor::new(&output[..]), None)?;

    assert_eq!(plugin_registry_file, read_file);

    Ok(())
}

#[test]
fn roundtrip_invalid() -> Result<(), ShellError> {
    let mut plugin_registry_file = PluginRegistryFile {
        nushell_version: env!("CARGO_PKG_VERSION").to_owned(),
        plugins: vec![PluginRegistryItem {
            name: "invalid".into(),
            filename: "/path/to/nu_plugin_invalid".into(),
            shell: None,
            data: PluginRegistryItemData::Invalid,
        }],
    };

    let mut output = vec![];

    plugin_registry_file.write_to(&mut output, None)?;

    let read_file = PluginRegistryFile::read_from(Cursor::new(&output[..]), None)?;

    assert_eq!(plugin_registry_file, read_file);

    Ok(())
}

#[test]
fn upsert_new() {
    let mut file = PluginRegistryFile::new();

    file.plugins.push(foo_plugin());

    file.upsert_plugin(bar_plugin());

    assert_eq!(2, file.plugins.len());
}

#[test]
fn upsert_replace() {
    let mut file = PluginRegistryFile::new();

    file.plugins.push(foo_plugin());

    let mut mutated_foo = foo_plugin();
    mutated_foo.shell = Some("/bin/sh".into());

    file.upsert_plugin(mutated_foo);

    assert_eq!(1, file.plugins.len());
    assert_eq!(Some("/bin/sh".into()), file.plugins[0].shell);
}