testrunner

Documentation

Index

• func ConvertToUnstructured(data []byte) (*unstructured.Unstructured, error)
• func LoadFile(path string) ([]byte, error)
• func RootDir() string
• type Expected
• type Generation
• type Input
• type Mutation
• type Scenario
• type TestCase
• type Validation

Functions

func ConvertToUnstructured

func ConvertToUnstructured(data []byte) (*unstructured.Unstructured, error)

ConvertToUnstructured converts a resource to unstructured format

func LoadFile

func LoadFile(path string) ([]byte, error)

LoadFile loads file in byte buffer

func RootDir

func RootDir() string

RootDir returns the kyverno project directory based on the location of the current file. It assumes that the project directory is 2 levels up. This means if this function is moved it may not work as expected.

Types

type Expected

type Expected struct {
	Mutation   Mutation   `yaml:"mutation,omitempty"`
	Validation Validation `yaml:"validation,omitempty"`
	Generation Generation `yaml:"generation,omitempty"`
}

type Generation

type Generation struct {
	// generated resources
	GeneratedResources []kyvernov1.ResourceSpec `yaml:"generatedResources"`
	// expected response from the policy engine
	PolicyResponse response.PolicyResponse `yaml:"policyresponse"`
}

type Input

type Input struct {
	Policy        string   `yaml:"policy"`
	Resource      string   `yaml:"resource"`
	LoadResources []string `yaml:"loadresources,omitempty"`
}

Input defines input for a test scenario

type Mutation

type Mutation struct {
	// path to the patched resource to be compared with
	PatchedResource string `yaml:"patchedresource,omitempty"`
	// expected response from the policy engine
	PolicyResponse response.PolicyResponse `yaml:"policyresponse"`
}

type Scenario

type Scenario struct {
	TestCases []TestCase
}

type TestCase

type TestCase struct {
	Input    Input    `yaml:"input"`
	Expected Expected `yaml:"expected"`
}

TestCase defines input and output for a case

type Validation

type Validation struct {
	// expected response from the policy engine
	PolicyResponse response.PolicyResponse `yaml:"policyresponse"`
}