lib/testing: Rename and test format_log_label

Author: mbland

lib/testing/log

@@ -33,6 +33,36 @@ run_log_script() {
   run "$TEST_GO_SCRIPT"
 }
 
+# Format a `log` module log level label
+#
+# Note that this must be called before any other log assertion, because it needs
+# to set _GO_LOG_FORMATTING before importing the `log` module.
+#
+# Arguments:
+#   label:  Log level label to format
+format_log_label() {
+  local label="$1"
+
+  if [[ -n "$__GO_LOG_INIT" ]]; then
+    local err_format=("\`%s\` must be called before any other function"
+      "or assertion that calls \`. \"\$_GO_USE_MODULES\" 'log'\`"
+      'because it needs to set `_GO_LOG_FORMATTING`.')
+    printf "${err_format[*]}" "$FUNCNAME" >&2
+    exit 1
+  fi
+
+  _GO_LOG_FORMATTING='true'
+  . "$_GO_USE_MODULES" 'log'
+  _@go.log_init
+
+  local __go_log_level_index=0
+  if ! _@go.log_level_index "$label"; then
+    printf 'Unknown log level label: %s\n' "$label" >&2
+    exit 1
+  fi
+  printf '%s' "${__GO_LOG_LEVELS_FORMATTED[$__go_log_level_index]}"
+}
+
 assert_log_equals() {
   set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
   local level
@@ -84,30 +114,6 @@ assert_log_file_equals() {
   fi
 }
 
-# Note that this must be called before any other log assertion, because it needs
-# to set _GO_LOG_FORMATTING before importing the `log` module.
-format_label() {
-  local label="$1"
-
-  if [[ -n "$__GO_LOG_INIT" ]]; then
-    echo "$FUNCNAME must be called before any other function or assertion" \
-      "that calls \`. \$_GO_USE_MODULES 'log'\` because it needs to set" \
-      "\`_GO_LOG_FORMATTING\`." >&2
-      return 1
-  fi
-
-  _GO_LOG_FORMATTING='true'
-  . "$_GO_USE_MODULES" 'log'
-  _@go.log_init
-
-  local __go_log_level_index=0
-  if ! _@go.log_level_index "$label"; then
-    echo "Unknown log level label: $label" >&2
-    return 1
-  fi
-  echo "${__GO_LOG_LEVELS_FORMATTED[$__go_log_level_index]}"
-}
-
 # Creates `LOG_COMMAND_STACK_TRACE_ITEMS` to help validate stack trace output.
 #
 # Call this before using "${LOG_COMMAND_STACK_TRACE_ITEMS[@]}" to inject
@@ -170,5 +176,3 @@ __expected_log_line() {
     printf '%b\n' "$level $message"
   fi
 }
-
-

tests/log/add-output-file.bats

@@ -66,7 +66,7 @@ run_log_script_and_assert_status_and_output() {
     "@go.log_add_output_file '$TEST_GO_ROOTDIR/info.log' 'INFO'" \
     "@go.log INFO Hello, World!"
   assert_success
-  assert_log_equals "$(format_label INFO)" 'Hello, World!'
+  assert_log_equals "$(format_log_label INFO)" 'Hello, World!'
   assert_file_equals "$TEST_GO_ROOTDIR/info.log" "${lines[@]}"
 }
 

tests/log/log-command.bats

@@ -115,8 +115,8 @@ teardown() {
 }
 
 @test "$SUITE: log failing command to standard error with formatting" {
-  local formatted_run_level_label="$(format_label RUN)"
-  local formatted_error_level_label="$(format_label ERROR)"
+  local formatted_run_level_label="$(format_log_label RUN)"
+  local formatted_error_level_label="$(format_log_label ERROR)"
 
   _GO_LOG_FORMATTING='true' run_log_script \
       'function failing_function() {' \

tests/log/main.bats

@@ -23,7 +23,7 @@ teardown() {
     'echo Goodbye, World!'
   assert_success
   assert_log_equals \
-    "$(format_label INFO)" '\e[1m\e[36mHello, World!' \
+    "$(format_log_label INFO)" '\e[1m\e[36mHello, World!' \
     'Goodbye, World!'
 }
 

tests/testing/log.bats

@@ -36,3 +36,25 @@ teardown() {
     "^  $_GO_CORE_DIR/lib/log:[0-9]+ _@go.log_command_invoke$" \
     "^  $_GO_CORE_DIR/lib/log:[0-9]+ @go.log_command$"
 }
+
+@test "$SUITE: format_log_label" {
+  run format_log_label INFO
+  assert_success
+
+  local expected_message
+  printf -v expected_message '%b' "$output Hello, World!\e[0m"
+
+  _GO_LOG_FORMATTING='true' run_log_script '@go.log INFO Hello, World!'
+  assert_success "$expected_message"
+}
+
+@test "$SUITE: format_log_label exits if log module already initialized" {
+  __GO_LOG_INIT='true' run format_log_label INFO
+  assert_failure
+  assert_output_matches '^`format_log_label` must be called before any other '
+}
+
+@test "$SUITE: format_log_label exits if log level label invalid" {
+  run format_log_label FOOBAR
+  assert_failure 'Unknown log level label: FOOBAR'
+}