mig1984 / bashible Goto Github PK

# Usage:
#   wait_file_present [-t TIMEOUT] [-i INTERVAL] FILE
# Parameters:
# -t: timeout in second (default: 60)
# -i: interval in second (default: 1)
# Example:
#   wait_file_present -t 10 -i 2 /tmp/file.txt
function wait_file_present() {
    local FILE TIMEOUT TIMEOUT_ORIGIN INTERVAL
    TIMEOUT=60
    INTERVAL=1
    local OPTIND arg
    while getopts ":t:i:" arg; do
        case $arg in
        t) TIMEOUT="${OPTARG}";;
        i) INTERVAL="${OPTARG}";;
        :) printlnError "Invalid option: $OPTARG requires an argument"; return 1;;
        ?) printlnError "Unkownn option: $OPTARG" ; return 1;;
        esac
    done
    shift $((OPTIND -1))

    FILE="${1?File not defined}"

    TIMEOUT_ORIGIN="${TIMEOUT}"
    until [ -f "${FILE}" ] > /dev/null 2>&1 && SUCCESS=1 || [ "$TIMEOUT" -le 0 ]; do 
        sleep "${INTERVAL}"
        TIMEOUT=$((TIMEOUT-INTERVAL))
    done
    if [ "${SUCCESS}" != "1" ]; then
        echo "Error: File \"${FILE}\" does not exists after ${TIMEOUT_ORIGIN}s"; 
        return 1; 
    fi
}


# Usage:
#   wait_tcp_port_open [-t TIMEOUT] [-i INTERVAL] HOST PORT
# Parameters:
# -t: timeout in second (default: 60)
# -i: interval in second (default: 1)
# Example:
#   wait_tcp_port_open -t 10 -i 2 localhost 8080
function wait_tcp_port_open() {
    local HOST PORT TIMEOUT TIMEOUT_ORIGIN INTERVAL
    TIMEOUT=60
    INTERVAL=1
    local OPTIND arg
    while getopts ":t:i:" arg; do
        case $arg in
        t) TIMEOUT="${OPTARG}";;
        i) INTERVAL="${OPTARG}";;
        :) printlnError "Invalid option: $OPTARG requires an argument"; return 1;;
        ?) printlnError "Unkownn option: $OPTARG" ; return 1;;
        esac
    done
    shift $((OPTIND -1))

    HOST="${1?Host not defined}"
    PORT="${2?Port not defined}"

    TIMEOUT_ORIGIN="${TIMEOUT}"
    SUCCESS=0
    until nc -zvw3 "${HOST}" "${PORT}" > /dev/null 2>&1 && SUCCESS=1 || [ "$TIMEOUT" -le 0 ]; do 
        sleep "${INTERVAL}"
        TIMEOUT=$((TIMEOUT-INTERVAL))
    done
    if [ "${SUCCESS}" != "1" ]; then
        echo "Error: Port \"${HOST}\" \"${PORT}\" is not open after ${TIMEOUT_ORIGIN}s"; 
        echo "Debug: Command: nc -zvw3 \"${HOST}\" \"${PORT}\")" 
        return 1; 
    fi
}


# Usage:
#   curl_status [-c EXPECTED_HTTP_CODE] [-- [CURL_ARGS]...] URL
# Parameters:
# -c: comma separated list of expected HTTP CODE (default: 200)
# -v: verbose (warning: this could print password)
# --: special option to delimit end of wait_curl_status parameters. All options behind are curl options (see example below)
# Example:
#   curl_status https://postman-echo.com/status/200
#   curl_status -c 204 https://postman-echo.com/status/204
#   curl_status -c 204 -- -X GET -H "host: local.com" https://postman-echo.com/status/204
#   curl_status -c 500,000 -- -X GET -H "host: local.com" https://postman-echo.com/status/500
function curl_status() {
    local EXPECTED_HTTP_CODE CURL_STATUS CURL_TIMEOUT VERBOSE=false
    EXPECTED_HTTP_CODE=200
    CURL_TIMEOUT=5

    local OPTIND arg
    while getopts ":c:v" arg; do
        case $arg in
        c) EXPECTED_HTTP_CODE="${OPTARG}";;
        v) VERBOSE=true;;
        :) printlnError "Invalid option: $OPTARG requires an argument"; return 1;;
        ?) printlnError "Unkownn option: $OPTARG" ; return 1;;
        esac
    done
    shift $((OPTIND -1))
    
    EXPECTED_HTTP_CODE_PATTERN=",${EXPECTED_HTTP_CODE},"
    CURL_STATUS=$(curl -sS -o /dev/null -w "%{http_code}" --connect-timeout "${CURL_TIMEOUT}" --max-time "${CURL_TIMEOUT}" "$@" 2>/dev/null)
    if [[ "${EXPECTED_HTTP_CODE_PATTERN}" != *",${CURL_STATUS},"* ]]; then
        echo "Error: Curl returned non expected status code ${CURL_STATUS} (expected status: ${EXPECTED_HTTP_CODE})"; 
        $VERBOSE && echo "Debug: Curl command: curl -s -o /dev/null -w %{http_code} --connect-timeout ${CURL_TIMEOUT} --max-time ${CURL_TIMEOUT} $(_echo_args "$@")" 
        return 1; 
    fi
}

# Usage:
#   wait_curl_status [-c EXPECTED_HTTP_CODE] [-t TIMEOUT] [-i INTERVAL] [-- [CURL_ARGS]...] URL
# Parameters:
# -c: comma separated list of expected HTTP CODE (default: 200)
# -t: timeout in second (default: 60)
# -i: interval in second (default: 1)
# -v: verbose (warning: this could print password)
# --: special option to delimit end of wait_curl_status parameters. All options behind are curl options (see example below)
# Example:
#   wait_curl_status https://postman-echo.com/status/200
#   wait_curl_status -c 204 -t 10 -i 2 https://postman-echo.com/status/204
#   wait_curl_status -c 204 -t 10 -i 2 -- -X GET -H "host: local.com" https://postman-echo.com/status/204
#   wait_curl_status -c 500,000 -t 10 -i 2 -- -X GET -H "host: local.com" https://postman-echo.com/status/500
function wait_curl_status() {
    local EXPECTED_HTTP_CODE TIMEOUT TIMEOUT_ORIGIN INTERVAL CURL_STATUS CURL_TIMEOUT VERBOSE=false
    EXPECTED_HTTP_CODE="200"
    CURL_TIMEOUT=5
    TIMEOUT=60
    INTERVAL=1
    local OPTIND arg
    while getopts ":c:t:i:v" arg; do
        case $arg in
        c) EXPECTED_HTTP_CODE="${OPTARG}";;
        t) TIMEOUT="${OPTARG}";;
        i) INTERVAL="${OPTARG}";;
        v) VERBOSE=true;;
        :) printlnError "Invalid option: $OPTARG requires an argument"; return 1;;
        ?) printlnError "Unkownn option: $OPTARG" ; return 1;;
        esac
    done
    shift $((OPTIND -1))
    EXPECTED_HTTP_CODE_PATTERN=",${EXPECTED_HTTP_CODE},"
    TIMEOUT_ORIGIN="${TIMEOUT}"
    until CURL_STATUS=$(curl -sS -o /dev/null -w "%{http_code}" --connect-timeout "${CURL_TIMEOUT}" --max-time "${CURL_TIMEOUT}" "$@" 2>/dev/null || true) && [[ "${EXPECTED_HTTP_CODE_PATTERN}" == *",${CURL_STATUS},"* ]] || [ "$TIMEOUT" -le 0 ]; do 
        sleep "${INTERVAL}"
        TIMEOUT=$((TIMEOUT-INTERVAL))
    done
    if [[ "${EXPECTED_HTTP_CODE_PATTERN}" != *",${CURL_STATUS},"* ]]; then
        echo "Error: Curl returned non expected status code ${CURL_STATUS} after ${TIMEOUT_ORIGIN}s (expected status: ${EXPECTED_HTTP_CODE})"; 
        $VERBOSE && echo "Debug: Curl command: curl -s -o /dev/null -w %{http_code} --connect-timeout ${CURL_TIMEOUT} --max-time ${CURL_TIMEOUT} $(_echo_args "$@")" 
        return 1; 
    fi
}


# Helper function to print args "$@" preserving the quote
# Usage:
#  _echo_args "first args" "second args"
#  echo "ls $(_echo_args "first args" "second args")"
#  # in a function (which is the main purpose)
#  echo "ls $(_echo_args "$@")"
function _echo_args () {
    local ARG ARGS=""
    for ARG in "${@}" ; do
        # add quote only if $ARG contains a space
        if [[ "$ARG" != "${ARG%[[:space:]]*}" ]]; then
            ARG="\"$ARG\""
        fi
        if [ -z "$ARGS" ]; then
            ARGS="$ARG"
        else
            ARGS="$ARGS $ARG"
        fi
    done
    echo "$ARGS"
}

shopt -s inherit_errexit 2>/dev/null || true