hack/verify-go-modules.sh: exit on dependency mismatch

On-behalf-of: SAP [email protected]
Signed-off-by: Robert Vasek <[email protected]>

Author: gman0

hack/verify-go-modules.sh

@@ -26,7 +26,22 @@ set -o pipefail
 
 REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)
 
-mapfile -t DIRS < <(find "${REPO_ROOT}" -name go.mod -print0 | xargs -0 dirname)
+# This is the list of directories that host the individual kcp go modules.
+#
+#   KEEP IT UP TO DATE and SORTED!
+#
+# The items must be sorted such that the module that is being dependent on
+# comes before the one that depends on it (i.e. topological order).
+DIRS=(
+  "${REPO_ROOT}/sdk"
+  "${REPO_ROOT}/cli"
+  "${REPO_ROOT}"
+  "${REPO_ROOT}/docs/generators/cli-doc"
+)
+
+# Check that DIRS is up to date.
+[[ "$(printf '%s\n' "${DIRS[@]}" | sort)" == "$(find "${REPO_ROOT}" -name go.mod -print0 | xargs -0 dirname | sort)" ]] \
+  || { echo "Error: DIRS list in ${BASH_SOURCE[0]} is out-of-date, and needs to be manually updated" 1>&2 ; exit 1 ; }
 
 # list_deps lists dependencies of the supplied go.mod file (dependencies
 # with version "v0.0.0" are skipped). The output is a json dictionary in the
@@ -75,22 +90,29 @@ function diff_version_deps {
   ' "${has_deps}" "${wants_deps}"
 }
 
-# print_diff_version_deps prints the output of diff_version_deps as a
-# human-readable multi-line text.
+# print_diff_version_deps prints the output of diff_version_deps (expected in stdin)
+# as a human-readable multi-line text.
+# Returns 1 if any lines were printed (i.e. errors were found).
 function print_diff_version_deps {
-  jq -r "to_entries | map(\"Warning: version mismatch: has \(.key)@\(.value.has), but \(.value.wants) expected\") | join(\"\\n\")"
+  jq -r '
+    to_entries
+      | map("Error: version mismatch: \(.key) is \(.value.has), but \(.value.wants) expected")
+      | join("\n")
+      | halt_error(1)
+    '
 }
 
 # Compares versions of dependencies in the supplied go.mod to
 # makes sure they are in line with the ones declared in
 # k8s.io/kubernetes module and prints the result.
-function compare_mod_versions {
+function compare_mod_versions_or_fail {
   gomod_file="${1}"
   echo "Verifying dependency versions in ${gomod_file} against ${k8s_gomod}"
   deps="$(list_deps ${gomod_file})"
 
   diff_version_deps <(echo "${deps}") <(echo "${k8s_deps}") \
-    | print_diff_version_deps "${gomod_file}"
+    | print_diff_version_deps "${gomod_file}" 1>&2 \
+    || { echo ; exit 1 ; }
 }
 
 function gomod_filepath_for {
@@ -111,9 +133,9 @@ for dir in "${DIRS[@]}"; do
       exit 1
     fi
 
-    compare_mod_versions "${dir}/go.mod"
+    compare_mod_versions_or_fail "${dir}/go.mod"
   )
 done
 
-compare_mod_versions "$(gomod_filepath_for github.com/kcp-dev/client-go)"
-compare_mod_versions "$(gomod_filepath_for github.com/kcp-dev/apimachinery/v2)"
+compare_mod_versions_or_fail "$(gomod_filepath_for github.com/kcp-dev/client-go)"
+compare_mod_versions_or_fail "$(gomod_filepath_for github.com/kcp-dev/apimachinery/v2)"