Allow environment variables to be hidden (#3950)

* Allow environment variables to be hidden

This change allows environment variables in Nushell to have a value of
`Nothing`, which can be set by the user by passing `$nothing` to
`let-env` and friends.

Environment variables with a value of Nothing behave as if they are not
set at all. This allows a user to shadow the value of an environment
variable in a parent scope, effectively removing it from their current
scope. This was not possible before, because a scope can not affect its
parent scopes.

This is a workaround for issues like #3920.

Additionally, this allows a user to simultaneously set, change and
remove multiple environment variables via `load-env`. Any environment
variables set to $nothing will be hidden and thus act as if they are
removed. This simplifies working with virtual environments, which rely
on setting multiple environment variables, including PATH, to specific
values, and remove/change them on deactivation.

One surprising behavior is that an environment variable set to $nothing
will act as if it is not set when querying it (via $nu.env.X), but it is
still possible to remove it entirely via `unlet-env`. If the same
environment variable is present in the parent scope, the value in the
parent scope will be visible to the user. This might be surprising
behavior to users who are not familiar with the implementation details.

An additional corner case is the the shorthand form of `with-env` does
not work with this feature. Using `X=$nothing` will set $nu.env.X to the
string "$nothing". The long-form works as expected: `with-env [X
$nothing] {...}`.

* Remove unused import

* Allow all primitives to be convert to strings
This commit is contained in:
Hristo Filaretov
2021-08-26 15:15:58 +02:00
committed by GitHub
parent 3e8ce43dcb
commit 88817a8f10
11 changed files with 253 additions and 31 deletions

View File

@ -424,6 +424,43 @@ fn let_env_variable() {
assert_eq!(actual.out, "hello world");
}
#[test]
fn let_env_hides_variable() {
let actual = nu!(
cwd: ".",
r#"
let-env TESTENVVAR = "hello world"
echo $nu.env.TESTENVVAR
let-env TESTENVVAR = $nothing
echo $nu.env.TESTENVVAR
"#
);
assert_eq!(actual.out, "hello world");
assert!(actual.err.contains("error"));
assert!(actual.err.contains("Unknown column"));
}
#[test]
fn let_env_hides_variable_in_parent_scope() {
let actual = nu!(
cwd: ".",
r#"
let-env TESTENVVAR = "hello world"
echo $nu.env.TESTENVVAR
do {
let-env TESTENVVAR = $nothing
echo $nu.env.TESTENVVAR
}
echo $nu.env.TESTENVVAR
"#
);
assert_eq!(actual.out, "hello worldhello world");
assert!(actual.err.contains("error"));
assert!(actual.err.contains("Unknown column"));
}
#[test]
fn unlet_env_variable() {
let actual = nu!(
@ -443,10 +480,31 @@ fn unlet_nonexistent_variable() {
cwd: ".",
r#"
unlet-env NONEXISTENT_VARIABLE
"
"#
);
assert!(actual.err.contains("did you mean"));
assert!(actual.err.contains("error"));
assert!(actual.err.contains("Not an environment variable"));
}
#[test]
fn unlet_variable_in_parent_scope() {
let actual = nu!(
cwd: ".",
r#"
let-env DEBUG = "1"
echo $nu.env.DEBUG
do {
let-env DEBUG = "2"
echo $nu.env.DEBUG
unlet-env DEBUG
echo $nu.env.DEBUG
}
echo $nu.env.DEBUG
"#
);
assert_eq!(actual.out, "1211");
}
#[test]
@ -534,6 +592,41 @@ fn proper_shadow_load_env_aliases() {
assert_eq!(actual.out, "truefalsetrue");
}
#[test]
fn load_env_can_hide_var_envs() {
let actual = nu!(
cwd: ".",
r#"
let-env DEBUG = "1"
echo $nu.env.DEBUG
load-env [[name, value]; [DEBUG $nothing]]
echo $nu.env.DEBUG
"#
);
assert_eq!(actual.out, "1");
assert!(actual.err.contains("error"));
assert!(actual.err.contains("Unknown column"));
}
#[test]
fn load_env_can_hide_var_envs_in_parent_scope() {
let actual = nu!(
cwd: ".",
r#"
let-env DEBUG = "1"
echo $nu.env.DEBUG
do {
load-env [[name, value]; [DEBUG $nothing]]
echo $nu.env.DEBUG
}
echo $nu.env.DEBUG
"#
);
assert_eq!(actual.out, "11");
assert!(actual.err.contains("error"));
assert!(actual.err.contains("Unknown column"));
}
#[test]
fn proper_shadow_let_aliases() {
let actual = nu!(