nushell/crates/nu-command/tests/commands/try_.rs
Darren Schroeder 8c8f795e9e add rendered and json error messages in try/catch (#14082)
# Description

This PR adds a couple more options for dealing with try/catch errors. It
adds a `json` version of the error and a `rendered` version of the
error. It also respects the error_style configuration point.

![image](https://github.com/user-attachments/assets/32574f07-f511-40c0-8b57-de5f6f13a9c4)


# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# 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` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` 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 Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
2024-10-20 23:14:11 +02:00

146 lines
4.0 KiB
Rust

use nu_test_support::nu;
#[test]
fn try_succeed() {
let output = nu!("try { 345 } catch { echo 'hello' }");
assert!(output.out.contains("345"));
}
#[test]
fn try_catch() {
let output = nu!("try { foobarbaz } catch { echo 'hello' }");
assert!(output.out.contains("hello"));
}
#[test]
fn catch_can_access_error() {
let output = nu!("try { foobarbaz } catch { |err| $err | get raw }");
assert!(output.err.contains("External command failed"));
}
#[test]
fn catch_can_access_error_as_dollar_in() {
let output = nu!("try { foobarbaz } catch { $in | get raw }");
assert!(output.err.contains("External command failed"));
}
#[test]
fn external_failed_should_be_caught() {
let output = nu!("try { nu --testbin fail; echo 'success' } catch { echo 'fail' }");
assert!(output.out.contains("fail"));
}
#[test]
fn loop_try_break_should_be_successful() {
let output =
nu!("loop { try { print 'successful'; break } catch { print 'failed'; continue } }");
assert_eq!(output.out, "successful");
}
#[test]
fn loop_catch_break_should_show_failed() {
let output = nu!("loop {
try { invalid 1;
continue; } catch { print 'failed'; break }
}
");
assert_eq!(output.out, "failed");
}
#[test]
fn loop_try_ignores_continue() {
let output = nu!("mut total = 0;
for i in 0..10 {
try { if ($i mod 2) == 0 {
continue;}
$total += 1
} catch { echo 'failed'; break }
}
echo $total
");
assert_eq!(output.out, "5");
}
#[test]
fn loop_try_break_on_command_should_show_successful() {
let output = nu!("loop { try { ls; break } catch { echo 'failed';continue }}");
assert!(!output.out.contains("failed"));
}
#[test]
fn catch_block_can_use_error_object() {
let output = nu!("try {1 / 0} catch {|err| print ($err | get msg)}");
assert_eq!(output.out, "Division by zero.")
}
// This test is disabled on Windows because they cause a stack overflow in CI (but not locally!).
// For reasons we don't understand, the Windows CI runners are prone to stack overflow.
// TODO: investigate so we can enable on Windows
#[cfg(not(target_os = "windows"))]
#[test]
fn can_catch_infinite_recursion() {
let actual = nu!(r#"
def bang [] { try { bang } catch { "Caught infinite recursion" } }; bang
"#);
assert_eq!(actual.out, "Caught infinite recursion");
}
#[test]
fn exit_code_available_in_catch_env() {
let actual = nu!("try { nu -c 'exit 42' } catch { $env.LAST_EXIT_CODE }");
assert_eq!(actual.out, "42");
}
#[test]
fn exit_code_available_in_catch() {
let actual = nu!("try { nu -c 'exit 42' } catch { |e| $e.exit_code }");
assert_eq!(actual.out, "42");
}
#[test]
fn catches_exit_code_in_assignment() {
let actual = nu!("let x = try { nu -c 'exit 42' } catch { |e| $e.exit_code }; $x");
assert_eq!(actual.out, "42");
}
#[test]
fn catches_exit_code_in_expr() {
let actual = nu!("print (try { nu -c 'exit 42' } catch { |e| $e.exit_code })");
assert_eq!(actual.out, "42");
}
#[test]
fn prints_only_if_last_pipeline() {
let actual = nu!("try { 'should not print' }; 'last value'");
assert_eq!(actual.out, "last value");
let actual = nu!("try { ['should not print'] | every 1 }; 'last value'");
assert_eq!(actual.out, "last value");
}
#[test]
fn get_error_columns() {
let actual = nu!(" try { non_existent_command } catch {|err| $err} | columns | to json -r");
assert_eq!(
actual.out,
"[\"msg\",\"debug\",\"raw\",\"rendered\",\"json\"]"
);
}
#[test]
fn get_json_error() {
let actual = nu!("try { non_existent_command } catch {|err| $err} | get json | from json | update labels.span {{start: 0 end: 0}} | to json -r");
assert_eq!(
actual.out, "{\"msg\":\"External command failed\",\"labels\":[{\"text\":\"Command `non_existent_command` not found\",\"span\":{\"start\":0,\"end\":0}}],\"code\":\"nu::shell::external_command\",\"url\":null,\"help\":\"`non_existent_command` is neither a Nushell built-in or a known external command\",\"inner\":[]}"
);
}