Use code-generator for clientset, informers, listers (kubeflow#2563)

* Use code-generator to for clientset, informer, lister

Signed-off-by: jbhalodia-slack <[email protected]>

* Add README in hack/ for code-generator

Signed-off-by: jbhalodia-slack <[email protected]>

* Run verify-codegen.sh in tests

Signed-off-by: jbhalodia-slack <[email protected]>

* make generate

Signed-off-by: jbhalodia-slack <[email protected]>

* make build-api-docs

Signed-off-by: jbhalodia-slack <[email protected]>

* update makefile

Signed-off-by: jbhalodia-slack <[email protected]>

* update makefile

Signed-off-by: jbhalodia-slack <[email protected]>

* make go-fmt

Signed-off-by: jbhalodia-slack <[email protected]>

* make generate

Signed-off-by: jbhalodia-slack <[email protected]>

* run tests

Signed-off-by: jbhalodia-slack <[email protected]>

* Remove deepcopy-gen since its conflicting with controller-gen

Signed-off-by: jbhalodia-slack <[email protected]>

* Revert some changes

Signed-off-by: jbhalodia-slack <[email protected]>

* Generate packages in pkg/client/

Signed-off-by: jbhalodia-slack <[email protected]>

* Update year to 2025 in boilerplate.go.txt

Signed-off-by: jbhalodia-slack <[email protected]>

* Update year to 2025 in types.go

Signed-off-by: jbhalodia-slack <[email protected]>

---------

Signed-off-by: jbhalodia-slack <[email protected]>

Author: jbhalodia-slack

.github/workflows/integration.yaml

@@ -47,6 +47,10 @@ jobs:
             false
           fi
 
+      - name: Verify Codegen
+        run: |
+          make verify-codegen
+
       - name: Run go fmt check
         run: |
           make go-fmt

Makefile

@@ -61,6 +61,7 @@ GEN_CRD_API_REFERENCE_DOCS_VERSION ?= v0.3.0
 HELM_VERSION ?= v3.15.3
 HELM_UNITTEST_VERSION ?= 0.5.1
 HELM_DOCS_VERSION ?= v1.14.2
+CODE_GENERATOR_VERSION ?= v0.33.1
 
 ## Binaries
 SPARK_OPERATOR ?= $(LOCALBIN)/spark-operator
@@ -118,6 +119,14 @@ generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and
 update-crd: manifests ## Update CRD files in the Helm chart.
 	cp config/crd/bases/* charts/spark-operator-chart/crds/
 
+.PHONY: verify-codegen
+verify-codegen: $(LOCALBIN) ## Install code-generator commands and verify changes
+	$(call go-install-tool,$(LOCALBIN)/register-gen-$(CODE_GENERATOR_VERSION),k8s.io/code-generator/cmd/register-gen,$(CODE_GENERATOR_VERSION))
+	$(call go-install-tool,$(LOCALBIN)/client-gen-$(CODE_GENERATOR_VERSION),k8s.io/code-generator/cmd/client-gen,$(CODE_GENERATOR_VERSION))
+	$(call go-install-tool,$(LOCALBIN)/lister-gen-$(CODE_GENERATOR_VERSION),k8s.io/code-generator/cmd/lister-gen,$(CODE_GENERATOR_VERSION))
+	$(call go-install-tool,$(LOCALBIN)/informer-gen-$(CODE_GENERATOR_VERSION),k8s.io/code-generator/cmd/informer-gen,$(CODE_GENERATOR_VERSION))
+	./hack/verify-codegen.sh
+
 .PHONY: go-clean
 go-clean: ## Clean up caches and output.
 	@echo "cleaning up caches and output"

api/v1beta2/scheduledsparkapplication_types.go

@@ -91,6 +91,8 @@ type ScheduledSparkApplicationStatus struct {
 // +kubebuilder:printcolumn:JSONPath=.status.lastRun,name=Last Run,type=date
 // +kubebuilder:printcolumn:JSONPath=.status.lastRunName,name=Last Run Name,type=string
 // +kubebuilder:printcolumn:JSONPath=.metadata.creationTimestamp,name=Age,type=date
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +genclient
 
 // ScheduledSparkApplication is the Schema for the scheduledsparkapplications API.
 type ScheduledSparkApplication struct {
@@ -102,6 +104,7 @@ type ScheduledSparkApplication struct {
 }
 
 // +kubebuilder:object:root=true
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // ScheduledSparkApplicationList contains a list of ScheduledSparkApplication.
 type ScheduledSparkApplicationList struct {

api/v1beta2/sparkapplication_types.go

@@ -182,6 +182,8 @@ type SparkApplicationStatus struct {
 // +kubebuilder:printcolumn:JSONPath=.status.lastSubmissionAttemptTime,name=Start,type=string
 // +kubebuilder:printcolumn:JSONPath=.status.terminationTime,name=Finish,type=string
 // +kubebuilder:printcolumn:JSONPath=.metadata.creationTimestamp,name=Age,type=date
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +genclient
 
 // SparkApplication is the Schema for the sparkapplications API
 type SparkApplication struct {
@@ -193,6 +195,7 @@ type SparkApplication struct {
 }
 
 // +kubebuilder:object:root=true
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // SparkApplicationList contains a list of SparkApplication
 type SparkApplicationList struct {

api/v1beta2/types.go

@@ -0,0 +1,23 @@
+/*
+Copyright 2025 The Kubeflow authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/*
+This file is needed for kubernetes/code-generator/kube_codegen.sh script used in hack/update-codegen.sh.
+*/
+
+package v1beta2
+
+//+genclient