Merge pull request #4781 from dongjiang1989/fix-aliasing-import

k8s-ci-robot · web-flow · commit 258b9c65ecd8 · 2025-04-11T02:54:42.000-07:00
🐛Fix: Incorrect Webhook Import Aliasing in cmd/main.go Scaffold
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml b/docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml
@@ -36,9 +36,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/cmd/main.go b/docs/book/src/cronjob-tutorial/testdata/project/cmd/main.go
@@ -40,7 +40,7 @@ import (
 
 	batchv1 "tutorial.kubebuilder.io/project/api/v1"
 	"tutorial.kubebuilder.io/project/internal/controller"
-	webhookbatchv1 "tutorial.kubebuilder.io/project/internal/webhook/v1"
+	webhookv1 "tutorial.kubebuilder.io/project/internal/webhook/v1"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -242,7 +242,7 @@ func main() {
 	*/
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookbatchv1.SetupCronJobWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupCronJobWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
 			os.Exit(1)
 		}
diff --git a/docs/book/src/getting-started/testdata/project/.golangci.yml b/docs/book/src/getting-started/testdata/project/.golangci.yml
@@ -36,9 +36,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/.golangci.yml b/docs/book/src/multiversion-tutorial/testdata/project/.golangci.yml
@@ -36,9 +36,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/cmd/main.go b/docs/book/src/multiversion-tutorial/testdata/project/cmd/main.go
@@ -42,8 +42,8 @@ import (
 	batchv1 "tutorial.kubebuilder.io/project/api/v1"
 	batchv2 "tutorial.kubebuilder.io/project/api/v2"
 	"tutorial.kubebuilder.io/project/internal/controller"
-	webhookbatchv1 "tutorial.kubebuilder.io/project/internal/webhook/v1"
-	webhookbatchv2 "tutorial.kubebuilder.io/project/internal/webhook/v2"
+	webhookv1 "tutorial.kubebuilder.io/project/internal/webhook/v1"
+	webhookv2 "tutorial.kubebuilder.io/project/internal/webhook/v2"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -235,14 +235,14 @@ func main() {
 	*/
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookbatchv1.SetupCronJobWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupCronJobWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
 			os.Exit(1)
 		}
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookbatchv2.SetupCronJobWebhookWithManager(mgr); err != nil {
+		if err := webhookv2.SetupCronJobWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
 			os.Exit(1)
 		}
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/cmd/main.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/cmd/main.go
@@ -158,10 +158,11 @@ func (f *MainUpdater) GetCodeFragments() machinery.CodeFragmentsMap {
 		imports = append(imports, fmt.Sprintf(apiImportCodeFragment, f.Resource.ImportAlias(), f.Resource.Path))
 	}
 	if f.WireWebhook && !f.IsLegacyPath {
-		importPath := fmt.Sprintf("webhook%s", f.Resource.ImportAlias())
 		if !f.MultiGroup || f.Resource.Group == "" {
+			importPath := fmt.Sprintf("webhook%s", f.Resource.Version)
 			imports = append(imports, fmt.Sprintf(webhookImportCodeFragment, importPath, f.Repo, f.Resource.Version))
 		} else {
+			importPath := fmt.Sprintf("webhook%s", f.Resource.ImportAlias())
 			imports = append(imports, fmt.Sprintf(multiGroupWebhookImportCodeFragment, importPath,
 				f.Repo, f.Resource.Group, f.Resource.Version))
 		}
@@ -198,8 +199,13 @@ func (f *MainUpdater) GetCodeFragments() machinery.CodeFragmentsMap {
 			setup = append(setup, fmt.Sprintf(webhookSetupCodeFragmentLegacy,
 				f.Resource.ImportAlias(), f.Resource.Kind, f.Resource.Kind))
 		} else {
-			setup = append(setup, fmt.Sprintf(webhookSetupCodeFragment,
-				"webhook"+f.Resource.ImportAlias(), f.Resource.Kind, f.Resource.Kind))
+			if !f.MultiGroup || f.Resource.Group == "" {
+				setup = append(setup, fmt.Sprintf(webhookSetupCodeFragment,
+					"webhook"+f.Resource.Version, f.Resource.Kind, f.Resource.Kind))
+			} else {
+				setup = append(setup, fmt.Sprintf(webhookSetupCodeFragment,
+					"webhook"+f.Resource.ImportAlias(), f.Resource.Kind, f.Resource.Kind))
+			}
 		}
 	}
 
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go
@@ -79,9 +79,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4-multigroup/.golangci.yml b/testdata/project-v4-multigroup/.golangci.yml
@@ -36,9 +36,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4-with-plugins/.golangci.yml b/testdata/project-v4-with-plugins/.golangci.yml
@@ -36,9 +36,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4-with-plugins/cmd/main.go b/testdata/project-v4-with-plugins/cmd/main.go
@@ -41,8 +41,8 @@ import (
 	examplecomv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/api/v1alpha1"
 	examplecomv2 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/api/v2"
 	"sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/controller"
-	webhookexamplecomv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1"
-	webhookexamplecomv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1alpha1"
+	webhookv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1"
+	webhookv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1alpha1"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -226,7 +226,7 @@ func main() {
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookexamplecomv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {
+		if err := webhookv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Memcached")
 			os.Exit(1)
 		}
@@ -240,7 +240,7 @@ func main() {
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookexamplecomv1.SetupWordpressWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupWordpressWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Wordpress")
 			os.Exit(1)
 		}
diff --git a/testdata/project-v4/.golangci.yml b/testdata/project-v4/.golangci.yml
@@ -36,9 +36,6 @@ linters:
           - dupl
           - lll
         path: internal/*
-      - linters:
-          - staticcheck
-        text: "ST1019"
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4/cmd/main.go b/testdata/project-v4/cmd/main.go
@@ -42,10 +42,7 @@ import (
 	crewv1 "sigs.k8s.io/kubebuilder/testdata/project-v4/api/v1"
 	crewv2 "sigs.k8s.io/kubebuilder/testdata/project-v4/api/v2"
 	"sigs.k8s.io/kubebuilder/testdata/project-v4/internal/controller"
-	webhookappsv1 "sigs.k8s.io/kubebuilder/testdata/project-v4/internal/webhook/v1"
-	webhookcertmanagerv1 "sigs.k8s.io/kubebuilder/testdata/project-v4/internal/webhook/v1"
-	webhookcorev1 "sigs.k8s.io/kubebuilder/testdata/project-v4/internal/webhook/v1"
-	webhookcrewv1 "sigs.k8s.io/kubebuilder/testdata/project-v4/internal/webhook/v1"
+	webhookv1 "sigs.k8s.io/kubebuilder/testdata/project-v4/internal/webhook/v1"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -220,7 +217,7 @@ func main() {
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookcrewv1.SetupCaptainWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupCaptainWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Captain")
 			os.Exit(1)
 		}
@@ -234,7 +231,7 @@ func main() {
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookcrewv1.SetupFirstMateWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupFirstMateWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "FirstMate")
 			os.Exit(1)
 		}
@@ -248,7 +245,7 @@ func main() {
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookcrewv1.SetupAdmiralWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupAdmiralWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Admiral")
 			os.Exit(1)
 		}
@@ -262,21 +259,21 @@ func main() {
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookcertmanagerv1.SetupIssuerWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupIssuerWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Issuer")
 			os.Exit(1)
 		}
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookcorev1.SetupPodWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupPodWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Pod")
 			os.Exit(1)
 		}
 	}
 	// nolint:goconst
 	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
-		if err := webhookappsv1.SetupDeploymentWebhookWithManager(mgr); err != nil {
+		if err := webhookv1.SetupDeploymentWebhookWithManager(mgr); err != nil {
 			setupLog.Error(err, "unable to create webhook", "webhook", "Deployment")
 			os.Exit(1)
 		}

Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,8 @@ import (`
`41`	`41`	`examplecomv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/api/v1alpha1"`
`42`	`42`	`examplecomv2 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/api/v2"`
`43`	`43`	`"sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/controller"`
`44`		`- webhookexamplecomv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1"`
`45`		`- webhookexamplecomv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1alpha1"`
	`44`	`+ webhookv1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1"`
	`45`	`+ webhookv1alpha1 "sigs.k8s.io/kubebuilder/testdata/project-v4-with-plugins/internal/webhook/v1alpha1"`
`46`	`46`	`// +kubebuilder:scaffold:imports`
`47`	`47`	`)`
`48`	`48`
`@@ -226,7 +226,7 @@ func main() {`
`226`	`226`	`}`
`227`	`227`	`// nolint:goconst`
`228`	`228`	`if os.Getenv("ENABLE_WEBHOOKS") != "false" {`
`229`		`- if err := webhookexamplecomv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {`
	`229`	`+ if err := webhookv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {`
`230`	`230`	`setupLog.Error(err, "unable to create webhook", "webhook", "Memcached")`
`231`	`231`	`os.Exit(1)`
`232`	`232`	`}`
`@@ -240,7 +240,7 @@ func main() {`
`240`	`240`	`}`
`241`	`241`	`// nolint:goconst`
`242`	`242`	`if os.Getenv("ENABLE_WEBHOOKS") != "false" {`
`243`		`- if err := webhookexamplecomv1.SetupWordpressWebhookWithManager(mgr); err != nil {`
	`243`	`+ if err := webhookv1.SetupWordpressWebhookWithManager(mgr); err != nil {`
`244`	`244`	`setupLog.Error(err, "unable to create webhook", "webhook", "Wordpress")`
`245`	`245`	`os.Exit(1)`
`246`	`246`	`}`