scripts/bash-utils.sh - master - githubmirror/commcare-hq

scripts/bash-utils.sh
145 строк4 KB
Joel Miller
Improve logging and CI grouping logic for container tests
07 дек 2021, 18:42
07 дек 2021, 18:425e24985
# NOTE: do not write logging output to STDERR, this can interfere with GitHub
# workflow groupings.

GROUP='0;33'    # gold
SUCCESS='0;32'  # green
FAIL='0;31'     # red


function logmsg {
    # USAGE: logmsg [-n] LEVELNAME [MESSAGE ...]
    #
    # Write a log message to STDOUT.
    # LEVELNAME  log level name (for colorization). Resulting message will be
    #            colorized (if STDOUT is a TTY) for common level names.
    #        -n  Do not write a trailing newline (must be *very first* argument)
    local echo_args=( -e )
    if [ "x${1}" == "x-n" ]; then
        shift
        echo_args+=( -n )
    fi
    local script=$(basename "$0")
    local levelname="$1"
    shift
    local msg="$*"
    local ccode=''
    local reset=''
    if [ -t 1 ]; then
        # only define color codes when STDOUT is a tty
        local color='0' # default no color
        case "$levelname" in
            DEBUG)
                color='1;35' # magenta
                ;;
            INFO)
                color='1;32' # green
                ;;
            WARNING)
                color='0;33' # gold
                ;;
            ERROR)
                color='1;31' # red
                ;;
        esac
        ccode="\\033[${color}m"
        reset='\033[0m'
    fi
    echo "${echo_args[@]}" "[${script}] ${ccode}${levelname}${reset}: $msg"
}

function func_text {
    # USAGE: func_text FUNC_NAME [FUNC_NAME ...]
    #
    # Write the full definition of function(s) FUNC_NAME to stdout.
    local func_name
    for func_name in "$@"; do
        if ! type "$func_name" 2>&1 | grep -E " is a function$" >/dev/null; then
            logmsg ERROR "$func_name is not a function"
            return 1
        fi
        type "$func_name" | tail -n +2
        echo ''
    done
}

function truthy {
    # USAGE: truthy [false|true|no|yes|off|on|0|1]
    #
    # Return with a success or failure based on whether or not the provided
    # argument is "truthy".
    function _usage {
        logmsg ERROR "USAGE: truthy [false|true|no|yes|off|on|0|1]"
        logmsg ERROR "$*"
    }
    if [ $# -gt 1 ]; then
        _usage "too many arguments: $*"
        exit 1
    fi
    local value="$1"
    if [ -n "$value" ]; then
        if echo "$value" | grep -Ei '^(t(rue)?|y(es)?|on|1)$' >/dev/null; then
            return 0
        elif echo "$value" | grep -Ei '^(f(alse)?|n(o)?|off|0)$' >/dev/null; then
            return 1
        else
            _usage "invalid boolean string: '$value'"
            exit 1
        fi
    else
        # absent == false
        return 1
    fi
}


function log_group_begin {
    # Public function for starting a CI group.  Scripts may safely use this
    # without concern for "which CI tool" is used under the hood.
    local group_info="$*"
    _gh_workflow_group_begin "$group_info"
    _log_force_color "$GROUP" INFO "$group_info"
}


function log_group_end {
    # Public function for ending a CI group.  Scripts may safely use this
    # without concern for "which CI tool" is used under the hood.
    _gh_workflow_group_end
}


function log_success {
    _log_force_color "$SUCCESS" INFO "$@"
}


function log_fail {
    _log_force_color "$FAIL" ERROR "$@"
}


function _log_force_color {
    local ccode="$1"
    local levelname="$2"
    shift 2
    local prefix=$(logmsg "$levelname")
    local msg="$*"
    echo -e "${prefix}\\033[${ccode}m${msg}\\033[0m"
}


function _gh_workflow_group_begin {
    # use GitHub workflow grouping log lines
    # see: https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines
    local group_info="$*"
    if truthy "$GITHUB_ACTIONS"; then
        echo "::group::${group_info}"
    fi
}


function _gh_workflow_group_end {
    if truthy "$GITHUB_ACTIONS"; then
        echo "::endgroup::"
    fi
}