lib/testing: Test create/run_log_script, test-go

Also moves `test-go` from `lib/testing/log` to
`lib/testing/environment`, as it may prove generally useful.

Author: mbland

lib/testing/environment

@@ -62,6 +62,19 @@ create_test_go_script() {
   fi
 }
 
+# Sets `_GO_CMD` to make for neater test output when running `TEST_GO_SCRIPT`
+#
+# Use `run test-go` instead of `run "$TEST_GO_SCRIPT"` to achieve the effect.
+#
+# Useful for tests that contain `_GO_CMD` in the output, to avoid clouding the
+# output with the full `TEST_GO_SCRIPT` path.
+#
+# Arguments:
+#    ...:  Command line arguments for `TEST_GO_SCRIPT`
+test-go() {
+  _GO_CMD="$FUNCNAME" "$TEST_GO_SCRIPT" "$@"
+}
+
 # Creates an executable `./go` command script in `TEST_GO_SCRIPTS_DIR`
 #
 # The script will be created as `$TEST_GO_SCRIPTS_DIR/$script_name`.

lib/testing/log

@@ -6,6 +6,16 @@
 
 . "${BASH_SOURCE[0]%/*}/stack-trace"
 
+# Creates a `./go` script that imports the `log` module
+#
+# If `TEST_LOG_FILE` is defined, it will add that file for logging output as
+# well.
+#
+# Globals:
+#   TEST_LOG_FILE:  (Optional) Path to the log file to add for all log levels
+#
+# Arguments:
+#   ...:  Lines comprising the `./go` script
 create_log_script(){
   create_test_go_script \
     ". \"\$_GO_USE_MODULES\" 'log'" \
@@ -15,17 +25,14 @@ create_log_script(){
     "$@"
 }
 
+# Creates and executes a `./go` script that imports the `log` module
+#
+# Globals and arguments are identical to `create_log_script`.
 run_log_script() {
   create_log_script "$@"
   run "$TEST_GO_SCRIPT"
 }
 
-# For tests that run command scripts via @go, set _GO_CMD to make sure that's
-# the variable included in the log.
-test-go() {
-  env _GO_CMD="$FUNCNAME" "$TEST_GO_SCRIPT" "$@"
-}
-
 assert_log_equals() {
   set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
   local level

tests/testing/environment.bats

@@ -87,3 +87,9 @@ teardown() {
   [ -x "$TEST_GO_SCRIPTS_DIR/foo.d/bar.d/xyzzy" ]
   [ -x "$TEST_GO_SCRIPTS_DIR/foo.d/bar.d/plugh" ]
 }
+
+@test "$SUITE: run TEST_GO_SCRIPT via test-go" {
+  create_test_go_script 'printf "_GO_CMD: %s\n" "$_GO_CMD"'
+  run test-go
+  assert_success '_GO_CMD: test-go'
+}

tests/testing/log.bats

@@ -11,6 +11,23 @@ teardown() {
   remove_test_go_rootdir
 }
 
+@test "$SUITE: create_log_script and run_log_script without log file" {
+  export TEST_LOG_FILE="$TEST_GO_ROOTDIR/test-script.log"
+  TEST_LOG_FILE= run_log_script '@go.log INFO Hello, World!'
+  assert_success
+  assert_output_matches '^INFO +Hello, World!$'
+  [ ! -e "$TEST_LOG_FILE" ]
+}
+
+@test "$SUITE: create_log_script and run_log_script with log file" {
+  export TEST_LOG_FILE="$TEST_GO_ROOTDIR/test-script.log"
+  run_log_script '@go.log INFO Hello, World!'
+  assert_success
+  assert_output_matches '^INFO +Hello, World!$'
+  [ -e "$TEST_LOG_FILE" ]
+  assert_file_matches "$TEST_LOG_FILE" '^INFO +Hello, World!$'
+}
+
 @test "$SUITE: set_log_command_stack_trace_items" {
   assert_equal '' "${LOG_COMMAND_STACK_TRACE_ITEMS[*]}"
   set_log_command_stack_trace_items