util

Documentation

Overview

Package util provides logging and testing related utility functions.

Index

• func CompletePath(prefix string, suffix string) string
• func Logger(ctx context.Context) logr.Logger
• func OriginalStatus(ctx context.Context) *v2alpha2.ExperimentStatus
• type ContextKey

Examples

• CompletePath

Functions

func CompletePath

func CompletePath(prefix string, suffix string) string

CompletePath is a helper function for converting file paths, specified relative to the caller of this function, into absolute ones. CompletePath is useful in tests and enables deriving the absolute path of experiment YAML files.

Example

filePath := CompletePath("../test/data", "expwithextrafields.yaml")
_, _ = ioutil.ReadFile(filePath)

func Logger

func Logger(ctx context.Context) logr.Logger

Logger gets the logger from the context.

func OriginalStatus

func OriginalStatus(ctx context.Context) *v2alpha2.ExperimentStatus

OriginalStatus gets the status from the context

Types

type ContextKey

type ContextKey string

ContextKey variables can be used to retrieve values from context object

const (
	// LoggerKey is the key used to extract logger from context
	LoggerKey ContextKey = "logger"

	// OriginalStatusKey is the key used to extract the original status from the context
	OriginalStatusKey ContextKey = "originalStatus"
)