k8stest

README

Kubernetes Test Helpers

The purpose of this package is to provide reusable kubernetes test helpers.

Functionality

This package includes the ability to create and delete k8s objects, run the collector, check data received from the collector, as well as create telemetry generators, all within a k8s environment.

Example usage

Please refer to the k8sattributes processor's e2e test for an example of how to use this package.

Documentation

Index

• func CreateCollectorObjects(t *testing.T, client *K8sClient, testID string, manifestsDir string) []*unstructured.Unstructured
• func CreateObject(client *K8sClient, manifest []byte) (*unstructured.Unstructured, error)
• func DeleteObject(client *K8sClient, obj *unstructured.Unstructured) error
• func HostEndpoint(t *testing.T) string
• func SelectorFromMap(labelMap map[string]any) labels.Selector
• func WaitForCollectorToStart(t *testing.T, client *K8sClient, podNamespace string, podLabels map[string]any)
• func WaitForTelemetryGenToStart(t *testing.T, client *K8sClient, podNamespace string, podLabels map[string]any, ...)
• type K8sClient
  • func NewK8sClient(kubeconfigPath string) (*K8sClient, error)
• type TelemetrygenCreateOpts
• type TelemetrygenObjInfo
  • func CreateTelemetryGenObjects(t *testing.T, client *K8sClient, createOpts *TelemetrygenCreateOpts) ([]*unstructured.Unstructured, []*TelemetrygenObjInfo)

Functions

func CreateCollectorObjects

func CreateCollectorObjects(t *testing.T, client *K8sClient, testID string, manifestsDir string) []*unstructured.Unstructured

func CreateObject

func CreateObject(client *K8sClient, manifest []byte) (*unstructured.Unstructured, error)

func DeleteObject

func DeleteObject(client *K8sClient, obj *unstructured.Unstructured) error

func HostEndpoint

func HostEndpoint(t *testing.T) string

func SelectorFromMap

func SelectorFromMap(labelMap map[string]any) labels.Selector

func WaitForCollectorToStart

func WaitForCollectorToStart(t *testing.T, client *K8sClient, podNamespace string, podLabels map[string]any)

func WaitForTelemetryGenToStart

func WaitForTelemetryGenToStart(t *testing.T, client *K8sClient, podNamespace string, podLabels map[string]any, workload, dataType string)

Types

type K8sClient

type K8sClient struct {
	DynamicClient   *dynamic.DynamicClient
	DiscoveryClient *discovery.DiscoveryClient
	Mapper          *restmapper.DeferredDiscoveryRESTMapper
}

func NewK8sClient

func NewK8sClient(kubeconfigPath string) (*K8sClient, error)

type TelemetrygenCreateOpts

type TelemetrygenCreateOpts struct {
	TestID       string
	ManifestsDir string
	OtlpEndpoint string
	DataTypes    []string
}

type TelemetrygenObjInfo

type TelemetrygenObjInfo struct {
	Namespace         string
	PodLabelSelectors map[string]any
	DataType          string
	Workload          string
}

func CreateTelemetryGenObjects

func CreateTelemetryGenObjects(t *testing.T, client *K8sClient, createOpts *TelemetrygenCreateOpts) ([]*unstructured.Unstructured, []*TelemetrygenObjInfo)