validate

Documentation

Overview

Copyright The Shipwright Contributors

SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func All(ctx context.Context, validations ...BuildPath) error
• func BuildParameters(parameterDefinitions []buildv1beta1.Parameter, ...) (bool, buildv1beta1.BuildReason, string)
• func BuildRunFields(buildRun *build.BuildRun) (string, string)
• func BuildRunParameters(parameterDefinitions []buildv1beta1.Parameter, ...) (bool, string, string)
• func BuildRunVolumes(strategyVolumes []buildv1beta1.BuildStrategyVolume, ...) (bool, string, string)
• func BuildVolumes(strategyVolumes []buildv1beta1.BuildStrategyVolume, ...) (bool, buildv1beta1.BuildReason, string)
• type BuildNameRef
  • func NewBuildName(build *build.Build) *BuildNameRef
  • func (b *BuildNameRef) ValidatePath(_ context.Context) error
• type BuildPath
  • func NewValidation(validationType string, build *build.Build, client client.Client, ...) (BuildPath, error)
• type BuildSpecOutputValidator
  • func (b *BuildSpecOutputValidator) ValidatePath(_ context.Context) error
• type Credentials
  • func NewCredentials(client client.Client, build *build.Build) *Credentials
  • func (s Credentials) ValidatePath(ctx context.Context) error
• type Env
  • func NewEnv(b *build.Build) *Env
  • func (e *Env) ValidatePath(_ context.Context) error
• type NodeSelectorRef
  • func NewNodeSelector(build *build.Build) *NodeSelectorRef
  • func (b *NodeSelectorRef) ValidatePath(_ context.Context) error
• type OwnerRef
  • func (o OwnerRef) ValidatePath(ctx context.Context) error
• type SourceRef
  • func NewSourceRef(b *build.Build) *SourceRef
  • func (s *SourceRef) ValidatePath(_ context.Context) error
• type SourceURLRef
  • func NewSourceURL(client client.Client, build *build.Build) *SourceURLRef
  • func (s SourceURLRef) MarkBuildStatus(b *build.Build, reason build.BuildReason, msg string)
  • func (s SourceURLRef) ValidatePath(ctx context.Context) error
• type Strategy
  • func NewStrategies(client client.Client, build *build.Build) *Strategy
  • func (s Strategy) ValidatePath(ctx context.Context) error
• type Trigger
  • func NewTrigger(b *build.Build) *Trigger
  • func (t *Trigger) ValidatePath(_ context.Context) error

Constants

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"
)

Functions

func All

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

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

func BuildParameters

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

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

func BuildRunFields

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

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

func BuildRunParameters

func BuildRunParameters(parameterDefinitions []buildv1beta1.Parameter, buildParamValues []buildv1beta1.ParamValue, buildRunParamValues []buildv1beta1.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 BuildRunVolumes

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

BuildRunVolumes is used to validate volumes in the BuildRun object

func BuildVolumes

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

BuildVolumes is used to validate volumes in the Build object

Types

type BuildNameRef

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

BuildNameRef contains all required fields to validate a build name

func NewBuildName

func NewBuildName(build *build.Build) *BuildNameRef

func (*BuildNameRef) ValidatePath

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 *build.Build,
	client client.Client,
	scheme *runtime.Scheme,
) (BuildPath, error)

NewValidation returns a specific structure that implements BuildPath interface

type BuildSpecOutputValidator

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

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

func (*BuildSpecOutputValidator) ValidatePath

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

type Credentials

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

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

func NewCredentials

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

func (Credentials) ValidatePath

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

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

type Env

type Env struct {
	Build *build.Build
}

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

func NewEnv

func NewEnv(b *build.Build) *Env

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

func (*Env) ValidatePath

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

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

type NodeSelectorRef

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

NodeSelectorRef contains all required fields to validate a node selector

func NewNodeSelector

func NewNodeSelector(build *build.Build) *NodeSelectorRef

func (*NodeSelectorRef) ValidatePath

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  *build.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 SourceRef

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

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

func NewSourceRef

func NewSourceRef(b *build.Build) *SourceRef

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

func (*SourceRef) ValidatePath

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

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

type SourceURLRef

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

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

func NewSourceURL

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

func (SourceURLRef) MarkBuildStatus

func (s SourceURLRef) MarkBuildStatus(b *build.Build, reason build.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

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

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

func NewStrategies

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

func (Strategy) ValidatePath

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 Trigger

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

func NewTrigger(b *build.Build) *Trigger

NewTrigger instantiate Trigger validation helper.

func (*Trigger) ValidatePath

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

ValidatePath validates the `.spec.trigger` path.