nushell/crates/nu-command/tests/commands/save.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

300 lines
8.7 KiB
Rust

use nu_test_support::fs::{file_contents, Stub};
use nu_test_support::nu;
use nu_test_support::playground::Playground;
use std::io::Write;
#[test]
fn writes_out_csv() {
Playground::setup("save_test_2", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("cargo_sample.csv");
nu!(
cwd: dirs.root(),
r#"[[name, version, description, license, edition]; [nu, "0.14", "A new type of shell", "MIT", "2018"]] | save save_test_2/cargo_sample.csv"#,
);
let actual = file_contents(expected_file);
println!("{actual}");
assert!(actual.contains("nu,0.14,A new type of shell,MIT,2018"));
})
}
#[test]
fn writes_out_list() {
Playground::setup("save_test_3", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("list_sample.txt");
nu!(
cwd: dirs.root(),
r#"[a b c d] | save save_test_3/list_sample.txt"#,
);
let actual = file_contents(expected_file);
println!("{actual}");
assert_eq!(actual, "a\nb\nc\nd\n")
})
}
#[test]
fn save_append_will_create_file_if_not_exists() {
Playground::setup("save_test_3", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("new-file.txt");
nu!(
cwd: dirs.root(),
r#"'hello' | save --raw --append save_test_3/new-file.txt"#,
);
let actual = file_contents(expected_file);
println!("{actual}");
assert_eq!(actual, "hello");
})
}
#[test]
fn save_append_will_not_overwrite_content() {
Playground::setup("save_test_4", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("new-file.txt");
{
let mut file =
std::fs::File::create(&expected_file).expect("Failed to create test file");
file.write_all("hello ".as_bytes())
.expect("Failed to write to test file");
file.flush().expect("Failed to flush io")
}
nu!(
cwd: dirs.root(),
r#"'world' | save --append save_test_4/new-file.txt"#,
);
let actual = file_contents(expected_file);
println!("{actual}");
assert_eq!(actual, "hello world");
})
}
#[test]
fn save_stderr_and_stdout_to_afame_file() {
Playground::setup("save_test_5", |dirs, sandbox| {
sandbox.with_files(vec![]);
let actual = nu!(
cwd: dirs.root(),
r#"
$env.FOO = "bar";
$env.BAZ = "ZZZ";
do -c {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -r save_test_5/new-file.txt --stderr save_test_5/new-file.txt
"#,
);
assert!(actual
.err
.contains("can't save both input and stderr input to the same file"));
})
}
#[test]
fn save_stderr_and_stdout_to_diff_file() {
Playground::setup("save_test_6", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("log.txt");
let expected_stderr_file = dirs.test().join("err.txt");
nu!(
cwd: dirs.root(),
r#"
$env.FOO = "bar";
$env.BAZ = "ZZZ";
do -c {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -r save_test_6/log.txt --stderr save_test_6/err.txt
"#,
);
let actual = file_contents(expected_file);
assert!(actual.contains("bar"));
assert!(!actual.contains("ZZZ"));
let actual = file_contents(expected_stderr_file);
assert!(actual.contains("ZZZ"));
assert!(!actual.contains("bar"));
})
}
#[test]
fn save_string_and_stream_as_raw() {
Playground::setup("save_test_7", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("temp.html");
nu!(
cwd: dirs.root(),
r#"
"<!DOCTYPE html><html><body><a href='http://example.org/'>Example</a></body></html>" | save save_test_7/temp.html
"#,
);
let actual = file_contents(expected_file);
assert_eq!(
actual,
r#"<!DOCTYPE html><html><body><a href='http://example.org/'>Example</a></body></html>"#
)
})
}
#[test]
fn save_not_override_file_by_default() {
Playground::setup("save_test_8", |dirs, sandbox| {
sandbox.with_files(vec![Stub::EmptyFile("log.txt")]);
let actual = nu!(
cwd: dirs.root(),
r#""abcd" | save save_test_8/log.txt"#
);
assert!(actual.err.contains("Destination file already exists"));
})
}
#[test]
fn save_override_works() {
Playground::setup("save_test_9", |dirs, sandbox| {
sandbox.with_files(vec![Stub::EmptyFile("log.txt")]);
let expected_file = dirs.test().join("log.txt");
nu!(
cwd: dirs.root(),
r#""abcd" | save save_test_9/log.txt -f"#
);
let actual = file_contents(expected_file);
assert_eq!(actual, "abcd");
})
}
#[test]
fn save_failure_not_overrides() {
Playground::setup("save_test_10", |dirs, sandbox| {
sandbox.with_files(vec![Stub::FileWithContent("result.toml", "Old content")]);
let expected_file = dirs.test().join("result.toml");
nu!(
cwd: dirs.root(),
// Writing number to file as toml fails
r#"3 | save save_test_10/result.toml -f"#
);
let actual = file_contents(expected_file);
assert_eq!(actual, "Old content");
})
}
#[test]
fn save_append_works_on_stderr() {
Playground::setup("save_test_11", |dirs, sandbox| {
sandbox.with_files(vec![
Stub::FileWithContent("log.txt", "Old"),
Stub::FileWithContent("err.txt", "Old Err"),
]);
let expected_file = dirs.test().join("log.txt");
let expected_stderr_file = dirs.test().join("err.txt");
nu!(
cwd: dirs.root(),
r#"
$env.FOO = " New";
$env.BAZ = " New Err";
do -i {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -a -r save_test_11/log.txt --stderr save_test_11/err.txt"#,
);
let actual = file_contents(expected_file);
assert_eq!(actual, "Old New\n");
let actual = file_contents(expected_stderr_file);
assert_eq!(actual, "Old Err New Err\n");
})
}
#[test]
fn save_not_overrides_err_by_default() {
Playground::setup("save_test_12", |dirs, sandbox| {
sandbox.with_files(vec![Stub::FileWithContent("err.txt", "Old Err")]);
let actual = nu!(
cwd: dirs.root(),
r#"
$env.FOO = " New";
$env.BAZ = " New Err";
do -i {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -r save_test_12/log.txt --stderr save_test_12/err.txt"#,
);
assert!(actual.err.contains("Destination file already exists"));
})
}
#[test]
fn save_override_works_stderr() {
Playground::setup("save_test_13", |dirs, sandbox| {
sandbox.with_files(vec![
Stub::FileWithContent("log.txt", "Old"),
Stub::FileWithContent("err.txt", "Old Err"),
]);
let expected_file = dirs.test().join("log.txt");
let expected_stderr_file = dirs.test().join("err.txt");
nu!(
cwd: dirs.root(),
r#"
$env.FOO = "New";
$env.BAZ = "New Err";
do -i {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -f -r save_test_13/log.txt --stderr save_test_13/err.txt"#,
);
let actual = file_contents(expected_file);
assert_eq!(actual, "New\n");
let actual = file_contents(expected_stderr_file);
assert_eq!(actual, "New Err\n");
})
}
#[test]
fn save_list_stream() {
Playground::setup("save_test_13", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("list_sample.txt");
nu!(
cwd: dirs.root(),
r#"[a b c d] | each {|i| $i} | save -r save_test_13/list_sample.txt"#,
);
let actual = file_contents(expected_file);
assert_eq!(actual, "a\nb\nc\nd\n")
})
}
#[test]
fn writes_out_range() {
Playground::setup("save_test_14", |dirs, sandbox| {
sandbox.with_files(vec![]);
let expected_file = dirs.test().join("list_sample.json");
nu!(
cwd: dirs.root(),
r#"1..3 | save save_test_14/list_sample.json"#,
);
let actual = file_contents(expected_file);
println!("{actual}");
assert_eq!(actual, "[\n 1,\n 2,\n 3\n]")
})
}