filter

Documentation

Index

• Constants
• func ObjectRunID(u *unstructured.Unstructured) string
• type MetaInjectionFilter
  • func (m *MetaInjectionFilter) Filter(rn *yaml.RNode) (*yaml.RNode, error)
• type Rename
  • func (r Rename) Filter(rn *yaml.RNode) (*yaml.RNode, error)
• type SpecialOpsFilter
  • func (s *SpecialOpsFilter) Filter(rn *yaml.RNode) (*yaml.RNode, error)
• type UnmarshalFunc
  • func (u UnmarshalFunc) UnmarshalYAML(node *yaml.Node) error

Constants

const (
	// LabelRunID is an annotation key to mark an object with
	// the unique ID of a test run.
	LabelRunID = "integration-tester/run-id"

	// LabelVersion is an annotation key to mark an object
	// with the version of the test harness that created it.
	LabelVersion = "integration-tester/version"

	// LabelManagedBy is a label key to mark an object as
	// managed by the test harness.
	LabelManagedBy = "app.kubernetes.io/managed-by"
)

Functions

func ObjectRunID

func ObjectRunID(u *unstructured.Unstructured) string

ObjectRunID returns the value of the LabelRunID annotation on the given object.

Types

type MetaInjectionFilter

type MetaInjectionFilter struct {
	RunID     string
	ManagedBy string
}

MetaInjectionFilter injects ObjectMeta data into Kubernetes objects. Specifically, it labels objects with the ManagedBy string, and annotates with the RunID.

func (*MetaInjectionFilter) Filter

func (m *MetaInjectionFilter) Filter(rn *yaml.RNode) (*yaml.RNode, error)

Filter ...

type Rename

type Rename struct {
	// Name is the new name of the object.
	Name string
	// Namespace is the new namespace of the object.
	Namespace string
}

Rename is a filter that rewrites the name of a Kubernetes object, i.e. it replaces the value of the `metadata.name` field.

func (Rename) Filter

func (r Rename) Filter(rn *yaml.RNode) (*yaml.RNode, error)

Filter applies the rename and returns rn.

type SpecialOpsFilter

type SpecialOpsFilter struct {
	Ops map[string]interface{}

	Decoders map[string]yaml.Unmarshaler
}

SpecialOpsFilter is a yaml.Filter that extracts top-level YAML keys whose name begins with `$`. These keys denote special operations that test drivers need to interpolate.

func (*SpecialOpsFilter) Filter

func (s *SpecialOpsFilter) Filter(rn *yaml.RNode) (*yaml.RNode, error)

Filter runs the SpecialOpsFilter.

type UnmarshalFunc

type UnmarshalFunc func(value *yaml.Node) error

UnmarshalFunc is a yaml.Unmarshaler adapator.

func (UnmarshalFunc) UnmarshalYAML

func (u UnmarshalFunc) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML ...