mbland / go-script-bash / 361

361

Pull #78

travis-ci

web-flow 
assertions: Improve return_from_bats_assertion

Closes #51. The short answer is yes, `set -o functrace` can be (and now
is) conditional in `return_from_bats_assertion`.

The fuller answer is that all assertions need to `set +eET` as the first
line (via the `set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"` convention),
and `return_from_bats_assertion` will automatically restore these
options upon exit from the outermost assertion function. It no longer
requires the `$BASH_SOURCE` argument, either, as it can do the right
thing based upon the immediate caller's information as provided by Bash.

It's now much easier to compose robust new assertions, even from
existing ones, using the `set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"`
and `return_from_bats_assertions` conventions.

The function comments for `return_from_bats_assertion` contain
meticulous details regarding how and why it works, and the file comments
for `lib/bats/assertions` now contain sample assertion patterns.

This change also updates a number of assertions from the `tests/`
directory to:

- replace `set +o functrace` in the first line with
  `set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"`
- update their calls to `return_from_bats_assertion`
- remove the no longer necessary `set +o functrace` calls in the rest of
  the function

Also, `check_sets_functrace` was removed from `tests/assertions.bats`,
as the `eval $assertion &>/dev/null || :` line for failing assertions
would succeed on Bash 4, but cause tests to exit immediately on Bash
3.2. This is due to `bats_teardown_trap` and `bats_exit_trap` from
`tests/bats/libexec/bats-exec-test` executing, which I'm pretty sure is
due to the following (from the Bash release notes at
https://tiswww.case.edu/php/chet/bash/CHANGES):

  This document details the changes between this version,
  bash-4.0-alpha, and the previous version, bash-3.2-release.

  ppp. Fixed a bug that caused the `-e' option to be inherited when
       sourcing a file or evaluating a co... (continued)
Pull Request #78: Improve `return_from_bats_assertion`

70 of 70 new or added lines in 2 files covered. (100.0%)

1920 of 2037 relevant lines covered (94.26%)

167.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.13
/tests/log/helpers.bash


Build SHA Not Found

The commit SHA "94230901187437d7c9d0223b340a941e4707e709" was not found in your repository, so the file cannot be loaded. This may be because you posted from a local development environment, or your CI created an ephemeral commit.