Unify webhook error messages

This patch unifies the error messages returned by the test operator
webhooks. Previously, some error messages were returned from the
validateCreate as a plain errors. This made the error messages
unreadable.

This patch returns all the errors in field.ErrorList. Each error is
properly categorized with Type and Detail err message.

Author: lpiwowar

api/v1beta1/common_webhook.go

@@ -4,6 +4,9 @@ const (
 	// ErrPrivilegedModeRequired
 	ErrPrivilegedModeRequired = "%s.Spec.Privileged is requied in order to successfully " +
 		"execute tests with the provided configuration."
+
+	// ErrDebug
+	ErrDebug = "%s.Spec.Workflow parameter must be empty to run debug mode"
 )
 
 const (

api/v1beta1/tempest_webhook.go

@@ -92,7 +92,11 @@ func (r *Tempest) ValidateCreate() (admission.Warnings, error) {
 	var allWarnings admission.Warnings
 
 	if len(r.Spec.Workflow) > 0 && r.Spec.Debug {
-		return nil, errors.New("workflow variable must be empty to run debug mode")
+		allErrs = append(allErrs, &field.Error{
+			Type:     field.ErrorTypeForbidden,
+			BadValue: r.Spec.Workflow,
+			Detail:   fmt.Sprintf(ErrDebug, "Tempest"),
+		})
 	}
 
 	if !r.Spec.Privileged && r.PrivilegedRequired() {

api/v1beta1/tobiko_webhook.go

@@ -25,8 +25,10 @@ package v1beta1
 import (
 	"fmt"
 
-	"errors"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/util/validation/field"
 	ctrl "sigs.k8s.io/controller-runtime"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
@@ -62,16 +64,29 @@ var _ webhook.Validator = &Tobiko{}
 func (r *Tobiko) ValidateCreate() (admission.Warnings, error) {
 	tobikolog.Info("validate create", "name", r.Name)
 
+	var allErrs field.ErrorList
 	var allWarnings admission.Warnings
 
+	if len(r.Spec.Workflow) > 0 && r.Spec.Debug {
+		allErrs = append(allErrs, &field.Error{
+			Type:     field.ErrorTypeForbidden,
+			BadValue: r.Spec.Workflow,
+			Detail:   fmt.Sprintf(ErrDebug, "Tobiko"),
+		})
+	}
+
 	if r.Spec.Privileged {
 		allWarnings = append(allWarnings, fmt.Sprintf(WarnPrivilegedModeOn, "Tobiko"))
 	} else {
 		allWarnings = append(allWarnings, fmt.Sprintf(WarnPrivilegedModeOff, "Tobiko"))
 	}
 
-	if len(r.Spec.Workflow) > 0 && r.Spec.Debug {
-		return allWarnings, errors.New("workflow variable must be empty to run debug mode")
+	if len(allErrs) > 0 {
+		return allWarnings, apierrors.NewInvalid(
+			schema.GroupKind{
+				Group: GroupVersion.WithKind("Tobiko").Group,
+				Kind:  GroupVersion.WithKind("Tobiko").Kind,
+			}, r.GetName(), allErrs)
 	}
 
 	return allWarnings, nil