nushell/tests/shell/mod.rs
JT 4af24363c2
remove let-env, focus on mutating $env (#9574)
# Description

For years, Nushell has used `let-env` to set a single environment
variable. As our work on scoping continued, we refined what it meant for
a variable to be in scope using `let` but never updated how `let-env`
would work. Instead, `let-env` confusingly created mutations to the
command's copy of `$env`.

So, to help fix the mental model and point people to the right way of
thinking about what changing the environment means, this PR removes
`let-env` to encourage people to think of it as updating the command's
environment variable via mutation.

Before:

```
let-env FOO = "BAR"
```

Now:

```
$env.FOO = "BAR"
```

It's also a good reminder that the environment owned by the command is
in the `$env` variable rather than global like it is in other shells.

# User-Facing Changes

BREAKING CHANGE BREAKING CHANGE

This completely removes `let-env FOO = "BAR"` so that we can focus on
`$env.FOO = "BAR"`.

# 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 -- crates/nu-std/tests/run.nu` 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 / Before Submitting
integration scripts to update:
- ✔️
[starship](https://github.com/starship/starship/blob/master/src/init/starship.nu)
- ✔️
[virtualenv](https://github.com/pypa/virtualenv/blob/main/src/virtualenv/activation/nushell/activate.nu)
- ✔️
[atuin](https://github.com/ellie/atuin/blob/main/atuin/src/shell/atuin.nu)
(PR: https://github.com/ellie/atuin/pull/1080)
- 
[zoxide](https://github.com/ajeetdsouza/zoxide/blob/main/templates/nushell.txt)
(PR: https://github.com/ajeetdsouza/zoxide/pull/587)
- ✔️
[oh-my-posh](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/src/shell/scripts/omp.nu)
(pr: https://github.com/JanDeDobbeleer/oh-my-posh/pull/4011)
2023-07-01 07:57:51 +12:00

290 lines
7.9 KiB
Rust

use nu_test_support::fs::Stub::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!(
cwd: ".", 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 = &[
r#"$env.NU_LIB_DIRS = [ ('scripts' | path expand) ]"#,
r#"source-env foo.nu"#,
r#"$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",
r#"
source-env foo.nu
"#,
)]);
let inp_lines = &[
r#"$env.NU_LIB_DIRS = [ ('scripts' | path expand) ]"#,
r#"source-env main.nu"#,
r#"$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 = &[
r#"$env.NU_LIB_DIRS = [ 'scripts' ]"#,
r#"source-env foo.nu"#,
r#"$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",
r#"
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",
r#"
source-env ../foo.nu
"#,
)])
.with_files(vec![FileWithContentToBeTrimmed(
"foo.nu",
r#"
$env.FOO = "foo"
"#,
)]);
let inp_lines = &[
r#"$env.NU_LIB_DIRS = [ 'scripts' ]"#,
r#"source-env scripts/main.nu"#,
r#"$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 = &[
r#"module spam { export def eggs [] { 'eggs' } }"#,
r#"export use spam eggs"#,
r#"export def foo [] { eggs }"#,
r#"export alias bar = foo"#,
r#"export def-env baz [] { bar }"#,
r#"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 = &[r#"export extern foo []"#, r#"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());
}