testutil

Documentation

Index

• Constants
• func Context(t *testing.T) (context.Context, context.CancelFunc)
• func CreateTemp(t *testing.T, dir, pattern string) *os.File
• func Eventually(ctx context.Context, t testing.TB, ...) (done bool)
• func GenerateTLSCertificate(t testing.TB, commonName string) tls.Certificate
• func TempFile(t *testing.T, dir, pattern string) string

Constants

const (
	WaitShort     = 5 * time.Second
	WaitMedium    = 10 * time.Second
	WaitLong      = 15 * time.Second
	WaitSuperLong = 60 * time.Second
)

Constants for timing out operations, usable for creating contexts that timeout or in require.Eventually.

const (
	IntervalFast   = 25 * time.Millisecond
	IntervalMedium = 250 * time.Millisecond
	IntervalSlow   = time.Second
)

Constants for delaying repeated operations, e.g. in require.Eventually.

Functions

func Context

func Context(t *testing.T) (context.Context, context.CancelFunc)

func CreateTemp

func CreateTemp(t *testing.T, dir, pattern string) *os.File

CreateTemp is a convenience function for creating a temporary file, like os.CreateTemp, but it also registers a cleanup function to close and remove the file.

func Eventually

func Eventually(ctx context.Context, t testing.TB, condition func(ctx context.Context) (done bool), tick time.Duration, msgAndArgs ...interface{}) (done bool)

Eventually is like require.Eventually except it allows passing a context into the condition. It is safe to use with `require.*`.

If ctx times out, the test will fail, but not immediately. It is the caller's responsibility to exit early if required.

It is the caller's responsibility to ensure that ctx has a deadline or timeout set. Eventually will panic if this is not the case in order to avoid potentially waiting forever.

condition is not run in a goroutine; use the provided context argument for cancellation if required.

func GenerateTLSCertificate

func GenerateTLSCertificate(t testing.TB, commonName string) tls.Certificate

func TempFile

func TempFile(t *testing.T, dir, pattern string) string

TempFile returns the name of a temporary file that does not exist.