envtest

Documentation

Index

• Constants
• Variables
• func AdminAPIOptFns(fns ...mocks.AdminAPIHandlerOpt) []mocks.AdminAPIHandlerOpt
• func ConfigForEnvConfig(t *testing.T, envcfg *rest.Config, opts ...mocks.AdminAPIHandlerOpt) manager.Config
• func CreateNamespace(ctx context.Context, t *testing.T, client ctrlclient.Client) corev1.Namespace
• func CreatePod(ctx context.Context, t *testing.T, client ctrlclient.Client, ns string) corev1.Pod
• func DumpLogsIfTestFailed(t *testing.T, logs LogsObserver)
• func NewControllerClient(t *testing.T, scheme *runtime.Scheme, cfg *rest.Config) ctrlclient.Client
• func Scheme(t *testing.T, opts ...SchemeOption) *k8sruntime.Scheme
• func Setup(t *testing.T, scheme *k8sruntime.Scheme, optModifiers ...OptionModifier) *rest.Config
• func StartAdminAPIServerMock(t *testing.T, opts ...mocks.AdminAPIHandlerOpt) *httptest.Server
• func StartReconcilers(ctx context.Context, t *testing.T, scheme *runtime.Scheme, cfg *rest.Config, ...)
• func WaitForManagerStart(t *testing.T, logsObserver LogsObserver)
• func WithAdmissionWebhookEnabled(key, cert []byte, addr string) func(cfg *manager.Config)
• func WithDiagnosticsServer(port int) func(cfg *manager.Config)
• func WithGatewayAPI(t *testing.T, s *k8sruntime.Scheme)
• func WithGatewayAPIControllers() func(cfg *manager.Config)
• func WithGatewayFeatureEnabled(cfg *manager.Config)
• func WithGatewayToReconcile(gatewayNN string) func(cfg *manager.Config)
• func WithHealthProbePort(port int) func(cfg *manager.Config)
• func WithIngressClass(name string) func(cfg *manager.Config)
• func WithKong(t *testing.T, s *k8sruntime.Scheme)
• func WithKongAdminURLs(urls ...string) func(cfg *manager.Config)
• func WithKongServiceFacadeFeatureEnabled() func(cfg *manager.Config)
• func WithProfiling() func(cfg *manager.Config)
• func WithProxySyncSeconds(period float32) func(cfg *manager.Config)
• func WithPublishService(namespace string) func(cfg *manager.Config)
• func WithPublishStatusAddress(addresses []string, udps []string) func(cfg *manager.Config)
• func WithUpdateStatus() func(cfg *manager.Config)
• type LogsObserver
  • func CreateTestLogger(ctx context.Context) (context.Context, logr.Logger, LogsObserver)
  • func RunManager(ctx context.Context, t *testing.T, envcfg *rest.Config, ...) (manager.Config, LogsObserver)
• type ModifyManagerConfigFn
• type OptionModifier
  • func WithInstallGatewayCRDs(install bool) OptionModifier
  • func WithInstallKongCRDs(install bool) OptionModifier
• type Options
• type SchemeOption

Constants

const (
	// PublishServiceName is the name of the publish service used in Gateway API tests.
	PublishServiceName = "publish-svc"

	// ManagerStartupWaitTime is the time to wait for the manager to start.
	ManagerStartupWaitTime = 5 * time.Second

	// ManagerStartupWaitInterval is the interval to wait for the manager to start.
	ManagerStartupWaitInterval = time.Millisecond
)

Variables

var DefaultEnvTestOpts = Options{
	InstallGatewayCRDs: true,
	InstallKongCRDs:    true,
}

Functions

func AdminAPIOptFns

func AdminAPIOptFns(fns ...mocks.AdminAPIHandlerOpt) []mocks.AdminAPIHandlerOpt

AdminAPIOptFns wraps a variadic list of mocks.AdminAPIHandlerOpt and returns a slice containing all of them. The purpose of this is func is to make the call sites a bit less verbose.

NOTE: Ideally we'd refactor the RunManager() so that it'd not need to accept an empty slice of mocks.AdminAPIHandlerOpt or a call to AdminAPIOptFns() with no arguments but we can't accept 2 variadic list parameters. A slight refactor might be beneficial here.

func ConfigForEnvConfig

func ConfigForEnvConfig(t *testing.T, envcfg *rest.Config, opts ...mocks.AdminAPIHandlerOpt) manager.Config

ConfigForEnvConfig prepares a manager.Config for use in tests It will start a mock Admin API server which will be set in KIC's config and which will be automatically stopped during test cleanup.

func CreateNamespace

func CreateNamespace(ctx context.Context, t *testing.T, client ctrlclient.Client) corev1.Namespace

CreateNamespace creates namespace using the provided client and returns it.

func CreatePod

func CreatePod(ctx context.Context, t *testing.T, client ctrlclient.Client, ns string) corev1.Pod

CreatePod creates pod using the provided client and returns it.

func DumpLogsIfTestFailed

func DumpLogsIfTestFailed(t *testing.T, logs LogsObserver)

DumpLogsIfTestFailed dumps the provided logs the if the test failed.

func NewControllerClient

func NewControllerClient(t *testing.T, scheme *runtime.Scheme, cfg *rest.Config) ctrlclient.Client

NewControllerClient returns a new controller-runtime Client for provided runtime.Scheme and rest.Config.

func Scheme

func Scheme(t *testing.T, opts ...SchemeOption) *k8sruntime.Scheme

Scheme returns a new scheme with the default Kubernetes types registered. It accepts optional SchemeOptions to register additional types.

func Setup

func Setup(t *testing.T, scheme *k8sruntime.Scheme, optModifiers ...OptionModifier) *rest.Config

Setup sets up the envtest environment which will be stopped on test cleanup using t.Cleanup().

Note: If you want apiserver output on stdout set KUBEBUILDER_ATTACH_CONTROL_PLANE_OUTPUT to true when running tests.

func StartAdminAPIServerMock

func StartAdminAPIServerMock(t *testing.T, opts ...mocks.AdminAPIHandlerOpt) *httptest.Server

StartAdminAPIServerMock starts a mock Kong Admin API server. It accepts a variadic list of options which can configure the test server.

Server's .Close() method will be called during test's cleanup.

func StartReconcilers

func StartReconcilers(ctx context.Context, t *testing.T, scheme *runtime.Scheme, cfg *rest.Config, reconcilers ...controllers.Reconciler)

StartReconcilers creates a controller manager and starts the provided reconciler as its runnable. It also adds a t.Cleanup which waits for the manager to exit so that the test can be self contained and logs from different tests' managers don't mix up.

func WaitForManagerStart

func WaitForManagerStart(t *testing.T, logsObserver LogsObserver)

WaitForManagerStart waits for the manager to start. The indication of the manager starting is the "Starting manager" log entry that is emitted just before the manager starts. Note: We cannot rely here on the manager's readiness probe because it returns 200 OK as soon as it starts listening which happens before the manager actually starts.

func WithAdmissionWebhookEnabled

func WithAdmissionWebhookEnabled(key, cert []byte, addr string) func(cfg *manager.Config)

func WithDiagnosticsServer

func WithDiagnosticsServer(port int) func(cfg *manager.Config)

func WithGatewayAPI

func WithGatewayAPI(t *testing.T, s *k8sruntime.Scheme)

WithGatewayAPI registers the Gateway API types with the scheme.

func WithGatewayAPIControllers

func WithGatewayAPIControllers() func(cfg *manager.Config)

func WithGatewayFeatureEnabled

func WithGatewayFeatureEnabled(cfg *manager.Config)

func WithGatewayToReconcile

func WithGatewayToReconcile(gatewayNN string) func(cfg *manager.Config)

func WithHealthProbePort

func WithHealthProbePort(port int) func(cfg *manager.Config)

func WithIngressClass

func WithIngressClass(name string) func(cfg *manager.Config)

func WithKong

func WithKong(t *testing.T, s *k8sruntime.Scheme)

WithKong registers the Kong types with the scheme.

func WithKongAdminURLs

func WithKongAdminURLs(urls ...string) func(cfg *manager.Config)

func WithKongServiceFacadeFeatureEnabled

func WithKongServiceFacadeFeatureEnabled() func(cfg *manager.Config)

func WithProfiling

func WithProfiling() func(cfg *manager.Config)

func WithProxySyncSeconds

func WithProxySyncSeconds(period float32) func(cfg *manager.Config)

func WithPublishService

func WithPublishService(namespace string) func(cfg *manager.Config)

func WithPublishStatusAddress

func WithPublishStatusAddress(addresses []string, udps []string) func(cfg *manager.Config)

func WithUpdateStatus

func WithUpdateStatus() func(cfg *manager.Config)

Types

type LogsObserver

type LogsObserver interface {
	// All returns all the logs that have been observed so far.
	All() []observer.LoggedEntry
}

func CreateTestLogger

func CreateTestLogger(ctx context.Context) (context.Context, logr.Logger, LogsObserver)

CreateTestLogger creates a logger for use in tests. It returns the logger - which is also added to the context - and the observer which can be used to dump logs if the test fails.

func RunManager

func RunManager(
	ctx context.Context,
	t *testing.T,
	envcfg *rest.Config,
	adminAPIOpts []mocks.AdminAPIHandlerOpt,
	modifyCfgFns ...func(cfg *manager.Config),
) (manager.Config, LogsObserver)

RunManager runs the manager in a goroutine. It's possible to modify the manager's configuration by passing in modifyCfgFns. The manager is stopped when the context is canceled.

type ModifyManagerConfigFn

type ModifyManagerConfigFn func(cfg *manager.Config)

type OptionModifier

type OptionModifier func(Options) Options

func WithInstallGatewayCRDs

func WithInstallGatewayCRDs(install bool) OptionModifier

func WithInstallKongCRDs

func WithInstallKongCRDs(install bool) OptionModifier

type Options

type Options struct {
	InstallGatewayCRDs bool
	InstallKongCRDs    bool
}

type SchemeOption

type SchemeOption func(t *testing.T, s *k8sruntime.Scheme)