Merge pull request #106 from erikgb/generate-ac

chore: generate applyconfigurations for APIs (SSA)
cybozu-go · Nov 15, 2023 · b30b46b · b30b46b
2 parents 5e3cfbd + 255eede
commit b30b46b
Show file tree

Hide file tree

Showing 36 changed files with 419 additions and 39 deletions.
diff --git a/Makefile b/Makefile
@@ -45,19 +45,33 @@ help: ## Display this help.
 HELM_CRDS_FILE := charts/accurate/templates/generated/crds.yaml
 .PHONY: manifests
 manifests: setup ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
-	controller-gen $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+	controller-gen $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="{./api/..., ./controllers/...}" output:crd:artifacts:config=config/crd/bases
 	echo '{{- if .Values.installCRDs }}' > $(HELM_CRDS_FILE)
 	kustomize build config/kustomize-to-helm/overlays/crds | yq e "." -p yaml - >> $(HELM_CRDS_FILE)
 	echo '{{- end }}' >> $(HELM_CRDS_FILE)
 	kustomize build config/kustomize-to-helm/overlays/templates | yq e "."  -p yaml - > charts/accurate/templates/generated/generated.yaml
 
 .PHONY: generate
-generate: setup ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
-	controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./..."
+generate: setup generate-applyconfigurations ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
+	controller-gen object:headerFile="hack/boilerplate.go.txt" paths="{./api/...}"
+
+GO_MODULE = $(shell go list -m)
+API_DIRS = $(shell find api -mindepth 2 -type d | sed "s|^|$(shell go list -m)/|" | paste -sd ",")
+AC_PKG = internal/applyconfigurations
+.PHONY: generate-applyconfigurations
+generate-applyconfigurations: applyconfiguration-gen ## Generate applyconfigurations to support typesafe SSA.
+	rm -rf $(AC_PKG)
+	@echo ">> generating $(AC_PKG)..."
+	$(APPLYCONFIGURATION_GEN) \
+		--go-header-file 	hack/boilerplate.go.txt \
+		--input-dirs		"$(API_DIRS)" \
+		--output-package  	"$(GO_MODULE)/$(AC_PKG)" \
+		--trim-path-prefix 	"$(GO_MODULE)" \
+		--output-base    	"."
 
 .PHONY: apidoc
 apidoc: setup $(wildcard api/*/*_types.go)
-	crd-to-markdown --links docs/links.csv -f api/v1/subnamespace_types.go -n SubNamespace > docs/crd_subnamespace.md
+	crd-to-markdown --links docs/links.csv -f api/accurate/v1/subnamespace_types.go -n SubNamespace > docs/crd_subnamespace.md
 
 .PHONY: book
 book: setup
@@ -109,6 +123,13 @@ $(SETUP_ENVTEST):
 	# see https://github.com/kubernetes-sigs/controller-runtime/tree/master/tools/setup-envtest
 	GOBIN=$(shell pwd)/bin go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
 
+APPLYCONFIGURATION_GEN := $(shell pwd)/bin/applyconfiguration-gen
+.PHONY: applyconfiguration-gen
+applyconfiguration-gen: $(APPLYCONFIGURATION_GEN) ## Download applyconfiguration-gen locally if necessary
+$(APPLYCONFIGURATION_GEN):
+	# see https://github.com/kubernetes/code-generator/tree/master/cmd/applyconfiguration-gen
+	GOBIN=$(shell pwd)/bin go install k8s.io/code-generator/cmd/[email protected]
+
 # go-get-tool will 'go get' any package $2 and install it to $1.
 PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
 define go-get-tool

diff --git a/PROJECT b/PROJECT
@@ -11,7 +11,7 @@ resources:
   domain: cybozu.com
   group: accurate
   kind: SubNamespace
-  path: github.com/cybozu-go/accurate/api/v1
+  path: github.com/cybozu-go/accurate/api/accurate/v1
   version: v1
   webhooks:
     defaulting: true

diff --git a/api/v1/conversion_test.go → api/accurate/v1/conversion_test.go b/api/v1/conversion_test.go → api/accurate/v1/conversion_test.go
@@ -3,7 +3,7 @@ package v1
 import (
 	"testing"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/v2alpha1"
+	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
 	utilconversion "github.com/cybozu-go/accurate/internal/util/conversion"
 	fuzz "github.com/google/gofuzz"
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"

diff --git a/api/accurate/v1/doc.go b/api/accurate/v1/doc.go
@@ -0,0 +1,3 @@
+// +kubebuilder:object:generate=true
+// +groupName=accurate.cybozu.com
+package v1
diff --git a/api/v1/groupversion_info.go → api/accurate/v1/groupversion_info.go b/api/v1/groupversion_info.go → api/accurate/v1/groupversion_info.go
@@ -1,6 +1,4 @@
 // Package v1 contains API Schema definitions for the accurate v1 API group
-// +kubebuilder:object:generate=true
-// +groupName=accurate.cybozu.com
 package v1
 
 import (
@@ -9,11 +7,11 @@ import (
 )
 
 var (
-	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "accurate.cybozu.com", Version: "v1"}
+	// SchemeGroupVersion is group version used to register these objects
+	SchemeGroupVersion = schema.GroupVersion{Group: "accurate.cybozu.com", Version: "v1"}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
-	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
 
 	// AddToScheme adds the types in this group-version to the given scheme.
 	AddToScheme = SchemeBuilder.AddToScheme

diff --git a/api/v1/subnamespace_conversion.go → api/accurate/v1/subnamespace_conversion.go b/api/v1/subnamespace_conversion.go → api/accurate/v1/subnamespace_conversion.go
@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"strconv"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/v2alpha1"
+	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/go-logr/logr"
 	"k8s.io/apimachinery/pkg/api/meta"
@@ -20,8 +20,8 @@ func (src *SubNamespace) ConvertTo(dstRaw conversion.Hub) error {
 	dst := dstRaw.(*accuratev2alpha1.SubNamespace)
 
 	logger := getConversionLogger(src).WithValues(
-		"source", GroupVersion.Version,
-		"destination", GroupVersion.Version,
+		"source", SchemeGroupVersion.Version,
+		"destination", SchemeGroupVersion.Version,
 	)
 	logger.V(5).Info("converting")
 
@@ -57,8 +57,8 @@ func (dst *SubNamespace) ConvertFrom(srcRaw conversion.Hub) error {
 	src := srcRaw.(*accuratev2alpha1.SubNamespace)
 
 	logger := getConversionLogger(src).WithValues(
-		"source", GroupVersion.Version,
-		"destination", GroupVersion.Version,
+		"source", SchemeGroupVersion.Version,
+		"destination", SchemeGroupVersion.Version,
 	)
 	logger.V(5).Info("converting")
 

diff --git a/api/v1/subnamespace_conversion_test.go → ...curate/v1/subnamespace_conversion_test.go b/api/v1/subnamespace_conversion_test.go → ...curate/v1/subnamespace_conversion_test.go
@@ -3,7 +3,7 @@ package v1
 import (
 	"testing"
 
-	accuratev2alpha1 "github.com/cybozu-go/accurate/api/v2alpha1"
+	accuratev2alpha1 "github.com/cybozu-go/accurate/api/accurate/v2alpha1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kstatus "sigs.k8s.io/cli-utils/pkg/kstatus/status"
 )

diff --git a/api/v1/subnamespace_types.go → api/accurate/v1/subnamespace_types.go b/api/v1/subnamespace_types.go → api/accurate/v1/subnamespace_types.go
diff --git a/api/v1/zz_generated.deepcopy.go → api/accurate/v1/zz_generated.deepcopy.go b/api/v1/zz_generated.deepcopy.go → api/accurate/v1/zz_generated.deepcopy.go
diff --git a/api/accurate/v2alpha1/doc.go b/api/accurate/v2alpha1/doc.go
@@ -0,0 +1,3 @@
+// +kubebuilder:object:generate=true
+// +groupName=accurate.cybozu.com
+package v2alpha1
diff --git a/api/v2alpha1/groupversion_info.go → api/accurate/v2alpha1/groupversion_info.go b/api/v2alpha1/groupversion_info.go → api/accurate/v2alpha1/groupversion_info.go
@@ -1,6 +1,4 @@
 // Package v2alpha1 contains API Schema definitions for the accurate v2alpha1 API group
-// +kubebuilder:object:generate=true
-// +groupName=accurate.cybozu.com
 package v2alpha1
 
 import (
@@ -9,11 +7,11 @@ import (
 )
 
 var (
-	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "accurate.cybozu.com", Version: "v2alpha1"}
+	// SchemeGroupVersion is group version used to register these objects
+	SchemeGroupVersion = schema.GroupVersion{Group: "accurate.cybozu.com", Version: "v2alpha1"}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
-	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
 
 	// AddToScheme adds the types in this group-version to the given scheme.
 	AddToScheme = SchemeBuilder.AddToScheme

diff --git a/api/v2alpha1/subnamespace_conversion.go → ...urate/v2alpha1/subnamespace_conversion.go b/api/v2alpha1/subnamespace_conversion.go → ...urate/v2alpha1/subnamespace_conversion.go
diff --git a/api/v2alpha1/subnamespace_types.go → api/accurate/v2alpha1/subnamespace_types.go b/api/v2alpha1/subnamespace_types.go → api/accurate/v2alpha1/subnamespace_types.go
@@ -35,6 +35,7 @@ type SubNamespaceSpec struct {
 //+kubebuilder:unservedversion
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
+//+genclient
 
 // SubNamespace is the Schema for the subnamespaces API
 type SubNamespace struct {

diff --git a/api/v2alpha1/zz_generated.deepcopy.go → ...ccurate/v2alpha1/zz_generated.deepcopy.go b/api/v2alpha1/zz_generated.deepcopy.go → ...ccurate/v2alpha1/zz_generated.deepcopy.go
diff --git a/cmd/accurate-controller/sub/run.go b/cmd/accurate-controller/sub/run.go
@@ -8,7 +8,7 @@ import (
 	// to ensure that exec-entrypoint and run can make use of them.
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/controllers"
 	"github.com/cybozu-go/accurate/hooks"
 	"github.com/cybozu-go/accurate/pkg/config"

diff --git a/cmd/kubectl-accurate/sub/sub_create.go b/cmd/kubectl-accurate/sub/sub_create.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"

diff --git a/cmd/kubectl-accurate/sub/sub_cut.go b/cmd/kubectl-accurate/sub/sub_cut.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"

diff --git a/cmd/kubectl-accurate/sub/sub_delete.go b/cmd/kubectl-accurate/sub/sub_delete.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"

diff --git a/cmd/kubectl-accurate/sub/sub_graft.go b/cmd/kubectl-accurate/sub/sub_graft.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"

diff --git a/cmd/kubectl-accurate/sub/sub_move.go b/cmd/kubectl-accurate/sub/sub_move.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"

diff --git a/cmd/kubectl-accurate/sub/util.go b/cmd/kubectl-accurate/sub/util.go
@@ -1,7 +1,7 @@
 package sub
 
 import (
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"

diff --git a/controllers/namespace_controller.go b/controllers/namespace_controller.go
@@ -6,7 +6,7 @@ import (
 	"path"
 	"reflect"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/equality"

diff --git a/controllers/namespace_controller_test.go b/controllers/namespace_controller_test.go
@@ -5,7 +5,7 @@ import (
 	"errors"
 	"time"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/cybozu-go/accurate/pkg/indexing"
 	. "github.com/onsi/ginkgo/v2"

diff --git a/controllers/subnamespace_controller.go b/controllers/subnamespace_controller.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"

diff --git a/controllers/subnamespace_controller_test.go b/controllers/subnamespace_controller_test.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"time"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"

diff --git a/controllers/suite_test.go b/controllers/suite_test.go
@@ -18,7 +18,7 @@ import (
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/config"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	"github.com/cybozu-go/accurate/pkg/feature"

diff --git a/e2e/e2e_test.go b/e2e/e2e_test.go
@@ -6,7 +6,7 @@ import (
 	"errors"
 	"os"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"

diff --git a/go.mod b/go.mod
@@ -19,6 +19,7 @@ require (
 	k8s.io/klog/v2 v2.100.1
 	sigs.k8s.io/cli-utils v0.35.0
 	sigs.k8s.io/controller-runtime v0.16.2
+	sigs.k8s.io/structured-merge-diff/v4 v4.3.0
 	sigs.k8s.io/yaml v1.3.0
 )
 
@@ -87,5 +88,4 @@ require (
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/kustomize/api v0.13.5-0.20230601165947-6ce0bf390ce3 // indirect
 	sigs.k8s.io/kustomize/kyaml v0.14.3-0.20230601165947-6ce0bf390ce3 // indirect
-	sigs.k8s.io/structured-merge-diff/v4 v4.3.0 // indirect
 )
diff --git a/hooks/subnamespace.go b/hooks/subnamespace.go
@@ -7,7 +7,7 @@ import (
 	"net/http"
 	"regexp"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/config"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	admissionv1 "k8s.io/api/admission/v1"

diff --git a/hooks/subnamespace_test.go b/hooks/subnamespace_test.go
@@ -3,7 +3,7 @@ package hooks
 import (
 	"context"
 
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/constants"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"

diff --git a/hooks/suite_test.go b/hooks/suite_test.go
@@ -14,7 +14,7 @@ import (
 
 	admissionv1beta1 "k8s.io/api/admission/v1beta1"
 	//+kubebuilder:scaffold:imports
-	accuratev1 "github.com/cybozu-go/accurate/api/v1"
+	accuratev1 "github.com/cybozu-go/accurate/api/accurate/v1"
 	"github.com/cybozu-go/accurate/pkg/config"
 	"github.com/cybozu-go/accurate/pkg/indexing"
 	"k8s.io/apimachinery/pkg/runtime"