build

Author: adrelanos

usr/share/usability-misc/dist-installer-cli-standalone

@@ -453,11 +453,12 @@ test_run_as_target_user() {
   ## root_output would catch xtrace and hence variable root_output would be non-empty.
   ## Therefore disabling xtrace.
   disable_xtrace
-  xtrace_force_no_re_enable=true root_output="$(run_as_target_user timeout --kill-after 5 5 test -d /usr 2>&1)"
-  re_enable_xtrace_maybe
+  trap 'xtrace_reenable_maybe' RETURN
+  root_output="$(run_as_target_user timeout --kill-after 5 5 test -d /usr 2>&1)"
   if test -n "${root_output}"; then
-    die 1 "${underline}run_as_target_user:${nounderline} 'sudo -u ${target_user}' test produced unexpected output: '${root_output}'"
+    die 1 "${underline}test_run_as_target_user:${nounderline} 'sudo -u ${target_user}' test produced unexpected output: '${root_output}'"
   fi
+  log info "test_run_as_target_user: OK."
 }
 
 
@@ -1008,38 +1009,58 @@ fi
 
 disable_xtrace() {
   if test "${xtrace:-}" = "1"; then
+    xtrace_was_on=true
     set +o xtrace
   else
-    case "${-}" in
-      *x*)
-        xtrace=1
-        set +o xtrace
-        ;;
-    esac
+    xtrace_was_on=false
   fi
 }
 
-re_enable_xtrace_maybe() {
-  if [ "${xtrace_force_no_re_enable:-}" = "true" ]; then
-    return 0
-  fi
-  if test "${xtrace:-}" = "1"; then
+xtrace_reenable_maybe() {
+  trap '' RETURN
+  if [ "${xtrace_was_on:-}" = "true" ]; then
     set -o xtrace
   fi
 }
 
+__log_level_num() {
+  case "${1:-notice}" in
+    bug|error) printf '%s' 0 ;;
+    warn)      printf '%s' 1 ;;
+    notice)    printf '%s' 2 ;;
+    info)      printf '%s' 3 ;;
+    debug)     printf '%s' 4 ;;
+    echo)      printf '%s' 5 ;;
+    null)      printf '%s' 6 ;;
+    *)         printf '%s' 2 ;; ## unknown -> treat as notice
+  esac
+  return 0
+}
+
 ## Logging mechanism with easy customization of message format as well as
 ## standardization on how the messages are delivered.
-## usage: log [info|notice|warn|error] "X occurred."
+## usage: log [info|notice|warn|error|debug|bug|echo|null] "X occurred."
 ## Variable to define by calling script: log_level
-log(){
-  : "${log_level:="notice"}"
+log() {
+  : "${log_level:=notice}"
+
   ## Avoid clogging output if log() is working alright.
   disable_xtrace
+  trap 'xtrace_reenable_maybe' RETURN
+
+  local log_type log_type_up log_color log_source_script log_level_colorized log_content log_full
+  local should_print=0
+  local caller_level_num msg_level_num
+
   log_type="${1:-notice}"
+
+  if (( $# > 0 )); then
+    shift || true
+  fi
+
   ## capitalize log level
-  log_type_up="$(printf '%s' "${log_type}" | tr "[:lower:]" "[:upper:]")"
-  shift 1
+  log_type_up="${log_type^^}"
+
   ## set formatting based on log level
   case "${log_type}" in
     bug)
@@ -1054,21 +1075,25 @@ log(){
     info)
       log_color="${cyan}"
       ;;
+    debug)
+      log_color="${cyan}"
+      ;;
     notice)
       log_color="${green}"
       ;;
     echo)
       log_color=""
-      true
       ;;
     null)
       log_color=""
-      true
       ;;
     *)
-      log bug "Unsupported log type specified: '${log_type}'"
-      re_enable_xtrace_maybe
+      ## Avoid recursion into log() on unsupported type; print directly.
+      #log bug "Unsupported log type specified: '${log_type}'"
+      stecho "${0##*/}: [${red}BUG${nocolor}]: Unsupported log type specified: '${log_type}'" >&2
       die 1 "Please report this bug."
+      return 0
+      ;;
   esac
   ## uniform log format
   log_color="${bold}${log_color}"
@@ -1082,32 +1107,25 @@ log(){
   case "${log_type}" in
     bug|error)
       stecho "${log_full}" >&2
-      re_enable_xtrace_maybe
       return 0
       ;;
     null)
-      true
+      return 0
       ;;
   esac
-  ## reverse importance order is required, excluding 'error'
-  all_log_levels="warn notice info debug echo null"
-  # shellcheck disable=SC2154
-  if printf '%s' " ${all_log_levels} " | grep -o ".* ${log_level} " \
-    | grep " ${log_type}" &>/dev/null
-  then
-    case "${log_type}" in
-      null)
-        true
-        ;;
-      *)
-        stecho "${log_full}" >&2
-        ;;
-    esac
+
+  caller_level_num="$(__log_level_num "${log_level}")"
+  msg_level_num="$(__log_level_num "${log_type}")"
+
+  if (( msg_level_num <= caller_level_num )); then
+    should_print=1
   fi
 
-  #sleep 0.1
+  if (( should_print == 1 )); then
+    stecho "${log_full}" >&2
+  fi
 
-  re_enable_xtrace_maybe
+  return 0
 }
 
 
@@ -1116,7 +1134,7 @@ log(){
 ## to log consecutive errors on multiple lines, making die more suitable
 ## usage: die # "msg"
 ## where '#' is the exit code.
-die(){
+die() {
   log error "${2}"
   if test "${allow_errors:-}" = "1"; then
     log warn "Skipping termination because of with code '${1}' due to 'allow_errors' setting."
@@ -1135,13 +1153,11 @@ die(){
 
 
 ## Wrapper to log command before running to avoid duplication of code
-log_run(){
+log_run() {
   local level command_without_extraneous_spaces_temp command_without_extraneous_spaces
   level="${1}"
-  shift
-  ## Extra spaces appearing when breaking log_run on multiple lines.
-  ## bug: removes all spaces
-  #command_without_extraneous_spaces="$(printf '%s' "${@}" | tr -s " ")"
+  shift || true
+
   printf -v command_without_extraneous_spaces_temp '%q ' "${@}"
   command_without_extraneous_spaces="$(printf "%s\n" "${command_without_extraneous_spaces_temp}")"
   if test "${dry_run:-}" = "1"; then
@@ -1155,7 +1171,7 @@ log_run(){
     log "${level}" "Background command starting: $ ${command_without_extraneous_spaces} &"
     "${@}" &
     background_pid="$!"
-    disown "$background_pid"
+    disown "${background_pid}" || true
   else
     log "${level}" "Command executing: $ ${command_without_extraneous_spaces}"
     "${@}" || return 1
@@ -1166,13 +1182,13 @@ log_run(){
 ## Useful to get runtime mid run to log easily
 ## Variable to define outside: start_time
 # shellcheck disable=SC2154
-get_elapsed_time(){
+get_elapsed_time() {
   printf '%s\n' "$(($(date +%s) - start_time))"
 }
 
 
 ## Log elapsed time, the name explains itself.
-log_time(){
+log_time() {
   log info "Time elapsed: $(get_elapsed_time)s."
 }
 ##### END pasted by build-dist-installer-cli from file /usr/libexec/helper-scripts/log_run_die.sh
@@ -1557,7 +1573,7 @@ update_sources() {
     update_cmd=( "${pkg_mngr_update[@]}" )
   fi
 
-  log info "update_cmd: '${update_cmd[*]}'"
+  log info "update_cmd: '${update_cmd[*]}' | console_write_command: '${console_write_command[*]}'"
 
   if update_output=$(root_cmd_loglevel=notice root_cmd "${update_cmd[@]}" 2>&1 | "${console_write_command[@]}") ; then
     log info "Package List Update: exit code '0' (OK)"
@@ -5234,19 +5250,19 @@ log_term_and_file() {
   tty_output=''
   ## global console_write_command
   if tty_output="$(tty 2>&1)" ; then
-    console_write_command=( 'tee' '--' '/dev/tty' )
+    console_write_command=( 'tee' '--' "${tty_output}" )
     log info "Terminal: 'tty' connected: 'yes' (console_write_command: '${console_write_command[*]}')"
   else
     ## github actions CI issue:
     ## tee: /dev/tty: No such device or address
     ## https://github.com/actions/runner/issues/241
     console_write_command=( 'cat' '--' )
-    log info "Terminal: 'tty' connected: 'no' (tty_output: '${tty_output}' | console_write_command: '${console_write_command[*]}')"
+    log notice "Terminal: 'tty' connected: 'no' (tty_output: '${tty_output}' | console_write_command: '${console_write_command[*]}')"
   fi
 
   ## Discover if terminal is attached to 'stdout'.
   if [ ! -t 1 ]; then
-    log info "Terminal: 'stdout' connected: 'no' - Output is not being sent to the terminal because terminal is not connected to 'stdout'."
+    log notice "Terminal: 'stdout' connected: 'no' - Output is not being sent to the terminal because terminal is not connected to 'stdout'."
     return 0
   fi
   log info "Terminal: 'stdout' connected: 'yes'"