Skip to content

Fixed some tests that would not pass, fixed some shellcheck warnings, used shellformat to format script #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
speedythesnail wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fixed some tests that would not pass, fixed some shellcheck warnings, used shellformat to format script #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55d8572
Update test.sh
speedythesnail Jan 7, 2024
a37f712
Update log.sh
speedythesnail Jan 7, 2024
bdd03d3
Update log.sh
speedythesnail Jan 7, 2024
cbbc62e
Update test.sh
speedythesnail Jan 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 128 additions & 125 deletions log.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,138 +1,141 @@
#!/bin/bash

set -uo pipefail;
set -uo pipefail

function _log_exception() {
(
BASHLOG_FILE=0;
BASHLOG_JSON=0;
BASHLOG_SYSLOG=0;
(
BASHLOG_FILE=0
BASHLOG_JSON=0
BASHLOG_SYSLOG=0

log 'error' "Logging Exception: ${@}";
);
log 'error' "Logging Exception: ${*}"
)
}

function log() {
local date_format="${BASHLOG_DATE_FORMAT:-+%F %T}";
local date="$(date "${date_format}")";
local date_s="$(date "+%s")";

local file="${BASHLOG_FILE:-0}";
local file_path="${BASHLOG_FILE_PATH:-/tmp/$(basename "${0}").log}";

local json="${BASHLOG_JSON:-0}";
local json_path="${BASHLOG_JSON_PATH:-/tmp/$(basename "${0}").log.json}";

local syslog="${BASHLOG_SYSLOG:-0}";
local tag="${BASHLOG_SYSLOG_TAG:-$(basename "${0}")}";
local facility="${BASHLOG_SYSLOG_FACILITY:-local0}";
local pid="${$}";

local level="${1}";
local upper="$(echo "${level}" | awk '{print toupper($0)}')";
local debug_level="${DEBUG:-0}";

shift 1;

local line="${@}";

# RFC 5424
#
# Numerical Severity
# Code
#
# 0 Emergency: system is unusable
# 1 Alert: action must be taken immediately
# 2 Critical: critical conditions
# 3 Error: error conditions
# 4 Warning: warning conditions
# 5 Notice: normal but significant condition
# 6 Informational: informational messages
# 7 Debug: debug-level messages

local -A severities;
severities['DEBUG']=7;
severities['INFO']=6;
severities['NOTICE']=5; # Unused
severities['WARN']=4;
severities['ERROR']=3;
severities['CRIT']=2; # Unused
severities['ALERT']=1; # Unused
severities['EMERG']=0; # Unused

local severity="${severities[${upper}]:-3}"

if [ "${debug_level}" -gt 0 ] || [ "${severity}" -lt 7 ]; then

if [ "${syslog}" -eq 1 ]; then
local syslog_line="${upper}: ${line}";

logger \
--id="${pid}" \
-t "${tag}" \
-p "${facility}.${severity}" \
"${syslog_line}" \
|| _log_exception "logger --id=\"${pid}\" -t \"${tag}\" -p \"${facility}.${severity}\" \"${syslog_line}\"";
fi;

if [ "${file}" -eq 1 ]; then
local file_line="${date} [${upper}] ${line}";
echo -e "${file_line}" >> "${file_path}" \
|| _log_exception "echo -e \"${file_line}\" >> \"${file_path}\"";
fi;

if [ "${json}" -eq 1 ]; then
local json_line="$(printf '{"timestamp":"%s","level":"%s","message":"%s"}' "${date_s}" "${level}" "${line}")";
echo -e "${json_line}" >> "${json_path}" \
|| _log_exception "echo -e \"${json_line}\" >> \"${json_path}\"";
fi;

fi;

local -A colours;
colours['DEBUG']='\033[34m' # Blue
colours['INFO']='\033[32m' # Green
colours['NOTICE']='' # Unused
colours['WARN']='\033[33m' # Yellow
colours['ERROR']='\033[31m' # Red
colours['CRIT']='' # Unused
colours['ALERT']='' # Unused
colours['EMERG']='' # Unused
colours['DEFAULT']='\033[0m' # Default

local norm="${colours['DEFAULT']}";
local colour="${colours[${upper}]:-\033[31m}";

local std_line="${colour}${date} [${upper}] ${line}${norm}";

# Standard Output (Pretty)
case "${level}" in
'info'|'warn')
echo -e "${std_line}";
;;
'debug')
if [ "${debug_level}" -gt 0 ]; then
echo -e "${std_line}";
fi;
;;
'error')
echo -e "${std_line}" >&2;
if [ "${debug_level}" -gt 0 ]; then
echo -e "Here's a shell to debug with. 'exit 0' to continue. Other exit codes will abort - parent shell will terminate.";
bash || exit "${?}";
fi;
;;
*)
log 'error' "Undefined log level trying to log: ${@}";
;;
esac
local __log_sh_script_name__=$(basename "$0")
local date_format="${BASHLOG_DATE_FORMAT:-+%F %T}"
local date="$(date "${date_format}")"
local date_s="$(date "+%s")"

local file="${BASHLOG_FILE:-0}"
local file_path="${BASHLOG_FILE_PATH:-/tmp/${__log_sh_script_name__}.log}"

local json="${BASHLOG_JSON:-0}"
local json_path="${BASHLOG_JSON_PATH:-/tmp/${__log_sh_script_name__}.log.json}"

local syslog="${BASHLOG_SYSLOG:-0}"
local tag="${BASHLOG_SYSLOG_TAG:-${__log_sh_script_name__}}"
local facility="${BASHLOG_SYSLOG_FACILITY:-local0}"
local pid="$$"

local level="$1"
local upper="${level^^}" # Bash natively can set variable to uppercase instead of calling other methods
local debug_level="${DEBUG:-0}"

shift 1

local line="${*}"

# RFC 5424
#
# Numerical Severity
# Code
#
# 0 Emergency: system is unusable
# 1 Alert: action must be taken immediately
# 2 Critical: critical conditions
# 3 Error: error conditions
# 4 Warning: warning conditions
# 5 Notice: normal but significant condition
# 6 Informational: informational messages
# 7 Debug: debug-level messages

local -A severities
severities['DEBUG']=7
severities['INFO']=6
severities['NOTICE']=5 # Unused
severities['WARN']=4
severities['ERROR']=3
severities['CRIT']=2 # Unused
severities['ALERT']=1 # Unused
severities['EMERG']=0 # Unused

local severity="${severities[${upper}]:-3}"

if [ "${debug_level}" -gt 0 ] || [ "${severity}" -lt 7 ]; then

if [ "${syslog}" -eq 1 ]; then
local syslog_line="${upper}: ${line}"

logger \
--id="${pid}" \
-t "${tag}" \
-p "${facility}.${severity}" \
"${syslog_line}" ||
_log_exception "logger --id=\"${pid}\" -t \"${tag}\" -p \"${facility}.${severity}\" \"${syslog_line}\""
fi

if [ "${file}" -eq 1 ]; then
local file_line="${date} [${upper}] ${line}"
echo -e "${file_line}" >>"${file_path}" ||
_log_exception "echo -e \"${file_line}\" >> \"${file_path}\""
fi

if [ "${json}" -eq 1 ]; then
# don't use printf anymore to speed up just a little
local json_line="{\"timestamp\":\"${date_s}\",\"level\":\"${level}\",\"message\":\"${line}\"}"
echo -e "${json_line}" >>"${json_path}" ||
_log_exception "echo -e \"${json_line}\" >> \"${json_path}\""
fi

fi

local -A colours
colours['DEBUG']='\033[34m' # Blue
colours['INFO']='\033[32m' # Green
colours['NOTICE']='' # Unused
colours['WARN']='\033[33m' # Yellow
colours['ERROR']='\033[31m' # Red
colours['CRIT']='' # Unused
colours['ALERT']='' # Unused
colours['EMERG']='' # Unused
colours['DEFAULT']='\033[0m' # Default

local norm="${colours['DEFAULT']}"
local colour="${colours[${upper}]:-\033[31m}"

local std_line="${colour}${date} [${upper}] ${line}${norm}"

# Standard Output (Pretty)
case "${level}" in
'info' | 'warn')
echo -e "${std_line}"
;;
'debug')
if [ "${debug_level}" -gt 0 ]; then
echo -e "${std_line}"
fi
;;
'error')
echo -e "${std_line}" >&2
if [ "${debug_level}" -gt 0 ]; then
echo -e "Here's a shell to debug with. 'exit 0' to continue. Other exit codes will abort - parent shell will terminate."
bash || exit "${?}"
fi
;;
*)
log 'error' "Undefined log level trying to log: ${*}"
;;
esac
}

declare prev_cmd="null";
declare this_cmd="null";
trap 'prev_cmd=$this_cmd; this_cmd=$BASH_COMMAND' DEBUG \
&& log debug 'DEBUG trap set' \
|| log error 'DEBUG trap failed to set';
# shellcheck disable=SC2034
declare prev_cmd="null"
declare this_cmd="null"
trap 'prev_cmd=$this_cmd; this_cmd=$BASH_COMMAND' DEBUG &&
log debug 'DEBUG trap set' ||
log error 'DEBUG trap failed to set'

# This is an option if you want to log every single command executed,
# but it will significantly impact script performance and unit tests will fail
Expand Down
Loading