test

Documentation

Overview

package test contains helpers for writing tests

Index

• Variables
• func ExecError(err error) error
• func HasCluster() error
• func JSONPretty(v any) string
• func JSONString(v any) string
• func ListenPort() (int, error)
• func Must[T any](v T, err error) T
• func PanicErr(err error)
• func SkipIfNoCluster(t *testing.T)
• func SkipIfNoCommand(t *testing.T, cmd string)
• func TempNamespace(t *testing.T, c client.Client) string
• func Watch(t *testing.T, w watch.Interface, timeout time.Duration, ...)
• type LokiServer
  • func NewLokiServer() (server *LokiServer, err error)
  • func RequireLokiServer(t *testing.T) *LokiServer
  • func (s *LokiServer) Close() error
  • func (s *LokiServer) Push(labels map[string]string, lines ...string) error
  • func (s *LokiServer) URL() *url.URL

Variables

var (

	// These variables are initialized if HasCluster succeeds.
	// Safe for use in tests after calling SkipIfNoCluster.
	RESTConfig *rest.Config
	K8sClient  client.WithWatch
	HTTPClient *http.Client
)

Functions

func ExecError

func ExecError(err error) error

ExecError extracts stderr if err is an exec.ExitError

func HasCluster

func HasCluster() error

func JSONPretty

func JSONPretty(v any) string

JSONPretty returns an indented JSON string, or error message if marshal fails.

func JSONString

func JSONString(v any) string

JSONString returns the JSON marshaled string from v, or the error message if marshal fails

func ListenPort

func ListenPort() (int, error)

ListenPort returns a free ephemeral port for listening.

func Must

func Must[T any](v T, err error) T

Must panics if err is not nil, else returns v.

func PanicErr

func PanicErr(err error)

PanicErr panics if err is not nil

func SkipIfNoCluster

func SkipIfNoCluster(t *testing.T)

SkipIfNoCluster calls t.Skip if no cluster is detected.

func SkipIfNoCommand

func SkipIfNoCommand(t *testing.T, cmd string)

SkipIfNoCommand skips a test if the cmd is not found in PATH

func TempNamespace

func TempNamespace(t *testing.T, c client.Client) string

TempNamespace creates a unique namespace.

func Watch

func Watch(t *testing.T, w watch.Interface, timeout time.Duration, f func(e watch.Event) (finished bool))

Watch in a loop, call f for each event, return when f returns true. Fatal if watch closes or times out

Types

type LokiServer

type LokiServer struct {
	Port        int
	ContainerID string
}

LokiServer is a single-process Loki instance running in a container.

func NewLokiServer

func NewLokiServer() (server *LokiServer, err error)

func RequireLokiServer

func RequireLokiServer(t *testing.T) *LokiServer

func (*LokiServer) Close

func (s *LokiServer) Close() error

func (*LokiServer) Push

func (s *LokiServer) Push(labels map[string]string, lines ...string) error

func (*LokiServer) URL

func (s *LokiServer) URL() *url.URL