fleet/ee/maintained-apps/script-diff.sh
Ian Littman 497401a75b
Add tool for diffing successive versions of install/uninstall scripts in FMA manifests (#31496)
Partly my elbow grease, partly Sonnet 4 via Zed, partly Sonnet 4 via
Jetbrains AI Chat; see individual 🤖 commits for prompts.

This gets us partway to #28189. Tested/confirmed with #31481. Internal
tool, hence no changes file.

# Checklist for submitter

- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)

## Testing

- [x] QA'd all new/changed functionality manually
2025-08-01 12:39:48 -05:00

116 lines
No EOL
3.4 KiB
Bash
Executable file

#!/bin/bash
set -e
# Check if file path is provided
if [ $# -ne 1 ]; then
echo "Usage: $0 <path_to_manifest>"
exit 1
fi
FILE_PATH="$1"
# Check if file exists
if [ ! -f "$FILE_PATH" ]; then
echo "Error: File '$FILE_PATH' does not exist"
exit 1
fi
# Check if we're in a git repository
if ! git rev-parse --git-dir > /dev/null 2>&1; then
echo "Error: Not in a git repository"
exit 1
fi
# Function to extract script content from refs
extract_script() {
local json_content="$1"
local ref_id="$2"
if [ -z "$ref_id" ] || [ "$ref_id" = "null" ]; then
echo ""
return
fi
echo "$json_content" | jq -r ".refs[\"$ref_id\"] // empty" 2>/dev/null || echo ""
}
# Get current and previous file content
CURRENT_CONTENT=$(cat "$FILE_PATH")
PREVIOUS_COMMIT=$(git log -n 1 --skip=1 --pretty=format:"%H" -- "$FILE_PATH")
PREVIOUS_CONTENT=$(git show "$PREVIOUS_COMMIT":"$FILE_PATH" 2>/dev/null || echo "")
if [ -z "$PREVIOUS_CONTENT" ]; then
echo "ERROR: Could not retrieve previous version of file (file may not exist in previous commit)"
exit 1
fi
# Extract script references from both versions
CURRENT_INSTALL_REF=$(echo "$CURRENT_CONTENT" | jq -r '.versions[0].install_script_ref // empty')
CURRENT_UNINSTALL_REF=$(echo "$CURRENT_CONTENT" | jq -r '.versions[0].uninstall_script_ref // empty')
PREVIOUS_INSTALL_REF=$(echo "$PREVIOUS_CONTENT" | jq -r '.versions[0].install_script_ref // empty')
PREVIOUS_UNINSTALL_REF=$(echo "$PREVIOUS_CONTENT" | jq -r '.versions[0].uninstall_script_ref // empty')
# Function to show script diff
show_script_diff() {
local script_type="$1"
local prev_ref="$2"
local curr_ref="$3"
local prev_content="$4"
local curr_content="$5"
if [ "$prev_ref" = "$curr_ref" ]; then
echo "=== $script_type Script (no changes) ==="
return
fi
echo "=== $script_type // $prev_ref -> $curr_ref ==="
echo ""
# Extract scripts
PREV_SCRIPT=$(extract_script "$prev_content" "$prev_ref")
CURR_SCRIPT=$(extract_script "$curr_content" "$curr_ref")
if [ -z "$PREV_SCRIPT" ] && [ -z "$CURR_SCRIPT" ]; then
echo "No scripts found for either version"
return
elif [ -z "$PREV_SCRIPT" ]; then
echo "Previous script not found, showing current script:"
echo "$CURR_SCRIPT"
return
elif [ -z "$CURR_SCRIPT" ]; then
echo "Current script not found, showing previous script:"
echo "$PREV_SCRIPT"
return
fi
# Create temporary files for diff
TEMP_PREV=$(mktemp -t old)
TEMP_CURR=$(mktemp -t new)
echo "$PREV_SCRIPT" > "$TEMP_PREV"
echo "$CURR_SCRIPT" > "$TEMP_CURR"
# Show unified diff
if diff -u "$TEMP_PREV" "$TEMP_CURR" > /dev/null 2>&1; then
echo "No differences found in script content"
else
diff -u "$TEMP_PREV" "$TEMP_CURR" || true
fi
# Clean up temp files
rm -f "$TEMP_PREV" "$TEMP_CURR"
echo ""
}
# Show install script diff
if [ -n "$CURRENT_INSTALL_REF" ] || [ -n "$PREVIOUS_INSTALL_REF" ]; then
show_script_diff "Install" "$PREVIOUS_INSTALL_REF" "$CURRENT_INSTALL_REF" "$PREVIOUS_CONTENT" "$CURRENT_CONTENT"
fi
# Show uninstall script diff
if [ -n "$CURRENT_UNINSTALL_REF" ] || [ -n "$PREVIOUS_UNINSTALL_REF" ]; then
show_script_diff "Uninstall" "$PREVIOUS_UNINSTALL_REF" "$CURRENT_UNINSTALL_REF" "$PREVIOUS_CONTENT" "$CURRENT_CONTENT"
fi