Add consistency check for deepcopy generated files

[varungup90]

Why are these changes needed?

Checks consistency for deepcopy generated files

Related issue number

Closes #1111

Checks

• I've made sure the tests are passing.
• Testing Strategy
  • Unit tests
  • Manual tests
  • This PR is not tested :(

[kevin85421]

cc @Yicheng-Lu-llll would you mind reviewing this PR?

[Yicheng-Lu-llll]

LGTM!

Also manually test it:

git clone https://github.com/varungup90/kuberay.git
cd kuberay
git checkout add-generated-files-check
cd ray-operator/


# do nothing to zz_generated.deepcopy.go
./hack/verify-generated-files.sh

#root@ip-172-31-8-217:/home/ubuntu/workspace/review/kuberay/ray-operator# ./hack/verify-generated-files.sh
#/home/ubuntu/workspace/review/kuberay/ray-operator/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" #paths="./..."
#diffing ./hack/../apis against freshly generated deepcopy files
#./hack/../apis up to date.


# manually change something to zz_generated.deepcopy.go
./hack/verify-generated-files.sh

#root@ip-172-31-8-217:/home/ubuntu/workspace/review/kuberay/ray-operator# ./hack/verify-generated-files.sh
#/home/ubuntu/workspace/review/kuberay/ray-operator/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" #paths="./..."
#diffing ./hack/../apis against freshly generated deepcopy files
#diff -Naupr ./hack/../apis/ray/v1alpha1/zz_generated.deepcopy.go #./hack/../_tmp/apis/ray/v1alpha1/zz_generated.deepcopy.go
#--- ./hack/../apis/ray/v1alpha1/zz_generated.deepcopy.go        2023-06-01 15:04:41.326004561 +0000
#+++ ./hack/../_tmp/apis/ray/v1alpha1/zz_generated.deepcopy.go   2023-06-01 15:04:37.166101782 +0000
#@@ -6,7 +6,7 @@
# package v1alpha1
 
# import (
#-       "k8s.io/api/core/v1"
#+       v1 "k8s.io/api/core/v1"
#        runtime "k8s.io/apimachinery/pkg/runtime"
# )
 
#./hack/../apis is out of date. Please run make generate

[Yicheng-Lu-llll]

Just a nit-picky comment, we can have a better name here.

-Verify Generated Files: showing it is used to verify the aforementioned runtime.Object interface generated by kubebuilder.

-Verify Codegen: showing it is used to verify things like clientset, lister, informer.

[varungup90]

I got the idea from Kubernetes repo (https://github.com/kubernetes/kubernetes/blob/v1.22.1/hack/verify-generated-files.sh). Please suggest better alternatives.

[kevin85421]

There seems to be a conflict between "Verify Generated Files" and "Go-build-and-test / Lint (pull_request)". The linter expects v1 "k8s.io/api/core/v1" in zz_generated.deepcopy.go, but the "Verify Generated Files" step expects "k8s.io/api/core/v1". Perhaps we need to fix the linter to align with the expected format.

[varungup90]

There seems to be a conflict between "Verify Generated Files" and "Go-build-and-test / Lint (pull_request)". The linter expects v1 "k8s.io/api/core/v1" in zz_generated.deepcopy.go, but the "Verify Generated Files" step expects "k8s.io/api/core/v1". Perhaps we need to fix the linter to align with the expected format.

Updated test-job.yaml file where goimports ignores zz_generated.deepcopy.go file. Verified it locally using github action act -W .github/workflows/test-job.yaml.

[kevin85421]

LGTM.

To summarize this PR,

• Because the generated file zz_generated.deepcopy.go does not adhere to the goimport rule (as mentioned in this issue: api/v1alpha1/zz_generated.deepcopy.go is not compliant with goimport format kubernetes-sigs/controller-tools#559), we have made the decision to exclude the goimport check for the zz_generated.deepcopy.go file.

• Excluding the goimport check for the zz_generated.deepcopy.go file is fine because this PR will check the consistency for the generated files.