Use setup-envtest

Use
https://github.com/kubernetes-sigs/controller-runtime/tree/master/tools/setup-envtest
since we want self-contained test dependencies for our integration tests.

Migrate PROJECT file to kubebuilder v3

see https://kubebuilder.io/migration/manually_migration_guide_v2_v3.html

Delete webhook files

We don't use a webhook in the cluster-operator at the moment.
Therefore delete the files.
If we need a webhook in the future, we can easily re-create the files
using 'kubebuilder create webhook' command.

Rename flag metrics-addr to metrics-bind-address

as described in
https://kubebuilder.io/migration/manually_migration_guide_v2_v3.html#rename-the-manager-flags
and
kubernetes-sigs/kubebuilder#1839

Co-authored-by: Chunyi Lyu <[email protected]>

Author: ansd

.gitignore

@@ -5,3 +5,4 @@ cover.out
 .envrc
 tags
 releases/
+testbin/

Makefile

@@ -1,16 +1,31 @@
+SHELL := bash
+platform := $(shell uname | tr A-Z a-z)
+
 .DEFAULT_GOAL = help
 .PHONY: help
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
 
-unit-tests: install-tools generate fmt vet manifests ## Run unit tests
+ENVTEST_K8S_VERSION = 1.20.2
+ARCHITECTURE = amd64
+LOCAL_TESTBIN = $(CURDIR)/testbin
+# "Control plane binaries (etcd and kube-apiserver) are loaded by default from /usr/local/kubebuilder/bin.
+# This can be overridden by setting the KUBEBUILDER_ASSETS environment variable"
+# https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest
+export KUBEBUILDER_ASSETS = $(LOCAL_TESTBIN)/k8s/$(ENVTEST_K8S_VERSION)-$(platform)-$(ARCHITECTURE)
+
+$(KUBEBUILDER_ASSETS):
+	setup-envtest --os $(platform) --arch $(ARCHITECTURE) --bin-dir $(LOCAL_TESTBIN) use $(ENVTEST_K8S_VERSION)
+
+.PHONY: unit-tests
+unit-tests: install-tools $(KUBEBUILDER_ASSETS) generate fmt vet manifests ## Run unit tests
 	ginkgo -r --randomizeAllSpecs api/ internal/
 
-integration-tests: install-tools generate fmt vet manifests ## Run integration tests
+.PHONY: integration-tests
+integration-tests: install-tools $(KUBEBUILDER_ASSETS) generate fmt vet manifests ## Run integration tests
 	ginkgo -r controllers/
 
-# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
-CRD_OPTIONS ?= "crd:trivialVersions=true, preserveUnknownFields=false, crdVersions=v1"
+CRD_OPTIONS ?= "crd:trivialVersions=true, preserveUnknownFields=false"
 
 manifests: install-tools ## Generate manifests e.g. CRD, RBAC etc.
 	controller-gen $(CRD_OPTIONS) rbac:roleName=operator-role paths="./api/...;./controllers/..." output:crd:artifacts:config=config/crd/bases

PROJECT

@@ -1,3 +1,16 @@
-version: "2"
 domain: rabbitmq.com
+layout:
+- go.kubebuilder.io/v3
+projectName: cluster-operator
 repo: github.com/rabbitmq/cluster-operator
+resources:
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: rabbitmq.com
+  group: rabbitmq.com
+  kind: RabbitmqCluster
+  path: github.com/rabbitmq/cluster-operator/api/v1beta1
+  version: v1beta1
+version: "3"

api/v1beta1/suite_test.go

@@ -57,6 +57,5 @@ var _ = BeforeSuite(func() {
 
 var _ = AfterSuite(func() {
 	By("tearing down the test environment")
-	err := testEnv.Stop()
-	Expect(err).ToNot(HaveOccurred())
+	Expect(testEnv.Stop()).To(Succeed())
 })

config/certmanager/certificate.yaml

@@ -10,7 +10,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.6.0
+    controller-gen.kubebuilder.io/version: v0.6.1
   creationTimestamp: null
   name: rabbitmqclusters.rabbitmq.com
 spec:

config/certmanager/kustomization.yaml

@@ -16,9 +16,6 @@ resources:
 
 patches:
 - patches/crd_labels_patch.yaml
-# patches here are for enabling the conversion webhook for each CRD
-#- patches/webhook_in_rabbitmqcluster.yaml
-# +kubebuilder:scaffold:kustomizepatch
 
 # the following config is for teaching kustomize how to do kustomization for CRDs.
 configurations: