fixtures

Documentation

Overview

This is for test fixtures only.

Index

• func DropSource(m *gostatsd.Metric)
• func MakeMetric(opts ...MetricOpt) *gostatsd.Metric
• func NewAdvancingClock(ctx context.Context) (context.Context, func())
• func NextStep(ctx context.Context, clck *clock.Mock)
• func SortCompare(ms []*gostatsd.Metric) func(i, j int) bool
• type MetricOpt
  • func AddTag(t ...string) MetricOpt
  • func DropTag(t string) MetricOpt
  • func Name(n string) MetricOpt

Functions

func DropSource

func DropSource(m *gostatsd.Metric)

func MakeMetric

func MakeMetric(opts ...MetricOpt) *gostatsd.Metric

MakeMetric provides a way to build a metric for tests. Hopefully over time this will be used more, bringing more consistency to tests.

func NewAdvancingClock

func NewAdvancingClock(ctx context.Context) (context.Context, func())

NewAdvancingClock attaches a virtual clock to a context which advances at full speed (not wall speed), and a cancel function to stop it. The clock also stops if the context is canceled.

func NextStep

func NextStep(ctx context.Context, clck *clock.Mock)

NextStep will advance the supplied clock.Mock until it moves, or the context.Context is canceled (which typically means it timed out in wall-time). This is useful when testing things that exist inside goroutines, when it's not possible to tell when the goroutine is ready to consume mock time.

func SortCompare

func SortCompare(ms []*gostatsd.Metric) func(i, j int) bool

SortCompare func for metrics so they can be compared with require.EqualValues Invoke with sort.Slice(x, SortCompare(x))

Types

type MetricOpt

type MetricOpt func(m *gostatsd.Metric)

func AddTag

func AddTag(t ...string) MetricOpt

func DropTag

func DropTag(t string) MetricOpt

func Name

func Name(n string) MetricOpt