testtool

func AssertChanNoReceive ¶

func AssertChanNoReceive(
	t *testing.T,
	ch chan struct{},
	name string,
	timeout time.Duration,
)

AssertChanNoreceive ensures that the specified channel never received a message. AssertChanNoReceive requires a name of the function that should not write to the channel in order to provide a useful error message.

func AssertChanReceive ¶

func AssertChanReceive(
	t *testing.T,
	ch chan struct{},
	name string,
	timeout time.Duration,
	numSends int,
)

AssertChanReceive ensures that the given channel received the specified number of messages. The supplied timeout specifies the timeout on each expected read. It is not a cumulative timeout for all reads. AssertChanReceive requires a name of the function that should write to the channel in order to provide a useful error message.

func Fatal ¶

func Fatal(t Logger, args ...interface{})

Fatal fails the test with a simple format for the message.

func Fatalf ¶

func Fatalf(l Logger, f string, args ...interface{})

Fatalf wraps Fatalf in order to provide a functional stack trace on failures rather than just a line number of the failing check. This helps if you have a test that fails in a loop since it will show the path to get there as well as the error directly.

func RandomTestString ¶

func RandomTestString(n int) string

RandomTestString generates a random test string from only upper and lower case letters.

func RootTempDir ¶

func RootTempDir(t *TestTool) string

RootTempDir creates a directory that will exist until the process running the tests exits.

func SendWithCancel ¶

func SendWithCancel(w chan<- struct{}, done <-chan struct{})

SendWithCancel expects a channel to write a signal to, and also a channel that indicates when the signal listener is no longer listening.

func TestEqual ¶

func TestEqual(t Logger, have, want interface{}, msg ...string)

func TestExpectError ¶

func TestExpectError(l Logger, err error, msg ...string)

TestExpectError calls Fatal if err is nil.

func TestExpectNonNil ¶

func TestExpectNonNil(t Logger, i interface{}, msg ...string)

func TestExpectNonZeroLength ¶

func TestExpectNonZeroLength(l Logger, size int)

TestExpectNonZeroLength fails the test if the given value is zero.

func TestExpectPanic ¶

func TestExpectPanic(l Logger, f func(), msg string)

TestExpectPanic verifies that a panic is called with the expected msg.

func TestExpectSuccess ¶

func TestExpectSuccess(l Logger, err error, msg ...string)

TestExpectSuccess fails the test if err is not nil and fails the test and output the reason for the failure as the err argument the same as Fatalf. If err implements the BackTracer interface a backtrace will also be displayed.

func TestExpectZeroLength ¶

func TestExpectZeroLength(l Logger, size int)

TestExpectNonZeroLength fails the test if the given value is not zero.

func TestFalse ¶

func TestFalse(t Logger, ans bool)

func TestHttpGet ¶

func TestHttpGet(t Logger, url string, expectedReturnCode int) (string, int)

Test an HTTP GET to the given URL. If expectedReturnCode is a value other than -1, the test will fail if the response status code doesn't match the exptected code. Method returns the string value of the response body and the status code.

func TestHttpGetTimeout ¶

func TestHttpGetTimeout(t Logger, url string, expectedReturnCode int, duration time.Duration) (string, int)

Test an HTTP GET to the given URL for the amount of time specified in duration. This will retry with multiple requests until one is successful or it has taken longer than the duration. If expectedReturnCode is a value other than -1, the test will fail if the response status code doesn't match the exptected code. Method returns the string value of the response body and the status code.

func TestHttpPost ¶

func TestHttpPost(
	t Logger, url string, contentType string, body string, expectedReturnCode int,
) (string, int)

Test an HTTP POST to the given URL, with the given content type and request body.. If expectedReturnCode is a value other than -1, the test will fail if the response status code doesn't match the exptected code. Method returns the string value of the response body and the status code.

func TestHttpPut ¶

func TestHttpPut(
	t Logger, url string, contentType string, body string, expectedReturnCode int,
) (string, int)

Test an HTTP PUT to the given URL, with the given content type and request body.. If expectedReturnCode is a value other than -1, the test will fail if the response status code doesn't match the exptected code. Method returns the string value of the response body and the status code.

func TestMatch ¶

func TestMatch(t Logger, have string, r *regexp.Regexp)

func TestNotEqual ¶

func TestNotEqual(t Logger, have, want interface{}, msg ...string)

func TestNotMatch ¶

func TestNotMatch(t Logger, have string, r *regexp.Regexp)

func TestRequiresRoot ¶

func TestRequiresRoot(l Logger)

TestRequiresRoot is called to require that your test is run as root. NOTICE: this does not cause the test to FAIL. This seems like the most sane thing to do based on the shortcomings of Go's test utilities.

As an added feature this function will append all skipped test names into the file name specified in the environment variable:

$SKIPPED_ROOT_TESTS_FILE

func TestTrue ¶

func TestTrue(t Logger, ans bool)

func Timeout ¶

func Timeout(l Logger, timeout, sleep time.Duration, f func() bool)

Timeout runs the given function until 'timeout' has passed, sleeping 'sleep' duration in between runs. If the function returns true this exits, otherwise after timeout this will fail the test.