v1beta1

package
v0.0.0-...-159d35f Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the testharness API group +k8s:openapi-gen=false +k8s:deepcopy-gen=package +groupName=kuttl.dev

Index

Constants

View Source 
const DefaultKINDContext = "kind"

DefaultKINDContext defines the default kind context to use.

Variables

This section is empty.

Functions

This section is empty.

Types

type Apply 

type Apply struct {
	File       string `json:"file,omitempty"`
	ShouldFail bool   `json:"shouldFail,omitempty"`
}

Apply holds infos for an apply statement

func (*Apply) DeepCopy 

func (in *Apply) DeepCopy() *Apply

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Apply.

func (*Apply) DeepCopyInto 

func (in *Apply) DeepCopyInto(out *Apply)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Apply) UnmarshalJSON 

func (apply *Apply) UnmarshalJSON(value []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

type Assert 

type Assert struct {
	// File specifies the relative or full path to the YAML containing the expected content.
	File    string   `json:"file"`
	Options *Options `json:"options,omitempty"`
}

func (*Assert) DeepCopy 

func (in *Assert) DeepCopy() *Assert

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Assert.

func (*Assert) DeepCopyInto 

func (in *Assert) DeepCopyInto(out *Assert)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Assert) UnmarshalJSON 

func (assert *Assert) UnmarshalJSON(value []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

type AssertArray 

type AssertArray struct {
	// Path indicates the location within the YAML file to extract data for verification.
	Path string `json:"path"`
	// Strategy defines how the extracted data should be compared against the Kubernetes resource.
	Strategy Strategy                      `json:"strategy"`
	Match    *metav1.PartialObjectMetadata `json:"match,omitempty"`
}

AssertArray specifies conditions for verifying content within a YAML against a Kubernetes resource.

func (*AssertArray) DeepCopy 

func (in *AssertArray) DeepCopy() *AssertArray

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AssertArray.

func (*AssertArray) DeepCopyInto 

func (in *AssertArray) DeepCopyInto(out *AssertArray)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Command 

type Command struct {
	// The command and argument to run as a string.
	Command string `json:"command"`
	// Output defines the expected output criteria for the command.
	// It can check if the command's output equals or contains specific strings.
	Output *CommandOutput `json:"output,omitempty"`
	// If set, the `--namespace` flag will be appended to the command with the namespace to use.
	Namespaced bool `json:"namespaced"`
	// Ability to run a shell script from TestStep (without a script file)
	// namespaced and command should not be used with script.  namespaced is ignored and command is an error.
	// env expansion is depended upon the shell but ENV is passed to the runtime env.
	Script string `json:"script"`
	// If set, exit failures (`exec.ExitError`) will be ignored. `exec.Error` are NOT ignored.
	IgnoreFailure bool `json:"ignoreFailure"`
	// If set, the command is run in the background.
	Background bool `json:"background"`
	// Override the TestSuite timeout for this command (in seconds).
	Timeout int `json:"timeout"`
	// If set, the output from the command is NOT logged.  Useful for sensitive logs or to reduce noise.
	SkipLogOutput bool `json:"skipLogOutput"`
}

Command describes a command to run as a part of a test step or suite.

func (*Command) DeepCopy 

func (in *Command) DeepCopy() *Command

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Command.

func (*Command) DeepCopyInto 

func (in *Command) DeepCopyInto(out *Command)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommandOutput 

type CommandOutput struct {
	// Stdout contains the expected output criteria for the standard output.
	Stdout *ExpectedOutput `json:"stdout,omitempty"`
	// Stderr contains the expected output criteria for the standard error.
	Stderr *ExpectedOutput `json:"stderr,omitempty"`
}

CommandOutput encapsulates expected outputs for stdout and stderr streams.

func (*CommandOutput) DeepCopy 

func (in *CommandOutput) DeepCopy() *CommandOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommandOutput.

func (*CommandOutput) DeepCopyInto 

func (in *CommandOutput) DeepCopyInto(out *CommandOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CommandOutput) ValidateCommandOutput 

func (c *CommandOutput) ValidateCommandOutput(stdoutOutput, stderrOutput strings.Builder) error

type ExpectedOutput 

type ExpectedOutput struct {
	// MatchType is the type of match that should be applied for validation.
	// This could be "Equals", "Contains", or "Wildcard".
	MatchType MatchType `json:"match"`
	// Value is the expected value or pattern that should be matched against the command's output.
	ExpectedValue string `json:"expected"`
}

ExpectedOutput defines the criteria that command output should meet.

func (*ExpectedOutput) DeepCopy 

func (in *ExpectedOutput) DeepCopy() *ExpectedOutput

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExpectedOutput.

func (*ExpectedOutput) DeepCopyInto 

func (in *ExpectedOutput) DeepCopyInto(out *ExpectedOutput)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MatchType 

type MatchType string
const (
	MatchEquals   MatchType = "Equals"
	MatchContains MatchType = "Contains"
	MatchWildcard MatchType = "Wildcard"
)

type ObjectReference 

type ObjectReference struct {
	corev1.ObjectReference `json:",inline"`
	// Labels to match on.
	Labels map[string]string `json:"labels"`
}

ObjectReference is a Kubernetes object reference with added labels to allow referencing objects by label.

func (*ObjectReference) DeepCopy 

func (in *ObjectReference) DeepCopy() *ObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectReference.

func (*ObjectReference) DeepCopyInto 

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Options 

type Options struct {
	AssertArray []AssertArray `json:"arrays,omitempty"`
}

func (*Options) DeepCopy 

func (in *Options) DeepCopy() *Options

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Options.

func (*Options) DeepCopyInto 

func (in *Options) DeepCopyInto(out *Options)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RestConfig 

type RestConfig struct {
	RC *rest.Config `json:"-"`
}

Create embedded struct to implement custom DeepCopyInto method

func (*RestConfig) DeepCopy 

func (in *RestConfig) DeepCopy() *RestConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestConfig.

func (*RestConfig) DeepCopyInto 

func (in *RestConfig) DeepCopyInto(out *RestConfig)

type Strategy 

type Strategy string
const (
	StrategyAnywhere Strategy = "Anywhere"
	StrategyExact    Strategy = "Exact"
)

type TestAssert 

type TestAssert struct {
	// The type meta object, should always be a GVK of  kuttl.dev/v1beta1/TestAssert or kuttl.dev/v1beta1/TestAssert.
	metav1.TypeMeta `json:",inline"`
	// Override the default metadata. Set labels or override the test step name.
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Override the default timeout of 30 seconds (in seconds).
	Timeout int `json:"timeout"`
	// Collectors is a set of pod log collectors fired on an assert failure
	Collectors []*TestCollector `json:"collectors,omitempty"`
	// Commands is a set of commands to be run as assertions for the current step
	Commands []TestAssertCommand `json:"commands,omitempty"`
}

TestAssert represents the settings needed to verify the result of a test step.

func (*TestAssert) DeepCopy 

func (in *TestAssert) DeepCopy() *TestAssert

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestAssert.

func (*TestAssert) DeepCopyInto 

func (in *TestAssert) DeepCopyInto(out *TestAssert)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TestAssert) DeepCopyObject 

func (in *TestAssert) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TestAssertCommand 

type TestAssertCommand struct {
	// The command and argument to run as a string.
	Command string `json:"command"`
	// If set, the `--namespace` flag will be appended to the command with the namespace to use.
	Namespaced bool `json:"namespaced"`
	// Ability to run a shell script from TestStep (without a script file)
	// namespaced and command should not be used with script.  namespaced is ignored and command is an error.
	// env expansion is depended upon the shell but ENV is passed to the runtime env.
	Script string `json:"script"`
	// If set, the output from the command is NOT logged.  Useful for sensitive logs or to reduce noise.
	SkipLogOutput bool `json:"skipLogOutput"`
}

TestAssertCommand an assertion based on the result of the execution of a command

func (*TestAssertCommand) DeepCopy 

func (in *TestAssertCommand) DeepCopy() *TestAssertCommand

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestAssertCommand.

func (*TestAssertCommand) DeepCopyInto 

func (in *TestAssertCommand) DeepCopyInto(out *TestAssertCommand)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TestCollector 

type TestCollector struct {
	// Type is a collector type which is pod, command or events
	// command is default type if command field is not empty
	// misconfiguration will lead to warning message in the logs
	Type string `json:"type,omitempty"`
	// The pod name to access logs.
	Pod string `json:"pod,omitempty"`
	// namespace to use. The current test namespace will be used by default.
	Namespace string `json:"namespace,omitempty"`
	// Container in pod to get logs from else --all-containers is used.
	Container string `json:"container,omitempty"`
	// Selector is a label query to select pod.
	Selector string `json:"selector,omitempty"`
	// Tail is the number of last lines to collect from pods. If omitted or zero,
	// then the default is 10 if you use a selector, or -1 (all) if you use a pod name.
	// This matches default behavior of `kubectl logs`.
	Tail int `json:"tail,omitempty"`
	// Cmd is a command to run for collection.  It requires an empty Type or Type=command
	Cmd string `json:"command,omitempty"`
}

TestCollector are post assert / error commands that allow for the collection of information sent to the test log. Type can be pod, command or event. For backward compatibility, pod is default and doesn't need to be specified For pod, At least one of `pod` or `selector` is required. For command, Command must be specified and Type can be == "command" but no other fields are valid For event, Type must be == "events" and Namespace and Name can be specified, if no ns or name, the default events are provided. If no name, than all events for that ns are provided.

func (*TestCollector) Command 

func (tc *TestCollector) Command() *Command

Command provides the command to exec to perform the collection

func (*TestCollector) DeepCopy 

func (in *TestCollector) DeepCopy() *TestCollector

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestCollector.

func (*TestCollector) DeepCopyInto 

func (in *TestCollector) DeepCopyInto(out *TestCollector)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TestCollector) String 

func (tc *TestCollector) String() string

String provides defaults of the type of collector

type TestStep 

type TestStep struct {
	// The type meta object, should always be a GVK of kuttl.dev/v1beta1/TestStep or kuttl.dev/v1beta1/TestStep.
	metav1.TypeMeta `json:",inline"`
	// Override the default metadata. Set labels or override the test step name.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// +kubebuilder:validation:Format:=int64
	Index int `json:"index,omitempty"`

	// Apply, Assert and Error lists of files or directories to use in the test step.
	// Useful to reuse a number of applies across tests / test steps.
	// all relative paths are relative to the folder the TestStep is defined in.
	Apply  []Apply  `json:"apply,omitempty"`
	Assert []Assert `json:"assert,omitempty"`
	Error  []string `json:"error,omitempty"`

	// Objects to delete at the beginning of the test step.
	Delete []ObjectReference `json:"delete,omitempty"`

	// Indicates that this is a unit test - safe to run without a real Kubernetes cluster.
	UnitTest bool `json:"unitTest"`

	// Commands to run prior at the beginning of the test step.
	Commands []Command `json:"commands"`

	// Kubeconfig to use when applying and asserting for this step.
	Kubeconfig string `json:"kubeconfig,omitempty"`
}

TestStep settings to apply to a test step.go

func (*TestStep) DeepCopy 

func (in *TestStep) DeepCopy() *TestStep

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestStep.

func (*TestStep) DeepCopyInto 

func (in *TestStep) DeepCopyInto(out *TestStep)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TestStep) DeepCopyObject 

func (in *TestStep) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type TestSuite 

type TestSuite struct {
	// The type meta object, should always be a GVK of kuttl.dev/v1beta1/TestSuite or kuttl.dev/v1beta1/TestSuite.
	metav1.TypeMeta `json:",inline"`
	// Set labels or the test suite name.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Path to CRDs to install before running tests.
	CRDDir string `json:"crdDir"`
	// Paths to directories containing manifests to install before running tests.
	ManifestDirs []string `json:"manifestDirs"`
	// Directories containing test cases to run.
	TestDirs []string `json:"testDirs"`
	// Whether or not to start a local etcd and kubernetes API server for the tests.
	StartControlPlane bool `json:"startControlPlane"`
	// ControlPlaneArgs defaults to APIServerDefaultArgs from controller-runtime pkg/internal/testing/integration/internal/apiserver.go
	// this allows for control over the args, however these are not serialized from a TestSuite.yaml
	ControlPlaneArgs []string `json:"controlPlaneArgs"`
	// AttachControlPlaneOutput if true, attaches control plane logs (api-server, etcd) into stdout. This is useful for debugging.
	// defaults to false
	AttachControlPlaneOutput bool `json:"attachControlPlaneOutput"`
	// Whether or not to start a local kind cluster for the tests.
	StartKIND bool `json:"startKIND"`
	// Path to the KIND configuration file to use.
	KINDConfig string `json:"kindConfig"`
	// KIND context to use.
	KINDContext string `json:"kindContext"`
	// If set, each node defined in the kind configuration will have a docker named volume mounted into it to persist
	// pulled container images across test runs.
	KINDNodeCache bool `json:"kindNodeCache"`
	// Containers to load to each KIND node prior to running the tests.
	KINDContainers []string `json:"kindContainers"`
	// If set, do not delete the resources after running the tests (implies SkipClusterDelete).
	SkipDelete bool `json:"skipDelete"`
	// If set, do not delete the mocked control plane or kind cluster.
	SkipClusterDelete bool `json:"skipClusterDelete"`
	// StopOnFirstFailure determines whether the test should stop upon encountering the first failure.
	StopOnFirstFailure bool `json:"stopOnFirstFailure"`
	// Override the default timeout of 30 seconds (in seconds).
	// +kubebuilder:validation:Format:=int64
	Timeout int `json:"timeout"`
	// The maximum number of tests to run at once (default: 8).
	// +kubebuilder:validation:Format:=int64
	Parallel int `json:"parallel"`
	// The directory to output artifacts to (current working directory if not specified).
	ArtifactsDir string `json:"artifactsDir"`
	// Commands to run prior to running the tests.
	Commands []Command `json:"commands"`

	// ReportFormat determines test report format (JSON|XML|nil) nil == no report
	// maps to report.Type, however we don't want generated.deepcopy to have reference to it.
	ReportFormat string `json:"reportFormat"`

	// ReportName defines the name of report to create.  It defaults to "kuttl-report" and is not used unless ReportFormat is defined.
	ReportName string `json:"reportName"`
	// Namespace defines the namespace to use for tests
	// The value "" means to auto-generate tests namespaces, these namespaces will be created and removed for each test
	// Any other value is the name of the namespace to use.  This namespace will be created if it does not exist and will
	// be removed it was created (unless --skipDelete is used).
	Namespace string `json:"namespace"`
	// Suppress is used to suppress logs.
	Suppress []string `json:"suppress"`
	// FullName makes use of the full test case folder path instead of the folder name.
	FullName bool `json:"fullName"`
	// SkipTestRegex is used to skip tests based on a regular expression.
	SkipTestRegex string `json:"skipTestRegex"`

	Config *RestConfig `json:"config,omitempty"`
}

TestSuite configures which tests should be loaded.

func (*TestSuite) DeepCopy 

func (in *TestSuite) DeepCopy() *TestSuite

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuite.

func (*TestSuite) DeepCopyInto 

func (in *TestSuite) DeepCopyInto(out *TestSuite)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TestSuite) DeepCopyObject 

func (in *TestSuite) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

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.