Merge pull request kubernetes-sigs#4154 from camilamacedo86/enhance-ci

🌱 ci:  add e2e tests for multigroup testdata layout and rename sample

.github/workflows/test-e2e-samples.yml

@@ -1,17 +1,20 @@
-name: Testing E2E Sample
+name: E2E Testdata Sample
 
 on:
   push:
-    paths-ignore:
-      - '**/*.md'
+    paths:
+      - 'testdata/**'
+      - '.github/workflows/test-e2e-samples.yml'
   pull_request:
-    paths-ignore:
-      - '**/*.md'
+    paths:
+      - 'testdata/**'
+      - '.github/workflows/test-e2e-samples.yml'
 
 jobs:
-  e2e-tests:
+  e2e-tests-project-v4:
     runs-on: ubuntu-latest
-    # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
+    strategy:
+      fail-fast: true
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     steps:
       - name: Checkout repository
@@ -48,8 +51,28 @@ jobs:
         run: |
           make test-e2e
 
-      - name: Teardown kind cluster
-        run: kind delete cluster
+  e2e-tests-project-v4-with-plugins:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '~1.22'
+
+      - name: Install the latest version of kind
+        run: |
+          curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64
+          chmod +x ./kind
+          sudo mv ./kind /usr/local/bin/kind
+
+      - name: Verify kind installation
+        run: kind version
 
       - name: Create kind cluster
         run: kind create cluster
@@ -62,7 +85,6 @@ jobs:
           # Uncomment only ValidatingWebhookConfiguration
           # from cert-manager replaces
           sed -i '55,70s/^#//' $KUSTOMIZATION_FILE_PATH
-          sed -i '55,70s/^#//' $KUSTOMIZATION_FILE_PATH
           sed -i '79,101s/^#//' $KUSTOMIZATION_FILE_PATH
           sed -i '110,151s/^#//' $KUSTOMIZATION_FILE_PATH
           # Comment the injection for MutatingWebhookConfiguration
@@ -74,6 +96,46 @@ jobs:
           go mod tidy
 
       - name: Testing make test-e2e for project-v4-with-plugins
-        working-directory: testdata/project-v4-with-plugins
+        working-directory: testdata/project-v4-with-plugins/
         run: |
           make test-e2e
+
+  e2e-tests-project-v4-multigroup:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '~1.22'
+
+      - name: Install the latest version of kind
+        run: |
+          curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64
+          chmod +x ./kind
+          sudo mv ./kind /usr/local/bin/kind
+
+      - name: Verify kind installation
+        run: kind version
+
+      - name: Create kind cluster
+        run: kind create cluster
+
+      - name: Prepare project-v4-multigroup
+        run: |
+          KUSTOMIZATION_FILE_PATH="testdata/project-v4-multigroup/config/default/kustomization.yaml"
+          sed -i '25s/^#//' $KUSTOMIZATION_FILE_PATH
+          sed -i '51s/^#//' $KUSTOMIZATION_FILE_PATH
+          sed -i '55,151s/^#//' $KUSTOMIZATION_FILE_PATH
+          cd testdata/project-v4-multigroup
+          go mod tidy
+
+      - name: Testing make test-e2e for project-v4-multigroup
+        working-directory: testdata/project-v4-multigroup/
+        run: |
+          make test-e2e          

test/testdata/generate.sh

@@ -80,7 +80,9 @@ function scaffold_test_project {
     $kb edit --plugins=grafana.kubebuilder.io/v1-alpha
   fi
 
+  make all
   make build-installer
+  # To avoid conflicts
   rm -f go.sum
   go mod tidy
   popd
@@ -89,5 +91,5 @@ function scaffold_test_project {
 build_kb
 
 scaffold_test_project project-v4 --plugins="go/v4"
-scaffold_test_project project-v4-multigroup-with-plugins --plugins="go/v4"
+scaffold_test_project project-v4-multigroup --plugins="go/v4"
 scaffold_test_project project-v4-with-plugins --plugins="go/v4"

test/testdata/test.sh

@@ -32,5 +32,5 @@ build_kb
 
 # Project version v4-alpha
 test_project project-v4
-test_project project-v4-multigroup-with-plugins
+test_project project-v4-multigroup
 test_project project-v4-with-plugins

testdata/project-v4-multigroup-with-plugins/Makefile → testdata/project-v4-multigroup/Makefile

@@ -120,10 +120,10 @@ PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 docker-buildx: ## Build and push docker image for the manager for cross-platform support
 	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
-	- $(CONTAINER_TOOL) buildx create --name project-v4-multigroup-with-plugins-builder
-	$(CONTAINER_TOOL) buildx use project-v4-multigroup-with-plugins-builder
+	- $(CONTAINER_TOOL) buildx create --name project-v4-multigroup-builder
+	$(CONTAINER_TOOL) buildx use project-v4-multigroup-builder
 	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
-	- $(CONTAINER_TOOL) buildx rm project-v4-multigroup-with-plugins-builder
+	- $(CONTAINER_TOOL) buildx rm project-v4-multigroup-builder
 	rm Dockerfile.cross
 
 .PHONY: build-installer

testdata/project-v4-multigroup-with-plugins/PROJECT → testdata/project-v4-multigroup/PROJECT

@@ -25,8 +25,8 @@ plugins:
         image: busybox:1.36.1
       version: v1alpha1
   grafana.kubebuilder.io/v1-alpha: {}
-projectName: project-v4-multigroup-with-plugins
-repo: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins
+projectName: project-v4-multigroup
+repo: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup
 resources:
 - api:
     crdVersion: v1
@@ -35,7 +35,7 @@ resources:
   domain: testproject.org
   group: crew
   kind: Captain
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/crew/v1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/crew/v1
   version: v1
   webhooks:
     defaulting: true
@@ -48,7 +48,7 @@ resources:
   domain: testproject.org
   group: ship
   kind: Frigate
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/ship/v1beta1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/ship/v1beta1
   version: v1beta1
   webhooks:
     conversion: true
@@ -59,7 +59,7 @@ resources:
   domain: testproject.org
   group: ship
   kind: Destroyer
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/ship/v1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/ship/v1
   version: v1
   webhooks:
     defaulting: true
@@ -70,7 +70,7 @@ resources:
   domain: testproject.org
   group: ship
   kind: Cruiser
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/ship/v2alpha1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/ship/v2alpha1
   version: v2alpha1
   webhooks:
     validation: true
@@ -82,7 +82,7 @@ resources:
   domain: testproject.org
   group: sea-creatures
   kind: Kraken
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/sea-creatures/v1beta1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/sea-creatures/v1beta1
   version: v1beta1
 - api:
     crdVersion: v1
@@ -91,7 +91,7 @@ resources:
   domain: testproject.org
   group: sea-creatures
   kind: Leviathan
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/sea-creatures/v1beta2
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/sea-creatures/v1beta2
   version: v1beta2
 - api:
     crdVersion: v1
@@ -100,7 +100,7 @@ resources:
   domain: testproject.org
   group: foo.policy
   kind: HealthCheckPolicy
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/foo.policy/v1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/foo.policy/v1
   version: v1
 - controller: true
   group: apps
@@ -114,7 +114,7 @@ resources:
   domain: testproject.org
   group: foo
   kind: Bar
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/foo/v1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/foo/v1
   version: v1
 - api:
     crdVersion: v1
@@ -123,7 +123,7 @@ resources:
   domain: testproject.org
   group: fiz
   kind: Bar
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/fiz/v1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/fiz/v1
   version: v1
 - api:
     crdVersion: v1
@@ -132,7 +132,7 @@ resources:
   domain: testproject.org
   group: example.com
   kind: Memcached
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/example.com/v1alpha1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/example.com/v1alpha1
   version: v1alpha1
   webhooks:
     validation: true
@@ -144,6 +144,6 @@ resources:
   domain: testproject.org
   group: example.com
   kind: Busybox
-  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/example.com/v1alpha1
+  path: sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/example.com/v1alpha1
   version: v1alpha1
 version: "3"

testdata/project-v4-multigroup-with-plugins/README.md → testdata/project-v4-multigroup/README.md

@@ -1,4 +1,4 @@
-# project-v4-multigroup-with-plugins
+# project-v4-multigroup
 // TODO(user): Add simple overview of use/purpose
 
 ## Description
@@ -16,7 +16,7 @@
 **Build and push your image to the location specified by `IMG`:**
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/project-v4-multigroup-with-plugins:tag
+make docker-build docker-push IMG=<some-registry>/project-v4-multigroup:tag
 ```
 
 **NOTE:** This image ought to be published in the personal registry you specified.
@@ -32,7 +32,7 @@ make install
 **Deploy the Manager to the cluster with the image specified by `IMG`:**
 
 ```sh
-make deploy IMG=<some-registry>/project-v4-multigroup-with-plugins:tag
+make deploy IMG=<some-registry>/project-v4-multigroup:tag
 ```
 
 > **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
@@ -73,7 +73,7 @@ Following are the steps to build the installer and distribute this project to us
 1. Build the installer for the image built and published in the registry:
 
 ```sh
-make build-installer IMG=<some-registry>/project-v4-multigroup-with-plugins:tag
+make build-installer IMG=<some-registry>/project-v4-multigroup:tag
 ```
 
 NOTE: The makefile target mentioned above generates an 'install.yaml'
@@ -86,7 +86,7 @@ its dependencies.
 Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
 
 ```sh
-kubectl apply -f https://raw.githubusercontent.com/<org>/project-v4-multigroup-with-plugins/<tag or branch>/dist/install.yaml
+kubectl apply -f https://raw.githubusercontent.com/<org>/project-v4-multigroup/<tag or branch>/dist/install.yaml
 ```
 
 ## Contributing

testdata/project-v4-multigroup-with-plugins/cmd/main.go → testdata/project-v4-multigroup/cmd/main.go

@@ -35,24 +35,24 @@ import (
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
-	crewv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/crew/v1"
-	examplecomv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/example.com/v1alpha1"
-	fizv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/fiz/v1"
-	foopolicyv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/foo.policy/v1"
-	foov1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/foo/v1"
-	seacreaturesv1beta1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/sea-creatures/v1beta1"
-	seacreaturesv1beta2 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/sea-creatures/v1beta2"
-	shipv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/ship/v1"
-	shipv1beta1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/ship/v1beta1"
-	shipv2alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/api/ship/v2alpha1"
-	appscontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/apps"
-	crewcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/crew"
-	examplecomcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/example.com"
-	fizcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/fiz"
-	foocontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/foo"
-	foopolicycontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/foo.policy"
-	seacreaturescontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/sea-creatures"
-	shipcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup-with-plugins/internal/controller/ship"
+	crewv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/crew/v1"
+	examplecomv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/example.com/v1alpha1"
+	fizv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/fiz/v1"
+	foopolicyv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/foo.policy/v1"
+	foov1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/foo/v1"
+	seacreaturesv1beta1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/sea-creatures/v1beta1"
+	seacreaturesv1beta2 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/sea-creatures/v1beta2"
+	shipv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/ship/v1"
+	shipv1beta1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/ship/v1beta1"
+	shipv2alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/api/ship/v2alpha1"
+	appscontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/apps"
+	crewcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/crew"
+	examplecomcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/example.com"
+	fizcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/fiz"
+	foocontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/foo"
+	foopolicycontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/foo.policy"
+	seacreaturescontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/sea-creatures"
+	shipcontroller "sigs.k8s.io/kubebuilder/testdata/project-v4-multigroup/internal/controller/ship"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -151,7 +151,7 @@ func main() {
 		WebhookServer:          webhookServer,
 		HealthProbeBindAddress: probeAddr,
 		LeaderElection:         enableLeaderElection,
-		LeaderElectionID:       "f0637429.testproject.org",
+		LeaderElectionID:       "3e9f67a9.testproject.org",
 		// LeaderElectionReleaseOnCancel defines if the leader should step down voluntarily
 		// when the Manager ends. This requires the binary to immediately end when the
 		// Manager is stopped, otherwise, this setting is unsafe. Setting this significantly

testdata/project-v4-multigroup-with-plugins/config/certmanager/certificate.yaml → testdata/project-v4-multigroup/config/certmanager/certificate.yaml

@@ -5,7 +5,7 @@ apiVersion: cert-manager.io/v1
 kind: Issuer
 metadata:
   labels:
-    app.kubernetes.io/name: project-v4-multigroup-with-plugins
+    app.kubernetes.io/name: project-v4-multigroup
     app.kubernetes.io/managed-by: kustomize
   name: selfsigned-issuer
   namespace: system
@@ -19,8 +19,8 @@ metadata:
     app.kubernetes.io/name: certificate
     app.kubernetes.io/instance: serving-cert
     app.kubernetes.io/component: certificate
-    app.kubernetes.io/created-by: project-v4-multigroup-with-plugins
-    app.kubernetes.io/part-of: project-v4-multigroup-with-plugins
+    app.kubernetes.io/created-by: project-v4-multigroup
+    app.kubernetes.io/part-of: project-v4-multigroup
     app.kubernetes.io/managed-by: kustomize
   name: serving-cert  # this name should match the one appeared in kustomizeconfig.yaml
   namespace: system

testdata/project-v4-multigroup-with-plugins/config/default/kustomization.yaml → testdata/project-v4-multigroup/config/default/kustomization.yaml

@@ -1,12 +1,12 @@
 # Adds namespace to all resources.
-namespace: project-v4-multigroup-with-plugins-system
+namespace: project-v4-multigroup-system
 
 # Value of this field is prepended to the
 # names of all resources, e.g. a deployment named
 # "wordpress" becomes "alices-wordpress".
 # Note that it should also match with the prefix (text before '-') of the namespace
 # field above.
-namePrefix: project-v4-multigroup-with-plugins-
+namePrefix: project-v4-multigroup-
 
 # Labels to add to all resources and selectors.
 #labels:

testdata/project-v4-multigroup-with-plugins/config/default/manager_webhook_patch.yaml → testdata/project-v4-multigroup/config/default/manager_webhook_patch.yaml

@@ -4,7 +4,7 @@ metadata:
   name: controller-manager
   namespace: system
   labels:
-    app.kubernetes.io/name: project-v4-multigroup-with-plugins
+    app.kubernetes.io/name: project-v4-multigroup
     app.kubernetes.io/managed-by: kustomize
 spec:
   template: