tests

Documentation

Index

• Constants
• func ContextWithTimeout(tc TestContext, duration time.Duration) context.Context
• func DefaultContext(tc TestContext) context.Context
• func DefaultNotifyContext(duration time.Duration, cleanup func(func())) context.Context
• func GetMetricValue(metrics NodeMetrics, name string, labels prometheus.Labels) (float64, bool)
• func LoggerForFormat(prefix string, rawLogFormat string) (logging.Logger, error)
• func NewDefaultLogger(prefix string) logging.Logger
• func WithDefaultContext(tc TestContext) common.Option
• type NodeMetrics
  • func GetNodeMetrics(ctx context.Context, nodeURI string) (NodeMetrics, error)
• type NodesMetrics
  • func GetNodesMetrics(ctx context.Context, nodeURIs []string) (NodesMetrics, error)
• type SimpleTestContext
  • func NewTestContext(log logging.Logger) *SimpleTestContext
  • func (tc *SimpleTestContext) By(_ string, _ ...func())
  • func (tc *SimpleTestContext) Cleanup()
  • func (tc *SimpleTestContext) ContextWithTimeout(duration time.Duration) context.Context
  • func (tc *SimpleTestContext) DefaultContext() context.Context
  • func (tc *SimpleTestContext) DeferCleanup(cleanup func())
  • func (tc *SimpleTestContext) Errorf(format string, args ...interface{})
  • func (tc *SimpleTestContext) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msg string)
  • func (*SimpleTestContext) FailNow()
  • func (tc *SimpleTestContext) Log() logging.Logger
  • func (tc *SimpleTestContext) WithDefaultContext() common.Option
• type TestContext

Constants

const DefaultTimeout = 2 * time.Minute

A long default timeout used to timeout failed operations but unlikely to induce flaking due to unexpected resource contention.

Functions

func ContextWithTimeout

func ContextWithTimeout(tc TestContext, duration time.Duration) context.Context

Helper simplifying use of a timed context by canceling the context with the test context.

func DefaultContext

func DefaultContext(tc TestContext) context.Context

Helper simplifying use of a timed context configured with the default timeout.

func DefaultNotifyContext

func DefaultNotifyContext(duration time.Duration, cleanup func(func())) context.Context

DefaultNotifyContext returns a context that is marked done when signals indicating process termination are received. If a non-zero duration is provided, the parent to the notify context will be a context with a timeout for that duration.

func GetMetricValue

func GetMetricValue(metrics NodeMetrics, name string, labels prometheus.Labels) (float64, bool)

GetMetricValue returns the value of the specified metric which has the required labels.

If multiple metrics match the provided labels, the first metric found is returned.

Only Counter and Gauge metrics are supported.

func LoggerForFormat

func LoggerForFormat(prefix string, rawLogFormat string) (logging.Logger, error)

TODO(marun) Does/should the logging package have a function like this?

func NewDefaultLogger

func NewDefaultLogger(prefix string) logging.Logger

func WithDefaultContext

func WithDefaultContext(tc TestContext) common.Option

Helper simplifying use via an option of a timed context configured with the default timeout.

Types

type NodeMetrics

type NodeMetrics map[string]*dto.MetricFamily

"metric name" -> "metric value"

func GetNodeMetrics

func GetNodeMetrics(ctx context.Context, nodeURI string) (NodeMetrics, error)

GetNodeMetrics retrieves the specified metrics the provided node URI.

type NodesMetrics

type NodesMetrics map[string]NodeMetrics

URI -> "metric name" -> "metric value"

func GetNodesMetrics

func GetNodesMetrics(ctx context.Context, nodeURIs []string) (NodesMetrics, error)

GetNodesMetrics retrieves the specified metrics for the provided node URIs.

type SimpleTestContext

type SimpleTestContext struct {
	// contains filtered or unexported fields
}

func NewTestContext

func NewTestContext(log logging.Logger) *SimpleTestContext

func (*SimpleTestContext) By

func (tc *SimpleTestContext) By(_ string, _ ...func())

func (*SimpleTestContext) Cleanup

func (tc *SimpleTestContext) Cleanup()

Cleanup is intended to be deferred by the caller to ensure cleanup is performed even in the event that a panic occurs.

func (*SimpleTestContext) ContextWithTimeout

func (tc *SimpleTestContext) ContextWithTimeout(duration time.Duration) context.Context

Helper simplifying use of a timed context by canceling the context on ginkgo teardown.

func (*SimpleTestContext) DefaultContext

func (tc *SimpleTestContext) DefaultContext() context.Context

Helper simplifying use of a timed context configured with the default timeout.

func (*SimpleTestContext) DeferCleanup

func (tc *SimpleTestContext) DeferCleanup(cleanup func())

func (*SimpleTestContext) Errorf

func (tc *SimpleTestContext) Errorf(format string, args ...interface{})

func (*SimpleTestContext) Eventually

func (tc *SimpleTestContext) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msg string)

func (*SimpleTestContext) FailNow

func (*SimpleTestContext) FailNow()

func (*SimpleTestContext) Log

func (tc *SimpleTestContext) Log() logging.Logger

func (*SimpleTestContext) WithDefaultContext

func (tc *SimpleTestContext) WithDefaultContext() common.Option

Helper simplifying use via an option of a timed context configured with the default timeout.

type TestContext

type TestContext interface {
	// Ensures the context can be used to instantiate a require instance
	require.TestingT

	// Ensures compatibility with ginkgo.By
	By(text string, callback ...func())

	// Provides a simple alternative to ginkgo.DeferCleanup
	DeferCleanup(cleanup func())

	// Returns a logger that can be used to log test output
	Log() logging.Logger

	// Context helpers requiring cleanup with DeferCleanup
	ContextWithTimeout(duration time.Duration) context.Context
	DefaultContext() context.Context
	WithDefaultContext() common.Option

	// Ensures compatibility with require.Eventually
	Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msg string)
}