nushell/tests/shell/environment/env.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

186 lines
4.5 KiB
Rust

use super::support::Trusted;
use nu_test_support::fs::Stub::FileWithContent;
use nu_test_support::nu;
use nu_test_support::playground::Playground;
use nu_test_support::{nu_repl_code, pipeline};
use pretty_assertions::assert_eq;
use serial_test::serial;
#[test]
fn env_shorthand() {
let actual = nu!(cwd: ".", r#"
FOO=bar echo $env.FOO
"#);
assert_eq!(actual.out, "bar");
}
#[test]
fn env_shorthand_with_equals() {
let actual = nu!(cwd: ".", r#"
RUST_LOG=my_module=info $env.RUST_LOG
"#);
assert_eq!(actual.out, "my_module=info");
}
#[test]
fn env_shorthand_with_interpolation() {
let actual = nu!(cwd: ".", r#"
let num = 123
FOO=$"($num) bar" echo $env.FOO
"#);
assert_eq!(actual.out, "123 bar");
}
#[test]
fn env_shorthand_with_comma_equals() {
let actual = nu!(cwd: ".", r#"
RUST_LOG=info,my_module=info $env.RUST_LOG
"#);
assert_eq!(actual.out, "info,my_module=info");
}
#[test]
fn env_shorthand_with_comma_colons_equals() {
let actual = nu!(cwd: ".", r#"
RUST_LOG=info,my_module=info,lib_crate::lib_mod=trace $env.RUST_LOG
"#);
assert_eq!(actual.out, "info,my_module=info,lib_crate::lib_mod=trace");
}
#[test]
fn env_shorthand_multi_second_with_comma_colons_equals() {
let actual = nu!(cwd: ".", r#"
FOO=bar RUST_LOG=info,my_module=info,lib_crate::lib_mod=trace $env.FOO + $env.RUST_LOG
"#);
assert_eq!(
actual.out,
"barinfo,my_module=info,lib_crate::lib_mod=trace"
);
}
#[test]
fn env_shorthand_multi_first_with_comma_colons_equals() {
let actual = nu!(cwd: ".", r#"
RUST_LOG=info,my_module=info,lib_crate::lib_mod=trace FOO=bar $env.FOO + $env.RUST_LOG
"#);
assert_eq!(
actual.out,
"barinfo,my_module=info,lib_crate::lib_mod=trace"
);
}
#[test]
fn env_shorthand_multi() {
let actual = nu!(cwd: ".", r#"
FOO=bar BAR=baz $env.FOO + $env.BAR
"#);
assert_eq!(actual.out, "barbaz");
}
#[test]
fn env_assignment() {
let actual = nu!(cwd: ".", r#"
$env.FOOBAR = "barbaz"; $env.FOOBAR
"#);
assert_eq!(actual.out, "barbaz");
}
#[test]
fn mutate_env_file_pwd_env_var_fails() {
let actual = nu!(cwd: ".", r#"$env.FILE_PWD = 'foo'"#);
assert!(actual.err.contains("automatic_env_var_set_manually"));
}
#[test]
fn load_env_file_pwd_env_var_fails() {
let actual = nu!(cwd: ".", r#"load-env { FILE_PWD : 'foo' }"#);
assert!(actual.err.contains("automatic_env_var_set_manually"));
}
#[test]
fn load_env_pwd_env_var_fails() {
let actual = nu!(cwd: ".", r#"load-env { PWD : 'foo' }"#);
assert!(actual.err.contains("automatic_env_var_set_manually"));
}
#[test]
fn passes_with_env_env_var_to_external_process() {
let actual = nu!(cwd: ".", r#"
with-env [FOO foo] {nu --testbin echo_env FOO}
"#);
assert_eq!(actual.out, "foo");
}
#[test]
fn has_file_pwd() {
Playground::setup("has_file_pwd", |dirs, sandbox| {
sandbox.with_files(vec![FileWithContent("spam.nu", "$env.FILE_PWD")]);
let actual = nu!(cwd: dirs.test(), "nu spam.nu");
assert!(actual.out.ends_with("has_file_pwd"));
})
}
#[test]
fn has_file_loc() {
Playground::setup("has_file_pwd", |dirs, sandbox| {
sandbox.with_files(vec![FileWithContent("spam.nu", "$env.CURRENT_FILE")]);
let actual = nu!(cwd: dirs.test(), "nu spam.nu");
assert!(actual.out.ends_with("spam.nu"));
})
}
// FIXME: autoenv not currently implemented
#[ignore]
#[test]
#[serial]
fn passes_env_from_local_cfg_to_external_process() {
Playground::setup("autoenv_dir", |dirs, sandbox| {
sandbox.with_files(vec![FileWithContent(
".nu-env",
r#"[env]
FOO = "foo"
"#,
)]);
let actual = Trusted::in_path(&dirs, || {
nu!(cwd: dirs.test(), r#"
nu --testbin echo_env FOO
"#)
});
assert_eq!(actual.out, "foo");
})
}
#[test]
fn hides_env_in_block() {
let inp = &[
"$env.foo = 'foo'",
"hide-env foo",
"let b = {|| $env.foo }",
"do $b",
];
let actual = nu!(cwd: "tests/shell/environment", pipeline(&inp.join("; ")));
let actual_repl = nu!(cwd: "tests/shell/environment", nu_repl_code(inp));
assert!(actual.err.contains("column_not_found"));
assert!(actual_repl.err.contains("column_not_found"));
}
#[test]
fn env_var_not_var() {
let actual = nu!(cwd: ".", r#"
echo $CARGO
"#);
assert!(actual.err.contains("use $env.CARGO instead of $CARGO"));
}