Fix invalid yq option causing hive development config generation failure

It seems that -y is no longer accepted by yq.

Cleaned up scripts by moving some functions into hack/util.sh
Fixed sourcing path

Remove unnecessary variable name references
    * A name ref for the image variable caused an interesting problem when running yq as a container. yq image assignment was attempting to overwrite hive_image. Passing the variable as a value mitigated this.

Author: s-fairchild

hack/hive/hive-generate-config.sh

@@ -25,10 +25,10 @@ main() {
                       kustomize_bin
     hive_repo_clone tmpdir
     hive_repo_hash_checkout tmpdir \
-                            hive_image_commit_hash
+                            "$hive_image_commit_hash"
     generate_hive_config kustomize_bin \
-                         hive_operator_namespace \
-                         hive_image \
+                         "$hive_operator_namespace" \
+                         "$hive_image" \
                          tmpdir
 
     log "Hive config generated."
@@ -81,7 +81,7 @@ hive_repo_clone() {
 
 hive_repo_hash_checkout() {
     local -n tmpd="$1"
-    local -n commit="$2"
+    local commit="$2"
     log "starting"
     log "Attempting to use commit: $commit"
 
@@ -94,10 +94,11 @@ hive_repo_hash_checkout() {
     popd 1> /dev/null
 }
 
+# generate_hive_config()
 generate_hive_config() {
     local -n kustomize="$1"
-    local -n namespace="$2"
-    local -n image="$3"
+    local namespace="$2"
+    local image="$3"
     local -n tmpd="$4"
     log "starting"
 
@@ -117,28 +118,17 @@ generate_hive_config() {
     mv "$tmpd/hive-deployment.yaml" ./hack/hive/hive-config/
 
     # ensure the hive deployment uses the pull secret
-    yq -yi 'select(.kind == "ServiceAccount").imagePullSecrets = [{"name": "hive-global-pull-secret"}]' ./hack/hive/hive-config/hive-deployment.yaml
+    yq -i 'select(.kind == "ServiceAccount").imagePullSecrets = [{"name": "hive-global-pull-secret"}]' ./hack/hive/hive-config/hive-deployment.yaml
 
     if [ -d ./hack/hive/hive-config/crds ]; then
         rm -rf ./hack/hive/hive-config/crds
     fi
     cp -R "$tmpd/config/crds" ./hack/hive/hive-config/
 }
 
-if [ ! -f go.mod ] || [ ! -d ".git" ]; then
-    echo "this script must by run from the repo's root directory"
-    exit 1
-fi
-
-declare -r util_script="hack/util.sh"
-if [ -f $util_script ]; then
-    # shellcheck source=util.sh
-    source "$util_script"
-fi
-
-cleanup() {
-    local tmpd="$1"
-    [ -d "$tmpd" ] && rm -fr "$tmpd"
-}
+declare -r util_lib="hack/util.sh"
+[ -f "$util_lib" ] || "$(echo "$util_lib not found. Are you in the ARO-RP repository root?"; exit 1)"
+# shellcheck source=../util.sh
+. "$util_lib"
 
 main "$@"

hack/util.sh

@@ -1,23 +1,46 @@
-#!/bin/bash
+# shellcheck shell=bash
 
-if [ "${DEBUG:-false}" == true ]; then
-    set -x
-fi
+# declare -r __hack_util_sourced="true"
+declare -r __hack_util_sourced="true"
 
+[ "${DEBUG:-false}" == true ] && set -x
+
+# log()
 # log is a wrapper for echo that includes the function name
-# Args
-# 1) msg - string
-# 2) stack_level - int; optional, defaults to calling function
+#
+# args:
+#   * 1) msg - string
+#   * 2) stack_level - int; optional, defaults to calling function
 log() {
     local -r msg="${1:-"log message is empty"}"
     local -r stack_level="${2:-1}"
+
     echo "${FUNCNAME[${stack_level}]}: ${msg}"
 }
 
-# abort is a wrapper for log that exits with an error code
+# abort is a wrapper for log followed by exit code 1
+#
+# args:
+#   * 1) message - string; error message passed to log
 abort() {
     local -ri origin_stacklevel=2
+
     log "${1}" "$origin_stacklevel"
     log "Exiting"
     exit 1
-}
+}
+
+# cleanup() {
+# Deletes all files and directories provided.
+#
+# args:
+#   * @) tmp - array; files and/or directories to be deleted
+cleanup() {
+    # shellcheck disable=SC2068
+    for tmp in $@; do
+        if [[ -d "$tmp" || -f "$tmp" ]]; then
+            log "Deleting $tmp"
+            rm -fr "$tmp"
+        fi
+    done
+}