Merge pull request #533 from z103cb/z103cb-issue514

Generate MCAD clients using clientgen tools

Author: openshift-merge-robot

.gitignore

@@ -20,6 +20,7 @@
 /output*/
 /_output*/
 /_output
+bin
 
 # Emacs save files
 *~

Makefile

@@ -13,9 +13,14 @@ $(LOCALBIN):
 
 ## Tool Versions
 CONTROLLER_TOOLS_VERSION ?= v0.9.2
+CODEGEN_VERSION ?= v0.20.15
 
 ## Tool Binaries
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
+APPLYCONFIGURATION_GEN ?= $(LOCALBIN)/applyconfiguration-gen
+CLIENT_GEN ?= $(LOCALBIN)/client-gen
+LISTER_GEN ?= $(LOCALBIN)/lister-gen
+INFORMER_GEN ?= $(LOCALBIN)/informer-gen
 
 # Reset branch name if this a Travis CI environment
 ifneq ($(strip $(TRAVIS_BRANCH)),)
@@ -70,12 +75,81 @@ init:
 verify-tag-name: print-global-variables
 # Check for invalid tag name
 t=${TAG} && [ $${#t} -le 128 ] || { echo "Target name $$t has 128 or more chars"; false; }
+.PHONY: generate-client ## Generate client packages
+generate-client: code-generator
+rm -rf pkg/client/clientset/versioned pkg/client/informers/externalversions pkg/client/listers/controller/v1beta1 pkg/client/listers/quotasubtree/v1
+# TODO: add this back when the version of the tool has been updated and supports this executable
+#$(APPLYCONFIGURATION_GEN) \
+#	--input-dirs="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/controller/v1beta1" \
+#	--go-header-file="hack/boilerplate/boilerplate.go.txt" \
+#	--output-package="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/applyconfiguration" \
+#	--trim-path-prefix "github.com/project-codeflare/multi-cluster-app-dispatcher"
+$(CLIENT_GEN) \
+	--input="pkg/apis/controller/v1beta1" \
+	--input="pkg/apis/quotaplugins/quotasubtree/v1" \
+	--input-base="github.com/project-codeflare/multi-cluster-app-dispatcher" \
+	--go-header-file="hack/boilerplate/boilerplate.go.txt" \
+	--clientset-name "versioned" \
+	--output-package="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/clientset" \
+	--output-base="." 
+# TODO: add the following line back once the tool has been upgraded
+#	--trim-path-prefix "github.com/project-codeflare/multi-cluster-app-dispatcher"
+$(LISTER_GEN) \
+	--input-dirs="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/controller/v1beta1" \
+	--input-dirs="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/quotaplugins/quotasubtree/v1" \
+	--go-header-file="hack/boilerplate/boilerplate.go.txt" \
+	--output-base="." \
+	--output-package="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/listers" 
+# TODO: add the following line back once the tool has been upgraded
+#	--trim-path-prefix "github.com/project-codeflare/multi-cluster-app-dispatcher"
+$(INFORMER_GEN) \
+	--input-dirs="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/controller/v1beta1" \
+	--input-dirs="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/quotaplugins/quotasubtree/v1" \
+	--versioned-clientset-package="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/clientset/versioned" \
+	--listers-package="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/listers" \
+	--go-header-file="hack/boilerplate/boilerplate.go.txt" \
+	--output-base="." \
+	--output-package="github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/informers" 
+# TODO: add the following line back once the tool has been upgraded
+#	--trim-path-prefix "github.com/project-codeflare/multi-cluster-app-dispatcher"
+# TODO: remove the following lines once the tool has been upgraded and they are no longer needed.
+# The `mv` and `rm` are necessary as the generators write to the gihub.com/... path.
+mv -f github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/clientset/versioned pkg/client/clientset/versioned
+mv -f github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/informers/externalversions pkg/client/informers/externalversions
+mv -f github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/listers/controller/v1beta1 pkg/client/listers/controller/v1beta1
+mv -f github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/client/listers/quotasubtree/v1 pkg/client/listers/quotasubtree/v1 
+rm -rf github.com
 
 .PHONY: controller-gen
 controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
 $(CONTROLLER_GEN): $(LOCALBIN)
 test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
 
+.PHONY: code-generator
+#TODO: add $(APPLYCONFIGURATION_GEN) as a dependency when the tool is supported
+code-generator: $(CLIENT_GEN) $(LISTER_GEN) $(INFORMER_GEN) $(CONTROLLER_GEN)
+
+# TODO: enable this target once the tools is supported
+#.PHONY: applyconfiguration-gen
+#applyconfiguration-gen: $(APPLYCONFIGURATION_GEN) 
+#$(APPLYCONFIGURATION_GEN): $(LOCALBIN)
+#test -s $(LOCALBIN)/applyconfiguration-gen || GOBIN=$(LOCALBIN) go install k8s.io/code-generator/cmd/applyconfiguration-gen@$(CODEGEN_VERSION)
+
+.PHONY: client-gen
+client-gen: $(CLIENT_GEN)
+$(CLIENT_GEN): $(LOCALBIN)
+test -s $(LOCALBIN)/client-gen || GOBIN=$(LOCALBIN) go install k8s.io/code-generator/cmd/client-gen@$(CODEGEN_VERSION)
+
+.PHONY: lister-gen
+lister-gen: $(LISTER_GEN)
+$(LISTER_GEN): $(LOCALBIN)
+test -s $(LOCALBIN)/lister-gen || GOBIN=$(LOCALBIN) go install k8s.io/code-generator/cmd/lister-gen@$(CODEGEN_VERSION)
+
+.PHONY: informer-gen
+informer-gen: $(INFORMER_GEN)
+$(INFORMER_GEN): $(LOCALBIN)
+test -s $(LOCALBIN)/informer-gen || GOBIN=$(LOCALBIN) go install k8s.io/code-generator/cmd/informer-gen@$(CODEGEN_VERSION)
+
 .PHONY: manifests
 manifests: controller-gen ## Generate CustomResourceDefinition objects.
 $(CONTROLLER_GEN) crd:allowDangerousTypes=true paths="./pkg/apis/..." output:crd:artifacts:config=config/crd/bases

hack/boilerplate/boilerplate.go.txt

@@ -1,19 +1,4 @@
 /*
-Copyright YEAR The Kubernetes 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
-
- http://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.
-*/
-/*
 Copyright 2019, 2021, 2022, YEAR The Multi-Cluster App Dispatcher Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");

pkg/apis/controller/v1beta1/appwrapper.go

@@ -28,6 +28,7 @@ const AppWrapperPlural string = "appwrappers"
 // which AppWrapper it belongs to.
 const AppWrapperAnnotationKey = "appwrapper.mcad.ibm.com/appwrapper-name"
 
+// +genclient
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

pkg/client/clientset/controller-versioned/clients/factory.go renamed to pkg/client/client_factory.go

@@ -1,34 +1,19 @@
 /*
-Copyright 2018 The Kubernetes Authors.
+Copyright 2019, 2021, 2022, 2023 The Multi-Cluster App Dispatcher 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
 
- http://www.apache.org/licenses/LICENSE-2.0
+http://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.
 */
-/*
-Copyright 2019, 2021 The Multi-Cluster App Dispatcher 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
-
- http://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.
-*/
-package clients
+package client
 
 import (
 "k8s.io/apimachinery/pkg/runtime"