Merge pull request #317 from NearNodeFlash/compare-releases-fixes

Fix compare-releases.sh: proper diff error handling, add options to for displaying the diffs

Author: ajfloeder

tools/release-all/compare-releases.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright 2024 Hewlett Packard Enterprise Development LP
+# Copyright 2024-2026 Hewlett Packard Enterprise Development LP
 # Other additional copyright holders may be indicated within.
 #
 # The entirety of this work is licensed under the Apache License,
@@ -39,22 +39,32 @@ msg(){
 NNF_URL="git@github.com:NearNodeFlash/nnf-deploy.git"
 
 WORKSPACE="workingspace"
+DISPLAY_DIFF=false
+IMAGES_ONLY=false
 
 usage() {
     echo "Usage: $PROG [-h]"
-    echo "       $PROG [-w workspace_dir] [-u nnf_deploy_url] <VERSION1> <VERSION2>"
+    echo "       $PROG [-d] [-i] [-w workspace_dir] [-u nnf_deploy_url] <VERSION1> <VERSION2>"
     echo
     echo "  VERSION1          Starting version for comparison. This may be"
     echo "                    a tag such as 'v0.1.7'."
     echo "  VERSION2          Ending version for comparison. This may be"
     echo "                    a tag such as 'v0.1.8'."
+    echo "  -d                Display the full diff output."
+    echo "  -i                Display only image version changes."
     echo "  -w workspace_dir  Name for working directory. Default: '$WORKSPACE'"
     echo "  -u nnf_deploy_url URL to the nnf-deploy repo. Default: '$NNF_URL'"
     echo
 }
 
-while getopts "hw:u:" opt; do
+while getopts "dhiw:u:" opt; do
     case $opt in
+    d)
+        DISPLAY_DIFF=true
+        ;;
+    i)
+        IMAGES_ONLY=true
+        ;;
     u)
         NNF_URL="$OPTARG"
         ;;
@@ -106,7 +116,7 @@ prep_for_manifest() {
         rm -rf "$ver"
     fi
 
-    if ! gh release view "$ver" > /dev/null 2>&1; then
+    if ! gh release view -R "$NNF_URL" "$ver" > /dev/null 2>&1; then
         do_fail "Release $ver does not exist"
     fi
 }
@@ -116,10 +126,14 @@ fetch_and_unpack_manifest() {
     local vtar="$2"
 
     gh release download -R "$NNF_URL" -O "$vtar" -p manifests.tar "$ver" || do_fail "Unable to find manifests.tar for $ver"
+    [[ -s "$vtar" ]] || do_fail "Downloaded tarball $vtar is empty"
 
     mkdir "$ver" || do_fail "Cannot mkdir $ver"
     cd "$ver"
     tar xfo "../$vtar" || do_fail "Unable to extract tar $vtar"
+    local count
+    count=$(find . -type f | wc -l)
+    [[ $count -gt 0 ]] || do_fail "No files were extracted from $vtar"
     cd ..
 }
 
@@ -135,6 +149,32 @@ manifest "$ver1" "$v1tar"
 manifest "$ver2" "$v2tar"
 
 diff_file="manifest-$ver1-to-$ver2.diff"
-diff -uNr "$ver1" "$ver2" > "$diff_file" || echo
-msg "Manifest diffs for $ver1 to $ver2 are in $WORKSPACE/$diff_file"
+rc=0
+diff -uNr "$ver1" "$ver2" > "$diff_file" || rc=$?
+if [[ $rc -eq 0 ]]; then
+    msg "No differences found between $ver1 and $ver2"
+    rm -f "$diff_file"
+elif [[ $rc -eq 1 ]]; then
+    lines=$(wc -l < "$diff_file" | tr -d ' ')
+    changed_files=""
+    changed_files=$(diff -rq "$ver1" "$ver2") || true
+    changed=$(echo "$changed_files" | wc -l | tr -d ' ')
+    msg "Manifest diffs for $ver1 to $ver2 are in $WORKSPACE/$diff_file ($lines lines, $changed files changed)"
+    msg "Changed files:"
+    echo "$changed_files"
+
+    if [[ $IMAGES_ONLY == true ]]; then
+        msg ""
+        msg "Image version changes:"
+        grep -E '^[+-].*image:.*:' "$diff_file" | grep -v '^[+-][+-][+-]' || echo "  (no image changes found)"
+    fi
+
+    if [[ $DISPLAY_DIFF == true ]]; then
+        msg ""
+        msg "Full diff:"
+        cat "$diff_file"
+    fi
+else
+    do_fail "diff encountered an error (rc=$rc) comparing $ver1 and $ver2"
+fi