testutil

Documentation

Index

• func Assert(tb testing.TB, condition bool, v ...interface{})
• func Equals(tb testing.TB, exp, act interface{}, v ...interface{})
• func FaultOrPanicToErr(f func()) (err error)
• func GatherAndCompare(t *testing.T, g1 prometheus.Gatherer, g2 prometheus.Gatherer, filter string)
• func NotOk(tb testing.TB, err error, v ...interface{})
• func Ok(tb testing.TB, err error, v ...interface{})
• func TolerantVerifyLeak(t *testing.T)
• func TolerantVerifyLeakMain(m *testing.M)
• type TB
  • func NewTB(t testing.TB) TB

Functions

func Assert

func Assert(tb testing.TB, condition bool, v ...interface{})

Assert fails the test if the condition is false.

func Equals

func Equals(tb testing.TB, exp, act interface{}, v ...interface{})

Equals fails the test if exp is not equal to act.

func FaultOrPanicToErr

func FaultOrPanicToErr(f func()) (err error)

FaultOrPanicToErr returns error if panic of fault was triggered during execution of function.

func GatherAndCompare

func GatherAndCompare(t *testing.T, g1 prometheus.Gatherer, g2 prometheus.Gatherer, filter string)

GatherAndCompare compares the metrics of a Gatherers pair.

func NotOk

func NotOk(tb testing.TB, err error, v ...interface{})

NotOk fails the test if an err is nil.

func Ok

func Ok(tb testing.TB, err error, v ...interface{})

Ok fails the test if an err is not nil.

func TolerantVerifyLeak

func TolerantVerifyLeak(t *testing.T)

TolerantVerifyLeak verifies go leaks but excludes the go routines that are launched as side effects of some of our dependencies.

func TolerantVerifyLeakMain

func TolerantVerifyLeakMain(m *testing.M)

TolerantVerifyLeakMain verifies go leaks but excludes the go routines that are launched as side effects of some of our dependencies.

Types

type TB

type TB interface {
	testing.TB
	IsBenchmark() bool
	Run(name string, f func(t TB)) bool

	SetBytes(n int64)
	N() int
	ResetTimer()
}

TB represents union of test and benchmark. This allows the same test suite to be run by both benchmark and test, helping to reuse more code. The reason is that usually benchmarks are not being run on CI, especially for short tests, so you need to recreate usually similar tests for `Test<Name>(t *testing.T)` methods. Example of usage is presented here:

 func TestTestOrBench(t *testing.T) {
	tb := NewTB(t)
	tb.Run("1", func(tb TB) { testorbenchComplexTest(tb) })
	tb.Run("2", func(tb TB) { testorbenchComplexTest(tb) })
}

func BenchmarkTestOrBench(b *testing.B) {
	tb := NewTB(t)
	tb.Run("1", func(tb TB) { testorbenchComplexTest(tb) })
	tb.Run("2", func(tb TB) { testorbenchComplexTest(tb) })
}

func NewTB

func NewTB(t testing.TB) TB

NewTB creates tb from testing.TB.