feat: finalization helper for ValidationRuleResults (#415)

## Issue
N/A

## Description
Add finalization helper for ValidationRuleResults. It must be called in
`Validate` for all plugins to ensure proper error handling in direct
mode.

---------

Signed-off-by: Tyler Gillson <[email protected]>

Author: TylerGillson

.golangci.yml

@@ -16,7 +16,6 @@ linters:
   enable:
     - dupl
     - errcheck
-    - exportloopref
     - ginkgolinter
     - goconst
     - gocyclo

build

@@ -162,7 +162,7 @@ func (c *CLIClient) run(name, namespace string, options Options, command string,
 	}
 
 	// Set values
-	if options.SetValues != nil && len(options.SetValues) > 0 {
+	if len(options.SetValues) > 0 {
 		args = append(args, "--set")
 
 		setString := ""
@@ -178,7 +178,7 @@ func (c *CLIClient) run(name, namespace string, options Options, command string,
 	}
 
 	// Set string values
-	if options.SetStringValues != nil && len(options.SetStringValues) > 0 {
+	if len(options.SetStringValues) > 0 {
 		args = append(args, "--set-string")
 
 		setString := ""

pkg/helm/helm.go

@@ -1,4 +1,4 @@
-package util
+package test
 
 import (
 	"reflect"

pkg/util/test.go renamed to pkg/test/util.go

@@ -1,14 +1,32 @@
 // Package types contains structs used by to construct ValidationResults.
 package types
 
-import "github.com/validator-labs/validator/api/v1alpha1"
+import (
+	corev1 "k8s.io/api/core/v1"
+
+	"github.com/validator-labs/validator/api/v1alpha1"
+	"github.com/validator-labs/validator/pkg/util"
+)
+
+// ErrValidationFailed is the error message returned when a validation rule fails.
+const ErrValidationFailed = "Validation failed with an unexpected error"
 
 // ValidationRuleResult is the result of the execution of a validation rule by a validator.
 type ValidationRuleResult struct {
 	Condition *v1alpha1.ValidationCondition
 	State     *v1alpha1.ValidationState
 }
 
+// Finalize sets the ValidationRuleResult state to ValidationFailed if an non-nil error is provided.
+func (vrr *ValidationRuleResult) Finalize(err error) {
+	if err != nil {
+		vrr.State = util.Ptr(v1alpha1.ValidationFailed)
+		vrr.Condition.Status = corev1.ConditionFalse
+		vrr.Condition.Message = ErrValidationFailed
+		vrr.Condition.Failures = append(vrr.Condition.Failures, err.Error())
+	}
+}
+
 // ValidationResponse is the reconciliation output of one or more validation rules by a validator.
 type ValidationResponse struct {
 	ValidationRuleResults []*ValidationRuleResult

pkg/types/types.go

@@ -19,8 +19,6 @@ import (
 	"github.com/validator-labs/validator/pkg/util"
 )
 
-const validationErrorMsg = "Validation failed with an unexpected error"
-
 // Patcher is an interface for patching objects.
 type Patcher interface {
 	Patch(ctx context.Context, obj client.Object, opts ...patch.Option) error
@@ -156,12 +154,7 @@ func Finalize(vr *v1alpha1.ValidationResult, vrr types.ValidationResponse, l log
 func updateStatus(vr *v1alpha1.ValidationResult, vrr *types.ValidationRuleResult, vrrErr error, l logr.Logger) {
 
 	// Finalize result State and Condition in the event of an unexpected error
-	if vrrErr != nil {
-		vrr.State = util.Ptr(v1alpha1.ValidationFailed)
-		vrr.Condition.Status = corev1.ConditionFalse
-		vrr.Condition.Message = validationErrorMsg
-		vrr.Condition.Failures = append(vrr.Condition.Failures, vrrErr.Error())
-	}
+	vrr.Finalize(vrrErr)
 
 	// Update and/or insert the ValidationResult's Conditions with the latest Condition
 	idx := getConditionIndexByValidationRule(vr.Status.ValidationConditions, vrr.Condition.ValidationRule)

pkg/validationresult/validation_result.go

@@ -41,7 +41,7 @@ func vr(cs []corev1.ConditionStatus, state v1alpha1.ValidationState, err error)
 			ValidationRule: constants.ValidationRulePrefix,
 		}
 		if err != nil {
-			condition.Message = validationErrorMsg
+			condition.Message = types.ErrValidationFailed
 			condition.Failures = append(condition.Failures, err.Error())
 		}
 		vr.Status.ValidationConditions = append(vr.Status.ValidationConditions, condition)