tests: Use lib/bats/helper-function features

Part of #156. This replaces `BATS_ASSERTION_DISABLE_SHELL_OPTIONS` with
`DISABLE_BATS_SHELL_OPTIONS` and replaces `return_from_bats_assertion`
with `restore_bats_shell_options` in assertions defined in Bats test
suite files.

Performance isn't greatly affected, except that the
`core/plugin-scope-variable-values` tests are twice as fast after
extracting `__assert_scope_value_equal_impl`.

Author: mbland

tests/commands/find.bats

@@ -25,11 +25,11 @@ teardown() {
 }
 
 assert_command_scripts_equal() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
   unset 'lines[0]' 'lines[1]'
   lines=("${lines[@]}")
   assert_lines_equal "$@"
-  return_from_bats_assertion "$?"
+  restore_bats_shell_options "$?"
 }
 
 @test "$SUITE: return only builtin commands" {

tests/complete/command-path.bats

@@ -28,7 +28,12 @@ teardown() {
 }
 
 assert_completions_match() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
+  __assert_completions_match_impl "$@"
+  restore_bats_shell_options "$?"
+}
+
+__assert_completions_match_impl() {
   # Trim the last three lines of output from the script to compare separately
   # from the output of _@go.complete_command_path.
   local num_lines="${#lines[@]}"
@@ -55,11 +60,7 @@ assert_completions_match() {
   if ! assert_equal "${__expected_argv[*]}" "${var_lines[2]}" 'argv list'; then
     ((++num_errors))
   fi
-  if [[ "$num_errors" -ne '0' ]]; then
-    return_from_bats_assertion '1'
-  else
-    return_from_bats_assertion
-  fi
+  [[ "$num_errors" -eq '0' ]]
 }
 
 @test "$SUITE: error on empty arguments" {

tests/core/plugin-scope-variable-values.bats

@@ -57,7 +57,12 @@ teardown() {
 }
 
 assert_scope_values_equal() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
+  __assert_scope_values_equal_impl "$@"
+  restore_bats_shell_options "$?"
+}
+
+__assert_scope_values_equal_impl() {
   local scope="$1"
   shift
   local orig_lines=("${lines[@]}")
@@ -71,15 +76,14 @@ assert_scope_values_equal() {
         result='1'
       fi
       lines=("${orig_lines[@]}")
-      return_from_bats_assertion "$result"
-      return
+      return "$result"
     fi
   done
 
   if [[ "$i" -eq "${#lines[@]}" ]]; then
     printf 'ERROR: could not find "%s" in output.\nOUTPUT:\n%s\n' \
       "$scope SCOPE:" "$output" >&2
-    return_from_bats_assertion '1'
+    return '1'
   fi
 }
 

tests/log/add-output-file.bats

@@ -8,7 +8,7 @@ teardown() {
 }
 
 run_log_script_and_assert_status_and_output() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
   local num_errors
   local expected
 
@@ -28,9 +28,9 @@ run_log_script_and_assert_status_and_output() {
       "$(@go.stack_trace_item_from_offset "$TEST_GO_SCRIPT")")
 
     @go.assert_log_equals "${expected[@]}"
-    return_from_bats_assertion "$?"
+    restore_bats_shell_options "$?"
   else
-    return_from_bats_assertion 1
+    restore_bats_shell_options 1
   fi
 }
 

tests/log/filters.bats

@@ -8,7 +8,7 @@ teardown() {
 }
 
 run_log_script_and_assert_success() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
   local result=0
 
   @go.run_log_script "$@" \
@@ -23,7 +23,7 @@ run_log_script_and_assert_success() {
     '@go.log INFO   Goodbye, World!'
 
   assert_success
-  return_from_bats_assertion "$?"
+  restore_bats_shell_options "$?"
 }
 
 @test "$SUITE: default _GO_LOG_LEVEL_FILTER is RUN" {

tests/validation.bats

@@ -7,34 +7,34 @@ teardown() {
 }
 
 assert_error_on_invalid_input() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
   run "$TEST_GO_SCRIPT" "$1"
 
   if [[ "$status" -eq '0' ]]; then
     echo "Expected input to fail validation: $1" >&2
-    return_from_bats_assertion 1
+    restore_bats_shell_options 1
   else
-    return_from_bats_assertion
+    restore_bats_shell_options
   fi
 }
 
 assert_success_on_valid_input() {
-  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  set "$DISABLE_BATS_SHELL_OPTIONS"
   run "$TEST_GO_SCRIPT" "$1"
 
   if [[ "$status" -ne '0' ]]; then
     printf 'Expected input to pass validation: %s\n' "$1" >&2
-    return_from_bats_assertion 1
+    restore_bats_shell_options 1
     return
   fi
 
   run eval "var=\"$1\""
 
   if [[ -n "$output" ]]; then
     fail "Evaluating input still produced output: $1" >&2
-    return_from_bats_assertion 1
+    restore_bats_shell_options 1
   else
-    return_from_bats_assertion
+    restore_bats_shell_options
   fi
 }