assert

Documentation

Overview

Package assert offers some very simple helper methods for testing. Not meant for external use per se, though there's nothing tying this to our codebase / project.

Assertion methods (Equal, True, False, etc) expect a `message` string to be passed in, which should be a simple explanation that will help you understand what went wrong, such as "foo.Bar is 25". Wordy messages won't necessarily help debugging as assert functions should report as much information as they can about where an assertion went wrong.

Index

• func Equal(expected, actual interface{}, message string, t *testing.T)
• func False(exp bool, m string, t *testing.T)
• func IncludesString(expected string, list []string, message string, t *testing.T)
• func True(expression bool, message string, t *testing.T)
• type Caller

Functions

func Equal

func Equal(expected, actual interface{}, message string, t *testing.T)

Equal verifies that `expected` and `actual` are the same as per "!=" rules. This makes it work well for simple types, but more complex types will still need specialized checks.

func False

func False(exp bool, m string, t *testing.T)

False is a convenience method wrapping True and negating the expression

func IncludesString

func IncludesString(expected string, list []string, message string, t *testing.T)

IncludesString checks `list` for inclusion of `string`, reporting failure if it is not present.

func True

func True(expression bool, message string, t *testing.T)

True fails the tests if `expression` isn't the boolean value `true`

Types

type Caller

type Caller struct {
	Func     *runtime.Func
	Name     string
	Filename string
	Line     int
}

Caller represents data used by an assertion to show the file/function/line of where an assertion went wrong, rather than using the built-in system which would report the "failure" function every time, since all asserts that fail eventually find their way in there.