2022-11-24 05:52:11 +01:00
use nu_test_support ::nu ;
#[ test ]
fn try_succeed ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " try { 345 } catch { echo 'hello' } " ) ;
2022-12-22 16:35:41 +01:00
assert! ( output . out . contains ( " 345 " ) ) ;
2022-11-24 05:52:11 +01:00
}
#[ test ]
fn try_catch ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " try { foobarbaz } catch { echo 'hello' } " ) ;
2022-12-22 16:35:41 +01:00
assert! ( output . out . contains ( " hello " ) ) ;
2022-11-24 05:52:11 +01:00
}
2022-11-24 19:02:20 +01:00
#[ test ]
fn catch_can_access_error ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " try { foobarbaz } catch { |err| $err | get raw } " ) ;
2022-12-22 16:35:41 +01:00
assert! ( output . err . contains ( " External command failed " ) ) ;
}
#[ test ]
fn catch_can_access_error_as_dollar_in ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " try { foobarbaz } catch { $in | get raw } " ) ;
2022-12-22 16:35:41 +01:00
assert! ( output . err . contains ( " External command failed " ) ) ;
2022-11-24 19:02:20 +01:00
}
2022-12-01 17:58:32 +01:00
#[ test ]
2023-01-16 12:43:46 +01:00
fn external_failed_should_be_caught ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " try { nu --testbin fail; echo 'success' } catch { echo 'fail' } " ) ;
2022-12-22 16:35:41 +01:00
assert! ( output . out . contains ( " fail " ) ) ;
2022-12-01 17:58:32 +01:00
}
2023-01-05 21:41:51 +01:00
#[ test ]
fn loop_try_break_should_be_successful ( ) {
2023-07-17 18:43:51 +02:00
let output =
nu! ( " loop { try { print 'successful'; break } catch { print 'failed'; continue } } " ) ;
2023-01-05 21:41:51 +01:00
assert_eq! ( output . out , " successful " ) ;
}
#[ test ]
fn loop_catch_break_should_show_failed ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " loop {
2023-01-05 21:41:51 +01:00
try { invalid 1 ;
2023-03-16 23:53:46 +01:00
continue ; } catch { print ' failed ' ; break }
2023-01-05 21:41:51 +01:00
}
2023-07-17 18:43:51 +02:00
" );
2023-01-05 21:41:51 +01:00
assert_eq! ( output . out , " failed " ) ;
}
#[ test ]
fn loop_try_ignores_continue ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " mut total = 0;
2023-01-05 21:41:51 +01:00
for i in 0 .. 10 {
2023-01-16 12:43:46 +01:00
try { if ( $i mod 2 ) = = 0 {
continue ; }
2023-01-05 21:41:51 +01:00
$total + = 1
2023-01-16 12:43:46 +01:00
} catch { echo ' failed ' ; break }
2023-01-05 21:41:51 +01:00
}
echo $total
2023-07-17 18:43:51 +02:00
" );
2023-01-05 21:41:51 +01:00
assert_eq! ( output . out , " 5 " ) ;
}
#[ test ]
fn loop_try_break_on_command_should_show_successful ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " loop { try { ls; break } catch { echo 'failed';continue }} " ) ;
2023-01-05 21:41:51 +01:00
assert! ( ! output . out . contains ( " failed " ) ) ;
}
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::shell::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-16 04:56:18 +01:00
#[ test ]
fn catch_block_can_use_error_object ( ) {
2023-07-17 18:43:51 +02:00
let output = nu! ( " try {1 / 0} catch {|err| print ($err | get msg)} " ) ;
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::shell::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-16 04:56:18 +01:00
assert_eq! ( output . out , " Division by zero. " )
}
2024-02-07 23:42:24 +01:00
// 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 " ) ;
}
2024-04-26 18:35:08 +02:00
Error on non-zero exit statuses (#13515)
# Description
This PR makes it so that non-zero exit codes and termination by signal
are treated as a normal `ShellError`. Currently, these are silent
errors. That is, if an external command fails, then it's code block is
aborted, but the parent block can sometimes continue execution. E.g.,
see #8569 and this example:
```nushell
[1 2] | each { ^false }
```
Before this would give:
```
╭───┬──╮
│ 0 │ │
│ 1 │ │
╰───┴──╯
```
Now, this shows an error:
```
Error: nu::shell::eval_block_with_input
× Eval block failed with pipeline input
╭─[entry #1:1:2]
1 │ [1 2] | each { ^false }
· ┬
· ╰── source value
╰────
Error: nu::shell::non_zero_exit_code
× External command had a non-zero exit code
╭─[entry #1:1:17]
1 │ [1 2] | each { ^false }
· ──┬──
· ╰── exited with code 1
╰────
```
This PR fixes #12874, fixes #5960, fixes #10856, and fixes #5347. This
PR also partially addresses #10633 and #10624 (only the last command of
a pipeline is currently checked). It looks like #8569 is already fixed,
but this PR will make sure it is definitely fixed (fixes #8569).
# User-Facing Changes
- Non-zero exit codes and termination by signal now cause an error to be
thrown.
- The error record value passed to a `catch` block may now have an
`exit_code` column containing the integer exit code if the error was due
to an external command.
- Adds new config values, `display_errors.exit_code` and
`display_errors.termination_signal`, which determine whether an error
message should be printed in the respective error cases. For
non-interactive sessions, these are set to `true`, and for interactive
sessions `display_errors.exit_code` is false (via the default config).
# Tests
Added a few tests.
# After Submitting
- Update docs and book.
- Future work:
- Error if other external commands besides the last in a pipeline exit
with a non-zero exit code. Then, deprecate `do -c` since this will be
the default behavior everywhere.
- Add a better mechanism for exit codes and deprecate
`$env.LAST_EXIT_CODE` (it's buggy).
2024-09-07 08:44:26 +02:00
#[ test ]
fn exit_code_available_in_catch_env ( ) {
2024-09-10 04:44:04 +02:00
let actual = nu! ( " try { nu -c 'exit 42' } catch { $env.LAST_EXIT_CODE } " ) ;
Error on non-zero exit statuses (#13515)
# Description
This PR makes it so that non-zero exit codes and termination by signal
are treated as a normal `ShellError`. Currently, these are silent
errors. That is, if an external command fails, then it's code block is
aborted, but the parent block can sometimes continue execution. E.g.,
see #8569 and this example:
```nushell
[1 2] | each { ^false }
```
Before this would give:
```
╭───┬──╮
│ 0 │ │
│ 1 │ │
╰───┴──╯
```
Now, this shows an error:
```
Error: nu::shell::eval_block_with_input
× Eval block failed with pipeline input
╭─[entry #1:1:2]
1 │ [1 2] | each { ^false }
· ┬
· ╰── source value
╰────
Error: nu::shell::non_zero_exit_code
× External command had a non-zero exit code
╭─[entry #1:1:17]
1 │ [1 2] | each { ^false }
· ──┬──
· ╰── exited with code 1
╰────
```
This PR fixes #12874, fixes #5960, fixes #10856, and fixes #5347. This
PR also partially addresses #10633 and #10624 (only the last command of
a pipeline is currently checked). It looks like #8569 is already fixed,
but this PR will make sure it is definitely fixed (fixes #8569).
# User-Facing Changes
- Non-zero exit codes and termination by signal now cause an error to be
thrown.
- The error record value passed to a `catch` block may now have an
`exit_code` column containing the integer exit code if the error was due
to an external command.
- Adds new config values, `display_errors.exit_code` and
`display_errors.termination_signal`, which determine whether an error
message should be printed in the respective error cases. For
non-interactive sessions, these are set to `true`, and for interactive
sessions `display_errors.exit_code` is false (via the default config).
# Tests
Added a few tests.
# After Submitting
- Update docs and book.
- Future work:
- Error if other external commands besides the last in a pipeline exit
with a non-zero exit code. Then, deprecate `do -c` since this will be
the default behavior everywhere.
- Add a better mechanism for exit codes and deprecate
`$env.LAST_EXIT_CODE` (it's buggy).
2024-09-07 08:44:26 +02:00
assert_eq! ( actual . out , " 42 " ) ;
}
2024-04-26 18:35:08 +02:00
#[ test ]
fn exit_code_available_in_catch ( ) {
2024-09-10 04:44:04 +02:00
let actual = nu! ( " try { nu -c 'exit 42' } catch { |e| $e.exit_code } " ) ;
2024-04-26 18:35:08 +02:00
assert_eq! ( actual . out , " 42 " ) ;
}
2024-09-23 13:44:25 +02:00
#[ test ]
2024-10-12 08:37:10 +02:00
fn catches_exit_code_in_assignment ( ) {
2024-09-23 13:44:25 +02:00
let actual = nu! ( " let x = try { nu -c 'exit 42' } catch { |e| $e.exit_code }; $x " ) ;
assert_eq! ( actual . out , " 42 " ) ;
}
#[ test ]
2024-10-12 08:37:10 +02:00
fn catches_exit_code_in_expr ( ) {
2024-09-23 13:44:25 +02:00
let actual = nu! ( " print (try { nu -c 'exit 42' } catch { |e| $e.exit_code }) " ) ;
assert_eq! ( actual . out , " 42 " ) ;
}
2024-10-12 08:37:10 +02:00
#[ 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 " ) ;
}
2024-10-18 03:16:38 +02:00
#[ 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 \" :[]} "
) ;
}