validationresult

Documentation

Overview

Package validationresult contains functions for handling ValidationResult objects.

Index

• func Build(r Validator) *v1alpha1.ValidationResult
• func Finalize(vr *v1alpha1.ValidationResult, vrr types.ValidationResponse, l logr.Logger) error
• func HandleExisting(vr *v1alpha1.ValidationResult, l logr.Logger)
• func HandleNew(ctx context.Context, c client.Client, p Patcher, vr *v1alpha1.ValidationResult, ...) error
• func Name(r Validator) string
• func SafeUpdate(ctx context.Context, p Patcher, vr *v1alpha1.ValidationResult, ...) error
• type Patcher
• type Validator

Functions

func Build

func Build(r Validator) *v1alpha1.ValidationResult

Build creates a new ValidationResult for a specific Validator.

func Finalize

func Finalize(vr *v1alpha1.ValidationResult, vrr types.ValidationResponse, l logr.Logger) error

Finalize finalizes a ValidationResult, ensuring that the overall validation status remains failed if a single rule fails.

func HandleExisting

func HandleExisting(vr *v1alpha1.ValidationResult, l logr.Logger)

HandleExisting processes a preexisting validation result for the active validator.

func HandleNew

func HandleNew(ctx context.Context, c client.Client, p Patcher, vr *v1alpha1.ValidationResult, l logr.Logger) error

HandleNew creates a new validation result for the active validator.

func Name

func Name(r Validator) string

Name returns the name of a ValidationResult for a specific Validator.

func SafeUpdate

func SafeUpdate(ctx context.Context, p Patcher, vr *v1alpha1.ValidationResult, vrr types.ValidationResponse, l logr.Logger) error

SafeUpdate processes and patches a ValidationResult with retry logic.

Types

type Patcher

type Patcher interface {
	Patch(ctx context.Context, obj client.Object, opts ...patch.Option) error
}

Patcher is an interface for patching objects.

type Validator

type Validator interface {
	client.Object
	GetKind() string
	PluginCode() string
	ResultCount() int
}

Validator is an interface for building ValidationResults.