testing

Documentation

Index

• func BeControlledBy(expectedOwner any) types.GomegaMatcher
• func BeOwnedBy(expectedOwner any) types.GomegaMatcher
• func BeSematicEqual(expected interface{}) types.GomegaMatcher
• func HaveBackendRefs(backends ...gwapiv1.HTTPBackendRef) types.GomegaMatcher
• func HaveCondition(conditionType string, expectedStatus string) types.GomegaMatcher
• func HaveContainerImage(expectedImage string) types.GomegaMatcher
• func HaveGatewayRefs(expectedGateways ...gwapiv1.ParentReference) types.GomegaMatcher
• func NewTestLogger(t testingT) logr.Logger
• func ProjectRoot() string
• func SetupEnvTest(crdDirectoryPaths []string) *envtest.Environment
• type AddToSchemeFunc
• type BeSematicEqualMatcher
  • func (matcher *BeSematicEqualMatcher) FailureMessage(actual interface{}) (message string)
  • func (matcher *BeSematicEqualMatcher) Match(actual interface{}) (success bool, err error)
  • func (matcher *BeSematicEqualMatcher) NegatedFailureMessage(actual interface{}) (message string)
• type Cleaner
  • func CreateCleaner(k8sClient client.Client, config *rest.Config, timeout, interval time.Duration) *Cleaner
  • func (c *Cleaner) DeleteAll(objects ...client.Object)
• type Client
  • func (c *Client) UsingExistingCluster() bool
• type Config
  • func Configure(options ...Option) *Config
  • func NewEnvTest(options ...Option) *Config
  • func (e *Config) Start(ctx context.Context) *Client
  • func (e *Config) WithControllers(setupFunc ...SetupFunc) *Config
  • func (e *Config) WithWebhooks(setupFunc ...SetupFunc) *Config
• type Option
  • func WithCRDs(paths ...string) Option
  • func WithScheme(addToScheme ...AddToSchemeFunc) Option
  • func WithWebhookManifests(paths ...string) Option
• type SetupFunc

Functions

func BeControlledBy

func BeControlledBy(expectedOwner any) types.GomegaMatcher

BeControlledBy returns a matcher that checks if a Kubernetes object is owned AND controlled by the specified owner

func BeOwnedBy

func BeOwnedBy(expectedOwner any) types.GomegaMatcher

BeOwnedBy returns a matcher that checks if a Kubernetes object is owned by the specified owner

func BeSematicEqual

func BeSematicEqual(expected interface{}) types.GomegaMatcher

func HaveBackendRefs

func HaveBackendRefs(backends ...gwapiv1.HTTPBackendRef) types.GomegaMatcher

HaveBackendRefs returns a matcher that checks if an HTTPRoute has the specified backend refs.

func HaveCondition

func HaveCondition(conditionType string, expectedStatus string) types.GomegaMatcher

HaveCondition returns a matcher that checks if a Status has a condition with the specified type and status

func HaveContainerImage

func HaveContainerImage(expectedImage string) types.GomegaMatcher

HaveContainerImage returns a matcher that checks if a Deployment has a container with the specified image

func HaveGatewayRefs

func HaveGatewayRefs(expectedGateways ...gwapiv1.ParentReference) types.GomegaMatcher

HaveGatewayRefs returns a matcher that checks if an HTTPRoute has the specified gateway parent refs

func NewTestLogger

func NewTestLogger(t testingT) logr.Logger

NewTestLogger returns a logr.Logger that prints to the given testing.T. This is useful for logging in tests, as the output will be buffered and printed only if the test fails.

func ProjectRoot

func ProjectRoot() string

ProjectRoot returns the root directory of the project by searching for the go.mod file up from where it is called.

func SetupEnvTest

func SetupEnvTest(crdDirectoryPaths []string) *envtest.Environment

Types

type AddToSchemeFunc

type AddToSchemeFunc func(scheme *runtime.Scheme) error

type BeSematicEqualMatcher

type BeSematicEqualMatcher struct {
	Expected interface{}
}

func (*BeSematicEqualMatcher) FailureMessage

func (matcher *BeSematicEqualMatcher) FailureMessage(actual interface{}) (message string)

func (*BeSematicEqualMatcher) Match

func (matcher *BeSematicEqualMatcher) Match(actual interface{}) (success bool, err error)

func (*BeSematicEqualMatcher) NegatedFailureMessage

func (matcher *BeSematicEqualMatcher) NegatedFailureMessage(actual interface{}) (message string)

type Cleaner

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

Cleaner is a struct to perform deletion of resources, enforcing removal of finalizers. Otherwise, deletion of namespaces wouldn't be possible. See: https://book.kubebuilder.io/reference/envtest.html#namespace-usage-limitation Based on https://github.com/kubernetes-sigs/controller-runtime/issues/880#issuecomment-749742403

func CreateCleaner

func CreateCleaner(k8sClient client.Client, config *rest.Config, timeout, interval time.Duration) *Cleaner

func (*Cleaner) DeleteAll

func (c *Cleaner) DeleteAll(objects ...client.Object)

type Client

type Client struct {
	client.Client
	*envtest.Environment
	*Cleaner
}

Client acts as a facade for setting up k8s envtest. It allows to wire controllers under tests through a simple builder funcs and configure underlying test environment through Option functions. It's composed of k8s client.Client and Cleaner to provide unified way of manipulating resources it the env test cluster.

func (*Client) UsingExistingCluster

func (c *Client) UsingExistingCluster() bool

type Config

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

func Configure

func Configure(options ...Option) *Config

Configure creates a new configuration for the Kubernetes EnvTest.

func NewEnvTest

func NewEnvTest(options ...Option) *Config

NewEnvTest prepares k8s EnvTest with prereq

func (*Config) Start

func (e *Config) Start(ctx context.Context) *Client

Start wires controller-runtime manager with controllers which are subject of the tests and starts Kubernetes EnvTest to verify their behavior.

func (*Config) WithControllers

func (e *Config) WithControllers(setupFunc ...SetupFunc) *Config

WithControllers register controllers under tests required for the test suite.

func (*Config) WithWebhooks

func (e *Config) WithWebhooks(setupFunc ...SetupFunc) *Config

WithWebhooks register webhooks under tests required for the test suite.

type Option

type Option func(target *envtest.Environment)

func WithCRDs

func WithCRDs(paths ...string) Option

WithCRDs adds CRDs to the test environment using paths.

func WithScheme

func WithScheme(addToScheme ...AddToSchemeFunc) Option

WithScheme sets the scheme for the test environment.

func WithWebhookManifests

func WithWebhookManifests(paths ...string) Option

WithWebhookManifests adds CRDs to the test environment using paths.

type SetupFunc

type SetupFunc func(cfg *rest.Config, mgr ctrl.Manager) error