Merge pull request #4162 from camilamacedo86/fix-multigroup

k8s-ci-robot · web-flow · commit 29a22d1acaa6 · 2024-09-13T09:49:14.000+01:00
🐛 fix: ensure unique controller names to fix name conflicts in multigroup setup
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go b/docs/book/src/cronjob-tutorial/testdata/project/internal/controller/cronjob_controller.go
@@ -574,5 +574,6 @@ func (r *CronJobReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&batchv1.CronJob{}).
 		Owns(&kbatch.Job{}).
+		Named("cronjob").
 		Complete(r)
 }
diff --git a/docs/book/src/getting-started/testdata/project/internal/controller/memcached_controller.go b/docs/book/src/getting-started/testdata/project/internal/controller/memcached_controller.go
@@ -205,6 +205,7 @@ func (r *MemcachedReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&cachev1alpha1.Memcached{}).
 		Owns(&appsv1.Deployment{}).
+		Named("memcached").
 		Complete(r)
 }
 
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/internal/controller/cronjob_controller.go b/docs/book/src/multiversion-tutorial/testdata/project/internal/controller/cronjob_controller.go
@@ -574,5 +574,6 @@ func (r *CronJobReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&batchv1.CronJob{}).
 		Owns(&kbatch.Job{}).
+		Named("cronjob").
 		Complete(r)
 }
diff --git a/pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/internal/templates/controllers/controller.go b/pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/internal/templates/controllers/controller.go
@@ -478,6 +478,11 @@ func (r *{{ .Resource.Kind }}Reconciler) SetupWithManager(mgr ctrl.Manager) erro
 		// Uncomment the following line adding a pointer to an instance of the controlled resource as an argument
 		// For().
 		{{- end }}
+		{{- if and (.MultiGroup) (not (isEmptyStr .Resource.Group)) }}
+		Named("{{ lower .Resource.Group }}-{{ lower .Resource.Kind }}").
+		{{- else }}
+		Named("{{ lower .Resource.Kind }}").
+		{{- end }}
 		// Watch the Deployment managed by the {{ .Resource.Kind }}Reconciler. If any changes occur to the Deployment
 		// owned and managed by this controller, it will trigger reconciliation, ensuring that the cluster
 		// state aligns with the desired state. See that the ownerRef was set when the Deployment was created.
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/controllers/controller.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/controllers/controller.go
@@ -115,6 +115,11 @@ func (r *{{ .Resource.Kind }}Reconciler) SetupWithManager(mgr ctrl.Manager) erro
 		// Uncomment the following line adding a pointer to an instance of the controlled resource as an argument
 		// For().
 		{{- end }}
+		{{- if and (.MultiGroup) (not (isEmptyStr .Resource.Group)) }}
+		Named("{{ lower .Resource.Group }}-{{ lower .Resource.Kind }}").
+		{{- else }}
+		Named("{{ lower .Resource.Kind }}").
+		{{- end }}
 		Complete(r)
 }
 `
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/apps/deployment_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/apps/deployment_controller.go
@@ -57,5 +57,6 @@ func (r *DeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 func (r *DeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&appsv1.Deployment{}).
+		Named("apps-deployment").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/crew/captain_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/crew/captain_controller.go
@@ -58,5 +58,6 @@ func (r *CaptainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 func (r *CaptainReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&crewv1.Captain{}).
+		Named("crew-captain").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/example.com/busybox_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/example.com/busybox_controller.go
@@ -434,6 +434,7 @@ func (r *BusyboxReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		// Watch the Busybox CR(s) and trigger reconciliation whenever it
 		// is created, updated, or deleted
 		For(&examplecomv1alpha1.Busybox{}).
+		Named("example.com-busybox").
 		// Watch the Deployment managed by the BusyboxReconciler. If any changes occur to the Deployment
 		// owned and managed by this controller, it will trigger reconciliation, ensuring that the cluster
 		// state aligns with the desired state. See that the ownerRef was set when the Deployment was created.
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/example.com/memcached_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/example.com/memcached_controller.go
@@ -440,6 +440,7 @@ func (r *MemcachedReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		// Watch the Memcached CR(s) and trigger reconciliation whenever it
 		// is created, updated, or deleted
 		For(&examplecomv1alpha1.Memcached{}).
+		Named("example.com-memcached").
 		// Watch the Deployment managed by the MemcachedReconciler. If any changes occur to the Deployment
 		// owned and managed by this controller, it will trigger reconciliation, ensuring that the cluster
 		// state aligns with the desired state. See that the ownerRef was set when the Deployment was created.
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/fiz/bar_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/fiz/bar_controller.go
@@ -58,5 +58,6 @@ func (r *BarReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 func (r *BarReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&fizv1.Bar{}).
+		Named("fiz-bar").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/foo.policy/healthcheckpolicy_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/foo.policy/healthcheckpolicy_controller.go
@@ -58,5 +58,6 @@ func (r *HealthCheckPolicyReconciler) Reconcile(ctx context.Context, req ctrl.Re
 func (r *HealthCheckPolicyReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&foopolicyv1.HealthCheckPolicy{}).
+		Named("foo.policy-healthcheckpolicy").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/foo/bar_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/foo/bar_controller.go
@@ -58,5 +58,6 @@ func (r *BarReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 func (r *BarReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&foov1.Bar{}).
+		Named("foo-bar").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/sea-creatures/kraken_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/sea-creatures/kraken_controller.go
@@ -58,5 +58,6 @@ func (r *KrakenReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
 func (r *KrakenReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&seacreaturesv1beta1.Kraken{}).
+		Named("sea-creatures-kraken").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/sea-creatures/leviathan_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/sea-creatures/leviathan_controller.go
@@ -58,5 +58,6 @@ func (r *LeviathanReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 func (r *LeviathanReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&seacreaturesv1beta2.Leviathan{}).
+		Named("sea-creatures-leviathan").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/ship/cruiser_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/ship/cruiser_controller.go
@@ -58,5 +58,6 @@ func (r *CruiserReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 func (r *CruiserReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&shipv2alpha1.Cruiser{}).
+		Named("ship-cruiser").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/ship/destroyer_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/ship/destroyer_controller.go
@@ -58,5 +58,6 @@ func (r *DestroyerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 func (r *DestroyerReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&shipv1.Destroyer{}).
+		Named("ship-destroyer").
 		Complete(r)
 }
diff --git a/testdata/project-v4-multigroup-with-plugins/internal/controller/ship/frigate_controller.go b/testdata/project-v4-multigroup-with-plugins/internal/controller/ship/frigate_controller.go
@@ -58,5 +58,6 @@ func (r *FrigateReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 func (r *FrigateReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&shipv1beta1.Frigate{}).
+		Named("ship-frigate").
 		Complete(r)
 }
diff --git a/testdata/project-v4-with-plugins/internal/controller/busybox_controller.go b/testdata/project-v4-with-plugins/internal/controller/busybox_controller.go
@@ -434,6 +434,7 @@ func (r *BusyboxReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		// Watch the Busybox CR(s) and trigger reconciliation whenever it
 		// is created, updated, or deleted
 		For(&examplecomv1alpha1.Busybox{}).
+		Named("busybox").
 		// Watch the Deployment managed by the BusyboxReconciler. If any changes occur to the Deployment
 		// owned and managed by this controller, it will trigger reconciliation, ensuring that the cluster
 		// state aligns with the desired state. See that the ownerRef was set when the Deployment was created.
diff --git a/testdata/project-v4-with-plugins/internal/controller/memcached_controller.go b/testdata/project-v4-with-plugins/internal/controller/memcached_controller.go
@@ -440,6 +440,7 @@ func (r *MemcachedReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		// Watch the Memcached CR(s) and trigger reconciliation whenever it
 		// is created, updated, or deleted
 		For(&examplecomv1alpha1.Memcached{}).
+		Named("memcached").
 		// Watch the Deployment managed by the MemcachedReconciler. If any changes occur to the Deployment
 		// owned and managed by this controller, it will trigger reconciliation, ensuring that the cluster
 		// state aligns with the desired state. See that the ownerRef was set when the Deployment was created.
diff --git a/testdata/project-v4/internal/controller/admiral_controller.go b/testdata/project-v4/internal/controller/admiral_controller.go
@@ -58,5 +58,6 @@ func (r *AdmiralReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 func (r *AdmiralReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&crewv1.Admiral{}).
+		Named("admiral").
 		Complete(r)
 }
diff --git a/testdata/project-v4/internal/controller/captain_controller.go b/testdata/project-v4/internal/controller/captain_controller.go
@@ -58,5 +58,6 @@ func (r *CaptainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 func (r *CaptainReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&crewv1.Captain{}).
+		Named("captain").
 		Complete(r)
 }
diff --git a/testdata/project-v4/internal/controller/firstmate_controller.go b/testdata/project-v4/internal/controller/firstmate_controller.go
@@ -58,5 +58,6 @@ func (r *FirstMateReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 func (r *FirstMateReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&crewv1.FirstMate{}).
+		Named("firstmate").
 		Complete(r)
 }

Original file line number	Diff line number	Diff line change
`@@ -574,5 +574,6 @@ func (r *CronJobReconciler) SetupWithManager(mgr ctrl.Manager) error {`
`574`	`574`	`return ctrl.NewControllerManagedBy(mgr).`
`575`	`575`	`For(&batchv1.CronJob{}).`
`576`	`576`	`Owns(&kbatch.Job{}).`
	`577`	`+ Named("cronjob").`
`577`	`578`	`Complete(r)`
`578`	`579`	`}`
Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,7 @@ func (r *MemcachedReconciler) SetupWithManager(mgr ctrl.Manager) error {`
`205`	`205`	`return ctrl.NewControllerManagedBy(mgr).`
`206`	`206`	`For(&cachev1alpha1.Memcached{}).`
`207`	`207`	`Owns(&appsv1.Deployment{}).`
	`208`	`+ Named("memcached").`
`208`	`209`	`Complete(r)`
`209`	`210`	`}`
`210`	`211`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,11 @@ func (r *{{ .Resource.Kind }}Reconciler) SetupWithManager(mgr ctrl.Manager) erro`
`115`	`115`	`// Uncomment the following line adding a pointer to an instance of the controlled resource as an argument`
`116`	`116`	`// For().`
`117`	`117`	`{{- end }}`
	`118`	`+ {{- if and (.MultiGroup) (not (isEmptyStr .Resource.Group)) }}`
	`119`	`+ Named("{{ lower .Resource.Group }}-{{ lower .Resource.Kind }}").`
	`120`	`+ {{- else }}`
	`121`	`+ Named("{{ lower .Resource.Kind }}").`
	`122`	`+ {{- end }}`
`118`	`123`	`Complete(r)`
`119`	`124`	`}`
`120`	`125`	`
Original file line number	Diff line number	Diff line change
`@@ -57,5 +57,6 @@ func (r *DeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Request)`
`57`	`57`	`func (r *DeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error {`
`58`	`58`	`return ctrl.NewControllerManagedBy(mgr).`
`59`	`59`	`For(&appsv1.Deployment{}).`
	`60`	`+ Named("apps-deployment").`
`60`	`61`	`Complete(r)`
`61`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,5 +58,6 @@ func (r *CaptainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct`
`58`	`58`	`func (r *CaptainReconciler) SetupWithManager(mgr ctrl.Manager) error {`
`59`	`59`	`return ctrl.NewControllerManagedBy(mgr).`
`60`	`60`	`For(&crewv1.Captain{}).`
	`61`	`+ Named("crew-captain").`
`61`	`62`	`Complete(r)`
`62`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,5 +58,6 @@ func (r *BarReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R`
`58`	`58`	`func (r *BarReconciler) SetupWithManager(mgr ctrl.Manager) error {`
`59`	`59`	`return ctrl.NewControllerManagedBy(mgr).`
`60`	`60`	`For(&fizv1.Bar{}).`
	`61`	`+ Named("fiz-bar").`
`61`	`62`	`Complete(r)`
`62`	`63`	`}`