ass-test-help: Use lib/bats/helper-function

This is in anticipation of migrating `lib/bats/assertions` to use
`lib/bats/helper-function` as well.

Author: mbland

lib/bats/assertion-test-helpers

@@ -6,8 +6,8 @@
 # a Bats assertion function complies with the expectations outlined in
 # `$_GO_CORE_DIR/lib/bats/assertions`, namely that it:
 #
-# - begins with `set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"`
-# - calls `return_from_bats_assertion` directly via every return path
+# - begins with `set "$DISABLE_BATS_SHELL_OPTIONS"`
+# - calls `restore_bats_shell_options` directly via every return path
 #
 # They also enforce that the assertion produces no output when successful, and
 # that it writes only to standard error (`>&2`) when it fails.
@@ -36,7 +36,7 @@ fi
 export TEST_OUTPUT_FILE="$BATS_TEST_ROOTDIR/test-output.txt"
 
 # Path to the script generated by `expect_assertion_*` to test whether
-# `return_from_bats_assertion` was called or not.
+# `restore_bats_shell_options` was called or not.
 readonly ASSERTION_TEST_SCRIPT="$BATS_TEST_ROOTDIR/assertion-test.bats"
 
 # Format for the error message emitted when `ASSERTION_TEST_SCRIPT` fails.
@@ -48,11 +48,11 @@ export ASSERTION_TEST_SCRIPT_FAILURE_MESSAGE=
 ! read -rd '' ASSERTION_TEST_SCRIPT_FAILURE_MESSAGE <<END_OF_FAILURE_MESSAGE
 The very first line of '%s' must be
 
-  set "\$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "\$DISABLE_BATS_SHELL_OPTIONS"
 
-and it must call 'return_from_bats_assertion' directly from every return path.
+and it must call 'restore_bats_shell_options' directly from every return path.
 
-For details, see the comments for 'return_from_bats_assertion' from:
+For details, see the comments for 'restore_bats_shell_options' from:
 
   ${BASH_SOURCE%/*}/assertions
 END_OF_FAILURE_MESSAGE
@@ -62,8 +62,7 @@ END_OF_FAILURE_MESSAGE
 # Will execute the command and assertion directly using the `run` command to
 # make sure the condition is satisfied as expected, then it will execute them
 # in a test script to make sure the assertion calls `set
-# "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS` and `return_from_bats_assertion`
-# appropriately.
+# "$DISABLE_BATS_SHELL_OPTIONS` and `restore_bats_shell_options` appropriately.
 #
 # Arguments:
 #   run_cmd:    The full command to pass to `run` as a single string
@@ -90,11 +89,11 @@ expect_assertion_success() {
   else
     # Although we expect the assertion under test to pass, this script injects a
     # failing assertion after it to check that the assertion under test directly
-    # calls `return_from_bats_assertion` upon returning. If it doesn't, `set
+    # calls `restore_bats_shell_options` upon returning. If it doesn't, `set
     # -eET` will not be in effect, so the failing assertion will not trigger the
     # ERR trap or fail the test case.
     #
-    # In an earlier incarnation of `return_from_bats_assertion` that only
+    # In an earlier incarnation of `restore_bats_shell_options` that only
     # restored `set -o functrace` (and when tests only started with `set +o
     # functrace`, equivalent to `set +T`), the failing assertion would fire the
     # ERR trap and exit the test case, but Bats would show the passing
@@ -125,8 +124,7 @@ expect_assertion_success() {
 # Will execute the command and assertion directly using the `run` command to
 # make sure the condition fails and the output is as expected, then it will
 # execute them in a test script to make sure the assertion calls `set
-# "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS` and `return_from_bats_assertion`
-# appropriately.
+# "$DISABLE_BATS_SHELL_OPTIONS` and `restore_bats_shell_options` appropriately.
 #
 # Arguments:
 #   run_cmd:    The full command to pass to `run` as a single string
@@ -300,7 +298,7 @@ __check_expected_output() {
   fi
 }
 
-# Basically the same as `return_from_bats_assertion`, but specific to this file.
+# Basically the same as `restore_bats_shell_options`, but specific to this file.
 #
 # Arguments:
 #   result:  Return value of the calling assertion; defaults to 0

tests/assertion-test-helpers.bash

@@ -16,27 +16,27 @@ __test_assertion_impl() {
   fi
 
   if [[ -n "$DELEGATE_RETURN_FROM_BATS_ASSERTION" ]]; then
-    return_from_bats_assertion "$assertion_status"
+    restore_bats_shell_options "$assertion_status"
   else
     return "$assertion_status"
   fi
 }
 
 test_assertion() {
-  # If an assertion fails to call `set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"`,
-  # then when it fails, the stack trace will show the implementation details of
-  # the assertion, rather than just the line at which it was called.
-  set "${TEST_ASSERTION_SHELL_OPTIONS:-$BATS_ASSERTION_DISABLE_SHELL_OPTIONS}"
+  # If an assertion fails to call `set "$DISABLE_BATS_SHELL_OPTIONS"`, then when
+  # it fails, the stack trace will show the implementation details of the
+  # assertion, rather than just the line at which it was called.
+  set "${TEST_ASSERTION_SHELL_OPTIONS:-$DISABLE_BATS_SHELL_OPTIONS}"
 
   __test_assertion_impl "$@"
   local result="$?"
 
-  # If an assertion calls `set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"`, but not
-  # `return_from_bats_assertion`, it will fail to scrub the stack and restore
+  # If an assertion calls `set "$DISABLE_BATS_SHELL_OPTIONS"`, but not
+  # `restore_bats_shell_options`, it will fail to scrub the stack and restore
   # `set -eET`.
   if [[ -z "$SKIP_RETURN_FROM_BATS_ASSERTION" &&
         -z "$DELEGATE_RETURN_FROM_BATS_ASSERTION" ]]; then
-    return_from_bats_assertion "$result"
+    restore_bats_shell_options "$result"
   else
     return "$result"
   fi

tests/assertion-test-helpers.bats

@@ -154,7 +154,7 @@ __check_failure_output() {
     "# 'test_assertion' should not produce output when successful."
 }
 
-@test "$SUITE: successful assertion must call return_from_bats_assertion" {
+@test "$SUITE: successful assertion must call restore_bats_shell_options" {
   SKIP_RETURN_FROM_BATS_ASSERTION='true' run_assertion_test 'success'
   [ "$status" -eq '1' ]
 
@@ -175,7 +175,7 @@ __check_failure_output() {
     "# $EXPECTED_TEST_SCRIPT_FAILURE_MESSAGE"
 }
 
-@test "$SUITE: successful assertion return_from_bats_assertion must be direct" {
+@test "$SUITE: successful assertion restore_bats_shell_options must be direct" {
   DELEGATE_RETURN_FROM_BATS_ASSERTION='true' run_assertion_test 'success'
   [ "$status" -eq '1' ]
 
@@ -278,7 +278,7 @@ __check_failure_output() {
     "# $EXPECTED_TEST_SCRIPT_FAILURE_MESSAGE"
 }
 
-@test "$SUITE: failing assertion must call return_from_bats_assertion" {
+@test "$SUITE: failing assertion must call restore_bats_shell_options" {
   ASSERTION_STATUS='1' SKIP_RETURN_FROM_BATS_ASSERTION='true' \
     run_assertion_test 'failure' 'foo bar baz'
   [ "$status" -eq '1' ]
@@ -300,7 +300,7 @@ __check_failure_output() {
     "# $EXPECTED_TEST_SCRIPT_FAILURE_MESSAGE"
 }
 
-@test "$SUITE: failing assertion return_from_bats_assertion must be direct" {
+@test "$SUITE: failing assertion restore_bats_shell_options must be direct" {
   ASSERTION_STATUS='1' DELEGATE_RETURN_FROM_BATS_ASSERTION='true' \
     run_assertion_test 'failure' 'foo bar baz'
   [ "$status" -eq '1' ]