Documentation
¶
Overview ¶
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/go-openapi/testify/v2/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/go-openapi/testify/v2/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.
Index ¶
- Variables
- func CallerInfo() []string
- func Condition(t TestingT, comp Comparison, msgAndArgs ...any) bool
- func Conditionf(t TestingT, comp Comparison, msg string, args ...any) bool
- func Contains(t TestingT, s, contains any, msgAndArgs ...any) bool
- func Containsf(t TestingT, s any, contains any, msg string, args ...any) bool
- func DirExists(t TestingT, path string, msgAndArgs ...any) bool
- func DirExistsf(t TestingT, path string, msg string, args ...any) bool
- func ElementsMatch(t TestingT, listA, listB any, msgAndArgs ...any) (ok bool)
- func ElementsMatchf(t TestingT, listA any, listB any, msg string, args ...any) bool
- func Empty(t TestingT, object any, msgAndArgs ...any) bool
- func Emptyf(t TestingT, object any, msg string, args ...any) bool
- func Equal(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func EqualError(t TestingT, theError error, errString string, msgAndArgs ...any) bool
- func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...any) bool
- func EqualExportedValues(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func EqualExportedValuesf(t TestingT, expected any, actual any, msg string, args ...any) bool
- func EqualValues(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func EqualValuesf(t TestingT, expected any, actual any, msg string, args ...any) bool
- func Equalf(t TestingT, expected any, actual any, msg string, args ...any) bool
- func Error(t TestingT, err error, msgAndArgs ...any) bool
- func ErrorAs(t TestingT, err error, target any, msgAndArgs ...any) bool
- func ErrorAsf(t TestingT, err error, target any, msg string, args ...any) bool
- func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...any) bool
- func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...any) bool
- func ErrorIs(t TestingT, err, target error, msgAndArgs ...any) bool
- func ErrorIsf(t TestingT, err error, target error, msg string, args ...any) bool
- func Errorf(t TestingT, err error, msg string, args ...any) bool
- func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool
- func EventuallyWithT(t TestingT, condition func(collect *CollectT), waitFor time.Duration, ...) bool
- func EventuallyWithTf(t TestingT, condition func(collect *CollectT), waitFor time.Duration, ...) bool
- func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool
- func Exactly(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func Exactlyf(t TestingT, expected any, actual any, msg string, args ...any) bool
- func Fail(t TestingT, failureMessage string, msgAndArgs ...any) bool
- func FailNow(t TestingT, failureMessage string, msgAndArgs ...any) bool
- func FailNowf(t TestingT, failureMessage string, msg string, args ...any) bool
- func Failf(t TestingT, failureMessage string, msg string, args ...any) bool
- func False(t TestingT, value bool, msgAndArgs ...any) bool
- func Falsef(t TestingT, value bool, msg string, args ...any) bool
- func FileExists(t TestingT, path string, msgAndArgs ...any) bool
- func FileExistsf(t TestingT, path string, msg string, args ...any) bool
- func Greater(t TestingT, e1 any, e2 any, msgAndArgs ...any) bool
- func GreaterOrEqual(t TestingT, e1 any, e2 any, msgAndArgs ...any) bool
- func GreaterOrEqualf(t TestingT, e1 any, e2 any, msg string, args ...any) bool
- func Greaterf(t TestingT, e1 any, e2 any, msg string, args ...any) bool
- func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) string
- func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, ...) bool
- func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, ...) bool
- func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, ...) bool
- func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, ...) bool
- func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, ...) bool
- func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, ...) bool
- func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, ...) bool
- func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, ...) bool
- func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, ...) bool
- func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, ...) bool
- func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, ...) bool
- func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, ...) bool
- func Implements(t TestingT, interfaceObject any, object any, msgAndArgs ...any) bool
- func Implementsf(t TestingT, interfaceObject any, object any, msg string, args ...any) bool
- func InDelta(t TestingT, expected, actual any, delta float64, msgAndArgs ...any) bool
- func InDeltaMapValues(t TestingT, expected, actual any, delta float64, msgAndArgs ...any) bool
- func InDeltaMapValuesf(t TestingT, expected any, actual any, delta float64, msg string, args ...any) bool
- func InDeltaSlice(t TestingT, expected, actual any, delta float64, msgAndArgs ...any) bool
- func InDeltaSlicef(t TestingT, expected any, actual any, delta float64, msg string, args ...any) bool
- func InDeltaf(t TestingT, expected any, actual any, delta float64, msg string, args ...any) bool
- func InEpsilon(t TestingT, expected, actual any, epsilon float64, msgAndArgs ...any) bool
- func InEpsilonSlice(t TestingT, expected, actual any, epsilon float64, msgAndArgs ...any) bool
- func InEpsilonSlicef(t TestingT, expected any, actual any, epsilon float64, msg string, args ...any) bool
- func InEpsilonf(t TestingT, expected any, actual any, epsilon float64, msg string, args ...any) bool
- func IsDecreasing(t TestingT, object any, msgAndArgs ...any) bool
- func IsDecreasingf(t TestingT, object any, msg string, args ...any) bool
- func IsIncreasing(t TestingT, object any, msgAndArgs ...any) bool
- func IsIncreasingf(t TestingT, object any, msg string, args ...any) bool
- func IsNonDecreasing(t TestingT, object any, msgAndArgs ...any) bool
- func IsNonDecreasingf(t TestingT, object any, msg string, args ...any) bool
- func IsNonIncreasing(t TestingT, object any, msgAndArgs ...any) bool
- func IsNonIncreasingf(t TestingT, object any, msg string, args ...any) bool
- func IsNotType(t TestingT, theType, object any, msgAndArgs ...any) bool
- func IsNotTypef(t TestingT, theType any, object any, msg string, args ...any) bool
- func IsType(t TestingT, expectedType, object any, msgAndArgs ...any) bool
- func IsTypef(t TestingT, expectedType any, object any, msg string, args ...any) bool
- func JSONEq(t TestingT, expected, actual string, msgAndArgs ...any) bool
- func JSONEqBytes(t TestingT, expected, actual []byte, msgAndArgs ...any) bool
- func JSONEqBytesf(t TestingT, expected []byte, actual []byte, msg string, args ...any) bool
- func JSONEqf(t TestingT, expected string, actual string, msg string, args ...any) bool
- func Len(t TestingT, object any, length int, msgAndArgs ...any) bool
- func Lenf(t TestingT, object any, length int, msg string, args ...any) bool
- func Less(t TestingT, e1 any, e2 any, msgAndArgs ...any) bool
- func LessOrEqual(t TestingT, e1 any, e2 any, msgAndArgs ...any) bool
- func LessOrEqualf(t TestingT, e1 any, e2 any, msg string, args ...any) bool
- func Lessf(t TestingT, e1 any, e2 any, msg string, args ...any) bool
- func Negative(t TestingT, e any, msgAndArgs ...any) bool
- func Negativef(t TestingT, e any, msg string, args ...any) bool
- func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool
- func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool
- func Nil(t TestingT, object any, msgAndArgs ...any) bool
- func Nilf(t TestingT, object any, msg string, args ...any) bool
- func NoDirExists(t TestingT, path string, msgAndArgs ...any) bool
- func NoDirExistsf(t TestingT, path string, msg string, args ...any) bool
- func NoError(t TestingT, err error, msgAndArgs ...any) bool
- func NoErrorf(t TestingT, err error, msg string, args ...any) bool
- func NoFileExists(t TestingT, path string, msgAndArgs ...any) bool
- func NoFileExistsf(t TestingT, path string, msg string, args ...any) bool
- func NotContains(t TestingT, s, contains any, msgAndArgs ...any) bool
- func NotContainsf(t TestingT, s any, contains any, msg string, args ...any) bool
- func NotElementsMatch(t TestingT, listA, listB any, msgAndArgs ...any) (ok bool)
- func NotElementsMatchf(t TestingT, listA any, listB any, msg string, args ...any) bool
- func NotEmpty(t TestingT, object any, msgAndArgs ...any) bool
- func NotEmptyf(t TestingT, object any, msg string, args ...any) bool
- func NotEqual(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func NotEqualValues(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func NotEqualValuesf(t TestingT, expected any, actual any, msg string, args ...any) bool
- func NotEqualf(t TestingT, expected any, actual any, msg string, args ...any) bool
- func NotErrorAs(t TestingT, err error, target any, msgAndArgs ...any) bool
- func NotErrorAsf(t TestingT, err error, target any, msg string, args ...any) bool
- func NotErrorIs(t TestingT, err, target error, msgAndArgs ...any) bool
- func NotErrorIsf(t TestingT, err error, target error, msg string, args ...any) bool
- func NotImplements(t TestingT, interfaceObject any, object any, msgAndArgs ...any) bool
- func NotImplementsf(t TestingT, interfaceObject any, object any, msg string, args ...any) bool
- func NotNil(t TestingT, object any, msgAndArgs ...any) bool
- func NotNilf(t TestingT, object any, msg string, args ...any) bool
- func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...any) bool
- func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...any) bool
- func NotRegexp(t TestingT, rx any, str any, msgAndArgs ...any) bool
- func NotRegexpf(t TestingT, rx any, str any, msg string, args ...any) bool
- func NotSame(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func NotSamef(t TestingT, expected any, actual any, msg string, args ...any) bool
- func NotSubset(t TestingT, list, subset any, msgAndArgs ...any) (ok bool)
- func NotSubsetf(t TestingT, list any, subset any, msg string, args ...any) bool
- func NotZero(t TestingT, i any, msgAndArgs ...any) bool
- func NotZerof(t TestingT, i any, msg string, args ...any) bool
- func ObjectsAreEqual(expected, actual any) bool
- func ObjectsAreEqualValues(expected, actual any) bool
- func ObjectsExportedFieldsAreEqual(expected, actual any) booldeprecated
- func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...any) bool
- func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs ...any) bool
- func PanicsWithErrorf(t TestingT, errString string, f PanicTestFunc, msg string, args ...any) bool
- func PanicsWithValue(t TestingT, expected any, f PanicTestFunc, msgAndArgs ...any) bool
- func PanicsWithValuef(t TestingT, expected any, f PanicTestFunc, msg string, args ...any) bool
- func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...any) bool
- func Positive(t TestingT, e any, msgAndArgs ...any) bool
- func Positivef(t TestingT, e any, msg string, args ...any) bool
- func Regexp(t TestingT, rx any, str any, msgAndArgs ...any) bool
- func Regexpf(t TestingT, rx any, str any, msg string, args ...any) bool
- func Same(t TestingT, expected, actual any, msgAndArgs ...any) bool
- func Samef(t TestingT, expected any, actual any, msg string, args ...any) bool
- func Subset(t TestingT, list, subset any, msgAndArgs ...any) (ok bool)
- func Subsetf(t TestingT, list any, subset any, msg string, args ...any) bool
- func True(t TestingT, value bool, msgAndArgs ...any) bool
- func Truef(t TestingT, value bool, msg string, args ...any) bool
- func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...any) bool
- func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, ...) bool
- func WithinRange(t TestingT, actual, start, end time.Time, msgAndArgs ...any) bool
- func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, ...) bool
- func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...any) bool
- func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...any) bool
- func Zero(t TestingT, i any, msgAndArgs ...any) bool
- func Zerof(t TestingT, i any, msg string, args ...any) bool
- type Assertions
- func (a *Assertions) Condition(comp Comparison, msgAndArgs ...any) bool
- func (a *Assertions) Conditionf(comp Comparison, msg string, args ...any) bool
- func (a *Assertions) Contains(s any, contains any, msgAndArgs ...any) bool
- func (a *Assertions) Containsf(s any, contains any, msg string, args ...any) bool
- func (a *Assertions) DirExists(path string, msgAndArgs ...any) bool
- func (a *Assertions) DirExistsf(path string, msg string, args ...any) bool
- func (a *Assertions) ElementsMatch(listA any, listB any, msgAndArgs ...any) bool
- func (a *Assertions) ElementsMatchf(listA any, listB any, msg string, args ...any) bool
- func (a *Assertions) Empty(object any, msgAndArgs ...any) bool
- func (a *Assertions) Emptyf(object any, msg string, args ...any) bool
- func (a *Assertions) Equal(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...any) bool
- func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...any) bool
- func (a *Assertions) EqualExportedValues(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) EqualExportedValuesf(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) EqualValues(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) EqualValuesf(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) Equalf(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) Error(err error, msgAndArgs ...any) bool
- func (a *Assertions) ErrorAs(err error, target any, msgAndArgs ...any) bool
- func (a *Assertions) ErrorAsf(err error, target any, msg string, args ...any) bool
- func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...any) bool
- func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...any) bool
- func (a *Assertions) ErrorIs(err error, target error, msgAndArgs ...any) bool
- func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...any) bool
- func (a *Assertions) Errorf(err error, msg string, args ...any) bool
- func (a *Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool
- func (a *Assertions) EventuallyWithT(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, ...) bool
- func (a *Assertions) EventuallyWithTf(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, ...) bool
- func (a *Assertions) Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, ...) bool
- func (a *Assertions) Exactly(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) Exactlyf(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) Fail(failureMessage string, msgAndArgs ...any) bool
- func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...any) bool
- func (a *Assertions) FailNowf(failureMessage string, msg string, args ...any) bool
- func (a *Assertions) Failf(failureMessage string, msg string, args ...any) bool
- func (a *Assertions) False(value bool, msgAndArgs ...any) bool
- func (a *Assertions) Falsef(value bool, msg string, args ...any) bool
- func (a *Assertions) FileExists(path string, msgAndArgs ...any) bool
- func (a *Assertions) FileExistsf(path string, msg string, args ...any) bool
- func (a *Assertions) Greater(e1 any, e2 any, msgAndArgs ...any) bool
- func (a *Assertions) GreaterOrEqual(e1 any, e2 any, msgAndArgs ...any) bool
- func (a *Assertions) GreaterOrEqualf(e1 any, e2 any, msg string, args ...any) bool
- func (a *Assertions) Greaterf(e1 any, e2 any, msg string, args ...any) bool
- func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPBodyContainsf(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPBodyNotContainsf(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPStatusCodef(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool
- func (a *Assertions) Implements(interfaceObject any, object any, msgAndArgs ...any) bool
- func (a *Assertions) Implementsf(interfaceObject any, object any, msg string, args ...any) bool
- func (a *Assertions) InDelta(expected any, actual any, delta float64, msgAndArgs ...any) bool
- func (a *Assertions) InDeltaMapValues(expected any, actual any, delta float64, msgAndArgs ...any) bool
- func (a *Assertions) InDeltaMapValuesf(expected any, actual any, delta float64, msg string, args ...any) bool
- func (a *Assertions) InDeltaSlice(expected any, actual any, delta float64, msgAndArgs ...any) bool
- func (a *Assertions) InDeltaSlicef(expected any, actual any, delta float64, msg string, args ...any) bool
- func (a *Assertions) InDeltaf(expected any, actual any, delta float64, msg string, args ...any) bool
- func (a *Assertions) InEpsilon(expected any, actual any, epsilon float64, msgAndArgs ...any) bool
- func (a *Assertions) InEpsilonSlice(expected any, actual any, epsilon float64, msgAndArgs ...any) bool
- func (a *Assertions) InEpsilonSlicef(expected any, actual any, epsilon float64, msg string, args ...any) bool
- func (a *Assertions) InEpsilonf(expected any, actual any, epsilon float64, msg string, args ...any) bool
- func (a *Assertions) IsDecreasing(object any, msgAndArgs ...any) bool
- func (a *Assertions) IsDecreasingf(object any, msg string, args ...any) bool
- func (a *Assertions) IsIncreasing(object any, msgAndArgs ...any) bool
- func (a *Assertions) IsIncreasingf(object any, msg string, args ...any) bool
- func (a *Assertions) IsNonDecreasing(object any, msgAndArgs ...any) bool
- func (a *Assertions) IsNonDecreasingf(object any, msg string, args ...any) bool
- func (a *Assertions) IsNonIncreasing(object any, msgAndArgs ...any) bool
- func (a *Assertions) IsNonIncreasingf(object any, msg string, args ...any) bool
- func (a *Assertions) IsNotType(theType any, object any, msgAndArgs ...any) bool
- func (a *Assertions) IsNotTypef(theType any, object any, msg string, args ...any) bool
- func (a *Assertions) IsType(expectedType any, object any, msgAndArgs ...any) bool
- func (a *Assertions) IsTypef(expectedType any, object any, msg string, args ...any) bool
- func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...any) bool
- func (a *Assertions) JSONEqBytes(expected []byte, actual []byte, msgAndArgs ...any) bool
- func (a *Assertions) JSONEqBytesf(expected []byte, actual []byte, msg string, args ...any) bool
- func (a *Assertions) JSONEqf(expected string, actual string, msg string, args ...any) bool
- func (a *Assertions) Len(object any, length int, msgAndArgs ...any) bool
- func (a *Assertions) Lenf(object any, length int, msg string, args ...any) bool
- func (a *Assertions) Less(e1 any, e2 any, msgAndArgs ...any) bool
- func (a *Assertions) LessOrEqual(e1 any, e2 any, msgAndArgs ...any) bool
- func (a *Assertions) LessOrEqualf(e1 any, e2 any, msg string, args ...any) bool
- func (a *Assertions) Lessf(e1 any, e2 any, msg string, args ...any) bool
- func (a *Assertions) Negative(e any, msgAndArgs ...any) bool
- func (a *Assertions) Negativef(e any, msg string, args ...any) bool
- func (a *Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool
- func (a *Assertions) Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, ...) bool
- func (a *Assertions) Nil(object any, msgAndArgs ...any) bool
- func (a *Assertions) Nilf(object any, msg string, args ...any) bool
- func (a *Assertions) NoDirExists(path string, msgAndArgs ...any) bool
- func (a *Assertions) NoDirExistsf(path string, msg string, args ...any) bool
- func (a *Assertions) NoError(err error, msgAndArgs ...any) bool
- func (a *Assertions) NoErrorf(err error, msg string, args ...any) bool
- func (a *Assertions) NoFileExists(path string, msgAndArgs ...any) bool
- func (a *Assertions) NoFileExistsf(path string, msg string, args ...any) bool
- func (a *Assertions) NotContains(s any, contains any, msgAndArgs ...any) bool
- func (a *Assertions) NotContainsf(s any, contains any, msg string, args ...any) bool
- func (a *Assertions) NotElementsMatch(listA any, listB any, msgAndArgs ...any) bool
- func (a *Assertions) NotElementsMatchf(listA any, listB any, msg string, args ...any) bool
- func (a *Assertions) NotEmpty(object any, msgAndArgs ...any) bool
- func (a *Assertions) NotEmptyf(object any, msg string, args ...any) bool
- func (a *Assertions) NotEqual(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) NotEqualValues(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) NotEqualValuesf(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) NotEqualf(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) NotErrorAs(err error, target any, msgAndArgs ...any) bool
- func (a *Assertions) NotErrorAsf(err error, target any, msg string, args ...any) bool
- func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...any) bool
- func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...any) bool
- func (a *Assertions) NotImplements(interfaceObject any, object any, msgAndArgs ...any) bool
- func (a *Assertions) NotImplementsf(interfaceObject any, object any, msg string, args ...any) bool
- func (a *Assertions) NotNil(object any, msgAndArgs ...any) bool
- func (a *Assertions) NotNilf(object any, msg string, args ...any) bool
- func (a *Assertions) NotPanics(f PanicTestFunc, msgAndArgs ...any) bool
- func (a *Assertions) NotPanicsf(f PanicTestFunc, msg string, args ...any) bool
- func (a *Assertions) NotRegexp(rx any, str any, msgAndArgs ...any) bool
- func (a *Assertions) NotRegexpf(rx any, str any, msg string, args ...any) bool
- func (a *Assertions) NotSame(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) NotSamef(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) NotSubset(list any, subset any, msgAndArgs ...any) bool
- func (a *Assertions) NotSubsetf(list any, subset any, msg string, args ...any) bool
- func (a *Assertions) NotZero(i any, msgAndArgs ...any) bool
- func (a *Assertions) NotZerof(i any, msg string, args ...any) bool
- func (a *Assertions) Panics(f PanicTestFunc, msgAndArgs ...any) bool
- func (a *Assertions) PanicsWithError(errString string, f PanicTestFunc, msgAndArgs ...any) bool
- func (a *Assertions) PanicsWithErrorf(errString string, f PanicTestFunc, msg string, args ...any) bool
- func (a *Assertions) PanicsWithValue(expected any, f PanicTestFunc, msgAndArgs ...any) bool
- func (a *Assertions) PanicsWithValuef(expected any, f PanicTestFunc, msg string, args ...any) bool
- func (a *Assertions) Panicsf(f PanicTestFunc, msg string, args ...any) bool
- func (a *Assertions) Positive(e any, msgAndArgs ...any) bool
- func (a *Assertions) Positivef(e any, msg string, args ...any) bool
- func (a *Assertions) Regexp(rx any, str any, msgAndArgs ...any) bool
- func (a *Assertions) Regexpf(rx any, str any, msg string, args ...any) bool
- func (a *Assertions) Same(expected any, actual any, msgAndArgs ...any) bool
- func (a *Assertions) Samef(expected any, actual any, msg string, args ...any) bool
- func (a *Assertions) Subset(list any, subset any, msgAndArgs ...any) bool
- func (a *Assertions) Subsetf(list any, subset any, msg string, args ...any) bool
- func (a *Assertions) True(value bool, msgAndArgs ...any) bool
- func (a *Assertions) Truef(value bool, msg string, args ...any) bool
- func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any) bool
- func (a *Assertions) WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, ...) bool
- func (a *Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...any) bool
- func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ...any) bool
- func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...any) bool
- func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...any) bool
- func (a *Assertions) Zero(i any, msgAndArgs ...any) bool
- func (a *Assertions) Zerof(i any, msg string, args ...any) bool
- type BoolAssertionFunc
- type CollectT
- type CompareTypedeprecated
- type Comparison
- type ComparisonAssertionFunc
- type ErrorAssertionFunc
- type PanicAssertionFunc
- type PanicTestFunc
- type TestingT
- type ValueAssertionFunc
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrTest = errors.New("assert.ErrTest general error for testing")
ErrTest is an error instance useful for testing.
If the code does not care about error specifics, and only needs to return the error for example, this error should be used to make the test code more readable.
Functions ¶
func CallerInfo ¶
func CallerInfo() []string
CallerInfo returns 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 ¶
func Condition(t TestingT, comp Comparison, msgAndArgs ...any) bool
Condition uses a Comparison to assert a complex condition.
func Conditionf ¶
func Conditionf(t TestingT, comp Comparison, msg string, args ...any) bool
Conditionf uses a Comparison to assert a complex condition.
func Contains ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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}) => false
func EqualExportedValuesf ¶
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") => false
func EqualValues ¶
EqualValues asserts that two objects are equal or convertible to the larger type and equal.
assert.EqualValues(t, uint32(123), int32(123))
func EqualValuesf ¶
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 ¶
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 ¶
Error asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction() assert.Error(t, err)
func ErrorAs ¶
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 ¶
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 ¶
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 ¶
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 ¶
ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func ErrorIsf ¶
ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func Errorf ¶
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 ¶
func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...any) bool
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 ¶
func EventuallyWithT(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...any) bool
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 ¶
func EventuallyWithTf(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...any) bool
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, "error message %s", "formatted") {
// 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 Eventuallyf ¶
func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...any) bool
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 ¶
Exactly asserts that two objects are equal in value and type.
assert.Exactly(t, int32(123), int64(123))
func Exactlyf ¶
Exactlyf asserts that two objects are equal in value and type.
assert.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted")
func Falsef ¶
Falsef asserts that the specified value is false.
assert.Falsef(t, myBool, "error message %s", "formatted")
func FileExists ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
HTTPBody is a helper that returns HTTP body of the response. It returns empty string if building a new request fails.
func HTTPBodyContains ¶
func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str any, msgAndArgs ...any) bool
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 ¶
func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str any, msg string, args ...any) bool
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 ¶
func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str any, msgAndArgs ...any) bool
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 ¶
func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str any, msg string, args ...any) bool
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 ¶
func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...any) bool
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 ¶
func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...any) bool
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 ¶
func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...any) bool
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 ¶
func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...any) bool
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 ¶
func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, statuscode int, msgAndArgs ...any) bool
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 ¶
func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...any) bool
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 ¶
func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...any) bool
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 ¶
func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...any) bool
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 ¶
Implements asserts that an object is implemented by the specified interface.
assert.Implements(t, (*MyInterface)(nil), new(MyObject))
func Implementsf ¶
Implementsf asserts that an object is implemented by the specified interface.
assert.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
func InDelta ¶
InDelta asserts that the two numerals are within delta of each other.
assert.InDelta(t, math.Pi, 22/7.0, 0.01)
func InDeltaMapValues ¶
InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func InDeltaMapValuesf ¶
func InDeltaMapValuesf(t TestingT, expected any, actual any, delta float64, msg string, args ...any) bool
InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func InDeltaSlice ¶
InDeltaSlice is the same as InDelta, except it compares two slices.
func InDeltaSlicef ¶
func InDeltaSlicef(t TestingT, expected any, actual any, delta float64, msg string, args ...any) bool
InDeltaSlicef is the same as InDelta, except it compares two slices.
func InDeltaf ¶
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 InEpsilonSlice ¶
InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
func InEpsilonSlicef ¶
func InEpsilonSlicef(t TestingT, expected any, actual any, epsilon float64, msg string, args ...any) bool
InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.
func InEpsilonf ¶
func InEpsilonf(t TestingT, expected any, actual any, epsilon float64, msg string, args ...any) bool
InEpsilonf asserts that expected and actual have a relative error less than epsilon
func IsDecreasing ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
IsNotType asserts that the specified objects are not of the same type.
assert.IsNotType(t, &NotMyStruct{}, &MyStruct{})
func IsNotTypef ¶
IsNotTypef asserts that the specified objects are not of the same type.
assert.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")
func IsType ¶
IsType asserts that the specified objects are of the same type.
assert.IsType(t, &MyStruct{}, &MyStruct{})
func IsTypef ¶
IsTypef asserts that the specified objects are of the same type.
assert.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted")
func JSONEq ¶
JSONEq asserts that two JSON strings are equivalent.
assert.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)
func JSONEqBytes ¶ added in v2.0.2
JSONEqBytes asserts that two JSON byte slices are equivalent.
assert.JSONEqBytes(t, []byte(`{"hello": "world", "foo": "bar"}`), []byte(`{"foo": "bar", "hello": "world"}`))
func JSONEqBytesf ¶ added in v2.0.2
JSONEqBytesf asserts that two JSON byte slices are equivalent.
assert.JSONEqBytesf(t, []byte(`{"hello": "world", "foo": "bar"}`), []byte(`{"foo": "bar", "hello": "world"}`), "error message %s", "formatted")
func JSONEqf ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
Negative asserts that the specified element is negative
assert.Negative(t, -1) assert.Negative(t, -1.23)
func Negativef ¶
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 ¶
func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...any) bool
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 ¶
func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...any) bool
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 Nilf ¶
Nilf asserts that the specified object is nil.
assert.Nilf(t, err, "error message %s", "formatted")
func NoDirExists ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
NotEmpty asserts that the specified object is NOT Empty.
if assert.NotEmpty(t, obj) {
assert.Equal(t, "two", obj[1])
}
func NotEmptyf ¶
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 ¶
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 ¶
NotEqualValues asserts that two objects are not equal even when converted to the same type
assert.NotEqualValues(t, obj1, obj2)
func NotEqualValuesf ¶
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 ¶
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 ¶
NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func NotErrorAsf ¶
NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func NotErrorIs ¶
NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func NotErrorIsf ¶
NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func NotImplements ¶
NotImplements asserts that an object does not implement the specified interface.
assert.NotImplements(t, (*MyInterface)(nil), new(MyObject))
func NotImplementsf ¶
NotImplementsf asserts that an object does not implement the specified interface.
assert.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
func NotNilf ¶
NotNilf asserts that the specified object is not nil.
assert.NotNilf(t, err, "error message %s", "formatted")
func NotPanics ¶
func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...any) bool
NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanics(t, func(){ RemainCalm() })
func NotPanicsf ¶
func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...any) bool
NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted")
func NotRegexp ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ObjectsAreEqual ¶
ObjectsAreEqual determines if two objects are considered equal.
This function does no assertion of any kind.
func ObjectsAreEqualValues ¶
ObjectsAreEqualValues gets whether two objects are equal, or if their values are equal.
func ObjectsExportedFieldsAreEqual
deprecated
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 ¶
func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...any) bool
Panics asserts that the code inside the specified PanicTestFunc panics.
assert.Panics(t, func(){ GoCrazy() })
func PanicsWithError ¶
func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs ...any) bool
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 ¶
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 ¶
func PanicsWithValue(t TestingT, expected any, f PanicTestFunc, msgAndArgs ...any) bool
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 ¶
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 ¶
func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...any) bool
Panicsf asserts that the code inside the specified PanicTestFunc panics.
assert.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")
func Positive ¶
Positive asserts that the specified element is positive
assert.Positive(t, 1) assert.Positive(t, 1.23)
func Positivef ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 Truef ¶
Truef asserts that the specified value is true.
assert.Truef(t, myBool, "error message %s", "formatted")
func WithinDuration ¶
func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...any) bool
WithinDuration asserts that the two times are within duration delta of each other.
assert.WithinDuration(t, time.Now(), 10*time.Second)
func WithinDurationf ¶
func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...any) bool
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 ¶
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 ¶
func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...any) bool
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 ¶
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 ¶
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")
Types ¶
type Assertions ¶
type Assertions struct {
// contains filtered or unexported fields
}
Assertions provides assertion methods around the TestingT interface.
func New ¶
func New(t TestingT) *Assertions
New makes a new Assertions object for the specified TestingT.
func (*Assertions) Condition ¶
func (a *Assertions) Condition(comp Comparison, msgAndArgs ...any) bool
Condition uses a Comparison to assert a complex condition.
func (*Assertions) Conditionf ¶
func (a *Assertions) Conditionf(comp Comparison, msg string, args ...any) bool
Conditionf uses a Comparison to assert a complex condition.
func (*Assertions) Contains ¶
func (a *Assertions) Contains(s any, contains any, msgAndArgs ...any) bool
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 (*Assertions) Containsf ¶
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 (*Assertions) DirExists ¶
func (a *Assertions) DirExists(path string, msgAndArgs ...any) bool
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 (*Assertions) DirExistsf ¶
func (a *Assertions) DirExistsf(path string, msg string, args ...any) bool
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 (*Assertions) ElementsMatch ¶
func (a *Assertions) ElementsMatch(listA any, listB any, msgAndArgs ...any) bool
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 (*Assertions) ElementsMatchf ¶
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 (*Assertions) Empty ¶
func (a *Assertions) Empty(object any, msgAndArgs ...any) bool
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 (*Assertions) Emptyf ¶
func (a *Assertions) Emptyf(object any, msg string, args ...any) bool
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 (*Assertions) Equal ¶
func (a *Assertions) Equal(expected any, actual any, msgAndArgs ...any) bool
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 (*Assertions) EqualError ¶
func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...any) bool
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 (*Assertions) EqualErrorf ¶
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 (*Assertions) EqualExportedValues ¶
func (a *Assertions) EqualExportedValues(expected any, actual any, msgAndArgs ...any) bool
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}) => false
func (*Assertions) EqualExportedValuesf ¶
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") => false
func (*Assertions) EqualValues ¶
func (a *Assertions) EqualValues(expected any, actual any, msgAndArgs ...any) bool
EqualValues asserts that two objects are equal or convertible to the larger type and equal.
a.EqualValues(uint32(123), int32(123))
func (*Assertions) EqualValuesf ¶
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 (*Assertions) Equalf ¶
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 (*Assertions) Error ¶
func (a *Assertions) Error(err error, msgAndArgs ...any) bool
Error asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction() a.Error(err)
func (*Assertions) ErrorAs ¶
func (a *Assertions) ErrorAs(err error, target any, msgAndArgs ...any) bool
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 (*Assertions) ErrorAsf ¶
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 (*Assertions) ErrorContains ¶
func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...any) bool
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 (*Assertions) ErrorContainsf ¶
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 (*Assertions) ErrorIs ¶
func (a *Assertions) ErrorIs(err error, target error, msgAndArgs ...any) bool
ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (*Assertions) ErrorIsf ¶
ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (*Assertions) Errorf ¶
func (a *Assertions) Errorf(err error, msg string, args ...any) bool
Errorf asserts that a function returned a non-nil error (ie. an error).
actualObj, err := SomeFunction() a.Errorf(err, "error message %s", "formatted")
func (*Assertions) Eventually ¶
func (a *Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...any) bool
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 (*Assertions) EventuallyWithT ¶
func (a *Assertions) EventuallyWithT(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...any) bool
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 (*Assertions) EventuallyWithTf ¶
func (a *Assertions) EventuallyWithTf(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...any) bool
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, "error message %s", "formatted") {
// 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 (*Assertions) Eventuallyf ¶
func (a *Assertions) Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...any) bool
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 (*Assertions) Exactly ¶
func (a *Assertions) Exactly(expected any, actual any, msgAndArgs ...any) bool
Exactly asserts that two objects are equal in value and type.
a.Exactly(int32(123), int64(123))
func (*Assertions) Exactlyf ¶
Exactlyf asserts that two objects are equal in value and type.
a.Exactlyf(int32(123), int64(123), "error message %s", "formatted")
func (*Assertions) Fail ¶
func (a *Assertions) Fail(failureMessage string, msgAndArgs ...any) bool
Fail reports a failure through
func (*Assertions) FailNow ¶
func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...any) bool
FailNow fails test
func (*Assertions) FailNowf ¶
func (a *Assertions) FailNowf(failureMessage string, msg string, args ...any) bool
FailNowf fails test
func (*Assertions) Failf ¶
func (a *Assertions) Failf(failureMessage string, msg string, args ...any) bool
Failf reports a failure through
func (*Assertions) False ¶
func (a *Assertions) False(value bool, msgAndArgs ...any) bool
False asserts that the specified value is false.
a.False(myBool)
func (*Assertions) Falsef ¶
func (a *Assertions) Falsef(value bool, msg string, args ...any) bool
Falsef asserts that the specified value is false.
a.Falsef(myBool, "error message %s", "formatted")
func (*Assertions) FileExists ¶
func (a *Assertions) FileExists(path string, msgAndArgs ...any) bool
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 (*Assertions) FileExistsf ¶
func (a *Assertions) FileExistsf(path string, msg string, args ...any) bool
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 (*Assertions) Greater ¶
func (a *Assertions) Greater(e1 any, e2 any, msgAndArgs ...any) bool
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 (*Assertions) GreaterOrEqual ¶
func (a *Assertions) GreaterOrEqual(e1 any, e2 any, msgAndArgs ...any) bool
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 (*Assertions) GreaterOrEqualf ¶
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 (*Assertions) Greaterf ¶
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 (*Assertions) HTTPBodyContains ¶
func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, str any, msgAndArgs ...any) bool
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 (*Assertions) HTTPBodyContainsf ¶
func (a *Assertions) HTTPBodyContainsf(handler http.HandlerFunc, method string, url string, values url.Values, str any, msg string, args ...any) bool
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 (*Assertions) HTTPBodyNotContains ¶
func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, str any, msgAndArgs ...any) bool
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 (*Assertions) HTTPBodyNotContainsf ¶
func (a *Assertions) HTTPBodyNotContainsf(handler http.HandlerFunc, method string, url string, values url.Values, str any, msg string, args ...any) bool
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 (*Assertions) HTTPError ¶
func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...any) bool
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 (*Assertions) HTTPErrorf ¶
func (a *Assertions) HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...any) bool
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 (*Assertions) HTTPRedirect ¶
func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...any) bool
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 (*Assertions) HTTPRedirectf ¶
func (a *Assertions) HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...any) bool
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 (*Assertions) HTTPStatusCode ¶
func (a *Assertions) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msgAndArgs ...any) bool
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 (*Assertions) HTTPStatusCodef ¶
func (a *Assertions) HTTPStatusCodef(handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...any) bool
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 (*Assertions) HTTPSuccess ¶
func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...any) bool
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 (*Assertions) HTTPSuccessf ¶
func (a *Assertions) HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...any) bool
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 (*Assertions) Implements ¶
func (a *Assertions) Implements(interfaceObject any, object any, msgAndArgs ...any) bool
Implements asserts that an object is implemented by the specified interface.
a.Implements((*MyInterface)(nil), new(MyObject))
func (*Assertions) Implementsf ¶
Implementsf asserts that an object is implemented by the specified interface.
a.Implementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
func (*Assertions) InDelta ¶
InDelta asserts that the two numerals are within delta of each other.
a.InDelta(math.Pi, 22/7.0, 0.01)
func (*Assertions) InDeltaMapValues ¶
func (a *Assertions) InDeltaMapValues(expected any, actual any, delta float64, msgAndArgs ...any) bool
InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func (*Assertions) InDeltaMapValuesf ¶
func (a *Assertions) InDeltaMapValuesf(expected any, actual any, delta float64, msg string, args ...any) bool
InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
func (*Assertions) InDeltaSlice ¶
InDeltaSlice is the same as InDelta, except it compares two slices.
func (*Assertions) InDeltaSlicef ¶
func (a *Assertions) InDeltaSlicef(expected any, actual any, delta float64, msg string, args ...any) bool
InDeltaSlicef is the same as InDelta, except it compares two slices.
func (*Assertions) InDeltaf ¶
func (a *Assertions) InDeltaf(expected any, actual any, delta float64, msg string, args ...any) bool
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 (*Assertions) InEpsilon ¶
InEpsilon asserts that expected and actual have a relative error less than epsilon
func (*Assertions) InEpsilonSlice ¶
func (a *Assertions) InEpsilonSlice(expected any, actual any, epsilon float64, msgAndArgs ...any) bool
InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
func (*Assertions) InEpsilonSlicef ¶
func (a *Assertions) InEpsilonSlicef(expected any, actual any, epsilon float64, msg string, args ...any) bool
InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.
func (*Assertions) InEpsilonf ¶
func (a *Assertions) InEpsilonf(expected any, actual any, epsilon float64, msg string, args ...any) bool
InEpsilonf asserts that expected and actual have a relative error less than epsilon
func (*Assertions) IsDecreasing ¶
func (a *Assertions) IsDecreasing(object any, msgAndArgs ...any) bool
IsDecreasing asserts that the collection is decreasing
a.IsDecreasing([]int{2, 1, 0})
a.IsDecreasing([]float{2, 1})
a.IsDecreasing([]string{"b", "a"})
func (*Assertions) IsDecreasingf ¶
func (a *Assertions) IsDecreasingf(object any, msg string, args ...any) bool
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 (*Assertions) IsIncreasing ¶
func (a *Assertions) IsIncreasing(object any, msgAndArgs ...any) bool
IsIncreasing asserts that the collection is increasing
a.IsIncreasing([]int{1, 2, 3})
a.IsIncreasing([]float{1, 2})
a.IsIncreasing([]string{"a", "b"})
func (*Assertions) IsIncreasingf ¶
func (a *Assertions) IsIncreasingf(object any, msg string, args ...any) bool
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 (*Assertions) IsNonDecreasing ¶
func (a *Assertions) IsNonDecreasing(object any, msgAndArgs ...any) bool
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 (*Assertions) IsNonDecreasingf ¶
func (a *Assertions) IsNonDecreasingf(object any, msg string, args ...any) bool
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 (*Assertions) IsNonIncreasing ¶
func (a *Assertions) IsNonIncreasing(object any, msgAndArgs ...any) bool
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 (*Assertions) IsNonIncreasingf ¶
func (a *Assertions) IsNonIncreasingf(object any, msg string, args ...any) bool
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 (*Assertions) IsNotType ¶
func (a *Assertions) IsNotType(theType any, object any, msgAndArgs ...any) bool
IsNotType asserts that the specified objects are not of the same type.
a.IsNotType(&NotMyStruct{}, &MyStruct{})
func (*Assertions) IsNotTypef ¶
IsNotTypef asserts that the specified objects are not of the same type.
a.IsNotTypef(&NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")
func (*Assertions) IsType ¶
func (a *Assertions) IsType(expectedType any, object any, msgAndArgs ...any) bool
IsType asserts that the specified objects are of the same type.
a.IsType(&MyStruct{}, &MyStruct{})
func (*Assertions) IsTypef ¶
IsTypef asserts that the specified objects are of the same type.
a.IsTypef(&MyStruct{}, &MyStruct{}, "error message %s", "formatted")
func (*Assertions) JSONEq ¶
func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...any) bool
JSONEq asserts that two JSON strings are equivalent.
a.JSONEq(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)
func (*Assertions) JSONEqBytes ¶ added in v2.0.2
func (a *Assertions) JSONEqBytes(expected []byte, actual []byte, msgAndArgs ...any) bool
JSONEqBytes asserts that two JSON byte slices are equivalent.
a.JSONEqBytes([]byte(`{"hello": "world", "foo": "bar"}`), []byte(`{"foo": "bar", "hello": "world"}`))
func (*Assertions) JSONEqBytesf ¶ added in v2.0.2
JSONEqBytesf asserts that two JSON byte slices are equivalent.
a.JSONEqBytesf([]byte(`{"hello": "world", "foo": "bar"}`), []byte(`{"foo": "bar", "hello": "world"}`), "error message %s", "formatted")
func (*Assertions) JSONEqf ¶
JSONEqf asserts that two JSON strings are equivalent.
a.JSONEqf(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted")
func (*Assertions) Len ¶
func (a *Assertions) Len(object any, length int, msgAndArgs ...any) bool
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 (*Assertions) Lenf ¶
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 (*Assertions) Less ¶
func (a *Assertions) Less(e1 any, e2 any, msgAndArgs ...any) bool
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 (*Assertions) LessOrEqual ¶
func (a *Assertions) LessOrEqual(e1 any, e2 any, msgAndArgs ...any) bool
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 (*Assertions) LessOrEqualf ¶
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 (*Assertions) Lessf ¶
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 (*Assertions) Negative ¶
func (a *Assertions) Negative(e any, msgAndArgs ...any) bool
Negative asserts that the specified element is negative
a.Negative(-1) a.Negative(-1.23)
func (*Assertions) Negativef ¶
func (a *Assertions) Negativef(e any, msg string, args ...any) bool
Negativef asserts that the specified element is negative
a.Negativef(-1, "error message %s", "formatted") a.Negativef(-1.23, "error message %s", "formatted")
func (*Assertions) Never ¶
func (a *Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...any) bool
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 (*Assertions) Neverf ¶
func (a *Assertions) Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...any) bool
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 (*Assertions) Nil ¶
func (a *Assertions) Nil(object any, msgAndArgs ...any) bool
Nil asserts that the specified object is nil.
a.Nil(err)
func (*Assertions) Nilf ¶
func (a *Assertions) Nilf(object any, msg string, args ...any) bool
Nilf asserts that the specified object is nil.
a.Nilf(err, "error message %s", "formatted")
func (*Assertions) NoDirExists ¶
func (a *Assertions) NoDirExists(path string, msgAndArgs ...any) bool
NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.
func (*Assertions) NoDirExistsf ¶
func (a *Assertions) NoDirExistsf(path string, msg string, args ...any) bool
NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.
func (*Assertions) NoError ¶
func (a *Assertions) NoError(err error, msgAndArgs ...any) bool
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 (*Assertions) NoErrorf ¶
func (a *Assertions) NoErrorf(err error, msg string, args ...any) bool
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 (*Assertions) NoFileExists ¶
func (a *Assertions) NoFileExists(path string, msgAndArgs ...any) bool
NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.
func (*Assertions) NoFileExistsf ¶
func (a *Assertions) NoFileExistsf(path string, msg string, args ...any) bool
NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.
func (*Assertions) NotContains ¶
func (a *Assertions) NotContains(s any, contains any, msgAndArgs ...any) bool
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 (*Assertions) NotContainsf ¶
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 (*Assertions) NotElementsMatch ¶
func (a *Assertions) NotElementsMatch(listA any, listB any, msgAndArgs ...any) bool
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 (*Assertions) NotElementsMatchf ¶
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 (*Assertions) NotEmpty ¶
func (a *Assertions) NotEmpty(object any, msgAndArgs ...any) bool
NotEmpty asserts that the specified object is NOT Empty.
if a.NotEmpty(obj) {
assert.Equal(t, "two", obj[1])
}
func (*Assertions) NotEmptyf ¶
func (a *Assertions) NotEmptyf(object any, msg string, args ...any) bool
NotEmptyf asserts that the specified object is NOT Empty.
if a.NotEmptyf(obj, "error message %s", "formatted") {
assert.Equal(t, "two", obj[1])
}
func (*Assertions) NotEqual ¶
func (a *Assertions) NotEqual(expected any, actual any, msgAndArgs ...any) bool
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 (*Assertions) NotEqualValues ¶
func (a *Assertions) NotEqualValues(expected any, actual any, msgAndArgs ...any) bool
NotEqualValues asserts that two objects are not equal even when converted to the same type
a.NotEqualValues(obj1, obj2)
func (*Assertions) NotEqualValuesf ¶
NotEqualValuesf asserts that two objects are not equal even when converted to the same type
a.NotEqualValuesf(obj1, obj2, "error message %s", "formatted")
func (*Assertions) NotEqualf ¶
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 (*Assertions) NotErrorAs ¶
func (a *Assertions) NotErrorAs(err error, target any, msgAndArgs ...any) bool
NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func (*Assertions) NotErrorAsf ¶
NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.
func (*Assertions) NotErrorIs ¶
func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...any) bool
NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (*Assertions) NotErrorIsf ¶
NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.
func (*Assertions) NotImplements ¶
func (a *Assertions) NotImplements(interfaceObject any, object any, msgAndArgs ...any) bool
NotImplements asserts that an object does not implement the specified interface.
a.NotImplements((*MyInterface)(nil), new(MyObject))
func (*Assertions) NotImplementsf ¶
NotImplementsf asserts that an object does not implement the specified interface.
a.NotImplementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
func (*Assertions) NotNil ¶
func (a *Assertions) NotNil(object any, msgAndArgs ...any) bool
NotNil asserts that the specified object is not nil.
a.NotNil(err)
func (*Assertions) NotNilf ¶
func (a *Assertions) NotNilf(object any, msg string, args ...any) bool
NotNilf asserts that the specified object is not nil.
a.NotNilf(err, "error message %s", "formatted")
func (*Assertions) NotPanics ¶
func (a *Assertions) NotPanics(f PanicTestFunc, msgAndArgs ...any) bool
NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
a.NotPanics(func(){ RemainCalm() })
func (*Assertions) NotPanicsf ¶
func (a *Assertions) NotPanicsf(f PanicTestFunc, msg string, args ...any) bool
NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
a.NotPanicsf(func(){ RemainCalm() }, "error message %s", "formatted")
func (*Assertions) NotRegexp ¶
func (a *Assertions) NotRegexp(rx any, str any, msgAndArgs ...any) bool
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 (*Assertions) NotRegexpf ¶
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 (*Assertions) NotSame ¶
func (a *Assertions) NotSame(expected any, actual any, msgAndArgs ...any) bool
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 (*Assertions) NotSamef ¶
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 (*Assertions) NotSubset ¶
func (a *Assertions) NotSubset(list any, subset any, msgAndArgs ...any) bool
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 (*Assertions) NotSubsetf ¶
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 (*Assertions) NotZero ¶
func (a *Assertions) NotZero(i any, msgAndArgs ...any) bool
NotZero asserts that i is not the zero value for its type.
func (*Assertions) NotZerof ¶
func (a *Assertions) NotZerof(i any, msg string, args ...any) bool
NotZerof asserts that i is not the zero value for its type.
func (*Assertions) Panics ¶
func (a *Assertions) Panics(f PanicTestFunc, msgAndArgs ...any) bool
Panics asserts that the code inside the specified PanicTestFunc panics.
a.Panics(func(){ GoCrazy() })
func (*Assertions) PanicsWithError ¶
func (a *Assertions) PanicsWithError(errString string, f PanicTestFunc, msgAndArgs ...any) bool
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 (*Assertions) PanicsWithErrorf ¶
func (a *Assertions) PanicsWithErrorf(errString string, f PanicTestFunc, msg string, args ...any) bool
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 (*Assertions) PanicsWithValue ¶
func (a *Assertions) PanicsWithValue(expected any, f PanicTestFunc, msgAndArgs ...any) bool
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 (*Assertions) PanicsWithValuef ¶
func (a *Assertions) PanicsWithValuef(expected any, f PanicTestFunc, msg string, args ...any) bool
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 (*Assertions) Panicsf ¶
func (a *Assertions) Panicsf(f PanicTestFunc, msg string, args ...any) bool
Panicsf asserts that the code inside the specified PanicTestFunc panics.
a.Panicsf(func(){ GoCrazy() }, "error message %s", "formatted")
func (*Assertions) Positive ¶
func (a *Assertions) Positive(e any, msgAndArgs ...any) bool
Positive asserts that the specified element is positive
a.Positive(1) a.Positive(1.23)
func (*Assertions) Positivef ¶
func (a *Assertions) Positivef(e any, msg string, args ...any) bool
Positivef asserts that the specified element is positive
a.Positivef(1, "error message %s", "formatted") a.Positivef(1.23, "error message %s", "formatted")
func (*Assertions) Regexp ¶
func (a *Assertions) Regexp(rx any, str any, msgAndArgs ...any) bool
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 (*Assertions) Regexpf ¶
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 (*Assertions) Same ¶
func (a *Assertions) Same(expected any, actual any, msgAndArgs ...any) bool
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 (*Assertions) Samef ¶
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 (*Assertions) Subset ¶
func (a *Assertions) Subset(list any, subset any, msgAndArgs ...any) bool
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 (*Assertions) Subsetf ¶
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 (*Assertions) True ¶
func (a *Assertions) True(value bool, msgAndArgs ...any) bool
True asserts that the specified value is true.
a.True(myBool)
func (*Assertions) Truef ¶
func (a *Assertions) Truef(value bool, msg string, args ...any) bool
Truef asserts that the specified value is true.
a.Truef(myBool, "error message %s", "formatted")
func (*Assertions) WithinDuration ¶
func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any) bool
WithinDuration asserts that the two times are within duration delta of each other.
a.WithinDuration(time.Now(), time.Now(), 10*time.Second)
func (*Assertions) WithinDurationf ¶
func (a *Assertions) WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, args ...any) bool
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 (*Assertions) WithinRange ¶
func (a *Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...any) bool
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 (*Assertions) WithinRangef ¶
func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ...any) bool
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 (*Assertions) YAMLEq ¶
func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...any) bool
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 (*Assertions) YAMLEqf ¶
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")
type BoolAssertionFunc ¶
BoolAssertionFunc is a common function prototype when validating a bool value. Can be useful for table driven tests.
Example ¶
t := &testing.T{} // provided by test
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 ¶
type CollectT struct {
// contains filtered or unexported fields
}
CollectT implements the TestingT interface and collects all errors.
type CompareType
deprecated
type CompareType = compareResult
Deprecated: CompareType has only ever been for internal use and has accidentally been published since v1.6.0. Do not use it.
type Comparison ¶
type Comparison func() (success bool)
Comparison is a custom function that returns true on success and false on failure
type ComparisonAssertionFunc ¶
ComparisonAssertionFunc is a common function prototype when comparing two values. Can be useful for table driven tests.
Example ¶
t := &testing.T{} // provided by test
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 ¶
ErrorAssertionFunc is a common function prototype when validating an error value. Can be useful for table driven tests.
Example ¶
t := &testing.T{} // provided by test
dumbParseNum := func(input string, v any) 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 ¶
type PanicAssertionFunc = func(t TestingT, f PanicTestFunc, msgAndArgs ...any) bool
PanicAssertionFunc is a common function prototype when validating a panic value. Can be useful for table driven tests.
Example ¶
t := &testing.T{} // provided by test
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 ¶
type PanicTestFunc func()
PanicTestFunc defines a func that should be passed to the assert.Panics and assert.NotPanics methods, and represents a simple func that takes no arguments, and returns nothing.
type ValueAssertionFunc ¶
ValueAssertionFunc is a common function prototype when validating a single value. Can be useful for table driven tests.
Example ¶
t := &testing.T{} // provided by test
dumbParse := func(input string) any {
var x any
_ = 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))
})
}
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
unsafetests
Package unsafetests exists only to isolate tests that reference the unsafe package.
|
Package unsafetests exists only to isolate tests that reference the unsafe package. |
|
Package yaml is just an indirection to handle YAML deserialization.
|
Package yaml is just an indirection to handle YAML deserialization. |