feat: generate CRDs (Portal and EventGateway) from OpenAPI spec

.mise.toml

@@ -1,6 +1,25 @@
 [settings.github]
 github_attestations = false
 
+################################################################################
+# Tools
+
+[tools."github:kubernetes-sigs/controller-tools"]
+# renovate: datasource=github-releases depName=kubernetes-sigs/controller-tools
+version = "0.20.1"
+
+[tools."github:golangci/golangci-lint"]
+# renovate: datasource=github-releases depName=golangci/golangci-lint
+version = "2.11.3"
+
+[tools."github:kubernetes-sigs/controller-runtime"]
+# renovate: datasource=github-releases depName=kubernetes-sigs/controller-runtime
+version = "0.23.3"
+[tools."github:kubernetes-sigs/controller-runtime".platforms]
+darwin-arm64 = { asset_pattern = "setup-envtest-darwin-arm64" }
+linux-arm64 = { asset_pattern = "setup-envtest-linux-arm64" }
+linux-amd64 = { asset_pattern = "setup-envtest-linux-amd64" }
+
 # NOTE: The reason for tool version being set here and not in .tools-versions.toml
 # is that mise requires the version to be specified when using version_prefix
 # and we need to set the latter for kustomize because its tags on GitHub are prefixed
@@ -48,3 +67,66 @@ macos-arm64 = { url = "https://get.helm.sh/helm-v{{version}}-darwin-arm64.tar.gz
 [tools."go:sigs.k8s.io/kube-api-linter/cmd/golangci-lint-kube-api-linter"]
 # renovate: datasource=git-refs packageName=https://github.com/kubernetes-sigs/kube-api-linter.git
 version = "39e3d06a2850e38a8e9e82918bab14ce84e608de"
+
+
+################################################################################
+# Tasks
+
+[env]
+DIR = "crd-from-oas"
+
+[tasks.build-crd-from-oas]
+description = "Build the {{env.DIR}} binary"
+dir = "./{{env.DIR}}"
+run = "go build -o ../bin/{{env.DIR}} main.go"
+
+[tasks.clean]
+# TODO: This hardcodes the x-konnect API group. Removing this hardcode would cause
+# the removal of other non generated APIs to be removed.
+description = "Clean generated api/x-konnect directory"
+run = "rm -rf ./api/x-konnect/"
+
+[tasks.generate-api]
+description = "Generate Kubernetes Go API from OpenAPI spec"
+dir = "./{{env.DIR}}"
+# NOTE we get the openapi.yaml file from the sdk-konnect-go module which is expected
+# to be present in the local Go module cache.
+# This ensures that we use the same OpenAPI spec as the one used to generate the
+# SDK which should help avoid potential discrepancies between the API and the SDK.
+run = '''
+export INPUT_FILE="$(go list -m -f '{{`{{.Dir}}`}}' github.com/Kong/sdk-konnect-go)/openapi.yaml"
+export OUTPUT_DIR="../api/"
+export CONFIG_FILE="config.yaml"
+go run .
+'''
+depends = [ "clean" ]
+depends_post = [ "generate-deepcopy" ]
+
+[tasks.generate-deepcopy]
+description = "Generate DeepCopy methods for the API types"
+dir = "./{{env.DIR}}"
+run = "controller-gen object:headerFile='../hack/generators/boilerplate.go.txt' paths=../api/..."
+
+[tasks.lint-api]
+description = "Run golangci-lint"
+# TODO: This hardcodes the x-konnect API group. Removing this hardcode would cause the linter
+# to run against all the API groups which might create unwanted issues being reported here.
+run = "golangci-lint-kube-api-linter run -v --config .golangci-kube-api.yaml ./api/x-konnect/..."
+
+[tasks.test-crdsvalidation]
+description = "Run CRD validation tests"
+dir = "./{{env.DIR}}"
+# Update test paths below if more API groups are added
+run = '''
+export KUBEBUILDER_ASSETS=$(setup-envtest use -p path)
+go test -v -count 1 ${GOTESTFLAGS} ./test/crdsvalidation/x-konnect.konghq.com/...
+'''
+
+[tasks.all]
+description = "Generate API, CRDs, and run all tests and linters"
+run = [
+       { task = "generate-api" },
+       { task = "lint" },
+       { tasks = [ "lint-api", "test-unit", "gofix"] },
+       { task = "test-crdsvalidation" },
+]

Makefile

@@ -323,7 +323,7 @@ API_DIR ?= api
 #   make generate && make manifests && make test.charts.golden.update
 # into a single command: make generate
 # Note: manifests is placed near the end to preserve the prior ordering (docs are generated from CRDs first).
-generate: generate.crds generate.crd-kustomize generate.k8sio-gomod-replace generate.deepcopy generate.apitypes-funcs generate.docs generate.lint-fix manifests test.charts.golden.update generate.cli-arguments-docs
+generate: generate.api generate.api-from-oas generate.crds generate.crd-kustomize generate.k8sio-gomod-replace generate.apitypes-funcs generate.docs generate.lint-fix manifests test.charts.golden.update generate.cli-arguments-docs
 
 .PHONY: generate.crds
 generate.crds: controller-gen ## Generate WebhookConfiguration and CustomResourceDefinition objects.
@@ -338,8 +338,9 @@ generate.crd-kustomize:
 generate.api: controller-gen
 	$(CONTROLLER_GEN) object:headerFile="hack/generators/boilerplate.go.txt" paths="./$(API_DIR)/..."
 
-.PHONY: generate.deepcopy
-generate.deepcopy: generate.api
+.PHONY: generate.api-from-oas
+generate.api-from-oas:
+	mise r generate-api
 
 .PHONY: generate.apitypes-funcs
 generate.apitypes-funcs:
@@ -566,6 +567,7 @@ KONG_CONTROLLER_FEATURE_GATES ?= GatewayAlpha=true
 test: test.unit
 
 UNIT_TEST_PATHS := ./api/... ./controller/... ./internal/... ./pkg/... ./modules/... ./ingress-controller/internal/... ./ingress-controller/pkg/...
+UNIT_TEST_PATHS_CRD_GEN := ./pkg/...
 
 .PHONY: _test.unit
 _test.unit: gotestsum
@@ -575,6 +577,11 @@ _test.unit: gotestsum
 		-coverprofile=coverage.unit.out \
 		-ldflags "$(LDFLAGS_COMMON) $(LDFLAGS)" \
 		$(UNIT_TEST_PATHS)
+	cd crd-from-oas && \
+		GOTESTSUM_FORMAT=$(GOTESTSUM_FORMAT) \
+		$(GOTESTSUM) -- $(GOTESTFLAGS) \
+		-race \
+		$(UNIT_TEST_PATHS_CRD_GEN)
 
 .PHONY: test.unit
 test.unit:
@@ -1135,3 +1142,4 @@ lint.api: download.kube-api-linter
 		./api/konnect/v1alpha1/... \
 		./api/konnect/v1alpha2/... \
 		./api/common/v1alpha1/...
+	mise r lint-api

api/x-konnect/v1alpha1/doc.go

@@ -0,0 +1,5 @@
+// Package v1alpha1 contains API types for the x-konnect.konghq.com API group.
+//
+// +kubebuilder:object:generate=true
+// +groupName=x-konnect.konghq.com
+package v1alpha1