Rename validator & defaulter functions

Signed-off-by: Damien Dassieu <[email protected]>

Author: damsien

pkg/builder/webhook.go

@@ -37,19 +37,19 @@ import (
 
 // WebhookBuilder builds a Webhook.
 type WebhookBuilder struct {
-	apiType              runtime.Object
-	customDefaulter      admission.CustomDefaulter
-	customDefaulterOpts  []admission.DefaulterOption
-	customValidator      admission.CustomValidator
-	customPath           string
-	validatingCustomPath string
-	defaultingCustomPath string
-	gvk                  schema.GroupVersionKind
-	mgr                  manager.Manager
-	config               *rest.Config
-	recoverPanic         *bool
-	logConstructor       func(base logr.Logger, req *admission.Request) logr.Logger
-	err                  error
+	apiType                   runtime.Object
+	customDefaulter           admission.CustomDefaulter
+	customDefaulterOpts       []admission.DefaulterOption
+	customValidator           admission.CustomValidator
+	customPath                string
+	customValidatorCustomPath string
+	customDefaulterCustomPath string
+	gvk                       schema.GroupVersionKind
+	mgr                       manager.Manager
+	config                    *rest.Config
+	recoverPanic              *bool
+	logConstructor            func(base logr.Logger, req *admission.Request) logr.Logger
+	err                       error
 }
 
 // WebhookManagedBy returns a new webhook builder.
@@ -99,21 +99,21 @@ func (blder *WebhookBuilder) RecoverPanic(recoverPanic bool) *WebhookBuilder {
 
 // WithCustomPath overrides the webhook's default path by the customPath
 // Deprecated: WithCustomPath should not be used anymore.
-// Please use WithValidatingCustomPath or WithDefaultingCustomPath instead.
+// Please use WithValidatorCustomPath or WithDefaulterCustomPath instead.
 func (blder *WebhookBuilder) WithCustomPath(customPath string) *WebhookBuilder {
 	blder.customPath = customPath
 	return blder
 }
 
-// WithValidatingCustomPath overrides the webhook's default validating path by the customPath
-func (blder *WebhookBuilder) WithValidatingCustomPath(customPath string) *WebhookBuilder {
-	blder.validatingCustomPath = customPath
+// WithValidatorCustomPath overrides the path of the Validator.
+func (blder *WebhookBuilder) WithValidatorCustomPath(customPath string) *WebhookBuilder {
+	blder.customValidatorCustomPath = customPath
 	return blder
 }
 
-// WithDefaultingCustomPath overrides the webhook's default defaulting path by the customPath
-func (blder *WebhookBuilder) WithDefaultingCustomPath(customPath string) *WebhookBuilder {
-	blder.defaultingCustomPath = customPath
+// WithDefaulterCustomPath overrides the path of the Defaulter.
+func (blder *WebhookBuilder) WithDefaulterCustomPath(customPath string) *WebhookBuilder {
+	blder.customDefaulterCustomPath = customPath
 	return blder
 }
 
@@ -156,7 +156,7 @@ func (blder *WebhookBuilder) setLogConstructor() {
 }
 
 func (blder *WebhookBuilder) isThereCustomPathConflict() bool {
-	return (blder.customPath != "" && blder.customDefaulter != nil && blder.customValidator != nil) || (blder.customPath != "" && blder.defaultingCustomPath != "") || (blder.customPath != "" && blder.validatingCustomPath != "")
+	return (blder.customPath != "" && blder.customDefaulter != nil && blder.customValidator != nil) || (blder.customPath != "" && blder.customDefaulterCustomPath != "") || (blder.customPath != "" && blder.customValidatorCustomPath != "")
 }
 
 func (blder *WebhookBuilder) registerWebhooks() error {
@@ -171,15 +171,14 @@ func (blder *WebhookBuilder) registerWebhooks() error {
 	}
 
 	if blder.isThereCustomPathConflict() {
-		return errors.New("only one of the custom defaulter or custom validtor should be set when using WithCustomPath. Otherwise, WithDefaultingCustomPath() and WithValidatingCustomPath() should be used.")
-	} else {
-		if blder.customPath != "" {
-			// isThereCustomPathConflict() already checks for potential conflicts.
-			// Since we are sure that only one of customDefaulter or customValidator will be used,
-			// we can set set both defaultingCustomPath and validatingCustomPath.
-			blder.defaultingCustomPath = blder.customPath
-			blder.validatingCustomPath = blder.customPath
-		}
+		return errors.New("only one of CustomDefaulter or CustomValidator should be set when using WithCustomPath. Otherwise, WithDefaulterCustomPath() and WithValidatorCustomPath() should be used")
+	}
+	if blder.customPath != "" {
+		// isThereCustomPathConflict() already checks for potential conflicts.
+		// Since we are sure that only one of customDefaulter or customValidator will be used,
+		// we can set both customDefaulterCustomPath and validatingCustomPath.
+		blder.customDefaulterCustomPath = blder.customPath
+		blder.customValidatorCustomPath = blder.customPath
 	}
 
 	// Register webhook(s) for type
@@ -206,8 +205,8 @@ func (blder *WebhookBuilder) registerDefaultingWebhook() error {
 	if mwh != nil {
 		mwh.LogConstructor = blder.logConstructor
 		path := generateMutatePath(blder.gvk)
-		if blder.defaultingCustomPath != "" {
-			generatedCustomPath, err := generateCustomPath(blder.defaultingCustomPath)
+		if blder.customDefaulterCustomPath != "" {
+			generatedCustomPath, err := generateCustomPath(blder.customDefaulterCustomPath)
 			if err != nil {
 				return err
 			}
@@ -244,8 +243,8 @@ func (blder *WebhookBuilder) registerValidatingWebhook() error {
 	if vwh != nil {
 		vwh.LogConstructor = blder.logConstructor
 		path := generateValidatePath(blder.gvk)
-		if blder.validatingCustomPath != "" {
-			generatedCustomPath, err := generateCustomPath(blder.validatingCustomPath)
+		if blder.customValidatorCustomPath != "" {
+			generatedCustomPath, err := generateCustomPath(blder.customValidatorCustomPath)
 			if err != nil {
 				return err
 			}

pkg/builder/webhook_test.go

@@ -47,6 +47,8 @@ const (
   "apiVersion":"admission.k8s.io/`
 
 	svcBaseAddr = "http://svc-name.svc-ns.svc"
+
+	customPath = "/custom-path"
 )
 
 var _ = Describe("webhook", func() {
@@ -171,7 +173,7 @@ func runTests(admissionReviewVersion string) {
 			WithLogConstructor(func(base logr.Logger, req *admission.Request) logr.Logger {
 				return admission.DefaultLogConstructor(testingLogger, req)
 			}).
-			WithDefaultingCustomPath(customPath).
+			WithDefaulterCustomPath(customPath).
 			Complete()
 		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 		svr := m.GetWebhookServer()
@@ -391,7 +393,7 @@ func runTests(admissionReviewVersion string) {
 			WithLogConstructor(func(base logr.Logger, req *admission.Request) logr.Logger {
 				return admission.DefaultLogConstructor(testingLogger, req)
 			}).
-			WithValidatingCustomPath(customPath).
+			WithValidatorCustomPath(customPath).
 			Complete()
 		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 		svr := m.GetWebhookServer()
@@ -731,8 +733,8 @@ func runTests(admissionReviewVersion string) {
 			WithLogConstructor(func(base logr.Logger, req *admission.Request) logr.Logger {
 				return admission.DefaultLogConstructor(testingLogger, req)
 			}).
-			WithValidatingCustomPath(validatingCustomPath).
-			WithDefaultingCustomPath(defaultingCustomPath).
+			WithValidatorCustomPath(validatingCustomPath).
+			WithDefaulterCustomPath(defaultingCustomPath).
 			Complete()
 		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 		svr := m.GetWebhookServer()
@@ -829,7 +831,6 @@ func runTests(admissionReviewVersion string) {
 		err = builder.AddToScheme(m.GetScheme())
 		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-		customPath := "/custom-path"
 		err = WebhookManagedBy(m).
 			For(&TestDefaultValidator{}).
 			WithDefaulter(&TestCustomDefaultValidator{}).
@@ -853,14 +854,13 @@ func runTests(admissionReviewVersion string) {
 		err = builder.AddToScheme(m.GetScheme())
 		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-		customPath := "/custom-path"
 		err = WebhookManagedBy(m).
 			For(&TestDefaulter{}).
 			WithDefaulter(&TestCustomDefaulter{}).
 			WithLogConstructor(func(base logr.Logger, req *admission.Request) logr.Logger {
 				return admission.DefaultLogConstructor(testingLogger, req)
 			}).
-			WithDefaultingCustomPath(customPath).
+			WithDefaulterCustomPath(customPath).
 			WithCustomPath(customPath).
 			Complete()
 		ExpectWithOffset(1, err).To(HaveOccurred())
@@ -877,14 +877,13 @@ func runTests(admissionReviewVersion string) {
 		err = builder.AddToScheme(m.GetScheme())
 		ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-		customPath := "/custom-path"
 		err = WebhookManagedBy(m).
 			For(&TestValidator{}).
 			WithValidator(&TestCustomValidator{}).
 			WithLogConstructor(func(base logr.Logger, req *admission.Request) logr.Logger {
 				return admission.DefaultLogConstructor(testingLogger, req)
 			}).
-			WithDefaultingCustomPath(customPath).
+			WithDefaulterCustomPath(customPath).
 			WithCustomPath(customPath).
 			Complete()
 		ExpectWithOffset(1, err).To(HaveOccurred())