mirror of
https://github.com/nushell/nushell
synced 2024-12-26 13:03:07 +00:00
077643cadf
# Description Add a few tests to ensure that you can add subcommands to scripts. We've supported this for a long time, though I'm not sure if anyone has actually tried it. As we weren't testing the support, this PR adds a few tests to ensure it stays working. Example script subcommand: ``` def "main addten" [x: int] { print ($x + 10) } ``` then call it with: ``` > nu ./script.nu addten 5 ``` # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
331 lines
9 KiB
Rust
331 lines
9 KiB
Rust
use nu_test_support::fs::Stub::{FileWithContent, FileWithContentToBeTrimmed};
|
|
use nu_test_support::playground::Playground;
|
|
use nu_test_support::{nu, nu_repl_code, pipeline};
|
|
use pretty_assertions::assert_eq;
|
|
|
|
#[cfg(feature = "which-support")]
|
|
mod environment;
|
|
|
|
mod pipeline;
|
|
|
|
//FIXME: jt: we need to focus some fixes on wix as the plugins will differ
|
|
#[ignore]
|
|
#[test]
|
|
fn plugins_are_declared_with_wix() {
|
|
let actual = nu!(pipeline(
|
|
r#"
|
|
open Cargo.toml
|
|
| get bin.name
|
|
| str replace "nu_plugin_(extra|core)_(.*)" "nu_plugin_$2"
|
|
| drop
|
|
| sort-by
|
|
| wrap cargo | merge {
|
|
open wix/main.wxs --raw | from xml
|
|
| get Wix.children.Product.children.0.Directory.children.0
|
|
| where Directory.attributes.Id == "$(var.PlatformProgramFilesFolder)"
|
|
| get Directory.children.Directory.children.0 | last
|
|
| get Directory.children.Component.children
|
|
| each { |it| echo $it | first }
|
|
| skip
|
|
| where File.attributes.Name =~ "nu_plugin"
|
|
| str substring [_, -4] File.attributes.Name
|
|
| get File.attributes.Name
|
|
| sort-by
|
|
| wrap wix
|
|
}
|
|
| default wix _
|
|
| each { |it| if $it.wix != $it.cargo { 1 } { 0 } }
|
|
| math sum
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "0");
|
|
}
|
|
|
|
#[test]
|
|
#[cfg(not(windows))]
|
|
fn do_not_panic_if_broken_pipe() {
|
|
// `nu -h | false`
|
|
// used to panic with a BrokenPipe error
|
|
let child_output = std::process::Command::new("sh")
|
|
.arg("-c")
|
|
.arg(format!(
|
|
"{:?} -h | false",
|
|
nu_test_support::fs::executable_path()
|
|
))
|
|
.output()
|
|
.expect("failed to execute process");
|
|
|
|
assert!(child_output.stderr.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn nu_lib_dirs_repl() {
|
|
Playground::setup("nu_lib_dirs_repl", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("scripts")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"scripts/foo.nu",
|
|
r#"
|
|
$env.FOO = "foo"
|
|
"#,
|
|
)]);
|
|
|
|
let inp_lines = &[
|
|
"$env.NU_LIB_DIRS = [ ('scripts' | path expand) ]",
|
|
"source-env foo.nu",
|
|
"$env.FOO",
|
|
];
|
|
|
|
let actual_repl = nu!(cwd: dirs.test(), nu_repl_code(inp_lines));
|
|
|
|
assert!(actual_repl.err.is_empty());
|
|
assert_eq!(actual_repl.out, "foo");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn nu_lib_dirs_script() {
|
|
Playground::setup("nu_lib_dirs_script", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("scripts")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"scripts/foo.nu",
|
|
r#"
|
|
$env.FOO = "foo"
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"main.nu",
|
|
"
|
|
source-env foo.nu
|
|
",
|
|
)]);
|
|
|
|
let inp_lines = &[
|
|
"$env.NU_LIB_DIRS = [ ('scripts' | path expand) ]",
|
|
"source-env main.nu",
|
|
"$env.FOO",
|
|
];
|
|
|
|
let actual_repl = nu!(cwd: dirs.test(), nu_repl_code(inp_lines));
|
|
|
|
assert!(actual_repl.err.is_empty());
|
|
assert_eq!(actual_repl.out, "foo");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn nu_lib_dirs_relative_repl() {
|
|
Playground::setup("nu_lib_dirs_relative_repl", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("scripts")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"scripts/foo.nu",
|
|
r#"
|
|
$env.FOO = "foo"
|
|
"#,
|
|
)]);
|
|
|
|
let inp_lines = &[
|
|
"$env.NU_LIB_DIRS = [ 'scripts' ]",
|
|
"source-env foo.nu",
|
|
"$env.FOO",
|
|
];
|
|
|
|
let actual_repl = nu!(cwd: dirs.test(), nu_repl_code(inp_lines));
|
|
|
|
assert!(actual_repl.err.is_empty());
|
|
assert_eq!(actual_repl.out, "foo");
|
|
})
|
|
}
|
|
|
|
// TODO: add absolute path tests after we expand const capabilities (see #8310)
|
|
#[test]
|
|
fn const_nu_lib_dirs_relative() {
|
|
Playground::setup("const_nu_lib_dirs_relative", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("scripts")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"scripts/foo.nu",
|
|
r#"
|
|
$env.FOO = "foo"
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"main.nu",
|
|
"
|
|
const NU_LIB_DIRS = [ 'scripts' ]
|
|
source-env foo.nu
|
|
$env.FOO
|
|
",
|
|
)]);
|
|
|
|
let outcome = nu!(cwd: dirs.test(), "source main.nu");
|
|
|
|
assert!(outcome.err.is_empty());
|
|
assert_eq!(outcome.out, "foo");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn nu_lib_dirs_relative_script() {
|
|
Playground::setup("nu_lib_dirs_relative_script", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("scripts")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"scripts/main.nu",
|
|
"
|
|
source-env ../foo.nu
|
|
",
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"foo.nu",
|
|
r#"
|
|
$env.FOO = "foo"
|
|
"#,
|
|
)]);
|
|
|
|
let inp_lines = &[
|
|
"$env.NU_LIB_DIRS = [ 'scripts' ]",
|
|
"source-env scripts/main.nu",
|
|
"$env.FOO",
|
|
];
|
|
|
|
let actual_repl = nu!(cwd: dirs.test(), nu_repl_code(inp_lines));
|
|
|
|
assert!(actual_repl.err.is_empty());
|
|
assert_eq!(actual_repl.out, "foo");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn run_script_that_looks_like_module() {
|
|
Playground::setup("run_script_that_looks_like_module", |dirs, _| {
|
|
let inp_lines = &[
|
|
"module spam { export def eggs [] { 'eggs' } }",
|
|
"export use spam eggs",
|
|
"export def foo [] { eggs }",
|
|
"export alias bar = foo",
|
|
"export def-env baz [] { bar }",
|
|
"baz",
|
|
];
|
|
|
|
let actual = nu!(cwd: dirs.test(), inp_lines.join("; "));
|
|
|
|
assert_eq!(actual.out, "eggs");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn run_export_extern() {
|
|
Playground::setup("run_script_that_looks_like_module", |dirs, _| {
|
|
let inp_lines = &["export extern foo []", "help foo"];
|
|
|
|
let actual = nu!(cwd: dirs.test(), inp_lines.join("; "));
|
|
|
|
assert!(actual.out.contains("Usage"));
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
#[cfg(not(windows))]
|
|
fn run_in_login_mode() {
|
|
let child_output = std::process::Command::new("sh")
|
|
.arg("-c")
|
|
.arg(format!(
|
|
"{:?} -l -c 'echo $nu.is-login'",
|
|
nu_test_support::fs::executable_path()
|
|
))
|
|
.output()
|
|
.expect("true");
|
|
|
|
assert!(child_output.stderr.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
#[cfg(not(windows))]
|
|
fn run_in_not_login_mode() {
|
|
let child_output = std::process::Command::new("sh")
|
|
.arg("-c")
|
|
.arg(format!(
|
|
"{:?} -c 'echo $nu.is-login'",
|
|
nu_test_support::fs::executable_path()
|
|
))
|
|
.output()
|
|
.expect("false");
|
|
|
|
assert!(child_output.stderr.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
#[cfg(not(windows))]
|
|
fn run_in_interactive_mode() {
|
|
let child_output = std::process::Command::new("sh")
|
|
.arg("-c")
|
|
.arg(format!(
|
|
"{:?} -i -c 'echo $nu.is-interactive'",
|
|
nu_test_support::fs::executable_path()
|
|
))
|
|
.output()
|
|
.expect("true");
|
|
|
|
assert!(child_output.stderr.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
#[cfg(not(windows))]
|
|
fn run_in_noninteractive_mode() {
|
|
let child_output = std::process::Command::new("sh")
|
|
.arg("-c")
|
|
.arg(format!(
|
|
"{:?} -c 'echo $nu.is-interactive'",
|
|
nu_test_support::fs::executable_path()
|
|
))
|
|
.output()
|
|
.expect("false");
|
|
|
|
assert!(child_output.stderr.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn main_script_can_have_subcommands1() {
|
|
Playground::setup("main_subcommands", |dirs, sandbox| {
|
|
sandbox.mkdir("main_subcommands");
|
|
sandbox.with_files(vec![FileWithContent(
|
|
"script.nu",
|
|
r#"def "main foo" [x: int] {
|
|
print ($x + 100)
|
|
}
|
|
|
|
def "main" [] {
|
|
print "usage: script.nu <command name>"
|
|
}"#,
|
|
)]);
|
|
|
|
let actual = nu!(cwd: dirs.test(), pipeline("nu script.nu foo 123"));
|
|
|
|
assert_eq!(actual.out, "223");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn main_script_can_have_subcommands2() {
|
|
Playground::setup("main_subcommands", |dirs, sandbox| {
|
|
sandbox.mkdir("main_subcommands");
|
|
sandbox.with_files(vec![FileWithContent(
|
|
"script.nu",
|
|
r#"def "main foo" [x: int] {
|
|
print ($x + 100)
|
|
}
|
|
|
|
def "main" [] {
|
|
print "usage: script.nu <command name>"
|
|
}"#,
|
|
)]);
|
|
|
|
let actual = nu!(cwd: dirs.test(), pipeline("nu script.nu"));
|
|
|
|
assert!(actual.out.contains("usage: script.nu"));
|
|
})
|
|
}
|