Update Ginkgo to V2

Two significant changes affected our code base:

1. The table DSL i.e. `DescribeTable` and `Entry` have been moved to
   top-level. It was not required to import `extensions/table` anymore
1. Changes to CLI flag arguments to randomise all specs

There was a function name conflict because our code base and Ginkgo
define the function `Label()`. Due to the dot-import, it caused a name
conflict. This was resolved by aliasing our module.

Disabled metrics in integration tests to avoid MacOS firewall popup
everytime we run integration tests. We do not observe or scrape metrics
in the integration tests at the moment. In the future, we could bind to
localhost if needed.

Small refactor on getting the configuration to use a library function,
instead of a home-made one.

Signed-off-by: Aitor Perez Cedres <acedres@vmware.com>

Author: Zerpet

Makefile

@@ -9,6 +9,9 @@ help:
 ENVTEST_K8S_VERSION = 1.20.2
 ARCHITECTURE = amd64
 LOCAL_TESTBIN = $(CURDIR)/testbin
+
+K8S_OPERATOR_NAMESPACE ?= rabbitmq-system
+
 # "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
@@ -19,7 +22,7 @@ $(KUBEBUILDER_ASSETS):
 
 .PHONY: unit-tests
 unit-tests: install-tools $(KUBEBUILDER_ASSETS) generate fmt vet manifests ## Run unit tests
-	ginkgo -r --randomizeAllSpecs api/ internal/
+	ginkgo -r --randomize-all api/ internal/
 
 .PHONY: integration-tests
 integration-tests: install-tools $(KUBEBUILDER_ASSETS) generate fmt vet manifests ## Run integration tests
@@ -54,7 +57,7 @@ generate: install-tools api-reference
 
 # Build manager binary
 manager: generate fmt vet
-	go mod tidy
+	go mod download
 	go build -o bin/manager main.go
 
 deploy-manager:  ## Deploy manager
@@ -77,15 +80,14 @@ destroy: ## Cleanup all controller artefacts
 run: generate manifests fmt vet install deploy-namespace-rbac just-run ## Run operator binary locally against the configured Kubernetes cluster in ~/.kube/config
 
 just-run: ## Just runs 'go run main.go' without regenerating any manifests or deploying RBACs
-	KUBECONFIG=${HOME}/.kube/config OPERATOR_NAMESPACE=rabbitmq-system go run ./main.go -metrics-bind-address 127.0.0.1:9782 --zap-devel $(OPERATOR_ARGS)
+	KUBECONFIG=${HOME}/.kube/config OPERATOR_NAMESPACE=$(K8S_OPERATOR_NAMESPACE) go run ./main.go -metrics-bind-address 127.0.0.1:9782 --zap-devel $(OPERATOR_ARGS)
 
 delve: generate install deploy-namespace-rbac just-delve ## Deploys CRD, Namespace, RBACs and starts Delve debugger
 
 just-delve: install-tools ## Just starts Delve debugger
-	KUBECONFIG=${HOME}/.kube/config OPERATOR_NAMESPACE=rabbitmq-system dlv debug
+	KUBECONFIG=${HOME}/.kube/config OPERATOR_NAMESPACE=$(K8S_OPERATOR_NAMESPACE) dlv debug
 
-# Install CRDs into a cluster
-install: manifests
+install: manifests ## Install CRDs into a cluster
 	kubectl apply -f config/crd/bases
 
 deploy-namespace-rbac:
@@ -161,15 +163,15 @@ kind-unprepare:  ## Remove KIND support for LoadBalancer services
 	@kubectl delete -f https://raw.githubusercontent.com/metallb/metallb/v0.9.3/manifests/namespace.yaml
 
 system-tests: install-tools ## Run end-to-end tests against Kubernetes cluster defined in ~/.kube/config
-	NAMESPACE="rabbitmq-system" ginkgo -nodes=3 -randomizeAllSpecs -r system_tests/
+	NAMESPACE="$(K8S_OPERATOR_NAMESPACE)" ginkgo -nodes=3 --randomize-all -r system_tests/
 
 kubectl-plugin-tests: ## Run kubectl-rabbitmq tests
 	echo "running kubectl plugin tests"
 	PATH=$(PWD)/bin:$$PATH ./bin/kubectl-rabbitmq.bats
 
 tests: unit-tests integration-tests system-tests kubectl-plugin-tests
 
-docker-registry-secret: check-env-docker-credentials operator-namespace
+docker-registry-secret: check-env-docker-credentials
 	echo "creating registry secret and patching default service account"
 	@kubectl -n $(K8S_OPERATOR_NAMESPACE) create secret docker-registry $(DOCKER_REGISTRY_SECRET) --docker-server='$(DOCKER_REGISTRY_SERVER)' --docker-username="$$DOCKER_REGISTRY_USERNAME" --docker-password="$$DOCKER_REGISTRY_PASSWORD" || true
 	@kubectl -n $(K8S_OPERATOR_NAMESPACE) patch serviceaccount rabbitmq-cluster-operator -p '{"imagePullSecrets": [{"name": "$(DOCKER_REGISTRY_SECRET)"}]}'
@@ -178,11 +180,6 @@ install-tools:
 	go mod download
 	grep _ tools/tools.go | awk -F '"' '{print $$2}' | xargs -t go install
 
-operator-namespace:
-ifeq (, $(K8S_OPERATOR_NAMESPACE))
-K8S_OPERATOR_NAMESPACE=rabbitmq-system
-endif
-
 check-env-docker-repo: check-env-registry-server
 ifndef OPERATOR_IMAGE
 	$(error OPERATOR_IMAGE is undefined: path to the Operator image within the registry specified in DOCKER_REGISTRY_SERVER (e.g. rabbitmq/cluster-operator - without leading slash))

api/v1beta1/rabbitmqcluster_status_test.go

@@ -1,7 +1,7 @@
 package v1beta1
 
 import (
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	"github.com/rabbitmq/cluster-operator/internal/status"
 	appsv1 "k8s.io/api/apps/v1"

api/v1beta1/rabbitmqcluster_types_test.go

@@ -9,7 +9,7 @@
 package v1beta1
 
 import (
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	"github.com/rabbitmq/cluster-operator/internal/status"
 	appsv1 "k8s.io/api/apps/v1"

api/v1beta1/suite_test.go

@@ -12,7 +12,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
 	"k8s.io/client-go/kubernetes/scheme"

controllers/rabbitmqcluster_controller_test.go

@@ -19,7 +19,7 @@ import (
 
 	"k8s.io/apimachinery/pkg/util/intstr"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 
 	. "github.com/onsi/gomega"
 	. "github.com/onsi/gomega/gstruct"

controllers/reconcile_cli_test.go

@@ -9,7 +9,7 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
 )

controllers/reconcile_finalizer_test.go

@@ -3,7 +3,7 @@ package controllers_test
 import (
 	rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

controllers/reconcile_no_persistence_test.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
 	"github.com/rabbitmq/cluster-operator/internal/status"

controllers/reconcile_persistence_test.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
 	"github.com/rabbitmq/cluster-operator/internal/status"

controllers/reconcile_rabbitmq_configurations_test.go

@@ -4,8 +4,7 @@ import (
 	rabbitmqv1beta1 "github.com/rabbitmq/cluster-operator/api/v1beta1"
 	"time"
 
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/ginkgo/extensions/table"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"