nushell/tests/hooks/mod.rs
Jakub Žádník 3676a8a48d
Expand Hooks Functionality (#5982)
* (WIP) Initial messy support for hooks as strings

* Cleanup after running condition & hook code

Also, remove prints

* Move env hooks eval into its own function

* Add env change hooks to simulator

* Fix hooks simulator not running env hooks properly

* Add missing hooks test file

* Expand hooks tests

* Add blocks as env hooks; Preserve hook environment

* Add full eval to pre prompt/exec hooks; Fix panic

* Rename env change hook back to orig. name

* Print err on test failure; Add list of hooks test

* Consolidate condition block; Fix panic; Misc

* CHange test to use real file

* Remove unused stuff

* Fix potential panics; Clean up errors

* Remove commented unused code

* Clippy: Fix extra references

* Add back support for old-style hooks

* Reorder functions; Fmt

* Fix test on Windows

* Add more test cases; Simplify some error reporting

* Add more tests for setting correct before/after

* Move pre_prompt hook to the beginning

Since we don't have a prompt or blocking on user input, all hooks just
follow after each other.
2022-07-10 13:45:46 +03:00

565 lines
12 KiB
Rust

use super::nu_repl::nu_repl;
fn env_change_hook_code_list(name: &str, code_list: &[&str]) -> String {
let mut list = String::new();
for code in code_list.iter() {
list.push_str("{ code: ");
list.push_str(code);
list.push_str(" }\n");
}
format!(
r#"let-env config = {{
hooks: {{
env_change: {{
{name} : [
{list}
]
}}
}}
}}"#
)
}
fn env_change_hook(name: &str, code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
env_change: {{
{name} : {code}
}}
}}
}}"#
)
}
fn env_change_hook_code(name: &str, code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
env_change: {{
{name} : {{
code: {code}
}}
}}
}}
}}"#
)
}
fn env_change_hook_code_condition(name: &str, condition: &str, code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
env_change: {{
{name} : {{
condition: {condition}
code: {code}
}}
}}
}}
}}"#
)
}
fn pre_prompt_hook(code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
pre_prompt: {code}
}}
}}"#
)
}
fn pre_prompt_hook_code(code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
pre_prompt: {{
code: {code}
}}
}}
}}"#
)
}
fn pre_execution_hook(code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
pre_execution: {code}
}}
}}"#
)
}
fn pre_execution_hook_code(code: &str) -> String {
format!(
r#"let-env config = {{
hooks: {{
pre_execution: {{
code: {code}
}}
}}
}}"#
)
}
#[test]
fn env_change_define_command() {
let inp = &[
&env_change_hook_code("FOO", r#"'def foo [] { "got foo!" }'"#),
"let-env FOO = 1",
"foo",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "got foo!");
}
#[test]
fn env_change_define_variable() {
let inp = &[
&env_change_hook_code("FOO", r#"'let x = "spam"'"#),
"let-env FOO = 1",
"$x",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_define_env_var() {
let inp = &[
&env_change_hook_code("FOO", r#"'let-env SPAM = "spam"'"#),
"let-env FOO = 1",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_define_alias() {
let inp = &[
&env_change_hook_code("FOO", r#"'alias spam = "spam"'"#),
"let-env FOO = 1",
"spam",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_simple_block_preserve_env_var() {
let inp = &[
&env_change_hook("FOO", r#"{ let-env SPAM = "spam" }"#),
"let-env FOO = 1",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_simple_block_list_shadow_env_var() {
let inp = &[
&env_change_hook(
"FOO",
r#"[
{ let-env SPAM = "foo" }
{ let-env SPAM = "spam" }
]"#,
),
"let-env FOO = 1",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_block_preserve_env_var() {
let inp = &[
&env_change_hook_code("FOO", r#"{ let-env SPAM = "spam" }"#),
"let-env FOO = 1",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn pre_prompt_define_command() {
let inp = &[
&pre_prompt_hook_code(r#"'def foo [] { "got foo!" }'"#),
"",
"foo",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "got foo!");
}
#[test]
fn pre_prompt_simple_block_preserve_env_var() {
let inp = &[
&pre_prompt_hook(r#"{ let-env SPAM = "spam" }"#),
"",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn pre_prompt_simple_block_list_shadow_env_var() {
let inp = &[
&pre_prompt_hook(
r#"[
{ let-env SPAM = "foo" }
{ let-env SPAM = "spam" }
]"#,
),
"",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn pre_prompt_block_preserve_env_var() {
let inp = &[
&pre_prompt_hook_code(r#"{ let-env SPAM = "spam" }"#),
"",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn pre_execution_define_command() {
let inp = &[
&pre_execution_hook_code(r#"'def foo [] { "got foo!" }'"#),
"",
"foo",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "got foo!");
}
#[test]
fn pre_execution_simple_block_preserve_env_var() {
let inp = &[
&pre_execution_hook(r#"{ let-env SPAM = "spam" }"#),
"",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn pre_execution_simple_block_list_shadow_env_var() {
let inp = &[
&pre_execution_hook(
r#"[
{ let-env SPAM = "foo" }
{ let-env SPAM = "spam" }
]"#,
),
"",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn pre_execution_block_preserve_env_var() {
let inp = &[
&pre_execution_hook_code(r#"{ let-env SPAM = "spam" }"#),
"",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_shadow_command() {
let inp = &[
&env_change_hook_code_list(
"FOO",
&[
r#"'def foo [] { "got spam!" }'"#,
r#"'def foo [] { "got foo!" }'"#,
],
),
"let-env FOO = 1",
"foo",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "got foo!");
}
#[test]
fn env_change_block_dont_preserve_command() {
let inp = &[
&env_change_hook_code("FOO", r#"{ def foo [] { "foo" } }"#),
"let-env FOO = 1",
"foo",
];
let actual_repl = nu_repl("tests/hooks", inp);
#[cfg(windows)]
assert!(actual_repl.out != "foo");
#[cfg(not(windows))]
assert!(actual_repl.err.contains("ExternalCommand"));
}
#[test]
fn env_change_block_condition_pwd() {
let inp = &[
&env_change_hook_code_condition(
"PWD",
r#"{|before, after| ($after | path basename) == samples }"#,
r#"'source .nu-env'"#,
),
"cd samples",
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "spam");
}
#[test]
fn env_change_block_condition_correct_args() {
let inp = &[
r#"let-env FOO = 1"#,
&env_change_hook_code_condition(
"FOO",
r#"{|before, after| $before == 1 and $after == 2}"#,
r#"{|before, after| let-env SPAM = ($before == 1 and $after == 2) }"#,
),
"",
r#"let-env FOO = 2"#,
"$env.SPAM",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert_eq!(actual_repl.err, "");
assert_eq!(actual_repl.out, "true");
}
#[test]
fn env_change_dont_panic_with_many_args() {
let inp = &[
&env_change_hook_code("FOO", r#"{ |a, b, c| let-env SPAM = 'spam' }"#),
"let-env FOO = 1",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("IncompatibleParametersSingle"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_wrong_env_type_1() {
let inp = &[
r#"let-env config = {
hooks: {
env_change: {
FOO : 1
}
}
}"#,
"let-env FOO = 1",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("UnsupportedConfigValue"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_wrong_env_type_2() {
let inp = &[
r#"let-env config = {
hooks: {
env_change: "print spam"
}
}"#,
"",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("TypeMismatch"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_wrong_env_type_3() {
let inp = &[
r#"let-env config = {
hooks: {
env_change: {
FOO : {
code: 1
}
}
}
}"#,
"let-env FOO = 1",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("UnsupportedConfigValue"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_non_boolean_condition_output() {
let inp = &[
r#"let-env config = {
hooks: {
env_change: {
FOO : {
condition: { "foo" }
code: "print spam"
}
}
}
}"#,
"let-env FOO = 1",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("UnsupportedConfigValue"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_non_condition_not_a_block() {
let inp = &[
r#"let-env config = {
hooks: {
env_change: {
FOO : {
condition: "foo"
code: "print spam"
}
}
}
}"#,
"let-env FOO = 1",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("UnsupportedConfigValue"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_parse_error() {
let inp = &[
r#"let-env config = {
hooks: {
env_change: {
FOO : {
code: "def foo { 'foo' }"
}
}
}
}"#,
"let-env FOO = 1",
"",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.err.contains("UnsupportedConfigValue"));
assert_eq!(actual_repl.out, "");
}
#[test]
fn err_hook_dont_allow_string() {
let inp = &[
&pre_prompt_hook(r#"'def foo [] { "got foo!" }'"#),
"",
"foo",
];
let actual_repl = nu_repl("tests/hooks", inp);
assert!(actual_repl.out.is_empty());
assert!(actual_repl.err.contains("UnsupportedConfigValue"));
}