Suppress detailed log messages unless debug is enabled

Author: gtjoseph

install_and_cache_pkgs.sh

@@ -59,10 +59,10 @@ log "Clean installing and caching ${package_count} package(s)."
 log_empty_line
 
 manifest_main=""
-log "Package list:"
+log_debug "Package list:"
 for package in ${packages}; do
   manifest_main="${manifest_main}${package},"
-  log "- ${package}"
+  log_debug "- ${package}"
 done
 write_manifest "main" "${manifest_main}" "${cache_dir}/manifest_main.log"
 
@@ -92,11 +92,13 @@ log "Installation log written to ${install_log_filepath}"
 log_empty_line
 
 installed_packages=$(get_installed_packages "${install_log_filepath}")
-log "Installed package list:"
-for installed_package in ${installed_packages}; do
-  # Reformat for human friendly reading.  
-  log "- $(echo ${installed_package} | awk -F\= '{print $1" ("$2")"}')"
-done
+if [ "${debug}" == "true" ] ; then
+  log "Installed package list:"
+  for installed_package in ${installed_packages}; do
+    # Reformat for human friendly reading.  
+    log "- $(echo ${installed_package} | awk -F\= '{print $1" ("$2")"}')"
+  done
+fi
 
 log_empty_line
 
@@ -108,7 +110,7 @@ for installed_package in ${installed_packages}; do
   # Sanity test in case APT enumerates duplicates.
   if test ! -f "${cache_filepath}"; then
     read package_name package_ver < <(get_package_name_ver "${installed_package}")
-    log "  * Caching ${package_name} to ${cache_filepath}..."
+    log_debug "  * Caching ${package_name} to ${cache_filepath}..."
 
     # Get the entry in /var/lib/dpkg/status
     mkdir -p /var/tmp/dpkg-restore || :
@@ -131,7 +133,7 @@ for installed_package in ${installed_packages}; do
       done
     )
 
-    log "    done (compressed size $(du -h "${cache_filepath}" | cut -f1))."
+    log_debug "    done (compressed size $(du -h "${cache_filepath}" | cut -f1))."
   fi
 
   # Comma delimited name:ver pairs in the all packages manifest.

lib.sh

@@ -20,13 +20,17 @@ function execute_install_script {
   local package_name=$(basename ${2} | awk -F\= '{print $1}')  
   local install_script_filepath=$(\
     get_install_script_filepath "${1}" "${package_name}" "${3}")
+  echocmd=""
   if test ! -z "${install_script_filepath}"; then
-    log "- Executing ${install_script_filepath}..."
+    if [ "${debug}" == "true" ] ; then
+        log "- Executing ${install_script_filepath}..."
+        echocmd="-x"
+    fi
     # Don't abort on errors; dpkg-trigger may error normally since it is
     # outside its run environment.  We'll set DPKG_MAINTSCRIPT_NAME though
     # to increase the odds of success. 
-    sudo DPKG_MAINTSCRIPT_NAME="${3}" sh -x "${install_script_filepath}" "${4}" || true
-    log "  done"
+    sudo DPKG_MAINTSCRIPT_NAME="${3}" sh ${echocmd} "${install_script_filepath}" "${4}" || true
+    log_debug "  done"
   fi
 }
 
@@ -175,6 +179,7 @@ function log { echo "${@}"; }
 function log_err { >&2 echo "${@}"; }
 
 function log_empty_line { echo ""; }
+function log_debug { test "${debug}" == "true" && echo "${@}" || : ; }
 
 ###############################################################################
 # Validates an argument to be of a boolean value.

pre_cache_action.sh

@@ -42,7 +42,7 @@ log "done"
 # Create cache directory so artifacts can be saved.
 mkdir -p ${cache_dir}
 
-log "Validating action arguments (version='${version}', packages='${packages}')...";
+log_debug "Validating action arguments (version='${version}', packages='${packages}')...";
 if grep -q " " <<< "${version}"; then
   log "aborted" 
   log "Version value '${version}' cannot contain spaces." >&2
@@ -115,7 +115,7 @@ if [ "${cpu_arch}" != "x86_64" ]; then
   log "- Architecture '${cpu_arch}' added to value."
 fi
 
-log "- Value to hash is '${value}'."
+log_debug "- Value to hash is '${value}'."
 
 key="$(echo "${value}" | md5sum | cut -f1 -d' ')"
 log "- Value hashed as '${key}'."

restore_pkgs.sh

@@ -25,16 +25,20 @@ execute_install_scripts="${3}"
 
 cache_filepaths="$(ls -1 "${cache_dir}" | sort)"
 log "Found $(echo ${cache_filepaths} | wc -w) files in the cache."
-for cache_filepath in ${cache_filepaths}; do
-  log "- "$(basename ${cache_filepath})""
-done
+if test "${debug}" == "true" ; then
+  for cache_filepath in ${cache_filepaths}; do
+    log "- $(basename ${cache_filepath})"
+  done
+fi
 
 log_empty_line
 
 log "Reading from main requested packages manifest..."
-for logline in $(cat "${cache_dir}/manifest_main.log" | tr ',' '\n' ); do
-  log "- $(echo "${logline}" | tr ':' ' ')"
-done
+if test "${debug}" == "true" ; then
+  for logline in $(cat "${cache_dir}/manifest_main.log" | tr ',' '\n' ); do
+    log "- $(echo "${logline}" | tr ':' ' ')"
+  done
+fi
 log "done"
 
 log_empty_line
@@ -53,7 +57,7 @@ restore_dpkg_status() {
 
 for package in "${packages[@]}"; do
   cached_filepath="${cache_dir}/${package}.tar"
-  log "- ${package} restoring..."
+  log_debug "- ${package} restoring..."
   sudo tar -xf "${cached_filepath}" -C "${cache_restore_root}" > /dev/null
 
   package_name="${package%%=*}"
@@ -62,7 +66,7 @@ for package in "${packages[@]}"; do
   else
     log "Status file ${cache_restore_root}/var/tmp/dpkg-restore/${package_name}.status not found"
   fi
-  log "  done"
+  log_debug "  done"
 
   # Execute install scripts if available.    
   if test ${execute_install_scripts} == "true"; then