Merge pull request #11 from ncdc/cleanups

Cleanups

Author: stevekuznetsov

.github/workflows/ci.yaml

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          path: logicalcluster
+          path: code-generator
       - uses: actions/checkout@v3
         with:
           repository: kubernetes/repo-infra
@@ -39,6 +39,17 @@ jobs:
       - name: Run golangci-lint
         run: make lint
 
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: v1.17
+      - name: Run go test
+        run: make test
+
   verify-codegen:
     name: verify-codegen
     runs-on: ubuntu-latest

Makefile

@@ -28,12 +28,49 @@ GOLANGCI_LINT_VER := v1.44.2
 GOLANGCI_LINT_BIN := golangci-lint
 GOLANGCI_LINT := $(GOBIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER)
 
+KUBE_CLIENT_GEN_VER := v0.24.0
+KUBE_CLIENT_GEN_BIN := client-gen
+KUBE_CLIENT_GEN := $(GOBIN_DIR)/$(KUBE_CLIENT_GEN_BIN)-$(KUBE_CLIENT_GEN_VER)
+
+$(KUBE_CLIENT_GEN):
+	GOBIN=$(GOBIN_DIR) $(GO_INSTALL) k8s.io/code-generator/cmd/client-gen $(KUBE_CLIENT_GEN_BIN) $(KUBE_CLIENT_GEN_VER)
+
 $(CONTROLLER_GEN):
 	GOBIN=$(GOBIN_DIR) $(GO_INSTALL) sigs.k8s.io/controller-tools/cmd/controller-gen $(CONTROLLER_GEN_BIN) $(CONTROLLER_GEN_VER)
 
+.PHONY: build
+build: ## Build the project
+	mkdir -p bin
+	go build -o bin
+
+.PHONY: install
+install:
+	go install
+
 .PHONY: codegen
-codegen: $(CONTROLLER_GEN)
-	${CONTROLLER_GEN} object paths=./testdata/pkg/apis/...
+codegen: $(CONTROLLER_GEN) $(KUBE_CLIENT_GEN) build
+	# Generate deepcopy functions
+	${CONTROLLER_GEN} object paths=./examples/pkg/apis/...
+
+	# Generate standard clientset
+	$(KUBE_CLIENT_GEN) \
+		--clientset-name versioned \
+		--go-header-file hack/boilerplate/boilerplate.generatego.txt \
+		--input-base github.com/kcp-dev/code-generator/examples/pkg/apis \
+		--input example/v1 \
+		--output-base . \
+		--output-package github.com/kcp-dev/code-generator/examples/pkg/generated/clientset \
+		--trim-path-prefix github.com/kcp-dev/code-generator
+
+	# Generate cluster clientset
+	bin/code-generator \
+		client \
+		--clientset-name clusterclient \
+		--go-header-file hack/boilerplate/boilerplate.generatego.txt \
+		--clientset-api-path github.com/kcp-dev/code-generator/examples/pkg/generated/clientset/versioned \
+		--input-dir ./examples/pkg/apis \
+		--output-dir ./examples/pkg \
+		--group-versions example:v1
 
 $(GOLANGCI_LINT):
 	GOBIN=$(GOBIN_DIR) $(GO_INSTALL) github.com/golangci/golangci-lint/cmd/golangci-lint $(GOLANGCI_LINT_BIN) $(GOLANGCI_LINT_VER)
@@ -42,6 +79,10 @@ $(GOLANGCI_LINT):
 lint: $(GOLANGCI_LINT)
 	$(GOLANGCI_LINT) run --timeout=10m ./...
 
+.PHONY: test
+test:
+	go test ./...
+
 # Note, running this locally if you have any modified files, even those that are not generated,
 # will result in an error. This target is mostly for CI jobs.
 .PHONY: verify-codegen

testdata/header.txt renamed to examples/header.txt

@@ -0,0 +1,21 @@
+/*
+Copyright 2021 The KCP 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 example
+
+const (
+	GroupName = "example.dev"
+)

examples/pkg/apis/example/register.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2021 The KCP 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 v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+
+	"github.com/kcp-dev/code-generator/examples/pkg/apis/example"
+)
+
+// SchemeGroupVersion is group version used to register these objects
+var SchemeGroupVersion = schema.GroupVersion{Group: example.GroupName, Version: "v1alpha1"}
+
+// Kind takes an unqualified kind and returns back a Group qualified GroupKind
+func Kind(kind string) schema.GroupKind {
+	return SchemeGroupVersion.WithKind(kind).GroupKind()
+}
+
+// Resource takes an unqualified resource and returns a Group qualified GroupResource
+func Resource(resource string) schema.GroupResource {
+	return SchemeGroupVersion.WithResource(resource).GroupResource()
+}
+
+var (
+	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
+	AddToScheme   = SchemeBuilder.AddToScheme
+)
+
+// Adds the list of known types to Scheme.
+func addKnownTypes(scheme *runtime.Scheme) error {
+	scheme.AddKnownTypes(SchemeGroupVersion,
+		&TestType{},
+		&TestTypeList{},
+		&ClusterTestType{},
+		&ClusterTestTypeList{},
+	)
+	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
+	return nil
+}

testdata/pkg/apis/example/v1/doc.go renamed to examples/pkg/apis/example/v1/doc.go

@@ -20,15 +20,22 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 // +genclient
 // TestType is a top-level type. A client is created for it.
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type TestType struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
 	// +optional
 	APIGroups []string `json:"apiGroups,omitempty"`
 }
 
 // TestTypeList is a top-level list type. The client methods for lists are automatically created.
 // You are not supposed to create a separated client for this one.
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 type TestTypeList struct {
-	Items []TestType `json:"items"`
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+	Items           []TestType `json:"items"`
 }
 
 // +genclient