refactor(e2e-setup): update Kind cluster naming for e2e tests

kersten · kersten · commit e87b922b8c3c · 2025-03-26T16:57:02.000+01:00
change default Kind cluster names to be project-specific for e2e tests

Previously, the default Kind cluster name was "kind", which could lead
to conflicts when running multiple e2e tests concurrently across
different projects. This change updates the Kind cluster name to be
project-specific, reducing potential conflicts and improving
the isolation of e2e test environments.
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/.github/workflows/test-e2e.yml b/docs/book/src/cronjob-tutorial/testdata/project/.github/workflows/test-e2e.yml
@@ -27,7 +27,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name project-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/Makefile b/docs/book/src/cronjob-tutorial/testdata/project/Makefile
@@ -69,16 +69,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q 'project-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: project-e2e-test"; \
+		$(KIND) create cluster --name project-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/test/utils/utils.go b/docs/book/src/cronjob-tutorial/testdata/project/test/utils/utils.go
@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "project-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}
diff --git a/docs/book/src/getting-started/testdata/project/.github/workflows/test-e2e.yml b/docs/book/src/getting-started/testdata/project/.github/workflows/test-e2e.yml
@@ -27,7 +27,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name project-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/docs/book/src/getting-started/testdata/project/Makefile b/docs/book/src/getting-started/testdata/project/Makefile
@@ -65,16 +65,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q 'project-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: project-e2e-test"; \
+		$(KIND) create cluster --name project-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/docs/book/src/getting-started/testdata/project/test/utils/utils.go b/docs/book/src/getting-started/testdata/project/test/utils/utils.go
@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "project-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/.github/workflows/test-e2e.yml b/docs/book/src/multiversion-tutorial/testdata/project/.github/workflows/test-e2e.yml
@@ -27,7 +27,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name project-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/Makefile b/docs/book/src/multiversion-tutorial/testdata/project/Makefile
@@ -69,16 +69,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q 'project-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: project-e2e-test"; \
+		$(KIND) create cluster --name project-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/test/utils/utils.go b/docs/book/src/multiversion-tutorial/testdata/project/test/utils/utils.go
@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "project-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/github/test-e2e.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/github/test-e2e.go
@@ -28,6 +28,7 @@ var _ machinery.Template = &E2eTestCi{}
 type E2eTestCi struct {
 	machinery.TemplateMixin
 	machinery.BoilerplateMixin
+	machinery.ProjectNameMixin
 }
 
 // SetTemplateDefaults implements machinery.Template
@@ -72,7 +73,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name {{ .ProjectName }}-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go
@@ -144,16 +144,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q '{{ .ProjectName }}-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: {{ .ProjectName }}-e2e-test"; \
+		$(KIND) create cluster --name {{ .ProjectName }}-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/test/utils/utils.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/test/utils/utils.go
@@ -26,6 +26,7 @@ var _ machinery.Template = &Utils{}
 type Utils struct {
 	machinery.TemplateMixin
 	machinery.BoilerplateMixin
+	machinery.ProjectNameMixin
 }
 
 // SetTemplateDefaults set the defaults for its template
@@ -194,7 +195,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "{{ .ProjectName }}-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}
diff --git a/testdata/project-v4-multigroup/.github/workflows/test-e2e.yml b/testdata/project-v4-multigroup/.github/workflows/test-e2e.yml
@@ -27,7 +27,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name project-v4-multigroup-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/testdata/project-v4-multigroup/Makefile b/testdata/project-v4-multigroup/Makefile
@@ -65,16 +65,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q 'project-v4-multigroup-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: project-v4-multigroup-e2e-test"; \
+		$(KIND) create cluster --name project-v4-multigroup-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/testdata/project-v4-multigroup/test/utils/utils.go b/testdata/project-v4-multigroup/test/utils/utils.go
@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "project-v4-multigroup-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}
diff --git a/testdata/project-v4-with-plugins/.github/workflows/test-e2e.yml b/testdata/project-v4-with-plugins/.github/workflows/test-e2e.yml
@@ -27,7 +27,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name project-v4-with-plugins-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/testdata/project-v4-with-plugins/Makefile b/testdata/project-v4-with-plugins/Makefile
@@ -65,16 +65,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q 'project-v4-with-plugins-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: project-v4-with-plugins-e2e-test"; \
+		$(KIND) create cluster --name project-v4-with-plugins-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/testdata/project-v4-with-plugins/test/utils/utils.go b/testdata/project-v4-with-plugins/test/utils/utils.go
@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "project-v4-with-plugins-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}
diff --git a/testdata/project-v4/.github/workflows/test-e2e.yml b/testdata/project-v4/.github/workflows/test-e2e.yml
@@ -27,7 +27,7 @@ jobs:
         run: kind version
 
       - name: Create kind cluster
-        run: kind create cluster
+        run: kind create cluster --name project-v4-test-e2e
 
       - name: Running Test e2e
         run: |
diff --git a/testdata/project-v4/Makefile b/testdata/project-v4/Makefile
@@ -65,16 +65,19 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-.PHONY: test-e2e
-test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
+.PHONY: setup-e2e-test
+setup-e2e-test: ## 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; \
 	}
-	@$(KIND) get clusters | grep -q 'kind' || { \
-		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
-		exit 1; \
+	@$(KIND) get clusters | grep -q 'project-v4-e2e-test' || { \
+		echo "Kind cluster not running, creating Kind cluster: project-v4-e2e-test"; \
+		$(KIND) create cluster --name project-v4-e2e-test; \
 	}
+
+.PHONY: test-e2e
+test-e2e: setup-e2e-test manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
 	go test ./test/e2e/ -v -ginkgo.v
 
 .PHONY: lint
diff --git a/testdata/project-v4/test/utils/utils.go b/testdata/project-v4/test/utils/utils.go
@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {
 
 // LoadImageToKindClusterWithName loads a local docker image to the kind cluster
 func LoadImageToKindClusterWithName(name string) error {
-	cluster := "kind"
+	cluster := "project-v4-e2e-test"
 	if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {
 		cluster = v
 	}

Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ func IsCertManagerCRDsInstalled() bool {`
`167`	`167`
`168`	`168`	`// LoadImageToKindClusterWithName loads a local docker image to the kind cluster`
`169`	`169`	`func LoadImageToKindClusterWithName(name string) error {`
`170`		`- cluster := "kind"`
	`170`	`+ cluster := "project-e2e-test"`
`171`	`171`	`if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {`
`172`	`172`	`cluster = v`
`173`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ var _ machinery.Template = &Utils{}`
`26`	`26`	`type Utils struct {`
`27`	`27`	`machinery.TemplateMixin`
`28`	`28`	`machinery.BoilerplateMixin`
	`29`	`+ machinery.ProjectNameMixin`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`// SetTemplateDefaults set the defaults for its template`
`@@ -194,7 +195,7 @@ func IsCertManagerCRDsInstalled() bool {`
`194`	`195`
`195`	`196`	`// LoadImageToKindClusterWithName loads a local docker image to the kind cluster`
`196`	`197`	`func LoadImageToKindClusterWithName(name string) error {`
`197`		`- cluster := "kind"`
	`198`	`+ cluster := "{{ .ProjectName }}-e2e-test"`
`198`	`199`	`if v, ok := os.LookupEnv("KIND_CLUSTER"); ok {`
`199`	`200`	`cluster = v`
`200`	`201`	`}`