validate

package
v0.20.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

Copyright The Shipwright Contributors

SPDX-License-Identifier: Apache-2.0

Index

Constants

View Source 
const (
	// Secrets for validating secret references in Build objects
	Secrets = "secrets"
	// Strategies for validating strategy references in Build objects
	Strategies = "strategy"
	// SourceURL for validating the source URL in Build objects
	SourceURL = "sourceurl"
	// Sources for validating `spec.sources` entries
	Source = "source"
	// Output for validating `spec.output` entry
	Output = "output"
	// BuildName for validating `metadata.name` entry
	BuildName = "buildname"
	// Envs for validating `spec.env` entries
	Envs = "env"
	// OwnerReferences for validating the ownerreferences between a Build
	// and BuildRun objects
	OwnerReferences = "ownerreferences"
	// Triggers for validating the `.spec.triggers` entries
	Triggers = "triggers"
	// NodeSelector for validating `spec.nodeSelector` entry
	NodeSelector = "nodeselector"
	// Tolerations for validating `spec.tolerations` entry
	Tolerations = "tolerations"
	// SchedulerName for validating `spec.schedulerName` entry
	SchedulerName = "schedulername"
	// RuntimeClassName for validating `spec.runtimeClassName` entry
	RuntimeClassName = "runtimeclassname"
)

Variables

This section is empty.

Functions

func All added in v0.9.0 

func All(ctx context.Context, validations ...BuildPath) error

All runs all given validations and exists at the first technical error

func BuildParameters added in v0.9.0 

func BuildParameters(parameterDefinitions []buildapi.Parameter, buildParamValues []buildapi.ParamValue) (bool, buildapi.BuildReason, string)

BuildParameters validates that the parameter values specified in Build are suitable for what is defined in the BuildStrategy

func BuildRunFields added in v0.9.0 

func BuildRunFields(buildRun *buildapi.BuildRun) (string, string)

BuildRunFields runs field validations against a BuildRun to detect disallowed field combinations and issues

func BuildRunNodeSelector added in v0.15.0 

func BuildRunNodeSelector(nodeSelector map[string]string) (bool, string, string)

BuildRunNodeSelector is used to validate nodeSelectors in the BuildRun object

func BuildRunParameters added in v0.9.0 

func BuildRunParameters(parameterDefinitions []buildapi.Parameter, buildParamValues []buildapi.ParamValue, buildRunParamValues []buildapi.ParamValue) (bool, string, string)

BuildRunParameters validates that the parameter values specified in Build and BuildRun are suitable for what is defined in the BuildStrategy

func BuildRunRuntimeClassName added in v0.19.0 

func BuildRunRuntimeClassName(runtimeClassName *string) (bool, string, string)

BuildRunRuntimeClassName is used to validate the runtimeClassName in the BuildRun object

func BuildRunSchedulerName added in v0.15.0 

func BuildRunSchedulerName(schedulerName *string) (bool, string, string)

BuildSchedulerName is used to validate the schedulerName in the BuildRun object

func BuildRunStepResources added in v0.19.0 

func BuildRunStepResources(strategySteps []buildapi.Step, buildRunStepResources []buildapi.StepResourceOverride) (bool, string, string)

BuildRunStepResources validates that all step resource overrides in the BuildRun reference steps that exist in the build strategy.

func BuildRunTolerations added in v0.15.0 

func BuildRunTolerations(tolerations []corev1.Toleration) (bool, string, string)

BuildRunTolerations is used to validate tolerations in the BuildRun object

func BuildRunVolumes added in v0.10.0 

func BuildRunVolumes(strategyVolumes []buildapi.BuildStrategyVolume, buildVolumes []buildapi.BuildVolume) (bool, string, string)

BuildRunVolumes is used to validate volumes in the BuildRun object

func BuildStepResources added in v0.19.0 

func BuildStepResources(strategySteps []buildapi.Step, buildStepResources []buildapi.StepResourceOverride) (bool, buildapi.BuildReason, string)

BuildStepResources validates that all step resource overrides in the Build reference steps that exist in the build strategy.

func BuildVolumes added in v0.10.0 

func BuildVolumes(strategyVolumes []buildapi.BuildStrategyVolume, buildVolumes []buildapi.BuildVolume) (bool, buildapi.BuildReason, string)

BuildVolumes is used to validate volumes in the Build object

func ValidateMultiArchPreflight added in v0.20.0 

func ValidateMultiArchPreflight(platforms []buildapi.ImagePlatform, nodeSelector map[string]string, executor string) (bool, string, string)

ValidateMultiArchPreflight runs platform, nodeSelector, and executor checks before the reconciler lists Nodes. If this returns (true, "", ""), the caller may List Nodes and then call ValidateNodeAvailability.

func ValidateNodeAvailability added in v0.20.0 

func ValidateNodeAvailability(platforms []buildapi.ImagePlatform, nodes []corev1.Node) (bool, string, string)

ValidateNodeAvailability checks that, for each requested platform, the cluster has at least one node that is Ready, is not unschedulable, and has kubernetes.io/os and kubernetes.io/arch labels matching that platform.

func ValidateOutputNodeSelector added in v0.20.0 

func ValidateOutputNodeSelector(nodeSelector map[string]string) (bool, string, string)

ValidateOutputNodeSelector checks that nodeSelector does not conflict with output platform scheduling.

func ValidatePipelineRunExecutor added in v0.20.0 

func ValidatePipelineRunExecutor(executor string) (bool, string, string)

ValidatePipelineRunExecutor checks that the controller is configured with PipelineRun executor mode, which is required for multi-arch builds to orchestrate per-platform PipelineTasks.

func ValidatePlatforms added in v0.20.0 

func ValidatePlatforms(platforms []buildapi.ImagePlatform) (bool, string, string)

ValidatePlatforms validates spec.output.platforms when non-empty.

Types

type BuildNameRef added in v0.6.0 

type BuildNameRef struct {
	Build *buildapi.Build // build instance for analysis
}

BuildNameRef contains all required fields to validate a build name

func NewBuildName added in v0.9.0 

func NewBuildName(build *buildapi.Build) *BuildNameRef

func (*BuildNameRef) ValidatePath added in v0.6.0 

func (b *BuildNameRef) ValidatePath(_ context.Context) error

ValidatePath implements BuildPath interface and validates that build name is a valid label value

type BuildPath 

type BuildPath interface {
	ValidatePath(ctx context.Context) error
}

BuildPath is an interface that holds a ValidatePath() function for validating different Build spec paths

func NewValidation 

func NewValidation(
	validationType string,
	build *buildapi.Build,
	client client.Client,
	scheme *runtime.Scheme,
) (BuildPath, error)

NewValidation returns a specific structure that implements BuildPath interface

type BuildSpecOutputValidator added in v0.13.0 

type BuildSpecOutputValidator struct {
	Build *buildapi.Build // build instance for analysis
}

BuildSpecOutputValidator implements validation interface to add validations for `buildapi.spec.output`.

func (*BuildSpecOutputValidator) ValidatePath added in v0.13.0 

func (b *BuildSpecOutputValidator) ValidatePath(_ context.Context) error

type Credentials added in v0.4.0 

type Credentials struct {
	Build  *buildapi.Build
	Client client.Client
}

Credentials contains all required fields to validate a Build spec secrets definitions

func NewCredentials added in v0.9.0 

func NewCredentials(client client.Client, build *buildapi.Build) *Credentials

func (Credentials) ValidatePath added in v0.4.0 

func (s Credentials) ValidatePath(ctx context.Context) error

ValidatePath implements BuildPath interface and validates that all referenced secrets under spec exists

type Env added in v0.6.0 

type Env struct {
	Build *buildapi.Build
}

Env implements the Env interface to add validations for the `buildapi.spec.env` slice.

func NewEnv added in v0.6.0 

func NewEnv(b *buildapi.Build) *Env

NewEnv instantiates a new Env passing the build object pointer along.

func (*Env) ValidatePath added in v0.6.0 

func (e *Env) ValidatePath(_ context.Context) error

ValidatePath executes the validation routine, inspecting the `buildapi.spec.env` path, which contains a slice of corev1.EnvVar.

type NodeSelectorRef added in v0.14.0 

type NodeSelectorRef struct {
	Build *buildapi.Build // build instance for analysis
}

NodeSelectorRef contains all required fields to validate a node selector

func NewNodeSelector added in v0.14.0 

func NewNodeSelector(build *buildapi.Build) *NodeSelectorRef

func (*NodeSelectorRef) ValidatePath added in v0.14.0 

func (b *NodeSelectorRef) ValidatePath(_ context.Context) error

ValidatePath implements BuildPath interface and validates that NodeSelector keys/values are valid labels

type OwnerRef 

type OwnerRef struct {
	Build  *buildapi.Build
	Client client.Client
	Scheme *runtime.Scheme
}

OwnerRef contains all required fields to validate a Build OwnerReference definition

func (OwnerRef) ValidatePath 

func (o OwnerRef) ValidatePath(ctx context.Context) error

ValidatePath implements BuildPath interface and validates setting the ownershipReference between a Build and a BuildRun

type RuntimeClassNameRef added in v0.19.0 

type RuntimeClassNameRef struct {
	Build *buildapi.Build // build instance for analysis
}

RuntimeClassNameRef contains all required fields to validate a RuntimeClassName

func NewRuntimeClassName added in v0.19.0 

func NewRuntimeClassName(build *buildapi.Build) *RuntimeClassNameRef

func (*RuntimeClassNameRef) ValidatePath added in v0.19.0 

func (b *RuntimeClassNameRef) ValidatePath(_ context.Context) error

ValidatePath implements BuildPath interface and validates that RuntimeClassName values are valid

type SchedulerNameRef added in v0.15.0 

type SchedulerNameRef struct {
	Build *buildapi.Build // build instance for analysis
}

SchedulerNameRef contains all required fields to validate a Scheduler name

func NewSchedulerName added in v0.15.0 

func NewSchedulerName(build *buildapi.Build) *SchedulerNameRef

func (*SchedulerNameRef) ValidatePath added in v0.15.0 

func (b *SchedulerNameRef) ValidatePath(_ context.Context) error

ValidatePath implements BuildPath interface and validates that SchedulerName values are valid

type SourceRef added in v0.13.0 

type SourceRef struct {
	Build *buildapi.Build // build instance for analysis
}

SourcesRef implements RuntimeRef interface to add validations for `buildapi.spec.source`.

func NewSourceRef added in v0.13.0 

func NewSourceRef(b *buildapi.Build) *SourceRef

NewSourcesRef instantiate a new SourcesRef passing the build object pointer along.

func (*SourceRef) ValidatePath added in v0.13.0 

func (s *SourceRef) ValidatePath(_ context.Context) error

ValidatePath executes the validation routine, inspecting the `buildapi.spec.source` path

type SourceURLRef 

type SourceURLRef struct {
	Build  *buildapi.Build
	Client client.Client
}

SourceURLRef contains all required fields to validate a Build spec source definition

func NewSourceURL added in v0.9.0 

func NewSourceURL(client client.Client, build *buildapi.Build) *SourceURLRef

func (SourceURLRef) MarkBuildStatus 

func (s SourceURLRef) MarkBuildStatus(b *buildapi.Build, reason buildapi.BuildReason, msg string)

MarkBuildStatus updates a Build Status fields

func (SourceURLRef) ValidatePath 

func (s SourceURLRef) ValidatePath(ctx context.Context) error

ValidatePath implements BuildPath interface and validates that the spec.source.url exists. This validation only applies to endpoints that do not require authentication.

type Strategy added in v0.4.0 

type Strategy struct {
	Build  *buildapi.Build
	Client client.Client
}

Strategy contains all required fields to validate a Build spec strategy definition

func NewStrategies added in v0.9.0 

func NewStrategies(client client.Client, build *buildapi.Build) *Strategy

func (Strategy) ValidatePath added in v0.4.0 

func (s Strategy) ValidatePath(ctx context.Context) error

ValidatePath implements BuildPath interface and validates that the referenced strategy exists. This applies to both namespaced or cluster scoped strategies

type TolerationsRef added in v0.15.0 

type TolerationsRef struct {
	Build *buildapi.Build // build instance for analysis
}

TolerationsRef contains all required fields to validate tolerations

func NewTolerations added in v0.15.0 

func NewTolerations(build *buildapi.Build) *TolerationsRef

func (*TolerationsRef) ValidatePath added in v0.15.0 

func (b *TolerationsRef) ValidatePath(_ context.Context) error

ValidatePath implements BuildPath interface and validates that tolerations key/operator/value are valid

type Trigger added in v0.11.0 

type Trigger struct {
	// contains filtered or unexported fields
}

Trigger implements the interface BuildPath with the objective of applying validations against the `.spec.trigger` related attributes.

func NewTrigger added in v0.11.0 

func NewTrigger(b *buildapi.Build) *Trigger

NewTrigger instantiate Trigger validation helper.

func (*Trigger) ValidatePath added in v0.11.0 

func (t *Trigger) ValidatePath(_ context.Context) error

ValidatePath validates the `.spec.trigger` path.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.