helpers

package

v0.2.0-alpha.1 Latest Latest Go to latest Published: Sep 19, 2025 License: Apache-2.0 Imports: 43 Imported by: 0

Documentation ¶

Overview ¶

Package helpers includes helper functions important for unit and integration testing.

Index ¶

Constants
type TestEnvironment
- func NewTestEnvironment() *TestEnvironment

Constants ¶

View Source

const (
	// DefaultKindClusterName is the name for workload kind cluster.
	DefaultKindClusterName = "cso-kind-workload-cluster"

	// DefaultPodNamespace is default the namespace for the envtest resources.
	DefaultPodNamespace = "cso-system"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type TestEnvironment ¶

type TestEnvironment struct {
	ctrl.Manager
	client.Client
	KubeConfig string
	Config     *rest.Config

	WorkloadClusterClient *kubernetes.Clientset
	AssetsClientFactory   assetsclient.Factory
	KubeClientFactory     kubeclient.Factory
	AssetsClient          *assetsclientmocks.Client
	KubeClient            *kubemocks.Client
	// contains filtered or unexported fields
}

TestEnvironment encapsulates a Kubernetes local test environment.

func NewTestEnvironment ¶

func NewTestEnvironment() *TestEnvironment

NewTestEnvironment creates a new environment spinning up a local api-server.

func (*TestEnvironment) Cleanup ¶

func (t *TestEnvironment) Cleanup(ctx context.Context, objs ...client.Object) error

Cleanup deletes client objects.

func (*TestEnvironment) CreateKubeconfigSecret ¶

func (t *TestEnvironment) CreateKubeconfigSecret(ctx context.Context, cluster *clusterv1.Cluster) error

CreateKubeconfigSecret generates a kubeconfig secret in a given capi cluster.

func (*TestEnvironment) CreateNamespace ¶

func (t *TestEnvironment) CreateNamespace(ctx context.Context, generateName string) (*corev1.Namespace, error)

CreateNamespace creates a namespace.

func (*TestEnvironment) StartManager ¶

func (t *TestEnvironment) StartManager(ctx context.Context) error

StartManager starts the manager and sets a cancel function into the testEnv object.

func (*TestEnvironment) Stop ¶

func (t *TestEnvironment) Stop() error

Stop stops the manager and cancels the context.

func (*TestEnvironment) WaitForWebhooks ¶

func (*TestEnvironment) WaitForWebhooks()

WaitForWebhooks waits for webhook port to be ready.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
builder Package builder contains important CRD definitions for different provider kind.	Package builder contains important CRD definitions for different provider kind.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL