nushell/crates/nu-command/tests/commands/try_.rs
WindSoilder 0b97f52a8b
make better usage of error value in catch block (#8460)
# Description

Fixes: #8402  #8391

The cause of these issue if when we want to evaluate a expression with
`Value::Error`, nushell show error immediately. To fix the issue, we can
wrap the `Value::Error` into a `Value::Record`. So user can see the
message he want.

# User-Facing Changes

Before
```
❯ try { 1 / 0 } catch {|e| echo $"error is ($e)"}
Error: nu:🐚:division_by_zero

  × Division by zero.
   ╭─[entry #2:1:1]
 1 │ try { 1 / 0 } catch {|e| echo $"error is ($e)"}
   ·         ┬
   ·         ╰── division by zero
   ╰────
```

After
```
❯ try { 1 / 0 } catch {|e| echo $"error is ($e)"}
error is {msg: Division by zero., debug: DivisionByZero { span: Span { start: 43104, end: 43105 } }, raw: DivisionByZero { sp
an: Span { start: 43104, end: 43105 } }}
```

As we can see, error becomes a record with `msg`, `debug`, `raw`
columns.
1. msg column is a user friendly message.
2. debug column is more about `Value::Error` information as a string.
3. raw column is a `Value::Error` itself, if user want to re-raise the
error, just use `$e | get raw`

# 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` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

> **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.
2023-03-15 20:56:18 -07:00

112 lines
2.2 KiB
Rust

use nu_test_support::nu;
#[test]
fn try_succeed() {
let output = nu!(
cwd: ".",
"try { 345 } catch { echo 'hello' }"
);
assert!(output.out.contains("345"));
}
#[test]
fn try_catch() {
let output = nu!(
cwd: ".",
"try { foobarbaz } catch { echo 'hello' }"
);
assert!(output.out.contains("hello"));
}
#[test]
fn catch_can_access_error() {
let output = nu!(
cwd: ".",
"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!(
cwd: ".",
"try { foobarbaz } catch { $in | get raw }"
);
assert!(output.err.contains("External command failed"));
}
#[test]
fn external_failed_should_be_caught() {
let output = nu!(
cwd: ".",
"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!(
cwd: ".",
"loop { try { echo 'successful'; break } catch { echo 'failed'; continue } }"
);
assert_eq!(output.out, "successful");
}
#[test]
fn loop_catch_break_should_show_failed() {
let output = nu!(
cwd: ".",
"loop {
try { invalid 1;
continue; } catch { echo 'failed'; break }
}
"
);
assert_eq!(output.out, "failed");
}
#[test]
fn loop_try_ignores_continue() {
let output = nu!(
cwd: ".",
"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!(
cwd: ".",
"loop { try { ls; break } catch { echo 'failed';continue }}"
);
assert!(!output.out.contains("failed"));
}
#[test]
fn catch_block_can_use_error_object() {
let output = nu!(
cwd: ".",
"try {1 / 0} catch {|err| print ($err | get msg)}"
);
assert_eq!(output.out, "Division by zero.")
}