testutil

Documentation

Index

• Constants
• func DirHash(t *testing.T, path string) []byte
• func NewLogger(t *testing.T) log.Logger
• func NewRoundTripCheckRequest(checkRequest func(*http.Request), theResponse *http.Response, theError error) http.RoundTripper
• func RandomUnprivilegedPort(t *testing.T) int
• func RequireEqual(t testing.TB, expected, actual interface{}, msgAndArgs ...interface{})
• func RequireEqualWithOptions(t testing.TB, expected, actual interface{}, extra []cmp.Option, ...)
• func TolerantVerifyLeak(m *testing.M)
• type Closer
  • func NewCallbackCloser(fn func()) Closer
• type MockContext
  • func (c *MockContext) Deadline() (deadline time.Time, ok bool)
  • func (c *MockContext) Done() <-chan struct{}
  • func (c *MockContext) Err() error
  • func (c *MockContext) Value(interface{}) interface{}
• type T
• type TemporaryDirectory
  • func NewTemporaryDirectory(name string, t T) (handler TemporaryDirectory)

Constants

const (

	// NilCloser is a no-op Closer.
	NilCloser = nilCloser(true)
)

Functions

func DirHash

func DirHash(t *testing.T, path string) []byte

DirHash returns a hash of all files attributes and their content within a directory.

func NewLogger

func NewLogger(t *testing.T) log.Logger

NewLogger returns a gokit compatible Logger which calls t.Log.

func NewRoundTripCheckRequest

func NewRoundTripCheckRequest(checkRequest func(*http.Request), theResponse *http.Response, theError error) http.RoundTripper

NewRoundTripCheckRequest creates a new instance of a type that implements http.RoundTripper, which before returning theResponse and theError, executes checkRequest against a http.Request.

func RandomUnprivilegedPort

func RandomUnprivilegedPort(t *testing.T) int

RandomUnprivilegedPort returns valid unprivileged random port number which can be used for testing.

func RequireEqual

func RequireEqual(t testing.TB, expected, actual interface{}, msgAndArgs ...interface{})

Replacement for require.Equal using go-cmp adapted for Prometheus data structures, instead of DeepEqual.

func RequireEqualWithOptions

func RequireEqualWithOptions(t testing.TB, expected, actual interface{}, extra []cmp.Option, msgAndArgs ...interface{})

As RequireEqual but allows extra cmp.Options.

func TolerantVerifyLeak

func TolerantVerifyLeak(m *testing.M)

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

Types

type Closer

type Closer interface {
	// Close reaps the underlying directory and its children. The directory
	// could be deleted by its users already.
	Close()
}

Closer is the interface that wraps the Close method.

func NewCallbackCloser

func NewCallbackCloser(fn func()) Closer

NewCallbackCloser returns a Closer that calls the provided function upon closing.

type MockContext

type MockContext struct {
	Error  error
	DoneCh chan struct{}
}

A MockContext provides a simple stub implementation of a Context.

func (*MockContext) Deadline

func (c *MockContext) Deadline() (deadline time.Time, ok bool)

Deadline always will return not set.

func (*MockContext) Done

func (c *MockContext) Done() <-chan struct{}

Done returns a read channel for listening to the Done event.

func (*MockContext) Err

func (c *MockContext) Err() error

Err returns the error, is nil if not set.

func (*MockContext) Value

func (c *MockContext) Value(interface{}) interface{}

Value ignores the Value and always returns nil.

type T

type T interface {
	Errorf(format string, args ...interface{})
	FailNow()
}

T implements the needed methods of testing.TB so that we do not need to actually import testing (which has the side effect of adding all the test flags, which we do not want in non-test binaries even if they make use of these utilities for some reason).

type TemporaryDirectory

type TemporaryDirectory interface {
	Closer

	// Path returns the underlying path for access.
	Path() string
}

TemporaryDirectory models a closeable path for transient POSIX disk activities.

func NewTemporaryDirectory

func NewTemporaryDirectory(name string, t T) (handler TemporaryDirectory)

NewTemporaryDirectory creates a new temporary directory for transient POSIX activities.