testboil

Documentation

Overview

testboil contains functions consistently reused for testing. It doesn't have any dependencies except standard library and go_away_boilerplate

Index

• func CaptureStdout(t *testing.T, do func(t *testing.T)) string
• func CheckEqualsWithinTimeout[T comparable](currMu *sync.Mutex, curr *T, want T, timeout, pollRate time.Duration) bool
• func CreateTestFile(t *testing.T, fileName string) *os.File
• func FailTestIfDiff[C comparable](t *testing.T, got, want C)
• func ReturnsOnContextCancel(t *testing.T, f func(context.Context), testTimeout time.Duration)

Functions

func CaptureStdout

func CaptureStdout(t *testing.T, do func(t *testing.T)) string

CaptureStdout when do is called. Restore stdout as test cleanup

func CheckEqualsWithinTimeout

func CheckEqualsWithinTimeout[T comparable](currMu *sync.Mutex, curr *T, want T, timeout, pollRate time.Duration) bool

CheckEqualsWithinTimeout by polling at pollRate. Will at most block for timeout, when it will return false in case that curr != want

func CreateTestFile

func CreateTestFile(t *testing.T, fileName string) *os.File

CreateTestFile or fatal trying. Since it t.Fatalf on failure, return value won't matter. So the return value can be assumed to never be nil

func FailTestIfDiff

func FailTestIfDiff[C comparable](t *testing.T, got, want C)

func ReturnsOnContextCancel

func ReturnsOnContextCancel(t *testing.T, f func(context.Context), testTimeout time.Duration)

ReturnsOnContextCancel by creating a context and ensuring that the function returns once the context has been cancelled