feat(log): support verbosing logging

Author: Jim Zhang

example/verbose.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+source "$(cd "${BASH_SOURCE[0]%/*}" && pwd)/../lib/oo-bootstrap.sh"
+
+import util/log
+
+namespace test/verbose
+VERBOSE=1
+
+Log::AddOutput test/verbose DEBUG
+
+Log "this log will be printed"
+V=1 Log "this log will be printed"
+V=2 Log "this log will be filtered"

lib/util/log.sh

@@ -6,6 +6,9 @@ declare -Ag __oo__logScopeOutputs
 declare -Ag __oo__logDisabledFilter
 declare -Ag __oo__loggers
 
+# Controls verbosity of the script output and logging.
+VERBOSE="${VERBOSE:-5}"
+
 Log::NameScope() {
   local scopeName="$1"
   local script="${BASH_SOURCE[1]}"
@@ -36,11 +39,16 @@ Log::DisableFilter() {
 }
 
 Log() {
+  # support verbosing logging
+  local V="${V:-0}"
+  if [[ $VERBOSE < $V ]]; then
+    return
+  fi
+
   local callingFunction="${FUNCNAME[1]}"
   local callingScript="${BASH_SOURCE[1]}"
   local scope
-  if [[ ! -z "${__oo__logScopes["$callingScript"]}" ]]
-  then
+  if [[ ! -z "${__oo__logScopes["$callingScript"]}" ]]; then
     scope="${__oo__logScopes["$callingScript"]}"
   else # just the filename without extension
     scope="${callingScript##*/}"
@@ -51,49 +59,38 @@ Log() {
   local logger
   local logged
 
-  if [[ ! -z "$subject" ]]
-  then
-    if [[ ! -z "${__oo__logScopeOutputs["$scope/$callingFunction/$subject"]}" ]]
-    then
+  if [[ ! -z "$subject" ]]; then
+    if [[ ! -z "${__oo__logScopeOutputs["$scope/$callingFunction/$subject"]}" ]]; then
       loggerList="${__oo__logScopeOutputs["$scope/$callingFunction/$subject"]}"
-    elif [[ ! -z "${__oo__logScopeOutputs["$scope/$subject"]}" ]]
-    then
+    elif [[ ! -z "${__oo__logScopeOutputs["$scope/$subject"]}" ]]; then
       loggerList="${__oo__logScopeOutputs["$scope/$subject"]}"
-    elif [[ ! -z "${__oo__logScopeOutputs["$subject"]}" ]]
-    then
+    elif [[ ! -z "${__oo__logScopeOutputs["$subject"]}" ]]; then
       loggerList="${__oo__logScopeOutputs["$subject"]}"
     fi
 
-    loggers=( ${loggerList//;/ } )
-    for logger in "${loggers[@]}"
-    do
+    loggers=(${loggerList//;/ })
+    for logger in "${loggers[@]}"; do
       subject="${subject:-LOG}" Log::Using "$logger" "$@"
       logged=true
     done
   fi
 
-  if [[ ! -z "${__oo__logScopeOutputs["$scope/$callingFunction"]}" ]]
-  then
-    if [[ -z $logged ]] || [[ ${__oo__logDisabledFilter["$scope/$callingFunction"]} == true || ${__oo__logDisabledFilter["$scope"]} == true ]]
-    then
+  if [[ ! -z "${__oo__logScopeOutputs["$scope/$callingFunction"]}" ]]; then
+    if [[ -z $logged ]] || [[ ${__oo__logDisabledFilter["$scope/$callingFunction"]} == true || ${__oo__logDisabledFilter["$scope"]} == true ]]; then
       loggerList="${__oo__logScopeOutputs["$scope/$callingFunction"]}"
-      loggers=( ${loggerList//;/ } )
-      for logger in "${loggers[@]}"
-      do
-          subject="${subject:-LOG}" Log::Using "$logger" "$@"
-          logged=true
+      loggers=(${loggerList//;/ })
+      for logger in "${loggers[@]}"; do
+        subject="${subject:-LOG}" Log::Using "$logger" "$@"
+        logged=true
       done
     fi
   fi
 
-  if [[ ! -z "${__oo__logScopeOutputs["$scope"]}" ]]
-  then
-    if [[ -z $logged ]] || [[ ${__oo__logDisabledFilter["$scope"]} == true ]]
-    then
+  if [[ ! -z "${__oo__logScopeOutputs["$scope"]}" ]]; then
+    if [[ -z $logged ]] || [[ ${__oo__logDisabledFilter["$scope"]} == true ]]; then
       loggerList="${__oo__logScopeOutputs["$scope"]}"
-      loggers=( ${loggerList//;/ } )
-      for logger in "${loggers[@]}"
-      do
+      loggers=(${loggerList//;/ })
+      for logger in "${loggers[@]}"; do
         subject="${subject:-LOG}" Log::Using "$logger" "$@"
       done
     fi
@@ -109,29 +106,28 @@ Log::RegisterLogger() {
 Log::Using() {
   local logger="$1"
   shift
-  if [[ ! -z ${__oo__loggers["$logger"]} ]]
-  then
-      ${__oo__loggers["$logger"]} "$@"
+  if [[ ! -z ${__oo__loggers["$logger"]} ]]; then
+    ${__oo__loggers["$logger"]} "$@"
   fi
 }
 
 Logger::DEBUG() {
-    Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Yellow) DEBUG "$@"
+  Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Yellow) DEBUG "$@"
 }
 Logger::ERROR() {
-    Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Red) ERROR "$@"
+  Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Red) ERROR "$@"
 }
 Logger::INFO() {
-    Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Blue) INFO "$@"
+  Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Blue) INFO "$@"
 }
 Logger::WARN() {
-    Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Yellow) WARN "$@"
+  Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Yellow) WARN "$@"
 }
 Logger::CUSTOM() {
-    Console::WriteStdErr "$(UI.Color.Yellow)[${subject^^}] $(UI.Color.Default)$* "
+  Console::WriteStdErr "$(UI.Color.Yellow)[${subject^^}] $(UI.Color.Default)$* "
 }
 Logger::DETAILED() {
-    Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Yellow) "${subject^^}" "$@"
+  Console::WriteStdErrAnnotated "${BASH_SOURCE[3]##*/}" ${BASH_LINENO[2]} $(UI.Color.Yellow) "${subject^^}" "$@"
 }
 
 Log::RegisterLogger STDERR Console::WriteStdErr