import "github.com/stretchr/testify/assert"
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
Note
All functions in this package return a bool value indicating whether the assertion has passed.
Example Usage
The following is a complete example using assert in a standard test function:
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestSomething(t *testing.T) {
var a string = "Hello"
var b string = "Hello"
assert.Equal(t, a, b, "The two words should be the same.")
}if you assert many times, use the format below:
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestSomething(t *testing.T) {
assert := assert.New(t)
var a string = "Hello"
var b string = "Hello"
assert.Equal(a, b, "The two words should be the same.")
}Assertions
Assertions allow you to easily write test code, and are global funcs in the assert package. All assertion functions take, as the first argument, the *testing.T object provided by the testing framework. This allows the assertion funcs to write the failings and other details to the correct place.
Every assertion function also takes an optional string message as the final argument, allowing custom error messages to be appended to the message the assertion method outputs.
Variables
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.
var AnError = errors.New("assert.AnError general error for testing")Functions
func CallerInfo() []string
Source: assert/assertions.go:211
CallerInfo returns an array of strings containing the file and line number of each stack frame leading from the current test to the assert call that failed.
func Condition(t TestingT, comp Comparison, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1265
Condition uses a Comparison to assert a complex condition.
func Conditionf(t TestingT, comp Comparison, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:12
Conditionf uses a Comparison to assert a complex condition.
func Contains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:961
Contains asserts that the specified string, list(array, slice...) or map contains the specified substring or element.
assert.Contains(t, "Hello World", "World")
assert.Contains(t, ["Hello", "World"], "World")
assert.Contains(t, {"Hello": "World"}, "Hello")func Containsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:25
Containsf asserts that the specified string, list(array, slice...) or map contains the specified substring or element.
assert.Containsf(t, "Hello World", "World", "error message %s", "formatted")
assert.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted")
assert.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted")func DirExists(t TestingT, path string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1823
DirExists checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists.
func DirExistsf(t TestingT, path string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:34
DirExistsf checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists.
func ElementsMatch(t TestingT, listA, listB interface{}, msgAndArgs ...interface{}) (ok bool)
Source: assert/assertions.go:1140
ElementsMatch asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.
assert.ElementsMatch(t, [1, 3, 2, 3], [1, 3, 3, 2])
func ElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:46
ElementsMatchf asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.
assert.ElementsMatchf(t, [1, 3, 2, 3], [1, 3, 3, 2], "error message %s", "formatted")
func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:791
Empty asserts that the given value is "empty".
Zero values are "empty".
Arrays are "empty" if every element is the zero value of the type (stricter than "empty").
Slices, maps and channels with zero length are "empty".
Pointer values are "empty" if the pointer is nil or if the pointed value is "empty".
assert.Empty(t, obj)func Emptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:66
Emptyf asserts that the given value is "empty".
Zero values are "empty".
Arrays are "empty" if every element is the zero value of the type (stricter than "empty").
Slices, maps and channels with zero length are "empty".
Pointer values are "empty" if the pointer is nil or if the pointed value is "empty".
assert.Emptyf(t, obj, "error message %s", "formatted")func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:496
Equal asserts that two objects are equal.
assert.Equal(t, 123, 123)Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail.
func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1671
EqualError asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error.
actualObj, err := SomeFunction()
assert.EqualError(t, err, expectedErrorString)func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:92
EqualErrorf asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error.
actualObj, err := SomeFunction()
assert.EqualErrorf(t, err, expectedErrorString, "error message %s", "formatted")func EqualExportedValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:661
EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ.
type S struct {
Exported int
notExported int
}
assert.EqualExportedValues(t, S{1, 2}, S{1, 3}) => true
assert.EqualExportedValues(t, S{1, 2}, S{2, 3}) => falsefunc EqualExportedValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:109
EqualExportedValuesf asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ.
type S struct {
Exported int
notExported int
}
assert.EqualExportedValuesf(t, S{1, 2}, S{1, 3}, "error message %s", "formatted") => true
assert.EqualExportedValuesf(t, S{1, 2}, S{2, 3}, "error message %s", "formatted") => falsefunc EqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:635
EqualValues asserts that two objects are equal or convertible to the larger type and equal.
assert.EqualValues(t, uint32(123), int32(123))func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:120
EqualValuesf asserts that two objects are equal or convertible to the larger type and equal.
assert.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted")func Equalf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:80
Equalf asserts that two objects are equal.
assert.Equalf(t, 123, 123, "error message %s", "formatted")Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail.
func Error(t TestingT, err error, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1655
Error asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction()
assert.Error(t, err)func ErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2240
ErrorAs asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As.
func ErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:140
ErrorAsf asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As.
func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1694
ErrorContains asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring.
actualObj, err := SomeFunction()
assert.ErrorContains(t, err, expectedErrorSubString)func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:152
ErrorContainsf asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring.
actualObj, err := SomeFunction()
assert.ErrorContainsf(t, err, expectedErrorSubString, "error message %s", "formatted")func ErrorIs(t TestingT, err, target error, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2191
ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func ErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:161
ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func Errorf(t TestingT, err error, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:131
Errorf asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction()
assert.Errorf(t, err, "error message %s", "formatted")func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2007
Eventually asserts that given condition will be met in waitFor time, periodically checking target function each tick.
assert.Eventually(t, func() bool { return true; }, time.Second, 10*time.Millisecond)func EventuallyWithT(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2102
EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t.
externalValue := false
go func() {
time.Sleep(8*time.Second)
externalValue = true
}()
assert.EventuallyWithT(t, func(c *assert.CollectT) {
// add assertions as needed; any assertion failure will fail the current tick
assert.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")func EventuallyWithTf(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:197
EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t.
externalValue := false
go func() {
time.Sleep(8*time.Second)
externalValue = true
}()
assert.EventuallyWithTf(t, func(c *assert.CollectT) {
// add assertions as needed; any assertion failure will fail the current tick
assert.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "error message %s", "formatted")func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:172
Eventuallyf asserts that given condition will be met in waitFor time, periodically checking target function each tick.
assert.Eventuallyf(t, func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")func Exactly(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:690
Exactly asserts that two objects are equal in value and type.
assert.Exactly(t, int32(123), int64(123))func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:207
Exactlyf asserts that two objects are equal in value and type.
assert.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted")func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:367
Fail reports a failure through
func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:346
FailNow fails test
func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:223
FailNowf fails test
func Failf(t TestingT, failureMessage string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:215
Failf reports a failure through
func False(t TestingT, value bool, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:866
False asserts that the specified value is false.
assert.False(t, myBool)func Falsef(t TestingT, value bool, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:233
Falsef asserts that the specified value is false.
assert.Falsef(t, myBool, "error message %s", "formatted")func FileExists(t TestingT, path string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1788
FileExists checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file.
func FileExistsf(t TestingT, path string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:242
FileExistsf checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file.
func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_compare.go:389
Greater asserts that the first element is greater than the second
assert.Greater(t, 2, 1)
assert.Greater(t, float64(2), float64(1))
assert.Greater(t, "b", "a")func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_compare.go:403
GreaterOrEqual asserts that the first element is greater than or equal to the second
assert.GreaterOrEqual(t, 2, 1)
assert.GreaterOrEqual(t, 2, 2)
assert.GreaterOrEqual(t, "b", "a")
assert.GreaterOrEqual(t, "b", "b")func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:267
GreaterOrEqualf asserts that the first element is greater than or equal to the second
assert.GreaterOrEqualf(t, 2, 1, "error message %s", "formatted")
assert.GreaterOrEqualf(t, 2, 2, "error message %s", "formatted")
assert.GreaterOrEqualf(t, "b", "a", "error message %s", "formatted")
assert.GreaterOrEqualf(t, "b", "b", "error message %s", "formatted")func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:254
Greaterf asserts that the first element is greater than the second
assert.Greaterf(t, 2, 1, "error message %s", "formatted")
assert.Greaterf(t, float64(2), float64(1), "error message %s", "formatted")
assert.Greaterf(t, "b", "a", "error message %s", "formatted")func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) string
Source: assert/http_assertions.go:114
HTTPBody is a helper that returns HTTP body of the response. It returns empty string if building a new request fails.
func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/http_assertions.go:133
HTTPBodyContains asserts that a specified handler returns a body that contains a string.
assert.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")Returns whether the assertion was successful (true) or not (false).
func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:280
HTTPBodyContainsf asserts that a specified handler returns a body that contains a string.
assert.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/http_assertions.go:153
HTTPBodyNotContains asserts that a specified handler returns a body that does not contain a string.
assert.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")Returns whether the assertion was successful (true) or not (false).
func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:293
HTTPBodyNotContainsf asserts that a specified handler returns a body that does not contain a string.
assert.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool
Source: assert/http_assertions.go:73
HTTPError asserts that a specified handler returns an error status code.
assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:305
HTTPErrorf asserts that a specified handler returns an error status code.
assert.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool
Source: assert/http_assertions.go:51
HTTPRedirect asserts that a specified handler returns a redirect status code.
assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:317
HTTPRedirectf asserts that a specified handler returns a redirect status code.
assert.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) bool
Source: assert/http_assertions.go:95
HTTPStatusCode asserts that a specified handler returns a specified status code.
assert.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501)Returns whether the assertion was successful (true) or not (false).
func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:329
HTTPStatusCodef asserts that a specified handler returns a specified status code.
assert.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool
Source: assert/http_assertions.go:29
HTTPSuccess asserts that a specified handler returns a success status code.
assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil)Returns whether the assertion was successful (true) or not (false).
func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:341
HTTPSuccessf asserts that a specified handler returns a success status code.
assert.HTTPSuccessf(t, myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:424
Implements asserts that an object is implemented by the specified interface.
assert.Implements(t, (*MyInterface)(nil), new(MyObject))func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:351
Implementsf asserts that an object is implemented by the specified interface.
assert.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")func InDelta(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1454
InDelta asserts that the two numerals are within delta of each other.
assert.InDelta(t, math.Pi, 22/7.0, 0.01)func InDeltaMapValues(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1511
InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func InDeltaMapValuesf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:369
InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func InDeltaSlice(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1487
InDeltaSlice is the same as InDelta, except it compares two slices.
func InDeltaSlicef(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:377
InDeltaSlicef is the same as InDelta, except it compares two slices.
func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:361
InDeltaf asserts that the two numerals are within delta of each other.
assert.InDeltaf(t, math.Pi, 22/7.0, 0.01, "error message %s", "formatted")func InEpsilon(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1577
InEpsilon asserts that expected and actual have a relative error less than epsilon
func InEpsilonSlice(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1600
InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
func InEpsilonSlicef(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:393
InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.
func InEpsilonf(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:385
InEpsilonf asserts that expected and actual have a relative error less than epsilon
func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_order.go:76
IsDecreasing asserts that the collection is decreasing
assert.IsDecreasing(t, []int{2, 1, 0})
assert.IsDecreasing(t, []float{2, 1})
assert.IsDecreasing(t, []string{"b", "a"})func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:405
IsDecreasingf asserts that the collection is decreasing
assert.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted")
assert.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted")
assert.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted")func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_order.go:52
IsIncreasing asserts that the collection is increasing
assert.IsIncreasing(t, []int{1, 2, 3})
assert.IsIncreasing(t, []float{1, 2})
assert.IsIncreasing(t, []string{"a", "b"})func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:417
IsIncreasingf asserts that the collection is increasing
assert.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted")
assert.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted")
assert.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted")func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_order.go:88
IsNonDecreasing asserts that the collection is not decreasing
assert.IsNonDecreasing(t, []int{1, 1, 2})
assert.IsNonDecreasing(t, []float{1, 2})
assert.IsNonDecreasing(t, []string{"a", "b"})func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:429
IsNonDecreasingf asserts that the collection is not decreasing
assert.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted")
assert.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted")
assert.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted")func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_order.go:64
IsNonIncreasing asserts that the collection is not increasing
assert.IsNonIncreasing(t, []int{2, 1, 1})
assert.IsNonIncreasing(t, []float{2, 1})
assert.IsNonIncreasing(t, []string{"b", "a"})func IsNonIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:441
IsNonIncreasingf asserts that the collection is not increasing
assert.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted")
assert.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted")
assert.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted")func IsNotType(t TestingT, theType, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:479
IsNotType asserts that the specified objects are not of the same type.
assert.IsNotType(t, &NotMyStruct{}, &MyStruct{})func IsNotTypef(t TestingT, theType interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:451
IsNotTypef asserts that the specified objects are not of the same type.
assert.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")func IsType(t TestingT, expectedType, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:466
IsType asserts that the specified objects are of the same type.
assert.IsType(t, &MyStruct{}, &MyStruct{})func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:461
IsTypef asserts that the specified objects are of the same type.
assert.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted")func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1862
JSONEq asserts that two JSON strings are equivalent.
assert.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)func JSONEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:471
JSONEqf asserts that two JSON strings are equivalent.
assert.JSONEqf(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted")func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:834
Len asserts that the specified object has specific length. Len also fails if the object has a type that len() not accept.
assert.Len(t, mySlice, 3)func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:482
Lenf asserts that the specified object has specific length. Lenf also fails if the object has a type that len() not accept.
assert.Lenf(t, mySlice, 3, "error message %s", "formatted")func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_compare.go:416
Less asserts that the first element is less than the second
assert.Less(t, 1, 2)
assert.Less(t, float64(1), float64(2))
assert.Less(t, "a", "b")func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_compare.go:430
LessOrEqual asserts that the first element is less than or equal to the second
assert.LessOrEqual(t, 1, 2)
assert.LessOrEqual(t, 2, 2)
assert.LessOrEqual(t, "a", "b")
assert.LessOrEqual(t, "b", "b")func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:507
LessOrEqualf asserts that the first element is less than or equal to the second
assert.LessOrEqualf(t, 1, 2, "error message %s", "formatted")
assert.LessOrEqualf(t, 2, 2, "error message %s", "formatted")
assert.LessOrEqualf(t, "a", "b", "error message %s", "formatted")
assert.LessOrEqualf(t, "b", "b", "error message %s", "formatted")func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:494
Lessf asserts that the first element is less than the second
assert.Lessf(t, 1, 2, "error message %s", "formatted")
assert.Lessf(t, float64(1), float64(2), "error message %s", "formatted")
assert.Lessf(t, "a", "b", "error message %s", "formatted")func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_compare.go:455
Negative asserts that the specified element is negative
assert.Negative(t, -1)
assert.Negative(t, -1.23)func Negativef(t TestingT, e interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:518
Negativef asserts that the specified element is negative
assert.Negativef(t, -1, "error message %s", "formatted")
assert.Negativef(t, -1.23, "error message %s", "formatted")func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2154
Never asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick.
assert.Never(t, func() bool { return false; }, time.Second, 10*time.Millisecond)func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:529
Neverf asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick.
assert.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")func New(t TestingT) *Assertions
Source: assert/forward_assertions.go:10
New makes a new Assertions object for the specified TestingT.
func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:740
Nil asserts that the specified object is nil.
assert.Nil(t, err)func Nilf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:539
Nilf asserts that the specified object is nil.
assert.Nilf(t, err, "error message %s", "formatted")func NoDirExists(t TestingT, path string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1842
NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.
func NoDirExistsf(t TestingT, path string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:548
NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.
func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1640
NoError asserts that a function returned a nil error (ie. no error).
actualObj, err := SomeFunction()
if assert.NoError(t, err) {
assert.Equal(t, expectedObj, actualObj)
}func NoErrorf(t TestingT, err error, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:561
NoErrorf asserts that a function returned a nil error (ie. no error).
actualObj, err := SomeFunction()
if assert.NoErrorf(t, err, "error message %s", "formatted") {
assert.Equal(t, expectedObj, actualObj)
}func NoFileExists(t TestingT, path string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1807
NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.
func NoFileExistsf(t TestingT, path string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:570
NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.
func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:983
NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element.
assert.NotContains(t, "Hello World", "Earth")
assert.NotContains(t, ["Hello", "World"], "Earth")
assert.NotContains(t, {"Hello": "World"}, "Earth")func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:583
NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element.
assert.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted")
assert.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted")
assert.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted")func NotElementsMatch(t TestingT, listA, listB interface{}, msgAndArgs ...interface{}) (ok bool)
Source: assert/assertions.go:1241
NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.
assert.NotElementsMatch(t, [1, 1, 2, 3], [1, 1, 2, 3]) -> false
assert.NotElementsMatch(t, [1, 1, 2, 3], [1, 2, 3]) -> true
assert.NotElementsMatch(t, [1, 2, 3], [1, 2, 4]) -> true
func NotElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:600
NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.
assert.NotElementsMatchf(t, [1, 1, 2, 3], [1, 1, 2, 3], "error message %s", "formatted") -> false
assert.NotElementsMatchf(t, [1, 1, 2, 3], [1, 2, 3], "error message %s", "formatted") -> true
assert.NotElementsMatchf(t, [1, 2, 3], [1, 2, 4], "error message %s", "formatted") -> true
func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:808
NotEmpty asserts that the specified object is NOT Empty.
if assert.NotEmpty(t, obj) {
assert.Equal(t, "two", obj[1])
}func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:612
NotEmptyf asserts that the specified object is NOT Empty.
if assert.NotEmptyf(t, obj, "error message %s", "formatted") {
assert.Equal(t, "two", obj[1])
}func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:883
NotEqual asserts that the specified values are NOT equal.
assert.NotEqual(t, obj1, obj2)Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses).
func NotEqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:902
NotEqualValues asserts that two objects are not equal even when converted to the same type
assert.NotEqualValues(t, obj1, obj2)func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:635
NotEqualValuesf asserts that two objects are not equal even when converted to the same type
assert.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted")func NotEqualf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:625
NotEqualf asserts that the specified values are NOT equal.
assert.NotEqualf(t, obj1, obj2, "error message %s", "formatted")Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses).
func NotErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2264
NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func NotErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:644
NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func NotErrorIs(t TestingT, err, target error, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:2217
NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:653
NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func NotImplements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:443
NotImplements asserts that an object does not implement the specified interface.
assert.NotImplements(t, (*MyInterface)(nil), new(MyObject))func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:663
NotImplementsf asserts that an object does not implement the specified interface.
assert.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:708
NotNil asserts that the specified object is not nil.
assert.NotNil(t, err)func NotNilf(t TestingT, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:673
NotNilf asserts that the specified object is not nil.
assert.NotNilf(t, err, "error message %s", "formatted")func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1364
NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanics(t, func(){ RemainCalm() })func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:683
NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted")func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1751
NotRegexp asserts that a specified regexp does not match a string.
assert.NotRegexp(t, regexp.MustCompile("starts"), "it's starting")
assert.NotRegexp(t, "^start", "it's not starting")func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:694
NotRegexpf asserts that a specified regexp does not match a string.
assert.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted")
assert.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted")func NotSame(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:561
NotSame asserts that two pointers do not reference the same object.
assert.NotSame(t, ptr1, ptr2)Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func NotSamef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:707
NotSamef asserts that two pointers do not reference the same object.
assert.NotSamef(t, ptr1, ptr2, "error message %s", "formatted")Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func NotSubset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool)
Source: assert/assertions.go:1076
NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
assert.NotSubset(t, [1, 3, 4], [1, 2])
assert.NotSubset(t, {"x": 1, "y": 2}, {"z": 3})
assert.NotSubset(t, [1, 3, 4], {1: "one", 2: "two"})
assert.NotSubset(t, {"x": 1, "y": 2}, ["z"])func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:723
NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
assert.NotSubsetf(t, [1, 3, 4], [1, 2], "error message %s", "formatted")
assert.NotSubsetf(t, {"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted")
assert.NotSubsetf(t, [1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted")
assert.NotSubsetf(t, {"x": 1, "y": 2}, ["z"], "error message %s", "formatted")func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1776
NotZero asserts that i is not the zero value for its type.
func NotZerof(t TestingT, i interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:731
NotZerof asserts that i is not the zero value for its type.
func ObjectsAreEqual(expected, actual interface{}) bool
Source: assert/assertions.go:63
ObjectsAreEqual determines if two objects are considered equal.
This function does no assertion of any kind.
func ObjectsAreEqualValues(expected, actual interface{}) bool
Source: assert/assertions.go:163
ObjectsAreEqualValues gets whether two objects are equal, or if their values are equal.
func ObjectsExportedFieldsAreEqual(expected, actual interface{}) bool
Source: assert/assertions.go:155
ObjectsExportedFieldsAreEqual determines if the exported (public) fields of two objects are considered equal. This comparison of only exported fields is applied recursively to nested data structures.
This function does no assertion of any kind.
Deprecated: Use EqualExportedValues instead.
func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1301
Panics asserts that the code inside the specified PanicTestFunc panics.
assert.Panics(t, func(){ GoCrazy() })func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1338
PanicsWithError asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison.
assert.PanicsWithError(t, "crazy error", func(){ GoCrazy() })func PanicsWithErrorf(t TestingT, errString string, f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:753
PanicsWithErrorf asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison.
assert.PanicsWithErrorf(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")func PanicsWithValue(t TestingT, expected interface{}, f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1317
PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value.
assert.PanicsWithValue(t, "crazy error", func(){ GoCrazy() })func PanicsWithValuef(t TestingT, expected interface{}, f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:764
PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value.
assert.PanicsWithValuef(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:741
Panicsf asserts that the code inside the specified PanicTestFunc panics.
assert.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_compare.go:442
Positive asserts that the specified element is positive
assert.Positive(t, 1)
assert.Positive(t, 1.23)func Positivef(t TestingT, e interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:775
Positivef asserts that the specified element is positive
assert.Positivef(t, 1, "error message %s", "formatted")
assert.Positivef(t, 1.23, "error message %s", "formatted")func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1733
Regexp asserts that a specified regexp matches a string.
assert.Regexp(t, regexp.MustCompile("start"), "it's starting")
assert.Regexp(t, "start...$", "it's not starting")func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:786
Regexpf asserts that a specified regexp matches a string.
assert.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted")
assert.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted")func Same(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:535
Same asserts that two pointers reference the same object.
assert.Same(t, ptr1, ptr2)Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func Samef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:799
Samef asserts that two pointers reference the same object.
assert.Samef(t, ptr1, ptr2, "error message %s", "formatted")Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func Subset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool)
Source: assert/assertions.go:1008
Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
assert.Subset(t, [1, 2, 3], [1, 2])
assert.Subset(t, {"x": 1, "y": 2}, {"x": 1})
assert.Subset(t, [1, 2, 3], {1: "one", 2: "two"})
assert.Subset(t, {"x": 1, "y": 2}, ["x"])func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:815
Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
assert.Subsetf(t, [1, 2, 3], [1, 2], "error message %s", "formatted")
assert.Subsetf(t, {"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted")
assert.Subsetf(t, [1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted")
assert.Subsetf(t, {"x": 1, "y": 2}, ["x"], "error message %s", "formatted")func True(t TestingT, value bool, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:852
True asserts that the specified value is true.
assert.True(t, myBool)func Truef(t TestingT, value bool, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:825
Truef asserts that the specified value is true.
assert.Truef(t, myBool, "error message %s", "formatted")func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1379
WithinDuration asserts that the two times are within duration delta of each other.
assert.WithinDuration(t, time.Now(), time.Now(), 10*time.Second)func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:835
WithinDurationf asserts that the two times are within duration delta of each other.
assert.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted")func WithinRange(t TestingT, actual, start, end time.Time, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1395
WithinRange asserts that a time is within a time range (inclusive).
assert.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second))func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:845
WithinRangef asserts that a time is within a time range (inclusive).
assert.WithinRangef(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted")func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1897
YAMLEq asserts that the first documents in the two YAML strings are equivalent.
expected := `---
key: value
---
key: this is a second document, it is not evaluated
`
actual := `---
key: value
---
key: this is a subsequent document, it is not evaluated
`
assert.YAMLEq(t, expected, actual)func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:865
YAMLEqf asserts that the first documents in the two YAML strings are equivalent.
expected := `---
key: value
---
key: this is a second document, it is not evaluated
`
actual := `---
key: value
---
key: this is a subsequent document, it is not evaluated
`
assert.YAMLEqf(t, expected, actual, "error message %s", "formatted")func Zero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertions.go:1765
Zero asserts that i is the zero value for its type.
func Zerof(t TestingT, i interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_format.go:873
Zerof asserts that i is the zero value for its type.
Types
type Assertions
Source: assert/forward_assertions.go:5
Assertions provides assertion methods around the TestingT interface.
type Assertions struct {
// contains filtered or unexported fields
}func (a *Assertions) Condition(comp Comparison, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:12
Condition uses a Comparison to assert a complex condition.
func (a *Assertions) Conditionf(comp Comparison, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:20
Conditionf uses a Comparison to assert a complex condition.
func (a *Assertions) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:33
Contains asserts that the specified string, list(array, slice...) or map contains the specified substring or element.
a.Contains("Hello World", "World")
a.Contains(["Hello", "World"], "World")
a.Contains({"Hello": "World"}, "Hello")func (a *Assertions) Containsf(s interface{}, contains interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:46
Containsf asserts that the specified string, list(array, slice...) or map contains the specified substring or element.
a.Containsf("Hello World", "World", "error message %s", "formatted")
a.Containsf(["Hello", "World"], "World", "error message %s", "formatted")
a.Containsf({"Hello": "World"}, "Hello", "error message %s", "formatted")func (a *Assertions) DirExists(path string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:55
DirExists checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists.
func (a *Assertions) DirExistsf(path string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:64
DirExistsf checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists.
func (a *Assertions) ElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:76
ElementsMatch asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.
a.ElementsMatch([1, 3, 2, 3], [1, 3, 3, 2])
func (a *Assertions) ElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:88
ElementsMatchf asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.
a.ElementsMatchf([1, 3, 2, 3], [1, 3, 3, 2], "error message %s", "formatted")
func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:108
Empty asserts that the given value is "empty".
Zero values are "empty".
Arrays are "empty" if every element is the zero value of the type (stricter than "empty").
Slices, maps and channels with zero length are "empty".
Pointer values are "empty" if the pointer is nil or if the pointed value is "empty".
a.Empty(obj)func (a *Assertions) Emptyf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:128
Emptyf asserts that the given value is "empty".
Zero values are "empty".
Arrays are "empty" if every element is the zero value of the type (stricter than "empty").
Slices, maps and channels with zero length are "empty".
Pointer values are "empty" if the pointer is nil or if the pointed value is "empty".
a.Emptyf(obj, "error message %s", "formatted")func (a *Assertions) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:142
Equal asserts that two objects are equal.
a.Equal(123, 123)Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail.
func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:154
EqualError asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error.
actualObj, err := SomeFunction()
a.EqualError(err, expectedErrorString)func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:166
EqualErrorf asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error.
actualObj, err := SomeFunction()
a.EqualErrorf(err, expectedErrorString, "error message %s", "formatted")func (a *Assertions) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:183
EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ.
type S struct {
Exported int
notExported int
}
a.EqualExportedValues(S{1, 2}, S{1, 3}) => true
a.EqualExportedValues(S{1, 2}, S{2, 3}) => falsefunc (a *Assertions) EqualExportedValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:200
EqualExportedValuesf asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ.
type S struct {
Exported int
notExported int
}
a.EqualExportedValuesf(S{1, 2}, S{1, 3}, "error message %s", "formatted") => true
a.EqualExportedValuesf(S{1, 2}, S{2, 3}, "error message %s", "formatted") => falsefunc (a *Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:211
EqualValues asserts that two objects are equal or convertible to the larger type and equal.
a.EqualValues(uint32(123), int32(123))func (a *Assertions) EqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:222
EqualValuesf asserts that two objects are equal or convertible to the larger type and equal.
a.EqualValuesf(uint32(123), int32(123), "error message %s", "formatted")func (a *Assertions) Equalf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:236
Equalf asserts that two objects are equal.
a.Equalf(123, 123, "error message %s", "formatted")Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail.
func (a *Assertions) Error(err error, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:247
Error asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction()
a.Error(err)func (a *Assertions) ErrorAs(err error, target interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:256
ErrorAs asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As.
func (a *Assertions) ErrorAsf(err error, target interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:265
ErrorAsf asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As.
func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:277
ErrorContains asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring.
actualObj, err := SomeFunction()
a.ErrorContains(err, expectedErrorSubString)func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:289
ErrorContainsf asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring.
actualObj, err := SomeFunction()
a.ErrorContainsf(err, expectedErrorSubString, "error message %s", "formatted")func (a *Assertions) ErrorIs(err error, target error, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:298
ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:307
ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (a *Assertions) Errorf(err error, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:318
Errorf asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction()
a.Errorf(err, "error message %s", "formatted")func (a *Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:329
Eventually asserts that given condition will be met in waitFor time, periodically checking target function each tick.
a.Eventually(func() bool { return true; }, time.Second, 10*time.Millisecond)func (a *Assertions) EventuallyWithT(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:354
EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t.
externalValue := false
go func() {
time.Sleep(8*time.Second)
externalValue = true
}()
a.EventuallyWithT(func(c *assert.CollectT) {
// add assertions as needed; any assertion failure will fail the current tick
assert.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")func (a *Assertions) EventuallyWithTf(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:379
EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t.
externalValue := false
go func() {
time.Sleep(8*time.Second)
externalValue = true
}()
a.EventuallyWithTf(func(c *assert.CollectT) {
// add assertions as needed; any assertion failure will fail the current tick
assert.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "error message %s", "formatted")func (a *Assertions) Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:390
Eventuallyf asserts that given condition will be met in waitFor time, periodically checking target function each tick.
a.Eventuallyf(func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")func (a *Assertions) Exactly(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:400
Exactly asserts that two objects are equal in value and type.
a.Exactly(int32(123), int64(123))func (a *Assertions) Exactlyf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:410
Exactlyf asserts that two objects are equal in value and type.
a.Exactlyf(int32(123), int64(123), "error message %s", "formatted")func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:418
Fail reports a failure through
func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:426
FailNow fails test
func (a *Assertions) FailNowf(failureMessage string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:434
FailNowf fails test
func (a *Assertions) Failf(failureMessage string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:442
Failf reports a failure through
func (a *Assertions) False(value bool, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:452
False asserts that the specified value is false.
a.False(myBool)func (a *Assertions) Falsef(value bool, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:462
Falsef asserts that the specified value is false.
a.Falsef(myBool, "error message %s", "formatted")func (a *Assertions) FileExists(path string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:471
FileExists checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file.
func (a *Assertions) FileExistsf(path string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:480
FileExistsf checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file.
func (a *Assertions) Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:492
Greater asserts that the first element is greater than the second
a.Greater(2, 1)
a.Greater(float64(2), float64(1))
a.Greater("b", "a")func (a *Assertions) GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:505
GreaterOrEqual asserts that the first element is greater than or equal to the second
a.GreaterOrEqual(2, 1)
a.GreaterOrEqual(2, 2)
a.GreaterOrEqual("b", "a")
a.GreaterOrEqual("b", "b")func (a *Assertions) GreaterOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:518
GreaterOrEqualf asserts that the first element is greater than or equal to the second
a.GreaterOrEqualf(2, 1, "error message %s", "formatted")
a.GreaterOrEqualf(2, 2, "error message %s", "formatted")
a.GreaterOrEqualf("b", "a", "error message %s", "formatted")
a.GreaterOrEqualf("b", "b", "error message %s", "formatted")func (a *Assertions) Greaterf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:530
Greaterf asserts that the first element is greater than the second
a.Greaterf(2, 1, "error message %s", "formatted")
a.Greaterf(float64(2), float64(1), "error message %s", "formatted")
a.Greaterf("b", "a", "error message %s", "formatted")func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:543
HTTPBodyContains asserts that a specified handler returns a body that contains a string.
a.HTTPBodyContains(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPBodyContainsf(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:556
HTTPBodyContainsf asserts that a specified handler returns a body that contains a string.
a.HTTPBodyContainsf(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:569
HTTPBodyNotContains asserts that a specified handler returns a body that does not contain a string.
a.HTTPBodyNotContains(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPBodyNotContainsf(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:582
HTTPBodyNotContainsf asserts that a specified handler returns a body that does not contain a string.
a.HTTPBodyNotContainsf(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:594
HTTPError asserts that a specified handler returns an error status code.
a.HTTPError(myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:606
HTTPErrorf asserts that a specified handler returns an error status code.
a.HTTPErrorf(myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:618
HTTPRedirect asserts that a specified handler returns a redirect status code.
a.HTTPRedirect(myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:630
HTTPRedirectf asserts that a specified handler returns a redirect status code.
a.HTTPRedirectf(myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:642
HTTPStatusCode asserts that a specified handler returns a specified status code.
a.HTTPStatusCode(myHandler, "GET", "/notImplemented", nil, 501)Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPStatusCodef(handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:654
HTTPStatusCodef asserts that a specified handler returns a specified status code.
a.HTTPStatusCodef(myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:666
HTTPSuccess asserts that a specified handler returns a success status code.
a.HTTPSuccess(myHandler, "POST", "http://www.google.com", nil)Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:678
HTTPSuccessf asserts that a specified handler returns a success status code.
a.HTTPSuccessf(myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted")Returns whether the assertion was successful (true) or not (false).
func (a *Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:688
Implements asserts that an object is implemented by the specified interface.
a.Implements((*MyInterface)(nil), new(MyObject))func (a *Assertions) Implementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:698
Implementsf asserts that an object is implemented by the specified interface.
a.Implementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted")func (a *Assertions) InDelta(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:708
InDelta asserts that the two numerals are within delta of each other.
a.InDelta(math.Pi, 22/7.0, 0.01)func (a *Assertions) InDeltaMapValues(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:716
InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func (a *Assertions) InDeltaMapValuesf(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:724
InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func (a *Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:732
InDeltaSlice is the same as InDelta, except it compares two slices.
func (a *Assertions) InDeltaSlicef(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:740
InDeltaSlicef is the same as InDelta, except it compares two slices.
func (a *Assertions) InDeltaf(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:750
InDeltaf asserts that the two numerals are within delta of each other.
a.InDeltaf(math.Pi, 22/7.0, 0.01, "error message %s", "formatted")func (a *Assertions) InEpsilon(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:758
InEpsilon asserts that expected and actual have a relative error less than epsilon
func (a *Assertions) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:766
InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
func (a *Assertions) InEpsilonSlicef(expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:774
InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.
func (a *Assertions) InEpsilonf(expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:782
InEpsilonf asserts that expected and actual have a relative error less than epsilon
func (a *Assertions) IsDecreasing(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:794
IsDecreasing asserts that the collection is decreasing
a.IsDecreasing([]int{2, 1, 0})
a.IsDecreasing([]float{2, 1})
a.IsDecreasing([]string{"b", "a"})func (a *Assertions) IsDecreasingf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:806
IsDecreasingf asserts that the collection is decreasing
a.IsDecreasingf([]int{2, 1, 0}, "error message %s", "formatted")
a.IsDecreasingf([]float{2, 1}, "error message %s", "formatted")
a.IsDecreasingf([]string{"b", "a"}, "error message %s", "formatted")func (a *Assertions) IsIncreasing(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:818
IsIncreasing asserts that the collection is increasing
a.IsIncreasing([]int{1, 2, 3})
a.IsIncreasing([]float{1, 2})
a.IsIncreasing([]string{"a", "b"})func (a *Assertions) IsIncreasingf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:830
IsIncreasingf asserts that the collection is increasing
a.IsIncreasingf([]int{1, 2, 3}, "error message %s", "formatted")
a.IsIncreasingf([]float{1, 2}, "error message %s", "formatted")
a.IsIncreasingf([]string{"a", "b"}, "error message %s", "formatted")func (a *Assertions) IsNonDecreasing(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:842
IsNonDecreasing asserts that the collection is not decreasing
a.IsNonDecreasing([]int{1, 1, 2})
a.IsNonDecreasing([]float{1, 2})
a.IsNonDecreasing([]string{"a", "b"})func (a *Assertions) IsNonDecreasingf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:854
IsNonDecreasingf asserts that the collection is not decreasing
a.IsNonDecreasingf([]int{1, 1, 2}, "error message %s", "formatted")
a.IsNonDecreasingf([]float{1, 2}, "error message %s", "formatted")
a.IsNonDecreasingf([]string{"a", "b"}, "error message %s", "formatted")func (a *Assertions) IsNonIncreasing(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:866
IsNonIncreasing asserts that the collection is not increasing
a.IsNonIncreasing([]int{2, 1, 1})
a.IsNonIncreasing([]float{2, 1})
a.IsNonIncreasing([]string{"b", "a"})func (a *Assertions) IsNonIncreasingf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:878
IsNonIncreasingf asserts that the collection is not increasing
a.IsNonIncreasingf([]int{2, 1, 1}, "error message %s", "formatted")
a.IsNonIncreasingf([]float{2, 1}, "error message %s", "formatted")
a.IsNonIncreasingf([]string{"b", "a"}, "error message %s", "formatted")func (a *Assertions) IsNotType(theType interface{}, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:888
IsNotType asserts that the specified objects are not of the same type.
a.IsNotType(&NotMyStruct{}, &MyStruct{})func (a *Assertions) IsNotTypef(theType interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:898
IsNotTypef asserts that the specified objects are not of the same type.
a.IsNotTypef(&NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:908
IsType asserts that the specified objects are of the same type.
a.IsType(&MyStruct{}, &MyStruct{})func (a *Assertions) IsTypef(expectedType interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:918
IsTypef asserts that the specified objects are of the same type.
a.IsTypef(&MyStruct{}, &MyStruct{}, "error message %s", "formatted")func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:928
JSONEq asserts that two JSON strings are equivalent.
a.JSONEq(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)func (a *Assertions) JSONEqf(expected string, actual string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:938
JSONEqf asserts that two JSON strings are equivalent.
a.JSONEqf(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted")func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:949
Len asserts that the specified object has specific length. Len also fails if the object has a type that len() not accept.
a.Len(mySlice, 3)func (a *Assertions) Lenf(object interface{}, length int, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:960
Lenf asserts that the specified object has specific length. Lenf also fails if the object has a type that len() not accept.
a.Lenf(mySlice, 3, "error message %s", "formatted")func (a *Assertions) Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:972
Less asserts that the first element is less than the second
a.Less(1, 2)
a.Less(float64(1), float64(2))
a.Less("a", "b")func (a *Assertions) LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:985
LessOrEqual asserts that the first element is less than or equal to the second
a.LessOrEqual(1, 2)
a.LessOrEqual(2, 2)
a.LessOrEqual("a", "b")
a.LessOrEqual("b", "b")func (a *Assertions) LessOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:998
LessOrEqualf asserts that the first element is less than or equal to the second
a.LessOrEqualf(1, 2, "error message %s", "formatted")
a.LessOrEqualf(2, 2, "error message %s", "formatted")
a.LessOrEqualf("a", "b", "error message %s", "formatted")
a.LessOrEqualf("b", "b", "error message %s", "formatted")func (a *Assertions) Lessf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1010
Lessf asserts that the first element is less than the second
a.Lessf(1, 2, "error message %s", "formatted")
a.Lessf(float64(1), float64(2), "error message %s", "formatted")
a.Lessf("a", "b", "error message %s", "formatted")func (a *Assertions) Negative(e interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1021
Negative asserts that the specified element is negative
a.Negative(-1)
a.Negative(-1.23)func (a *Assertions) Negativef(e interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1032
Negativef asserts that the specified element is negative
a.Negativef(-1, "error message %s", "formatted")
a.Negativef(-1.23, "error message %s", "formatted")func (a *Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1043
Never asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick.
a.Never(func() bool { return false; }, time.Second, 10*time.Millisecond)func (a *Assertions) Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1054
Neverf asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick.
a.Neverf(func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1064
Nil asserts that the specified object is nil.
a.Nil(err)func (a *Assertions) Nilf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1074
Nilf asserts that the specified object is nil.
a.Nilf(err, "error message %s", "formatted")func (a *Assertions) NoDirExists(path string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1083
NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.
func (a *Assertions) NoDirExistsf(path string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1092
NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.
func (a *Assertions) NoError(err error, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1105
NoError asserts that a function returned a nil error (ie. no error).
actualObj, err := SomeFunction()
if a.NoError(err) {
assert.Equal(t, expectedObj, actualObj)
}func (a *Assertions) NoErrorf(err error, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1118
NoErrorf asserts that a function returned a nil error (ie. no error).
actualObj, err := SomeFunction()
if a.NoErrorf(err, "error message %s", "formatted") {
assert.Equal(t, expectedObj, actualObj)
}func (a *Assertions) NoFileExists(path string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1127
NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.
func (a *Assertions) NoFileExistsf(path string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1136
NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.
func (a *Assertions) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1149
NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element.
a.NotContains("Hello World", "Earth")
a.NotContains(["Hello", "World"], "Earth")
a.NotContains({"Hello": "World"}, "Earth")func (a *Assertions) NotContainsf(s interface{}, contains interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1162
NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element.
a.NotContainsf("Hello World", "Earth", "error message %s", "formatted")
a.NotContainsf(["Hello", "World"], "Earth", "error message %s", "formatted")
a.NotContainsf({"Hello": "World"}, "Earth", "error message %s", "formatted")func (a *Assertions) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1179
NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.
a.NotElementsMatch([1, 1, 2, 3], [1, 1, 2, 3]) -> false
a.NotElementsMatch([1, 1, 2, 3], [1, 2, 3]) -> true
a.NotElementsMatch([1, 2, 3], [1, 2, 4]) -> true
func (a *Assertions) NotElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1196
NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.
a.NotElementsMatchf([1, 1, 2, 3], [1, 1, 2, 3], "error message %s", "formatted") -> false
a.NotElementsMatchf([1, 1, 2, 3], [1, 2, 3], "error message %s", "formatted") -> true
a.NotElementsMatchf([1, 2, 3], [1, 2, 4], "error message %s", "formatted") -> true
func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1208
NotEmpty asserts that the specified object is NOT Empty.
if a.NotEmpty(obj) {
assert.Equal(t, "two", obj[1])
}func (a *Assertions) NotEmptyf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1220
NotEmptyf asserts that the specified object is NOT Empty.
if a.NotEmptyf(obj, "error message %s", "formatted") {
assert.Equal(t, "two", obj[1])
}func (a *Assertions) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1233
NotEqual asserts that the specified values are NOT equal.
a.NotEqual(obj1, obj2)Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses).
func (a *Assertions) NotEqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1243
NotEqualValues asserts that two objects are not equal even when converted to the same type
a.NotEqualValues(obj1, obj2)func (a *Assertions) NotEqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1253
NotEqualValuesf asserts that two objects are not equal even when converted to the same type
a.NotEqualValuesf(obj1, obj2, "error message %s", "formatted")func (a *Assertions) NotEqualf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1266
NotEqualf asserts that the specified values are NOT equal.
a.NotEqualf(obj1, obj2, "error message %s", "formatted")Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses).
func (a *Assertions) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1275
NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func (a *Assertions) NotErrorAsf(err error, target interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1284
NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1293
NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1302
NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (a *Assertions) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1312
NotImplements asserts that an object does not implement the specified interface.
a.NotImplements((*MyInterface)(nil), new(MyObject))func (a *Assertions) NotImplementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1322
NotImplementsf asserts that an object does not implement the specified interface.
a.NotImplementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted")func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1332
NotNil asserts that the specified object is not nil.
a.NotNil(err)func (a *Assertions) NotNilf(object interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1342
NotNilf asserts that the specified object is not nil.
a.NotNilf(err, "error message %s", "formatted")func (a *Assertions) NotPanics(f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1352
NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
a.NotPanics(func(){ RemainCalm() })func (a *Assertions) NotPanicsf(f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1362
NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
a.NotPanicsf(func(){ RemainCalm() }, "error message %s", "formatted")func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1373
NotRegexp asserts that a specified regexp does not match a string.
a.NotRegexp(regexp.MustCompile("starts"), "it's starting")
a.NotRegexp("^start", "it's not starting")func (a *Assertions) NotRegexpf(rx interface{}, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1384
NotRegexpf asserts that a specified regexp does not match a string.
a.NotRegexpf(regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted")
a.NotRegexpf("^start", "it's not starting", "error message %s", "formatted")func (a *Assertions) NotSame(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1397
NotSame asserts that two pointers do not reference the same object.
a.NotSame(ptr1, ptr2)Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func (a *Assertions) NotSamef(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1410
NotSamef asserts that two pointers do not reference the same object.
a.NotSamef(ptr1, ptr2, "error message %s", "formatted")Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func (a *Assertions) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1426
NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
a.NotSubset([1, 3, 4], [1, 2])
a.NotSubset({"x": 1, "y": 2}, {"z": 3})
a.NotSubset([1, 3, 4], {1: "one", 2: "two"})
a.NotSubset({"x": 1, "y": 2}, ["z"])func (a *Assertions) NotSubsetf(list interface{}, subset interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1442
NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
a.NotSubsetf([1, 3, 4], [1, 2], "error message %s", "formatted")
a.NotSubsetf({"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted")
a.NotSubsetf([1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted")
a.NotSubsetf({"x": 1, "y": 2}, ["z"], "error message %s", "formatted")func (a *Assertions) NotZero(i interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1450
NotZero asserts that i is not the zero value for its type.
func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1458
NotZerof asserts that i is not the zero value for its type.
func (a *Assertions) Panics(f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1468
Panics asserts that the code inside the specified PanicTestFunc panics.
a.Panics(func(){ GoCrazy() })func (a *Assertions) PanicsWithError(errString string, f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1480
PanicsWithError asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison.
a.PanicsWithError("crazy error", func(){ GoCrazy() })func (a *Assertions) PanicsWithErrorf(errString string, f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1492
PanicsWithErrorf asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison.
a.PanicsWithErrorf("crazy error", func(){ GoCrazy() }, "error message %s", "formatted")func (a *Assertions) PanicsWithValue(expected interface{}, f PanicTestFunc, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1503
PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value.
a.PanicsWithValue("crazy error", func(){ GoCrazy() })func (a *Assertions) PanicsWithValuef(expected interface{}, f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1514
PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value.
a.PanicsWithValuef("crazy error", func(){ GoCrazy() }, "error message %s", "formatted")func (a *Assertions) Panicsf(f PanicTestFunc, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1524
Panicsf asserts that the code inside the specified PanicTestFunc panics.
a.Panicsf(func(){ GoCrazy() }, "error message %s", "formatted")func (a *Assertions) Positive(e interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1535
Positive asserts that the specified element is positive
a.Positive(1)
a.Positive(1.23)func (a *Assertions) Positivef(e interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1546
Positivef asserts that the specified element is positive
a.Positivef(1, "error message %s", "formatted")
a.Positivef(1.23, "error message %s", "formatted")func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1557
Regexp asserts that a specified regexp matches a string.
a.Regexp(regexp.MustCompile("start"), "it's starting")
a.Regexp("start...$", "it's not starting")func (a *Assertions) Regexpf(rx interface{}, str interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1568
Regexpf asserts that a specified regexp matches a string.
a.Regexpf(regexp.MustCompile("start"), "it's starting", "error message %s", "formatted")
a.Regexpf("start...$", "it's not starting", "error message %s", "formatted")func (a *Assertions) Same(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1581
Same asserts that two pointers reference the same object.
a.Same(ptr1, ptr2)Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func (a *Assertions) Samef(expected interface{}, actual interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1594
Samef asserts that two pointers reference the same object.
a.Samef(ptr1, ptr2, "error message %s", "formatted")Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.
func (a *Assertions) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1610
Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
a.Subset([1, 2, 3], [1, 2])
a.Subset({"x": 1, "y": 2}, {"x": 1})
a.Subset([1, 2, 3], {1: "one", 2: "two"})
a.Subset({"x": 1, "y": 2}, ["x"])func (a *Assertions) Subsetf(list interface{}, subset interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1626
Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
a.Subsetf([1, 2, 3], [1, 2], "error message %s", "formatted")
a.Subsetf({"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted")
a.Subsetf([1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted")
a.Subsetf({"x": 1, "y": 2}, ["x"], "error message %s", "formatted")func (a *Assertions) True(value bool, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1636
True asserts that the specified value is true.
a.True(myBool)func (a *Assertions) Truef(value bool, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1646
Truef asserts that the specified value is true.
a.Truef(myBool, "error message %s", "formatted")func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1656
WithinDuration asserts that the two times are within duration delta of each other.
a.WithinDuration(time.Now(), time.Now(), 10*time.Second)func (a *Assertions) WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1666
WithinDurationf asserts that the two times are within duration delta of each other.
a.WithinDurationf(time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted")func (a *Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1676
WithinRange asserts that a time is within a time range (inclusive).
a.WithinRange(time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second))func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1686
WithinRangef asserts that a time is within a time range (inclusive).
a.WithinRangef(time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted")func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1706
YAMLEq asserts that the first documents in the two YAML strings are equivalent.
expected := `---
key: value
---
key: this is a second document, it is not evaluated
`
actual := `---
key: value
---
key: this is a subsequent document, it is not evaluated
`
a.YAMLEq(expected, actual)func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1726
YAMLEqf asserts that the first documents in the two YAML strings are equivalent.
expected := `---
key: value
---
key: this is a second document, it is not evaluated
`
actual := `---
key: value
---
key: this is a subsequent document, it is not evaluated
`
a.YAMLEqf(expected, actual, "error message %s", "formatted")func (a *Assertions) Zero(i interface{}, msgAndArgs ...interface{}) bool
Source: assert/assertion_forward.go:1734
Zero asserts that i is the zero value for its type.
func (a *Assertions) Zerof(i interface{}, msg string, args ...interface{}) bool
Source: assert/assertion_forward.go:1742
Zerof asserts that i is the zero value for its type.
type BoolAssertionFunc
Source: assert/assertions.go:43
BoolAssertionFunc is a common function prototype when validating a bool value. Can be useful for table driven tests.
type BoolAssertionFunc = func(TestingT, bool, ...interface{}) boolExample
{
t := &testing.T{}
isOkay := func(x int) bool {
return x >= 42
}
tests := []struct {
name string
arg int
assertion BoolAssertionFunc
}{
{"-1 is bad", -1, False},
{"42 is good", 42, True},
{"41 is bad", 41, False},
{"45 is cool", 45, True},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.assertion(t, isOkay(tt.arg))
})
}
}type CollectT
Source: assert/assertions.go:2043
CollectT implements the TestingT interface and collects all errors.
type CollectT struct {
// contains filtered or unexported fields
}func (*CollectT) Copy(TestingT)
Source: assert/assertions.go:2070
Deprecated: That was a method for internal usage that should not have been published. Now just panics.
func (c *CollectT) Errorf(format string, args ...interface{})
Source: assert/assertions.go:2054
Errorf collects the error.
func (c *CollectT) FailNow()
Source: assert/assertions.go:2059
FailNow stops execution by calling runtime.Goexit.
func (CollectT) Helper()
Source: assert/assertions.go:2051
Helper is like testing.T.Helper but does nothing.
func (*CollectT) Reset()
Source: assert/assertions.go:2065
Deprecated: That was a method for internal usage that should not have been published. Now just panics.
type CompareType
Source: assert/assertion_compare.go:11
Deprecated: CompareType has only ever been for internal use and has accidentally been published since v1.6.0. Do not use it.
type CompareType = compareResulttype Comparison
Source: assert/assertions.go:54
Comparison is a custom function that returns true on success and false on failure
type Comparison func() (success bool)type ComparisonAssertionFunc
Source: assert/assertions.go:35
ComparisonAssertionFunc is a common function prototype when comparing two values. Can be useful for table driven tests.
type ComparisonAssertionFunc = func(TestingT, interface{}, interface{}, ...interface{}) boolExample
{
t := &testing.T{}
adder := func(x, y int) int {
return x + y
}
type args struct {
x int
y int
}
tests := []struct {
name string
args args
expect int
assertion ComparisonAssertionFunc
}{
{"2+2=4", args{2, 2}, 4, Equal},
{"2+2!=5", args{2, 2}, 5, NotEqual},
{"2+3==5", args{2, 3}, 5, Exactly},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.assertion(t, tt.expect, adder(tt.args.x, tt.args.y))
})
}
}type ErrorAssertionFunc
Source: assert/assertions.go:47
ErrorAssertionFunc is a common function prototype when validating an error value. Can be useful for table driven tests.
type ErrorAssertionFunc = func(TestingT, error, ...interface{}) boolExample
{
t := &testing.T{}
dumbParseNum := func(input string, v interface{}) error {
return json.Unmarshal([]byte(input), v)
}
tests := []struct {
name string
arg string
assertion ErrorAssertionFunc
}{
{"1.2 is number", "1.2", NoError},
{"1.2.3 not number", "1.2.3", Error},
{"true is not number", "true", Error},
{"3 is number", "3", NoError},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var x float64
tt.assertion(t, dumbParseNum(tt.arg, &x))
})
}
}type PanicAssertionFunc
Source: assert/assertions.go:51
PanicAssertionFunc is a common function prototype when validating a panic value. Can be useful for table driven tests.
type PanicAssertionFunc = func(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) boolExample
{
t := &testing.T{}
tests := []struct {
name string
panicFn PanicTestFunc
assertion PanicAssertionFunc
}{
{"with panic", func() { panic(nil) }, Panics},
{"without panic", func() {}, NotPanics},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.assertion(t, tt.panicFn)
})
}
}type PanicTestFunc
Source: assert/assertions.go:1278
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.
type PanicTestFunc func()type TestingT
Source: assert/assertions.go:29
TestingT is an interface wrapper around *testing.T
type TestingT interface {
Errorf(format string, args ...interface{})
}Methods
Errorf func(format string, args ...interface{})
type ValueAssertionFunc
Source: assert/assertions.go:39
ValueAssertionFunc is a common function prototype when validating a single value. Can be useful for table driven tests.
type ValueAssertionFunc = func(TestingT, interface{}, ...interface{}) boolExample
{
t := &testing.T{}
dumbParse := func(input string) interface{} {
var x interface{}
_ = json.Unmarshal([]byte(input), &x)
return x
}
tests := []struct {
name string
arg string
assertion ValueAssertionFunc
}{
{"true is not nil", "true", NotNil},
{"empty string is nil", "", Nil},
{"zero is not nil", "0", NotNil},
{"zero is zero", "0", Zero},
{"false is zero", "false", Zero},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.assertion(t, dumbParse(tt.arg))
})
}
}