Add consistency check for deepcopy generated files (#1127)

Add consistency check for deepcopy generated files

.github/workflows/consistency-check.yaml

@@ -30,6 +30,10 @@ jobs:
       - name: Verify Codegen
         working-directory: ./ray-operator
         run: ./hack/verify-codegen.sh
+
+      - name: Verify Generated Files
+        working-directory: ./ray-operator
+        run: ./hack/verify-generated-files.sh
   # 1. Check consistency between types.go and CRD YAML files.
   # 2. Check consistency between kubebuilder markers and RBAC.
   ray-operator-verify-crd-rbac:

.github/workflows/test-job.yaml

@@ -81,13 +81,13 @@ jobs:
         skip-pkg-cache: true
 
     - name: Run goimports
-      run: test -z "$(set -o pipefail && $(go env GOPATH)/bin/goimports -l apiserver/ ray-operator/ cli/ | tee goimports.out)" || { cat goimports.out && exit 1; }
+      run: test -z "$(set -o pipefail && $(go env GOPATH)/bin/goimports -l apiserver/ cli/ $(find ./ray-operator -name "*.go" | grep -v zz_generated.deepcopy.go) | tee goimports.out)" || { cat goimports.out && exit 1; }
 
     - name: Open this to see how to fix goimports if it fails
       run: |
-        echo "Run command 'goimports -w apiserver/ ray-operator/ cli/' to correct your code format."
+        echo "Run command 'goimports -w apiserver/ cli/ $(find ./ray-operator -name "*.go" | grep -v zz_generated.deepcopy.go)' to correct your code format."
         echo "Proposed format changes:"
-        $(go env GOPATH)/bin/goimports -d apiserver/ ray-operator/ cli/
+        $(go env GOPATH)/bin/goimports -d apiserver/ cli/ $(find ./ray-operator -name "*.go" | grep -v zz_generated.deepcopy.go)
       if: failure()
 
     - name: Run gofumpt

ray-operator/hack/verify-generated-files.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+SCRIPT_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+
+DIFFROOT="${SCRIPT_ROOT}/apis"
+TMP_DIFFROOT="${SCRIPT_ROOT}/_tmp/apis"
+_tmp="${SCRIPT_ROOT}/_tmp"
+
+cleanup() {
+  rm -rf "${_tmp}"
+}
+trap "cleanup" EXIT SIGINT
+
+cleanup
+
+mkdir -p "${TMP_DIFFROOT}"
+cp -a "${DIFFROOT}"/* "${TMP_DIFFROOT}"
+
+make generate
+echo "diffing ${DIFFROOT} against freshly generated deepcopy files"
+ret=0
+diff -Naupr "${DIFFROOT}" "${TMP_DIFFROOT}" || ret=$?
+if [[ $ret -eq 0 ]]
+then
+  echo "${DIFFROOT} up to date."
+else
+  echo "${DIFFROOT} is out of date. Please run make generate"
+  exit 1
+fi