Add --plural flag (go/v3)

Adds the flags and the required marker to the types file.

Signed-off-by: Adrian Orive Oneca <[email protected]>

generate_testdata.sh

@@ -59,31 +59,47 @@ scaffold_test_project() {
     $kb create api --group crew --version v1 --kind Captain --controller=true --resource=true --make=false
     $kb create api --group crew --version v1 --kind Captain --controller=true --resource=true --make=false --force
     $kb create webhook --group crew --version v1 --kind Captain --defaulting --programmatic-validation
+    if [ $project == "project-v3" ]; then
+      $kb create webhook --group crew --version v1 --kind Captain --defaulting --programmatic-validation --force
+    fi
+
     $kb create api --group crew --version v1 --kind FirstMate --controller=true --resource=true --make=false
     $kb create webhook --group crew --version v1 --kind FirstMate --conversion
-    $kb create api --group crew --version v1 --kind Admiral --controller=true --resource=true --namespaced=false --make=false
-    $kb create webhook --group crew --version v1 --kind Admiral --defaulting
-    $kb create api --group crew --version v1 --kind Laker --controller=true --resource=false --make=false
+
     if [ $project == "project-v3" ]; then
-      $kb create webhook --group crew --version v1 --kind Captain --defaulting --programmatic-validation --force
+      $kb create api --group crew --version v1 --kind Admiral --plural=admirales --controller=true --resource=true --namespaced=false --make=false
+      $kb create webhook --group crew --version v1 --kind Admiral --plural=admirales --defaulting
+    else
+      $kb create api --group crew --version v1 --kind Admiral --controller=true --resource=true --namespaced=false --make=false
+      $kb create webhook --group crew --version v1 --kind Admiral --defaulting
     fi
+
+    $kb create api --group crew --version v1 --kind Laker --controller=true --resource=false --make=false
   elif [[ $project =~ multigroup ]]; then
     header_text 'Switching to multigroup layout ...'
     $kb edit --multigroup=true
 
     header_text 'Creating APIs ...'
     $kb create api --group crew --version v1 --kind Captain --controller=true --resource=true --make=false
     $kb create webhook --group crew --version v1 --kind Captain --defaulting --programmatic-validation
+
     $kb create api --group ship --version v1beta1 --kind Frigate --controller=true --resource=true --make=false
     $kb create webhook --group ship --version v1beta1 --kind Frigate --conversion
+
     $kb create api --group ship --version v1 --kind Destroyer --controller=true --resource=true --namespaced=false --make=false
     $kb create webhook --group ship --version v1 --kind Destroyer --defaulting
+
     $kb create api --group ship --version v2alpha1 --kind Cruiser --controller=true --resource=true --namespaced=false --make=false
     $kb create webhook --group ship --version v2alpha1 --kind Cruiser --programmatic-validation
+
     $kb create api --group sea-creatures --version v1beta1 --kind Kraken --controller=true --resource=true --make=false
+
     $kb create api --group sea-creatures --version v1beta2 --kind Leviathan --controller=true --resource=true --make=false
+
     $kb create api --group foo.policy --version v1 --kind HealthCheckPolicy --controller=true --resource=true --make=false
+
     $kb create api --group apps --version v1 --kind Pod --controller=true --resource=false --make=false
+
     if [ $project == "project-v3-multigroup" ]; then
       $kb create api --version v1 --kind Lakers --controller=true --resource=true --make=false
       $kb create webhook --version v1 --kind Lakers --defaulting --programmatic-validation

pkg/model/resource/resource.go

@@ -85,6 +85,11 @@ func (r Resource) HasConversionWebhook() bool {
 	return r.Webhooks != nil && r.Webhooks.Conversion
 }
 
+// IsRegularPlural returns true if the plural is the regular plural form for the kind.
+func (r Resource) IsRegularPlural() bool {
+	return r.Plural == RegularPlural(r.Kind)
+}
+
 // Copy returns a deep copy of the Resource that can be safely modified without affecting the original.
 func (r Resource) Copy() Resource {
 	// As this function doesn't use a pointer receiver, r is already a shallow copy.
@@ -112,9 +117,13 @@ func (r *Resource) Update(other Resource) error {
 		return fmt.Errorf("unable to update a Resource with another with non-matching GVK")
 	}
 
-	// TODO: currently Plural & Path will always match. In the future, this may not be true (e.g. providing a
-	//       --plural flag). In that case, we should yield an error in case of updating two resources with different
-	//       values for these fields.
+	if r.Plural != other.Plural {
+		return fmt.Errorf("unable to update Resource with another with non-matching Plural")
+	}
+
+	if r.Path != other.Path {
+		return fmt.Errorf("unable to update Resource with another with non-matching Path")
+	}
 
 	// Update API.
 	if r.API == nil && other.API != nil {

pkg/model/resource/resource_test.go

@@ -138,6 +138,16 @@ var _ = Describe("Resource", func() {
 				Entry("no conversion", Resource{Webhooks: &Webhooks{Conversion: false}}),
 			)
 		})
+
+		Context("IsRegularPlural", func() {
+			It("should return true if the regular plural form is used", func() {
+				Expect(Resource{GVK: GVK{Kind: "FirstMate"}, Plural: "firstmates"}.IsRegularPlural()).To(BeTrue())
+			})
+
+			It("should return false if an irregular plural form is used", func() {
+				Expect(Resource{GVK: GVK{Kind: "FirstMate"}, Plural: "mates"}.IsRegularPlural()).To(BeFalse())
+			})
+		})
 	})
 
 	Context("Copy", func() {
@@ -251,6 +261,46 @@ var _ = Describe("Resource", func() {
 			Expect(r.Update(other)).NotTo(Succeed())
 		})
 
+		It("should fail for different Plurals", func() {
+			r = Resource{
+				GVK: GVK{
+					Group:   group,
+					Version: version,
+					Kind:    kind,
+				},
+				Plural: "kinds",
+			}
+			other = Resource{
+				GVK: GVK{
+					Group:   group,
+					Version: version,
+					Kind:    kind,
+				},
+				Plural: "types",
+			}
+			Expect(r.Update(other)).NotTo(Succeed())
+		})
+
+		It("should fail for different Paths", func() {
+			r = Resource{
+				GVK: GVK{
+					Group:   group,
+					Version: version,
+					Kind:    kind,
+				},
+				Path: "api/v1",
+			}
+			other = Resource{
+				GVK: GVK{
+					Group:   group,
+					Version: version,
+					Kind:    kind,
+				},
+				Path: "apis/group/v1",
+			}
+			Expect(r.Update(other)).NotTo(Succeed())
+		})
+
 		Context("API", func() {
 			It("should work with nil APIs", func() {
 				r = Resource{

pkg/plugins/golang/v3/api.go

@@ -121,7 +121,7 @@ func (p *createAPISubcommand) BindFlags(fs *pflag.FlagSet) {
 	p.options.Domain = p.config.GetDomain()
 	fs.StringVar(&p.options.Version, "version", "", "resource Version")
 	fs.StringVar(&p.options.Kind, "kind", "", "resource Kind")
-	// p.options.Plural can be set to specify an irregular plural form
+	fs.StringVar(&p.options.Plural, "plural", "", "resource irregular plural form")
 
 	fs.BoolVar(&p.options.DoAPI, "resource", true,
 		"if set, generate the resource without prompting the user")

pkg/plugins/golang/v3/scaffolds/internal/templates/api/types.go

@@ -91,7 +91,8 @@ type {{ .Resource.Kind }}Status struct {
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
-{{ if not .Resource.API.Namespaced }} //+kubebuilder:resource:scope=Cluster {{ end }}
+{{ if not .Resource.API.Namespaced }}//+kubebuilder:resource:scope=Cluster{{ end }}
+{{ if not .Resource.IsRegularPlural }}//+kubebuilder:resource:path={{ .Resource.Plural }}{{ end }}
 
 // {{ .Resource.Kind }} is the Schema for the {{ .Resource.Plural }} API
 type {{ .Resource.Kind }} struct {

pkg/plugins/golang/v3/webhook.go

@@ -76,7 +76,7 @@ func (p *createWebhookSubcommand) BindFlags(fs *pflag.FlagSet) {
 	p.options.Domain = p.config.GetDomain()
 	fs.StringVar(&p.options.Version, "version", "", "resource Version")
 	fs.StringVar(&p.options.Kind, "kind", "", "resource Kind")
-	fs.StringVar(&p.options.Plural, "resource", "", "resource irregular plural form")
+	fs.StringVar(&p.options.Plural, "plural", "", "resource irregular plural form")
 
 	fs.StringVar(&p.options.WebhookVersion, "webhook-version", defaultWebhookVersion,
 		"version of {Mutating,Validating}WebhookConfigurations to scaffold. Options: [v1, v1beta1]")

testdata/project-v3/api/v1/admiral_types.go

@@ -41,8 +41,9 @@ type AdmiralStatus struct {
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 //+kubebuilder:resource:scope=Cluster
+//+kubebuilder:resource:path=admirales
 
-// Admiral is the Schema for the admirals API
+// Admiral is the Schema for the admirales API
 type Admiral struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

testdata/project-v3/api/v1/admiral_webhook.go

@@ -33,7 +33,7 @@ func (r *Admiral) SetupWebhookWithManager(mgr ctrl.Manager) error {
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 
-//+kubebuilder:webhook:path=/mutate-crew-testproject-org-v1-admiral,mutating=true,failurePolicy=fail,sideEffects=None,groups=crew.testproject.org,resources=admirals,verbs=create;update,versions=v1,name=madmiral.kb.io,admissionReviewVersions={v1,v1beta1}
+//+kubebuilder:webhook:path=/mutate-crew-testproject-org-v1-admiral,mutating=true,failurePolicy=fail,sideEffects=None,groups=crew.testproject.org,resources=admirales,verbs=create;update,versions=v1,name=madmiral.kb.io,admissionReviewVersions={v1,v1beta1}
 
 var _ webhook.Defaulter = &Admiral{}
 

testdata/project-v3/api/v1/webhook_suite_test.go

@@ -109,10 +109,10 @@ var _ = BeforeSuite(func() {
 	err = (&Captain{}).SetupWebhookWithManager(mgr)
 	Expect(err).NotTo(HaveOccurred())
 
-	err = (&Admiral{}).SetupWebhookWithManager(mgr)
+	err = (&Captain{}).SetupWebhookWithManager(mgr)
 	Expect(err).NotTo(HaveOccurred())
 
-	err = (&Captain{}).SetupWebhookWithManager(mgr)
+	err = (&Admiral{}).SetupWebhookWithManager(mgr)
 	Expect(err).NotTo(HaveOccurred())
 
 	//+kubebuilder:scaffold:webhook

testdata/project-v3/config/crd/bases/crew.testproject.org_admirals.yaml → testdata/project-v3/config/crd/bases/crew.testproject.org_admirales.yaml

@@ -6,20 +6,20 @@ metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.4.1
   creationTimestamp: null
-  name: admirals.crew.testproject.org
+  name: admirales.crew.testproject.org
 spec:
   group: crew.testproject.org
   names:
     kind: Admiral
     listKind: AdmiralList
-    plural: admirals
+    plural: admirales
     singular: admiral
   scope: Cluster
   versions:
   - name: v1
     schema:
       openAPIV3Schema:
-        description: Admiral is the Schema for the admirals API
+        description: Admiral is the Schema for the admirales API
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

testdata/project-v3/config/crd/kustomization.yaml

@@ -4,22 +4,22 @@
 resources:
 - bases/crew.testproject.org_captains.yaml
 - bases/crew.testproject.org_firstmates.yaml
-- bases/crew.testproject.org_admirals.yaml
+- bases/crew.testproject.org_admirales.yaml
 #+kubebuilder:scaffold:crdkustomizeresource
 
 patchesStrategicMerge:
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix.
 # patches here are for enabling the conversion webhook for each CRD
 #- patches/webhook_in_captains.yaml
 #- patches/webhook_in_firstmates.yaml
-#- patches/webhook_in_admirals.yaml
+#- patches/webhook_in_admirales.yaml
 #+kubebuilder:scaffold:crdkustomizewebhookpatch
 
 # [CERTMANAGER] To enable webhook, uncomment all the sections with [CERTMANAGER] prefix.
 # patches here are for enabling the CA injection for each CRD
 #- patches/cainjection_in_captains.yaml
 #- patches/cainjection_in_firstmates.yaml
-#- patches/cainjection_in_admirals.yaml
+#- patches/cainjection_in_admirales.yaml
 #+kubebuilder:scaffold:crdkustomizecainjectionpatch
 
 # the following config is for teaching kustomize how to do kustomization for CRDs.

testdata/project-v3/config/crd/patches/cainjection_in_admirals.yaml → testdata/project-v3/config/crd/patches/cainjection_in_admirales.yaml

@@ -4,4 +4,4 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: $(CERTIFICATE_NAMESPACE)/$(CERTIFICATE_NAME)
-  name: admirals.crew.testproject.org
+  name: admirales.crew.testproject.org

testdata/project-v3/config/crd/patches/webhook_in_admirals.yaml → testdata/project-v3/config/crd/patches/webhook_in_admirales.yaml

@@ -2,7 +2,7 @@
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: admirals.crew.testproject.org
+  name: admirales.crew.testproject.org
 spec:
   conversion:
     strategy: Webhook

testdata/project-v3/config/rbac/admiral_editor_role.yaml

@@ -1,4 +1,4 @@
-# permissions for end users to edit admirals.
+# permissions for end users to edit admirales.
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
@@ -7,7 +7,7 @@ rules:
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals
+  - admirales
   verbs:
   - create
   - delete
@@ -19,6 +19,6 @@ rules:
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals/status
+  - admirales/status
   verbs:
   - get

testdata/project-v3/config/rbac/admiral_viewer_role.yaml

@@ -1,4 +1,4 @@
-# permissions for end users to view admirals.
+# permissions for end users to view admirales.
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
@@ -7,14 +7,14 @@ rules:
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals
+  - admirales
   verbs:
   - get
   - list
   - watch
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals/status
+  - admirales/status
   verbs:
   - get

testdata/project-v3/config/rbac/role.yaml

@@ -9,7 +9,7 @@ rules:
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals
+  - admirales
   verbs:
   - create
   - delete
@@ -21,13 +21,13 @@ rules:
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals/finalizers
+  - admirales/finalizers
   verbs:
   - update
 - apiGroups:
   - crew.testproject.org
   resources:
-  - admirals/status
+  - admirales/status
   verbs:
   - get
   - patch

testdata/project-v3/config/webhook/manifests.yaml

@@ -25,7 +25,7 @@ webhooks:
     - CREATE
     - UPDATE
     resources:
-    - admirals
+    - admirales
   sideEffects: None
 - admissionReviewVersions:
   - v1

testdata/project-v3/controllers/admiral_controller.go

@@ -34,9 +34,9 @@ type AdmiralReconciler struct {
 	Scheme *runtime.Scheme
 }
 
-//+kubebuilder:rbac:groups=crew.testproject.org,resources=admirals,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=crew.testproject.org,resources=admirals/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=crew.testproject.org,resources=admirals/finalizers,verbs=update
+//+kubebuilder:rbac:groups=crew.testproject.org,resources=admirales,verbs=get;list;watch;create;update;patch;delete
+//+kubebuilder:rbac:groups=crew.testproject.org,resources=admirales/status,verbs=get;update;patch
+//+kubebuilder:rbac:groups=crew.testproject.org,resources=admirales/finalizers,verbs=update
 
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.

testdata/project-v3/main.go

@@ -98,6 +98,10 @@ func main() {
 		setupLog.Error(err, "unable to create webhook", "webhook", "Captain")
 		os.Exit(1)
 	}
+	if err = (&crewv1.Captain{}).SetupWebhookWithManager(mgr); err != nil {
+		setupLog.Error(err, "unable to create webhook", "webhook", "Captain")
+		os.Exit(1)
+	}
 	if err = (&controllers.FirstMateReconciler{
 		Client: mgr.GetClient(),
 		Log:    ctrl.Log.WithName("controllers").WithName("FirstMate"),
@@ -130,10 +134,6 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "Laker")
 		os.Exit(1)
 	}
-	if err = (&crewv1.Captain{}).SetupWebhookWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create webhook", "webhook", "Captain")
-		os.Exit(1)
-	}
 	//+kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {