From af335544496909b684bf85afca2ab527c3f648e6 Mon Sep 17 00:00:00 2001
From: Balazs Gibizer <gibi@redhat.com>
Date: Fri, 22 Nov 2024 11:30:48 +0100
Subject: [PATCH] [make][pre-commit]Check CRD schema to avoid update issues

The new crd-schema-check make target compares the CRD schema of the
patch with the schema on the tip of main and report errors on non
backward compatible changes.

This make target now also run in pre-commit both locally and in CI.

This make target uses https://github.com/openshift/crd-schema-checker
to do the actual checking.

Related: OSPRH-11833
---
 .pre-commit-config.yaml          |  6 ++++++
 Makefile                         |  5 +++++
 hack/build-crd-schema-checker.sh | 15 +++++++++++++++
 hack/crd-schema-checker.sh       | 21 +++++++++++++++++++++
 4 files changed, 47 insertions(+)
 create mode 100755 hack/build-crd-schema-checker.sh
 create mode 100755 hack/crd-schema-checker.sh

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 01b4ed01a..56ad6d089 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -25,6 +25,12 @@ repos:
       entry: make
       args: ['operator-lint']
       pass_filenames: false
+    - id: make-crd-schema-check
+      name: make-crd-schema-check
+      language: system
+      entry: make
+      args: ['crd-schema-check']
+      pass_filenames: false
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0
diff --git a/Makefile b/Makefile
index faf4fb948..427fdc11d 100644
--- a/Makefile
+++ b/Makefile
@@ -477,3 +477,8 @@ run-with-webhook: manifests generate fmt vet ## Run a controller from your host.
 .PHONY: webhook-cleanup
 webhook-cleanup:
 	/bin/bash hack/clean_local_webhook.sh
+
+PHONY: crd-schema-check
+crd-schema-check: manifests
+	INSTALL_DIR=$(LOCALBIN) CRD_SCHEMA_CHECKER_VERSION=release-4.16 hack/build-crd-schema-checker.sh
+	INSTALL_DIR=$(LOCALBIN) BRANCH=$(BRANCH) hack/crd-schema-checker.sh
diff --git a/hack/build-crd-schema-checker.sh b/hack/build-crd-schema-checker.sh
new file mode 100755
index 000000000..12bf3be9a
--- /dev/null
+++ b/hack/build-crd-schema-checker.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+set -euxo pipefail
+
+if [ -f "$INSTALL_DIR/crd-schema-checker" ]; then
+    exit 0
+fi
+
+mkdir -p "$INSTALL_DIR/git-tmp"
+git clone https://github.com/openshift/crd-schema-checker.git \
+    -b "$CRD_SCHEMA_CHECKER_VERSION" "$INSTALL_DIR/git-tmp"
+pushd "$INSTALL_DIR/git-tmp"
+GOWORK=off make
+cp crd-schema-checker "$INSTALL_DIR/"
+popd
+rm -rf "$INSTALL_DIR/git-tmp"
diff --git a/hack/crd-schema-checker.sh b/hack/crd-schema-checker.sh
new file mode 100755
index 000000000..284e688cc
--- /dev/null
+++ b/hack/crd-schema-checker.sh
@@ -0,0 +1,21 @@
+#!/bin/bash
+set -euxo pipefail
+
+CHECKER=$INSTALL_DIR/crd-schema-checker
+
+TMP_DIR=$(mktemp -d)
+
+function cleanup {
+    rm -rf "$TMP_DIR"
+}
+
+trap cleanup EXIT
+
+
+for crd in config/crd/bases/*.yaml; do
+    mkdir -p "$(dirname "$TMP_DIR/$crd")"
+    git show "origin/$BRANCH:$crd" > "$TMP_DIR/$crd"
+    $CHECKER check-manifests \
+        --existing-crd-filename="$TMP_DIR/$crd" \
+        --new-crd-filename="$crd"
+done