nu-protocol 0.113.0

Nushell's internal protocols, including its abstract syntax tree
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use nu_protocol::{ConfigError, Record, Type};
use nu_test_support::prelude::*;

const DEFAULT_FILES_DIR: &str = "crates/nu-utils/src/default_files";

#[track_caller]
fn config_error<const N: usize>(err: &ShellError) -> Result<&[ConfigError; N]> {
    match err {
        ShellError::InvalidConfig { errors } => match errors.as_slice().try_into() {
            Ok(errs) => Ok(errs),
            _ => panic!("expected {N} config error, got {}", errors.len()),
        },
        _ => Err(err.clone().into()),
    }
}

#[test]
fn config_is_mutable() -> Result {
    let mut tester = test();
    let () = tester.run("$env.config = { ls: { clickable_links: true } }")?;
    let () = tester.run("$env.config.ls.clickable_links = false")?;
    tester
        .run("$env.config.ls.clickable_links")
        .expect_value_eq(false)
}

#[test]
fn config_preserved_after_do() -> Result {
    let mut tester = test();
    let () = tester.run("$env.config = { ls: { clickable_links: true } }")?;
    let () = tester.run("do -i { $env.config.ls.clickable_links = false }")?;
    tester
        .run("$env.config.ls.clickable_links")
        .expect_value_eq(true)
}

#[test]
#[env(NU_TEST_LOCALE_OVERRIDE = "en_US.UTF-8")]
fn config_affected_when_mutated() -> Result {
    let mut tester = test();
    let () = tester.run("$env.config = { filesize: { unit: binary } }")?;
    let () = tester.run("$env.config = { filesize: { unit: metric } }")?;
    tester.run("20MB | into string").expect_value_eq("20.0 MB")
}

#[test]
#[env(NU_TEST_LOCALE_OVERRIDE = "en_US.UTF-8")]
fn config_affected_when_deep_mutated() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run("source default_config.nu")?;
    let () = tester.run("$env.config.filesize.unit = 'binary'")?;
    tester
        .run("20MiB | into string")
        .expect_value_eq("20.0 MiB")
}

#[test]
fn config_add_unsupported_key() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run("source default_config.nu")?;
    let shell_error = tester.run("$env.config.foo = 2").expect_shell_error()?;
    let [err] = config_error(&shell_error)?;

    match err {
        ConfigError::UnknownOption { path, .. } if path == "$env.config.foo" => Ok(()),
        _ => Err(shell_error.into()),
    }
}

#[test]
fn config_add_unsupported_type() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run("source default_config.nu")?;
    let shell_error = tester.run("$env.config.ls = '' ").expect_shell_error()?;
    let [err] = config_error(&shell_error)?;

    match err {
        ConfigError::TypeMismatch {
            expected: Type::Record(_),
            actual: Type::String,
            ..
        } => Ok(()),
        _ => Err(shell_error.into()),
    }
}

#[test]
fn config_add_unsupported_value() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run("source default_config.nu")?;
    let shell_error = tester
        .run("$env.config.history.file_format = ''")
        .expect_shell_error()?;
    let [err] = config_error(&shell_error)?;

    match err {
        ConfigError::InvalidValue { valid, actual, .. } => {
            #[cfg(feature = "sqlite")]
            assert_eq!(valid, "'sqlite' or 'plaintext'");
            #[cfg(not(feature = "sqlite"))]
            assert_eq!(valid, "'plaintext'");

            assert_eq!(actual, "''");
            Ok(())
        }
        _ => Err(shell_error.into()),
    }
}

#[test]
fn config_unsupported_key_reverted() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run("source default_config.nu")?;
    let _ = tester.run("$env.config.foo = 1").expect_shell_error()?;
    tester.run("'foo' in $env.config").expect_value_eq(false)
}

#[test]
fn config_unsupported_type_reverted() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run(" source default_config.nu")?;
    let _ = tester.run("$env.config.ls = ''").expect_shell_error()?;
    let _: Record = tester.run("$env.config.ls")?;
    Ok(())
}

#[test]
fn config_unsupported_value_reverted() -> Result {
    let mut tester = test().cwd(DEFAULT_FILES_DIR);
    let () = tester.run(" source default_config.nu")?;
    let () = tester.run("$env.config.history.file_format = 'plaintext'")?;
    let _ = tester
        .run("$env.config.history.file_format = ''")
        .expect_shell_error()?;
    tester
        .run("$env.config.history.file_format")
        .expect_value_eq("plaintext")
}