Add our logging library, and use it

Signed-off-by: Christopher Maier <[email protected]>

Author: christophermaier

hooks/environment

@@ -2,15 +2,17 @@
 
 set -euo pipefail
 
+# shellcheck source-path=SCRIPTDIR
+source "$(dirname "${BASH_SOURCE[0]}")/../lib/log.sh"
+
 readonly default_image="hashicorp/envconsul"
 readonly default_tag="latest"
 readonly image="${BUILDKITE_PLUGIN_VAULT_ENV_IMAGE:-${default_image}}:${BUILDKITE_PLUGIN_VAULT_ENV_TAG:-${default_tag}}"
 
 # Fail if there is no Vault token; gotta log in first
 ########################################################################
 if [ -z "${VAULT_TOKEN:-}" ]; then
-    echo "--- :skull_and_crossbones: Could not find 'VAULT_TOKEN' in the environment!"
-    exit 1
+    raise_error "Could not find 'VAULT_TOKEN' in the environment!"
 fi
 
 # Resolve Vault address
@@ -20,8 +22,7 @@ if [ -n "${BUILDKITE_PLUGIN_VAULT_ENV_ADDRESS:-}" ]; then
     export VAULT_ADDR
 fi
 if [ -z "${VAULT_ADDR:-}" ]; then
-    echo "--- :skull_and_crossbones: Could not find 'VAULT_ADDR' in the environment, and 'BUILDKITE_PLUGIN_VAULT_ENV_ADDRESS' was not specified!"
-    exit 1
+    raise_error "Could not find 'VAULT_ADDR' in the environment, and 'BUILDKITE_PLUGIN_VAULT_ENV_ADDRESS' was not specified!"
 fi
 
 # Resolve Vault namespace
@@ -31,8 +32,7 @@ if [ -n "${BUILDKITE_PLUGIN_VAULT_ENV_NAMESPACE:-}" ]; then
     export VAULT_NAMESPACE
 fi
 if [ -z "${VAULT_NAMESPACE:-}" ]; then
-    echo "--- :skull_and_crossbones: Could not find 'VAULT_NAMESPACE' in the environment, and 'BUILDKITE_PLUGIN_VAULT_ENV_NAMESPACE' was not specified!"
-    exit 1
+    raise_error "Could not find 'VAULT_NAMESPACE' in the environment, and 'BUILDKITE_PLUGIN_VAULT_ENV_NAMESPACE' was not specified!"
 fi
 
 # Resolve secret prefix
@@ -61,8 +61,7 @@ plugin_read_list_into_result() {
         local parameter="${prefix}_${i}"
 
         if [[ -n "${!prefix:-}" ]]; then
-            echo ":rotating_light: Plugin received a string for $prefix, expected an array" >&2
-            exit 1
+            raise_error "Plugin received a string for $prefix, expected an array"
         fi
 
         while [[ -n "${!parameter:-}" ]]; do
@@ -87,7 +86,7 @@ envconsul_env() {
 
     # Explicitly *not* using `--rm` so we can output the container
     # logs in case of a failure.
-    docker run \
+    log_and_run docker run \
         --env VAULT_TOKEN \
         --name="${container_name}" \
         -- \
@@ -105,23 +104,23 @@ envconsul_env() {
 }
 
 cleanup() {
-    docker container rm --force "${container_name}" > /dev/null 2>&1
+    log_and_run docker container rm --force "${container_name}" > /dev/null 2>&1
 }
 
 trap cleanup EXIT INT QUIT
 
-echo "--- :vault: Pulling secrets from Vault"
-echo "Using Docker image: ${image}"
-echo "VAULT_ADDR=${VAULT_ADDR}"
-echo "VAULT_NAMESPACE=${VAULT_NAMESPACE}"
+log "--- :vault: Pulling secrets from Vault"
+log "Using Docker image: ${image}"
+log "VAULT_ADDR=${VAULT_ADDR}"
+log "VAULT_NAMESPACE=${VAULT_NAMESPACE}"
 
 if vault_env=$(envconsul_env); then
     set -o allexport
     eval "${vault_env}"
     set +o allexport
 else
     retval=$?
-    echo "--- :skull_and_crossbones: Failed to retrieve secrets from Vault"
-    docker container logs "${container_name}"
+    log "--- :skull_and_crossbones: Failed to retrieve secrets from Vault"
+    log_and_run docker container logs "${container_name}"
     exit ${retval}
 fi

lib/BUILD

@@ -0,0 +1 @@
+shell_sources()

lib/log.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# Various logging functions and helpers to make logging nice.
+
+# ANSI Formatting Codes
+########################################################################
+# Because who wants to remember all those fiddly details?
+
+# CSI = "Control Sequence Introducer"
+CSI="\e["
+END=m
+
+NORMAL=0
+BOLD=1
+
+WHITE=37
+
+RESET="${CSI}${NORMAL}${END}"
+
+function _bold_color() {
+    color="${1}"
+    shift
+    echo "${CSI}${BOLD};${color}${END}${*}${RESET}"
+}
+
+function bright_white() {
+    _bold_color "${WHITE}" "${@}"
+}
+
+# Logging
+########################################################################
+# NOTE: All logs get sent to standard error
+
+function log() {
+    echo -e "${@}" >&2
+}
+
+# Handy for logging the exact command to be run, and then running it
+function log_and_run() {
+    log ❯❯ "$(bright_white "$(printf "%q " "${@}")")"
+    "$@"
+}
+
+raise_error() {
+    log "--- :rotating_light:" "${@}"
+    # Yes, these numbers are correct :/
+    if [ -z "${BASH_SOURCE[2]:-}" ]; then
+        # If we're calling raise_error from a script directly, we'll
+        # have a shorter call stack.
+        log "Failed in ${FUNCNAME[1]}() at [${BASH_SOURCE[1]}:${BASH_LINENO[0]}]"
+    else
+        log "Failed in ${FUNCNAME[1]}() at [${BASH_SOURCE[1]}:${BASH_LINENO[0]}], called from [${BASH_SOURCE[2]}:${BASH_LINENO[1]}]"
+    fi
+    exit 1
+}