hack: improve validate-boskos.sh with better error handling - Add dynamic path resolution to find repo root - Add color-coded output for better readability in CI - Improve error handling for missing files and failed generation - Restore original file on failure to prevent workspace pollution - Add proper cleanup and backup mechanisms - Use function-based structure for better maintainability This makes the validation script more robust and user-friendly. (#69966)

Author: pgstorm148

hack/validate-boskos.sh

@@ -7,25 +7,93 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-base_dir=.
-
-cd "${base_dir}/core-services/prow/02_config"
-ORIGINAL="$(cat _boskos.yaml)"
-./generate-boskos.py
-DIFF="$(diff -u <(echo "${ORIGINAL}") _boskos.yaml || true)"
-if test -n "${DIFF}"
-then
-	cat << EOF
-ERROR: This check enforces that the Boskos configuration is generated
-ERROR: correctly. We have automation in place that updates the configuration and
-ERROR: new changes to the configuration should be followed with a re-generation.
-
-ERROR: Run the following command to re-generate the Boskos configuration:
-ERROR: $ make boskos-config
-
-ERROR: The following errors were found:
-
-EOF
-	echo "${DIFF}"
-	exit 1
-fi
+# Color codes for better output
+readonly RED='\033[0;31m'
+readonly GREEN='\033[0;32m'
+readonly YELLOW='\033[0;33m'
+readonly NC='\033[0m' # No Color
+
+# Function to print colored output
+print_error() {
+    echo -e "${RED}ERROR: $1${NC}" >&2
+}
+
+print_info() {
+    echo -e "${GREEN}INFO: $1${NC}"
+}
+
+print_warning() {
+    echo -e "${YELLOW}WARNING: $1${NC}"
+}
+
+# Get the root directory of the repository
+get_repo_root() {
+    local script_dir
+    script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+    echo "$(cd "${script_dir}/../.." && pwd)"
+}
+
+main() {
+    local repo_root
+    repo_root="$(get_repo_root)"
+    local config_dir="${repo_root}/core-services/prow/02_config"
+    local config_file="_boskos.yaml"
+    local generator_script="generate-boskos.py"
+
+    print_info "Validating Boskos configuration..."
+
+    # Check if required files exist
+    if [[ ! -d "${config_dir}" ]]; then
+        print_error "Configuration directory not found: ${config_dir}"
+        exit 1
+    fi
+
+    if [[ ! -f "${config_dir}/${generator_script}" ]]; then
+        print_error "Generator script not found: ${config_dir}/${generator_script}"
+        exit 1
+    fi
+
+    cd "${config_dir}"
+
+    # Create backup of original file for cleanup
+    local original_content
+    if [[ ! -f "${config_file}" ]]; then
+        print_error "Boskos configuration file not found: ${config_file}"
+        exit 1
+    fi
+    original_content="$(cat "${config_file}")"
+
+    # Generate new configuration
+    if ! python3 "./${generator_script}"; then
+        print_error "Failed to generate Boskos configuration"
+        # Restore original content if generation failed
+        echo "${original_content}" > "${config_file}"
+        exit 1
+    fi
+
+    # Compare with original
+    local diff_output
+    if diff_output="$(diff -u <(echo "${original_content}") "${config_file}" 2>/dev/null)"; then
+        print_info "Boskos configuration is up-to-date!"
+        exit 0
+    fi
+
+    # Configuration is out of date
+    print_error "Boskos configuration is out-of-date!"
+    echo
+    print_warning "This check enforces that the Boskos configuration is generated"
+    print_warning "correctly. We have automation in place that updates the configuration and"
+    print_warning "new changes to the configuration should be followed with a re-generation."
+    echo
+    print_info "Run the following command to re-generate the Boskos configuration:"
+    print_info "$ make boskos-config"
+    echo
+    print_info "The following changes are required:"
+    echo "${diff_output}"
+    
+    # Restore original file to avoid modifying the workspace
+    echo "${original_content}" > "${config_file}"
+    exit 1
+}
+
+main "$@"