Makefile: Improve e2e-tests by utilizing make tasks

Author: marcofranssen

Makefile

@@ -76,9 +76,27 @@ vet: ## Run go vet against code.
 test: manifests generate fmt vet setup-envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
 
-# Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
-.PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
-test-e2e: fluentd-e2e
+KIND_CLUSTER ?= fluent-operator-test-e2e
+
+.PHONY: setup-test-e2e
+setup-test-e2e: $(KIND) ## Set up a Kind cluster for e2e tests if it does not exist
+	@case "$$($(KIND) get clusters)" in \
+		*"$(KIND_CLUSTER)"*) \
+		echo "Kind cluster '$(KIND_CLUSTER)' already exists. Skipping creation." ;; \
+		*) \
+		echo "Creating Kind cluster '$(KIND_CLUSTER)'…"; \
+		$(KIND) create cluster --name $(KIND_CLUSTER) ;; \
+	esac
+
+.PHONY: cleanup-test-e2e
+cleanup-test-e2e:
+	$(KIND) delete cluster --name $(KIND_CLUSTER)
+
+.PHONY: test-e2e
+test-e2e: setup-test-e2e fluentd-e2e ## Run the e2e tests against a Kind k8s instance that is spun up.
+
+%-e2e: ginkgo
+	@export KIND_CLUSTER=$(KIND_CLUSTER); tests/scripts/$*_e2e.sh
 
 .PHONY: lint
 lint: golangci-lint ## Run golangci-lint linter
@@ -230,7 +248,7 @@ $(CONTROLLER_GEN): $(LOCALBIN)
 
 .PHONY: setup-envtest
 setup-envtest: envtest ## Download the binaries required for ENVTEST in the local bin directory.
-	@echo "Setting up envtest binaries for Kubernetes version $(ENVTEST_K8S_VERSION)..."
+	@echo "Setting up envtest binaries for Kubernetes version $(ENVTEST_K8S_VERSION)…"
 	@$(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path || { \
 		echo "Error: Failed to set up envtest binaries for version $(ENVTEST_K8S_VERSION)."; \
 		exit 1; \
@@ -256,26 +274,6 @@ code-generator: $(CODE_GENERATOR) ## Download code-generator locally if necessar
 $(CODE_GENERATOR): $(LOCALBIN)
 	$(call go-install-tool,$(CODE_GENERATOR),k8s.io/code-generator,$(CODE_GENERATOR_VERSION))
 
-KIND_CLUSTER ?= fluent-operator-test-e2e
-
-.PHONY: setup-test-e2e
-setup-test-e2e: ## Set up a Kind cluster for e2e tests if it does not exist
-	@command -v $(KIND) >/dev/null 2>&1 || { \
-		echo "Kind is not installed. Please install Kind manually."; \
-		exit 1; \
-	}
-	@case "$$($(KIND) get clusters)" in \
-		*"$(KIND_CLUSTER)"*) \
-		echo "Kind cluster '$(KIND_CLUSTER)' already exists. Skipping creation." ;; \
-		*) \
-		echo "Creating Kind cluster '$(KIND_CLUSTER)'..."; \
-		$(KIND) create cluster --name $(KIND_CLUSTER) ;; \
-	esac
-
-.PHONY: cleanup-test-e2e
-cleanup-test-e2e:
-	$(KIND) delete cluster --name $(KIND_CLUSTER)
-
 .PHONY: kind
 kind: $(KIND) ## Download code-generator locally if necessary.
 $(KIND): $(LOCALBIN)
@@ -375,12 +373,6 @@ go-deps: # download go dependencies
 docs-update: # update api docs
 	go run ./cmd/doc-gen/main.go
 
-fluentd-e2e: ginkgo # make e2e tests
-	tests/scripts/fluentd_e2e.sh
-
-fluentd-helm-e2e: ginkgo # make helm e2e tests
-	tests/scripts/fluentd_helm_e2e.sh
-
 update-helm-package: # update helm repo
 	./hack/update-helm-package.sh
 

tests/scripts/fluentd_e2e.sh

@@ -14,6 +14,7 @@ LOGGING_NAMESPACE="fluent"
 IMAGE_TAG="$(date "+%Y-%m-%d-%H-%M-%S")"
 VERSION="$(tr -d " \t\n\r" < VERSION)"
 IMAGE_NAME="ghcr.io/fluent/fluent-operator/fluent-operator"
+KIND_CLUSTER="${KIND_CLUSTER:-fluent-operator-test-e2e}"
 
 GINKGO_BIN="ginkgo"
 if [ -f "$PROJECT_ROOT/bin/ginkgo" ]; then
@@ -29,32 +30,29 @@ function build_ginkgo_test() {
 # shellcheck disable=SC2329
 function cleanup() {
   local exit_code=$?
-  
+
   if [ "${SKIP_CLEANUP:-false}" == "true" ]; then
     echo "Skipping cleanup as requested."
     exit "$exit_code"
   fi
 
-  echo "Cleaning up..."
+  echo "Cleaning up…"
   pushd "$PROJECT_ROOT" >/dev/null || true
-  # kubectl delete -f manifests/setup/setup.yaml
-  # kubectl delete ns $LOGGING_NAMESPACE
-  kind delete cluster --name test || true
+  make cleanup-test-e2e KIND_CLUSTER="$KIND_CLUSTER"
   popd >/dev/null || true
 }
 
 function prepare_cluster() {
-  kind create cluster --name test
   kubectl create ns "$LOGGING_NAMESPACE"
 
-  echo "wait the control-plane ready..."
-  kubectl wait --for=condition=Ready node/test-control-plane --timeout=60s
+  echo "wait the control-plane ready…"
+  kubectl wait --for=condition=Ready "node/${KIND_CLUSTER}-control-plane" --timeout=60s
 }
 
 function build_image() {
   pushd "$PROJECT_ROOT" >/dev/null
   make build-op-amd64 -e "FO_IMG=$IMAGE_NAME:$IMAGE_TAG"
-  kind load docker-image "$IMAGE_NAME:$IMAGE_TAG" --name test
+  kind load docker-image "$IMAGE_NAME:$IMAGE_TAG" --name "$KIND_CLUSTER"
   popd >/dev/null
 }
 
@@ -79,19 +77,19 @@ function run_test() {
 function main() {
   trap cleanup EXIT
 
-  echo -e "\nBuilding testcases..."
+  echo -e "\nBuilding testcases…"
   build_ginkgo_test
 
-  echo -e "\nPreparing cluster..."
+  echo -e "\nPreparing cluster…"
   prepare_cluster
 
-  echo -e "\nBuilding image..."
+  echo -e "\nBuilding image…"
   build_image
 
-  echo -e "\nStart fluent operator..."
+  echo -e "\nStart fluent operator…"
   start_fluent_operator
 
-  echo -e "\nRunning test..."
+  echo -e "\nRunning test…"
   run_test
 }
 

tests/scripts/fluentd_helm_e2e.sh

@@ -6,6 +6,7 @@ PROJECT_ROOT=$PWD
 E2E_DIR=$(realpath "$(dirname "$0")/..")
 LOGGING_NAMESPACE=fluent
 IMAGE_TAG=$(date "+%Y-%m-%d-%H-%M-%S")
+KIND_CLUSTER="${KIND_CLUSTER:-fluent-operator-test-e2e}"
 
 function build_ginkgo_test() {
   ginkgo build -r e2e/fluentd/
@@ -18,25 +19,24 @@ function cleanup() {
   #  helm uninstall fluent-operator -n $LOGGING_NAMESPACE
   #  kubectl delete ns $LOGGING_NAMESPACE
   # shellcheck disable=SC2317
-  kind delete cluster --name test-helm
+  kind delete cluster --name "$KIND_CLUSTER"
   # shellcheck disable=SC2317
   popd >/dev/null
   # shellcheck disable=SC2317
   exit 0
 }
 
 function prepare_cluster() {
-  kind create cluster --name test-helm
   kubectl create ns $LOGGING_NAMESPACE
 
-  echo "wait the control-plane ready..."
-  kubectl wait --for=condition=Ready node/test-helm-control-plane --timeout=60s
+  echo "wait the control-plane ready…"
+  kubectl wait --for=condition=Ready "node/${KIND_CLUSTER}-control-plane" --timeout=60s
 }
 
 function build_image() {
   pushd "$PROJECT_ROOT" >/dev/null
   make build-op-amd64 -e "FO_IMG=kubesphere/fluent-operator:$IMAGE_TAG"
-  kind load docker-image "kubesphere/fluent-operator:$IMAGE_TAG" --name test-helm
+  kind load docker-image "kubesphere/fluent-operator:$IMAGE_TAG" --name "$KIND_CLUSTER"
   popd >/dev/null
 }
 
@@ -74,19 +74,19 @@ function run_test() {
 set -Ee
 trap cleanup EXIT ERR
 
-echo -e "\nBuilding testcases..."
+echo -e "\nBuilding testcases…"
 pushd "$E2E_DIR" >/dev/null
 build_ginkgo_test
 popd >/dev/null
 
-echo -e "\nPreparing cluster..."
+echo -e "\nPreparing cluster…"
 prepare_cluster
 
-echo -e "\nBuilding image..."
+echo -e "\nBuilding image…"
 build_image
 
-echo -e "\nStart fluent operator..."
+echo -e "\nStart fluent operator…"
 start_fluent_operator
 
-echo -e "\nRunning test..."
+echo -e "\nRunning test…"
 run_test