hack/check-links.sh: add 'ignore' check options (#4205)

hack/check-links.sh: ignore urls containing
github.com/operator-framework/operator-sdk/edit/master/

hack/*: move test_lib.sh functions into common.sh and
import common.sh where applicable

Author: Eric Stroczynski

hack/check-error-log-msg-format.sh

@@ -3,7 +3,7 @@
 set -o nounset
 set -o pipefail
 
-source "hack/lib/test_lib.sh"
+source "hack/lib/common.sh"
 
 echo "Checking format of error and log messages..."
 allfiles=$(listFiles|grep -v ./internal/bindata/...)

hack/check-license.sh

@@ -4,7 +4,7 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-source "hack/lib/test_lib.sh"
+source "hack/lib/common.sh"
 
 echo "Checking for license header..."
 allfiles=$(listFiles|grep -v ./internal/bindata/...)

hack/check-links.sh

@@ -4,8 +4,15 @@ set -e
 
 source ./hack/lib/common.sh
 
-header_text "Building the site and checking links"
+header_text "Building the website"
 docker volume create sdk-html
+trap_add "docker volume rm sdk-html" EXIT
 docker run --rm -v "$(pwd):/src" -v sdk-html:/src/website/public klakegg/hugo:0.73.0-ext-ubuntu -s website
-docker run --rm -v sdk-html:/target mtlynch/htmlproofer /target --empty-alt-ignore --http-status-ignore 429 --allow_hash_href
-docker volume rm sdk-html
+
+header_text "Checking links"
+# For config explanation: https://github.com/gjtorikian/html-proofer#special-cases-for-the-command-line
+docker run --rm -v sdk-html:/target klakegg/html-proofer:latest /target \
+  --empty-alt-ignore \
+  --http-status-ignore 429 \
+  --allow_hash_href \
+  --url-ignore "/github.com\/operator-framework\/operator-sdk\/edit\/master\//"

hack/lib/common.sh

@@ -24,3 +24,43 @@ function header_text {
 function error_text {
   echo "$error_color$*$reset_color"
 }
+
+#===================================================================
+# FUNCTION trap_add ()
+#
+# Purpose:  prepends a command to a trap
+#
+# - 1st arg:  code to add
+# - remaining args:  names of traps to modify
+#
+# Example:  trap_add 'echo "in trap DEBUG"' DEBUG
+#
+# See: http://stackoverflow.com/questions/3338030/multiple-bash-traps-for-the-same-signal
+#===================================================================
+function trap_add() {
+    trap_add_cmd=$1; shift || fatal "${FUNCNAME} usage error"
+    new_cmd=
+    for trap_add_name in "$@"; do
+        # Grab the currently defined trap commands for this trap
+        existing_cmd=`trap -p "${trap_add_name}" |  awk -F"'" '{print $2}'`
+
+        # Define default command
+        [ -z "${existing_cmd}" ] && existing_cmd="echo exiting @ `date`"
+
+        # Generate the new command
+        new_cmd="${trap_add_cmd};${existing_cmd}"
+
+        # Assign the test
+         trap   "${new_cmd}" "${trap_add_name}" || \
+                fatal "unable to add to trap ${trap_add_name}"
+    done
+}
+
+function listPkgDirs() {
+	go list -f '{{.Dir}}' ./cmd/... ./test/... ./internal/... | grep -v generated
+}
+
+function listFiles() {
+	# pipeline is much faster than for loop
+	listPkgDirs | xargs -I {} find {} -name '*.go' | grep -v generated
+}

hack/lib/test_lib.sh

@@ -1,7 +1,6 @@
 #!/usr/bin/env bash
 
 source hack/lib/common.sh
-source hack/lib/test_lib.sh
 source hack/lib/image_lib.sh
 
 set -eu

hack/tests/e2e-ansible-molecule.sh

@@ -3,7 +3,6 @@
 set -eu
 
 source hack/lib/common.sh
-source hack/lib/test_lib.sh
 source hack/lib/image_lib.sh
 
 TMPDIR="$(mktemp -d -p /tmp memcached-operator-XXXX)"