mirror of
https://github.com/tomav/docker-mailserver.git
synced 2024-07-04 23:21:23 +02:00
7721a48b9b
* `update-check.sh` now uses the new log * refactored `setup-stack.sh` The changes are: 1. Replaced `""` wiht `''` where possible (reasoning: Bash is very implicit and I'd like to use `''` where possible to indicate no variables are expanded here) 2. `> /file` -> `>/file` according to our style guide 3. Some log adjustments for messages where I deemed it appropriate 4. Then, an error message from a Dovecot setup was also prevented (by adding a check whether the directory is present before a `: >...` command would create a file in this directory). These are all small, miscellaneous changes that I wanted to combine into one commit and ultimately one PR because I see no point in opening a PR for every small change here. I hope this is fine. * added a small `sleep` to the `_shutdown` function This ensure the last log message is actually logged before Supervisor logs the message that it received a SIGTERM. This makes reading the log easier because now the causal relationship is shown (we are terminating Supervisor, and not someone else and we're just logging it). I forgot to replace `""` with `''` in `update-check.sh`, so I included it here because this is the last commit before PR review. * re-add exit on successful update (only) * re-added date information to update-check log messages * added `_log_with_date` function The new function will log a message with a proper timestamp. This is all handled in `log.sh`, we therefore not need to source other files too. This will be used in the future by `check-for-changes.sh` as well :) Co-authored-by: Casper <casperklein@users.noreply.github.com> Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
122 lines
3.2 KiB
Bash
122 lines
3.2 KiB
Bash
#! /bin/bash
|
|
|
|
LOG_RESET='\e[0m'
|
|
LOG_LGRAY='\e[37m'
|
|
LOG_LBLUE='\e[94m'
|
|
LOG_BLUE='\e[34m'
|
|
LOG_LYELLOW='\e[93m'
|
|
LOG_RED='\e[91m'
|
|
|
|
# ### DMS Logging Functionality
|
|
#
|
|
# This function provides the logging for scripts used by DMS.
|
|
# It adheres to the convention for log levels.
|
|
# Valid values (in order of increasing verbosity) are: `error`,
|
|
# `warn`, `info`, `debug` and `trace`. The default log level
|
|
# is `info`.
|
|
#
|
|
# #### Arguments
|
|
#
|
|
# $1 :: the log level to log the message with
|
|
# $2 :: the message
|
|
#
|
|
# #### Panics
|
|
#
|
|
# If the first argument is not set or invalid, an error
|
|
# message is logged. Likewise when the second argument
|
|
# is missing. Both failures will return with exit code '1'.
|
|
function _log
|
|
{
|
|
if [[ -z ${1+set} ]]
|
|
then
|
|
echo "Call to '_log' is missing a valid log level" >&2
|
|
return 1
|
|
fi
|
|
|
|
if [[ -z ${2+set} ]]
|
|
then
|
|
echo "Call to '_log' is missing a message to log" >&2
|
|
return 1
|
|
fi
|
|
|
|
local MESSAGE LEVEL_AS_INT
|
|
MESSAGE="${LOG_RESET}["
|
|
|
|
case "${LOG_LEVEL:-}" in
|
|
( 'trace' ) LEVEL_AS_INT=5 ;;
|
|
( 'debug' ) LEVEL_AS_INT=4 ;;
|
|
( 'warn' ) LEVEL_AS_INT=2 ;;
|
|
( 'error' ) LEVEL_AS_INT=1 ;;
|
|
( * ) LEVEL_AS_INT=3 ;;
|
|
esac
|
|
|
|
case "${1}" in
|
|
( 'trace' )
|
|
[[ ${LEVEL_AS_INT} -ge 5 ]] || return 0
|
|
MESSAGE+=" ${LOG_LGRAY}TRACE "
|
|
;;
|
|
|
|
( 'debug' )
|
|
[[ ${LEVEL_AS_INT} -ge 4 ]] || return 0
|
|
MESSAGE+=" ${LOG_LBLUE}DEBUG "
|
|
;;
|
|
|
|
( 'info' )
|
|
[[ ${LEVEL_AS_INT} -ge 3 ]] || return 0
|
|
MESSAGE+=" ${LOG_BLUE}INF "
|
|
;;
|
|
|
|
( 'warn' )
|
|
[[ ${LEVEL_AS_INT} -ge 2 ]] || return 0
|
|
MESSAGE+=" ${LOG_LYELLOW}WARNING "
|
|
;;
|
|
|
|
( 'error' )
|
|
[[ ${LEVEL_AS_INT} -ge 1 ]] || return 0
|
|
MESSAGE+=" ${LOG_RED}ERROR " ;;
|
|
|
|
( * )
|
|
echo "Call to '_log' with invalid log level argument '${1}'" >&2
|
|
return 1
|
|
;;
|
|
esac
|
|
|
|
MESSAGE+="${LOG_RESET}] ${2}"
|
|
|
|
if [[ ${1} =~ ^(warn|error)$ ]]
|
|
then
|
|
echo -e "${MESSAGE}" >&2
|
|
else
|
|
echo -e "${MESSAGE}"
|
|
fi
|
|
}
|
|
|
|
function _log_with_date { _log "${1}" "$(date '+%Y-%m-%d %H:%M:%S') ${2}" ; }
|
|
|
|
# Still used by `check-for-changes.sh` for legacy / test purposes. Adjusting
|
|
# `check-for-changes.sh` must be done with great care and requires some effort.
|
|
# As a consequence, this function is kept to keep some of the original log for
|
|
# `check-for-changes.sh` for tests to pass.
|
|
function _notify
|
|
{
|
|
{ [[ -z ${1:-} ]] || [[ -z ${2:-} ]] ; } && return 0
|
|
|
|
local RESET LGREEN LYELLOW LRED RED LBLUE LGREY LMAGENTA
|
|
|
|
RESET='\e[0m' ; LGREEN='\e[92m' ; LYELLOW='\e[93m'
|
|
LRED='\e[31m' ; RED='\e[91m' ; LBLUE='\e[34m'
|
|
LGREY='\e[37m' ; LMAGENTA='\e[95m'
|
|
|
|
case "${1}" in
|
|
'tasklog' ) echo "-e${3:-}" "[ ${LGREEN}TASKLOG${RESET} ] ${2}" ;;
|
|
'warn' ) echo "-e${3:-}" "[ ${LYELLOW}WARNING${RESET} ] ${2}" ;;
|
|
'err' ) echo "-e${3:-}" "[ ${LRED}ERROR${RESET} ] ${2}" ;;
|
|
'fatal' ) echo "-e${3:-}" "[ ${RED}FATAL${RESET} ] ${2}" ;;
|
|
'inf' ) [[ ${DMS_DEBUG} -eq 1 ]] && echo "-e${3:-}" "[[ ${LBLUE}INF${RESET} ]] ${2}" ;;
|
|
'task' ) [[ ${DMS_DEBUG} -eq 1 ]] && echo "-e${3:-}" "[[ ${LGREY}TASKS${RESET} ]] ${2}" ;;
|
|
* ) echo "-e${3:-}" "[ ${LMAGENTA}UNKNOWN${RESET} ] ${2}" ;;
|
|
esac
|
|
|
|
return 0
|
|
}
|