mirror of
https://github.com/koalaman/shellcheck.git
synced 2025-10-03 19:29:44 +08:00
Add
45
SC2315.md
Normal file
45
SC2315.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
## In bats, ! does not cause a test failure. Fold the `!` into the conditional!
|
||||||
|
|
||||||
|
### Problematic code:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/usr/bin/env bats
|
||||||
|
|
||||||
|
@test "test" {
|
||||||
|
# ... code
|
||||||
|
! [ $status == 0 ]
|
||||||
|
# ... more code
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Correct code:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
#!/usr/bin/env bats
|
||||||
|
|
||||||
|
@test "test" {
|
||||||
|
# ... code
|
||||||
|
[ $status != 0 ]
|
||||||
|
# ... more code
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Rationale:
|
||||||
|
|
||||||
|
Bats uses `set -e` and `trap ERR` to catch test failures as early as possible.
|
||||||
|
Although the return code of a `!` negated command is inverted, they will never trigger `errexit`, due to a bash design decision (see [Related Resources](#related-resources)).
|
||||||
|
This means that tests which use `!` can never fail.
|
||||||
|
|
||||||
|
### Exceptions:
|
||||||
|
|
||||||
|
The return code of the last command in the test will be the exit code of the test function.
|
||||||
|
This means that you can use `! <command>` on the last line of the test and it will still fail appropriately.
|
||||||
|
However, you are encouraged to still transform the code in this case for consistency.
|
||||||
|
|
||||||
|
### Related resources:
|
||||||
|
|
||||||
|
* [SC2314: In bats, ! does not cause a test failure (for non `[ ]` commands)](SC2314)
|
||||||
|
* [SC2251: This ! is not on a condition and skips errexit](SC2251.md)
|
||||||
|
* [Stackoverflow: Why do I need parenthesis In bash `set -e` and negated return code](https://stackoverflow.com/a/39582012/760746)
|
||||||
|
* [bash manpage](https://linux.die.net/man/1/bash) (look at `trap [-lp] [[arg] sigspec ...]`):
|
||||||
|
> The ERR trap is not executed [...] if the command's return value is being inverted via !
|
Reference in New Issue
Block a user