Documentation
¶
Index ¶
- Variables
- func CallerInfo() string
- func Condition(t TestingT, comp Comparison, msgAndArgs ...interface{}) bool
- func Contains(t TestingT, s, contains string, msgAndArgs ...interface{}) bool
- func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
- func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
- func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) bool
- func Error(t TestingT, err error, msgAndArgs ...interface{}) bool
- func Exactly(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
- func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool
- func False(t TestingT, value bool, msgAndArgs ...interface{}) bool
- func Implements(t TestingT, interfaceObject interface{}, object interface{}, ...) bool
- func IsType(t TestingT, expectedType interface{}, object interface{}, ...) bool
- func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
- func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool
- func NotContains(t TestingT, s, contains string, msgAndArgs ...interface{}) bool
- func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
- func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
- func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
- func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
- func ObjectsAreEqual(expected, actual interface{}) bool
- func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
- func True(t TestingT, value bool, msgAndArgs ...interface{}) bool
- func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, ...) bool
- type Comparison
- type PanicTestFunc
- type TestingT
Constants ¶
This section is empty.
Variables ¶
var AnError error = errors.New("assert.AnError general error for testing.")
AnError is an error instance useful for testing. If the code does not care about error specifics, and only needs to return the error for example, this error should be used to make the test code more readable.
Functions ¶
func CallerInfo ¶
func CallerInfo() string
CallerInfo returns a string containing the file and line number of the assert call that failed.
func Condition ¶
func Condition(t TestingT, comp Comparison, msgAndArgs ...interface{}) bool
Uses a Comparison to assert a complex condition.
func Contains ¶
Contains asserts that the specified string contains the specified substring.
assert.Contains(t, "Hello World", "World", "But 'Hello World' does contain 'World'")
Returns whether the assertion was successful (true) or not (false).
func Empty ¶
Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or a slice with len == 0.
assert.Empty(t, obj)
Returns whether the assertion was successful (true) or not (false).
func Equal ¶
Equal asserts that two objects are equal.
assert.Equal(t, 123, 123, "123 and 123 should be equal")
Returns whether the assertion was successful (true) or not (false).
func EqualError ¶
Error asserts that a function returned an error (i.e. not `nil`).
actualObj, err := SomeFunction()
if assert.Error(t, err, "An error was expected") {
assert.Equal(t, err, expectedError)
}
Returns whether the assertion was successful (true) or not (false).
func Error ¶
Error asserts that a function returned an error (i.e. not `nil`).
actualObj, err := SomeFunction()
if assert.Error(t, err, "An error was expected") {
assert.Equal(t, err, expectedError)
}
Returns whether the assertion was successful (true) or not (false).
func Exactly ¶
Exactly asserts that two objects are equal is value and type.
assert.Exactly(t, int32(123), int64(123), "123 and 123 should NOT be equal")
Returns whether the assertion was successful (true) or not (false).
func False ¶
False asserts that the specified value is true.
assert.False(t, myBool, "myBool should be false")
Returns whether the assertion was successful (true) or not (false).
func Implements ¶
func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool
Implements asserts that an object is implemented by the specified interface.
assert.Implements(t, (*MyInterface)(nil), new(MyObject), "MyObject")
func IsType ¶
func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool
IsType asserts that the specified objects are of the same type.
func Nil ¶
Nil asserts that the specified object is nil.
assert.Nil(t, err, "err should be nothing")
Returns whether the assertion was successful (true) or not (false).
func NoError ¶
NoError asserts that a function returned no error (i.e. `nil`).
actualObj, err := SomeFunction()
if assert.NoError(t, err) {
assert.Equal(t, actualObj, expectedObj)
}
Returns whether the assertion was successful (true) or not (false).
func NotContains ¶
NotContains asserts that the specified string does NOT contain the specified substring.
assert.NotContains(t, "Hello World", "Earth", "But 'Hello World' does NOT contain 'Earth'")
Returns whether the assertion was successful (true) or not (false).
func NotEmpty ¶
Empty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or a slice with len == 0.
if assert.NotEmpty(t, obj) {
assert.Equal(t, "two", obj[1])
}
Returns whether the assertion was successful (true) or not (false).
func NotEqual ¶
NotEqual asserts that the specified values are NOT equal.
assert.NotEqual(t, obj1, obj2, "two objects shouldn't be equal")
Returns whether the assertion was successful (true) or not (false).
func NotNil ¶
NotNil asserts that the specified object is not nil.
assert.NotNil(t, err, "err should be something")
Returns whether the assertion was successful (true) or not (false).
func NotPanics ¶
func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanics(t, func(){
RemainCalm()
}, "Calling RemainCalm() should NOT panic")
Returns whether the assertion was successful (true) or not (false).
func ObjectsAreEqual ¶
func ObjectsAreEqual(expected, actual interface{}) bool
ObjectsAreEqual determines if two objects are considered equal.
This function does no assertion of any kind.
func Panics ¶
func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
Panics asserts that the code inside the specified PanicTestFunc panics.
assert.Panics(t, func(){
GoCrazy()
}, "Calling GoCrazy() should panic")
Returns whether the assertion was successful (true) or not (false).
func True ¶
True asserts that the specified value is true.
assert.True(t, myBool, "myBool should be true")
Returns whether the assertion was successful (true) or not (false).
func WithinDuration ¶
func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool
WithinDuration asserts that the two times are within duration delta of each other.
assert.WithinDuration(t, time.Now(), time.Now(), 10*time.Second, "The difference should not be more than 10s")
Returns whether the assertion was successful (true) or not (false).
Types ¶
type Comparison ¶
type Comparison func() (success bool)
Comparison a custom function that returns true on success and false on failure
type PanicTestFunc ¶
type PanicTestFunc func()
PanicTestFunc defines a func that should be passed to the assert.Panics and assert.NotPanics methods, and represents a simple func that takes no arguments, and returns nothing.
Source Files