require

package

v2.0.2 Latest Latest Go to latest Published: Oct 3, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/go-openapi/testify

Links

Open Source Insights

Documentation ¶

Overview ¶

Package require implements the same assertions as the assert package but stops test execution when a test fails.

Example Usage ¶

The following is a complete example using require in a standard test function:

import (
  "testing"
  "github.com/go-openapi/testify/v2/require"
)

func TestSomething(t *testing.T) {
  var a string = "Hello"
  var b string = "Hello"

  require.Equal(t, a, b, "The two words should be the same.")
}

Assertions ¶

The require package have same global functions as in the assert package, but instead of returning a boolean result they call testing.T.FailNow. A consequence of this is that it must be called from the goroutine running the test function, not from other goroutines created during the test.

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 ¶

func Condition(t TestingT, comp assert.Comparison, msgAndArgs ...any)
func Conditionf(t TestingT, comp assert.Comparison, msg string, args ...any)
func Contains(t TestingT, s any, contains any, msgAndArgs ...any)
func Containsf(t TestingT, s any, contains any, msg string, args ...any)
func DirExists(t TestingT, path string, msgAndArgs ...any)
func DirExistsf(t TestingT, path string, msg string, args ...any)
func ElementsMatch(t TestingT, listA any, listB any, msgAndArgs ...any)
func ElementsMatchf(t TestingT, listA any, listB any, msg string, args ...any)
func Empty(t TestingT, object any, msgAndArgs ...any)
func Emptyf(t TestingT, object any, msg string, args ...any)
func Equal(t TestingT, expected any, actual any, msgAndArgs ...any)
func EqualError(t TestingT, theError error, errString string, msgAndArgs ...any)
func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...any)
func EqualExportedValues(t TestingT, expected any, actual any, msgAndArgs ...any)
func EqualExportedValuesf(t TestingT, expected any, actual any, msg string, args ...any)
func EqualValues(t TestingT, expected any, actual any, msgAndArgs ...any)
func EqualValuesf(t TestingT, expected any, actual any, msg string, args ...any)
func Equalf(t TestingT, expected any, actual any, msg string, args ...any)
func Error(t TestingT, err error, msgAndArgs ...any)
func ErrorAs(t TestingT, err error, target any, msgAndArgs ...any)
func ErrorAsf(t TestingT, err error, target any, msg string, args ...any)
func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...any)
func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...any)
func ErrorIs(t TestingT, err error, target error, msgAndArgs ...any)
func ErrorIsf(t TestingT, err error, target error, msg string, args ...any)
func Errorf(t TestingT, err error, msg string, args ...any)
func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...)
func EventuallyWithT(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, ...)
func EventuallyWithTf(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, ...)
func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...)
func Exactly(t TestingT, expected any, actual any, msgAndArgs ...any)
func Exactlyf(t TestingT, expected any, actual any, msg string, args ...any)
func Fail(t TestingT, failureMessage string, msgAndArgs ...any)
func FailNow(t TestingT, failureMessage string, msgAndArgs ...any)
func FailNowf(t TestingT, failureMessage string, msg string, args ...any)
func Failf(t TestingT, failureMessage string, msg string, args ...any)
func False(t TestingT, value bool, msgAndArgs ...any)
func Falsef(t TestingT, value bool, msg string, args ...any)
func FileExists(t TestingT, path string, msgAndArgs ...any)
func FileExistsf(t TestingT, path string, msg string, args ...any)
func Greater(t TestingT, e1 any, e2 any, msgAndArgs ...any)
func GreaterOrEqual(t TestingT, e1 any, e2 any, msgAndArgs ...any)
func GreaterOrEqualf(t TestingT, e1 any, e2 any, msg string, args ...any)
func Greaterf(t TestingT, e1 any, e2 any, msg string, args ...any)
func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPError(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPRedirect(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPSuccess(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, ...)
func Implements(t TestingT, interfaceObject any, object any, msgAndArgs ...any)
func Implementsf(t TestingT, interfaceObject any, object any, msg string, args ...any)
func InDelta(t TestingT, expected any, actual any, delta float64, msgAndArgs ...any)
func InDeltaMapValues(t TestingT, expected any, actual any, delta float64, msgAndArgs ...any)
func InDeltaMapValuesf(t TestingT, expected any, actual any, delta float64, msg string, args ...any)
func InDeltaSlice(t TestingT, expected any, actual any, delta float64, msgAndArgs ...any)
func InDeltaSlicef(t TestingT, expected any, actual any, delta float64, msg string, args ...any)
func InDeltaf(t TestingT, expected any, actual any, delta float64, msg string, args ...any)
func InEpsilon(t TestingT, expected any, actual any, epsilon float64, msgAndArgs ...any)
func InEpsilonSlice(t TestingT, expected any, actual any, epsilon float64, msgAndArgs ...any)
func InEpsilonSlicef(t TestingT, expected any, actual any, epsilon float64, msg string, args ...any)
func InEpsilonf(t TestingT, expected any, actual any, epsilon float64, msg string, args ...any)
func IsDecreasing(t TestingT, object any, msgAndArgs ...any)
func IsDecreasingf(t TestingT, object any, msg string, args ...any)
func IsIncreasing(t TestingT, object any, msgAndArgs ...any)
func IsIncreasingf(t TestingT, object any, msg string, args ...any)
func IsNonDecreasing(t TestingT, object any, msgAndArgs ...any)
func IsNonDecreasingf(t TestingT, object any, msg string, args ...any)
func IsNonIncreasing(t TestingT, object any, msgAndArgs ...any)
func IsNonIncreasingf(t TestingT, object any, msg string, args ...any)
func IsNotType(t TestingT, theType any, object any, msgAndArgs ...any)
func IsNotTypef(t TestingT, theType any, object any, msg string, args ...any)
func IsType(t TestingT, expectedType any, object any, msgAndArgs ...any)
func IsTypef(t TestingT, expectedType any, object any, msg string, args ...any)
func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...any)
func JSONEqBytes(t TestingT, expected []byte, actual []byte, msgAndArgs ...any)
func JSONEqBytesf(t TestingT, expected []byte, actual []byte, msg string, args ...any)
func JSONEqf(t TestingT, expected string, actual string, msg string, args ...any)
func Len(t TestingT, object any, length int, msgAndArgs ...any)
func Lenf(t TestingT, object any, length int, msg string, args ...any)
func Less(t TestingT, e1 any, e2 any, msgAndArgs ...any)
func LessOrEqual(t TestingT, e1 any, e2 any, msgAndArgs ...any)
func LessOrEqualf(t TestingT, e1 any, e2 any, msg string, args ...any)
func Lessf(t TestingT, e1 any, e2 any, msg string, args ...any)
func Negative(t TestingT, e any, msgAndArgs ...any)
func Negativef(t TestingT, e any, msg string, args ...any)
func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...)
func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, ...)
func Nil(t TestingT, object any, msgAndArgs ...any)
func Nilf(t TestingT, object any, msg string, args ...any)
func NoDirExists(t TestingT, path string, msgAndArgs ...any)
func NoDirExistsf(t TestingT, path string, msg string, args ...any)
func NoError(t TestingT, err error, msgAndArgs ...any)
func NoErrorf(t TestingT, err error, msg string, args ...any)
func NoFileExists(t TestingT, path string, msgAndArgs ...any)
func NoFileExistsf(t TestingT, path string, msg string, args ...any)
func NotContains(t TestingT, s any, contains any, msgAndArgs ...any)
func NotContainsf(t TestingT, s any, contains any, msg string, args ...any)
func NotElementsMatch(t TestingT, listA any, listB any, msgAndArgs ...any)
func NotElementsMatchf(t TestingT, listA any, listB any, msg string, args ...any)
func NotEmpty(t TestingT, object any, msgAndArgs ...any)
func NotEmptyf(t TestingT, object any, msg string, args ...any)
func NotEqual(t TestingT, expected any, actual any, msgAndArgs ...any)
func NotEqualValues(t TestingT, expected any, actual any, msgAndArgs ...any)
func NotEqualValuesf(t TestingT, expected any, actual any, msg string, args ...any)
func NotEqualf(t TestingT, expected any, actual any, msg string, args ...any)
func NotErrorAs(t TestingT, err error, target any, msgAndArgs ...any)
func NotErrorAsf(t TestingT, err error, target any, msg string, args ...any)
func NotErrorIs(t TestingT, err error, target error, msgAndArgs ...any)
func NotErrorIsf(t TestingT, err error, target error, msg string, args ...any)
func NotImplements(t TestingT, interfaceObject any, object any, msgAndArgs ...any)
func NotImplementsf(t TestingT, interfaceObject any, object any, msg string, args ...any)
func NotNil(t TestingT, object any, msgAndArgs ...any)
func NotNilf(t TestingT, object any, msg string, args ...any)
func NotPanics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...any)
func NotPanicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...any)
func NotRegexp(t TestingT, rx any, str any, msgAndArgs ...any)
func NotRegexpf(t TestingT, rx any, str any, msg string, args ...any)
func NotSame(t TestingT, expected any, actual any, msgAndArgs ...any)
func NotSamef(t TestingT, expected any, actual any, msg string, args ...any)
func NotSubset(t TestingT, list any, subset any, msgAndArgs ...any)
func NotSubsetf(t TestingT, list any, subset any, msg string, args ...any)
func NotZero(t TestingT, i any, msgAndArgs ...any)
func NotZerof(t TestingT, i any, msg string, args ...any)
func Panics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...any)
func PanicsWithError(t TestingT, errString string, f assert.PanicTestFunc, msgAndArgs ...any)
func PanicsWithErrorf(t TestingT, errString string, f assert.PanicTestFunc, msg string, args ...any)
func PanicsWithValue(t TestingT, expected any, f assert.PanicTestFunc, msgAndArgs ...any)
func PanicsWithValuef(t TestingT, expected any, f assert.PanicTestFunc, msg string, args ...any)
func Panicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...any)
func Positive(t TestingT, e any, msgAndArgs ...any)
func Positivef(t TestingT, e any, msg string, args ...any)
func Regexp(t TestingT, rx any, str any, msgAndArgs ...any)
func Regexpf(t TestingT, rx any, str any, msg string, args ...any)
func Same(t TestingT, expected any, actual any, msgAndArgs ...any)
func Samef(t TestingT, expected any, actual any, msg string, args ...any)
func Subset(t TestingT, list any, subset any, msgAndArgs ...any)
func Subsetf(t TestingT, list any, subset any, msg string, args ...any)
func True(t TestingT, value bool, msgAndArgs ...any)
func Truef(t TestingT, value bool, msg string, args ...any)
func WithinDuration(t TestingT, expected time.Time, actual time.Time, delta time.Duration, ...)
func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, ...)
func WithinRange(t TestingT, actual time.Time, start time.Time, end time.Time, ...)
func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, ...)
func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...any)
func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...any)
func Zero(t TestingT, i any, msgAndArgs ...any)
func Zerof(t TestingT, i any, msg string, args ...any)
type Assertions
- func New(t TestingT) *Assertions
- func (a *Assertions) Condition(comp assert.Comparison, msgAndArgs ...any)
- func (a *Assertions) Conditionf(comp assert.Comparison, msg string, args ...any)
- func (a *Assertions) Contains(s any, contains any, msgAndArgs ...any)
- func (a *Assertions) Containsf(s any, contains any, msg string, args ...any)
- func (a *Assertions) DirExists(path string, msgAndArgs ...any)
- func (a *Assertions) DirExistsf(path string, msg string, args ...any)
- func (a *Assertions) ElementsMatch(listA any, listB any, msgAndArgs ...any)
- func (a *Assertions) ElementsMatchf(listA any, listB any, msg string, args ...any)
- func (a *Assertions) Empty(object any, msgAndArgs ...any)
- func (a *Assertions) Emptyf(object any, msg string, args ...any)
- func (a *Assertions) Equal(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...any)
- func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...any)
- func (a *Assertions) EqualExportedValues(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) EqualExportedValuesf(expected any, actual any, msg string, args ...any)
- func (a *Assertions) EqualValues(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) EqualValuesf(expected any, actual any, msg string, args ...any)
- func (a *Assertions) Equalf(expected any, actual any, msg string, args ...any)
- func (a *Assertions) Error(err error, msgAndArgs ...any)
- func (a *Assertions) ErrorAs(err error, target any, msgAndArgs ...any)
- func (a *Assertions) ErrorAsf(err error, target any, msg string, args ...any)
- func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...any)
- func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...any)
- func (a *Assertions) ErrorIs(err error, target error, msgAndArgs ...any)
- func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...any)
- func (a *Assertions) Errorf(err error, msg string, args ...any)
- func (a *Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, ...)
- func (a *Assertions) EventuallyWithT(condition func(collect *assert.CollectT), waitFor time.Duration, ...)
- func (a *Assertions) EventuallyWithTf(condition func(collect *assert.CollectT), waitFor time.Duration, ...)
- func (a *Assertions) Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, ...)
- func (a *Assertions) Exactly(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) Exactlyf(expected any, actual any, msg string, args ...any)
- func (a *Assertions) Fail(failureMessage string, msgAndArgs ...any)
- func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...any)
- func (a *Assertions) FailNowf(failureMessage string, msg string, args ...any)
- func (a *Assertions) Failf(failureMessage string, msg string, args ...any)
- func (a *Assertions) False(value bool, msgAndArgs ...any)
- func (a *Assertions) Falsef(value bool, msg string, args ...any)
- func (a *Assertions) FileExists(path string, msgAndArgs ...any)
- func (a *Assertions) FileExistsf(path string, msg string, args ...any)
- func (a *Assertions) Greater(e1 any, e2 any, msgAndArgs ...any)
- func (a *Assertions) GreaterOrEqual(e1 any, e2 any, msgAndArgs ...any)
- func (a *Assertions) GreaterOrEqualf(e1 any, e2 any, msg string, args ...any)
- func (a *Assertions) Greaterf(e1 any, e2 any, msg string, args ...any)
- func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPBodyContainsf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPBodyNotContainsf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPStatusCodef(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
- func (a *Assertions) Implements(interfaceObject any, object any, msgAndArgs ...any)
- func (a *Assertions) Implementsf(interfaceObject any, object any, msg string, args ...any)
- func (a *Assertions) InDelta(expected any, actual any, delta float64, msgAndArgs ...any)
- func (a *Assertions) InDeltaMapValues(expected any, actual any, delta float64, msgAndArgs ...any)
- func (a *Assertions) InDeltaMapValuesf(expected any, actual any, delta float64, msg string, args ...any)
- func (a *Assertions) InDeltaSlice(expected any, actual any, delta float64, msgAndArgs ...any)
- func (a *Assertions) InDeltaSlicef(expected any, actual any, delta float64, msg string, args ...any)
- func (a *Assertions) InDeltaf(expected any, actual any, delta float64, msg string, args ...any)
- func (a *Assertions) InEpsilon(expected any, actual any, epsilon float64, msgAndArgs ...any)
- func (a *Assertions) InEpsilonSlice(expected any, actual any, epsilon float64, msgAndArgs ...any)
- func (a *Assertions) InEpsilonSlicef(expected any, actual any, epsilon float64, msg string, args ...any)
- func (a *Assertions) InEpsilonf(expected any, actual any, epsilon float64, msg string, args ...any)
- func (a *Assertions) IsDecreasing(object any, msgAndArgs ...any)
- func (a *Assertions) IsDecreasingf(object any, msg string, args ...any)
- func (a *Assertions) IsIncreasing(object any, msgAndArgs ...any)
- func (a *Assertions) IsIncreasingf(object any, msg string, args ...any)
- func (a *Assertions) IsNonDecreasing(object any, msgAndArgs ...any)
- func (a *Assertions) IsNonDecreasingf(object any, msg string, args ...any)
- func (a *Assertions) IsNonIncreasing(object any, msgAndArgs ...any)
- func (a *Assertions) IsNonIncreasingf(object any, msg string, args ...any)
- func (a *Assertions) IsNotType(theType any, object any, msgAndArgs ...any)
- func (a *Assertions) IsNotTypef(theType any, object any, msg string, args ...any)
- func (a *Assertions) IsType(expectedType any, object any, msgAndArgs ...any)
- func (a *Assertions) IsTypef(expectedType any, object any, msg string, args ...any)
- func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...any)
- func (a *Assertions) JSONEqBytes(expected []byte, actual []byte, msgAndArgs ...any)
- func (a *Assertions) JSONEqBytesf(expected []byte, actual []byte, msg string, args ...any)
- func (a *Assertions) JSONEqf(expected string, actual string, msg string, args ...any)
- func (a *Assertions) Len(object any, length int, msgAndArgs ...any)
- func (a *Assertions) Lenf(object any, length int, msg string, args ...any)
- func (a *Assertions) Less(e1 any, e2 any, msgAndArgs ...any)
- func (a *Assertions) LessOrEqual(e1 any, e2 any, msgAndArgs ...any)
- func (a *Assertions) LessOrEqualf(e1 any, e2 any, msg string, args ...any)
- func (a *Assertions) Lessf(e1 any, e2 any, msg string, args ...any)
- func (a *Assertions) Negative(e any, msgAndArgs ...any)
- func (a *Assertions) Negativef(e any, msg string, args ...any)
- func (a *Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, ...)
- func (a *Assertions) Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, ...)
- func (a *Assertions) Nil(object any, msgAndArgs ...any)
- func (a *Assertions) Nilf(object any, msg string, args ...any)
- func (a *Assertions) NoDirExists(path string, msgAndArgs ...any)
- func (a *Assertions) NoDirExistsf(path string, msg string, args ...any)
- func (a *Assertions) NoError(err error, msgAndArgs ...any)
- func (a *Assertions) NoErrorf(err error, msg string, args ...any)
- func (a *Assertions) NoFileExists(path string, msgAndArgs ...any)
- func (a *Assertions) NoFileExistsf(path string, msg string, args ...any)
- func (a *Assertions) NotContains(s any, contains any, msgAndArgs ...any)
- func (a *Assertions) NotContainsf(s any, contains any, msg string, args ...any)
- func (a *Assertions) NotElementsMatch(listA any, listB any, msgAndArgs ...any)
- func (a *Assertions) NotElementsMatchf(listA any, listB any, msg string, args ...any)
- func (a *Assertions) NotEmpty(object any, msgAndArgs ...any)
- func (a *Assertions) NotEmptyf(object any, msg string, args ...any)
- func (a *Assertions) NotEqual(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) NotEqualValues(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) NotEqualValuesf(expected any, actual any, msg string, args ...any)
- func (a *Assertions) NotEqualf(expected any, actual any, msg string, args ...any)
- func (a *Assertions) NotErrorAs(err error, target any, msgAndArgs ...any)
- func (a *Assertions) NotErrorAsf(err error, target any, msg string, args ...any)
- func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...any)
- func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...any)
- func (a *Assertions) NotImplements(interfaceObject any, object any, msgAndArgs ...any)
- func (a *Assertions) NotImplementsf(interfaceObject any, object any, msg string, args ...any)
- func (a *Assertions) NotNil(object any, msgAndArgs ...any)
- func (a *Assertions) NotNilf(object any, msg string, args ...any)
- func (a *Assertions) NotPanics(f assert.PanicTestFunc, msgAndArgs ...any)
- func (a *Assertions) NotPanicsf(f assert.PanicTestFunc, msg string, args ...any)
- func (a *Assertions) NotRegexp(rx any, str any, msgAndArgs ...any)
- func (a *Assertions) NotRegexpf(rx any, str any, msg string, args ...any)
- func (a *Assertions) NotSame(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) NotSamef(expected any, actual any, msg string, args ...any)
- func (a *Assertions) NotSubset(list any, subset any, msgAndArgs ...any)
- func (a *Assertions) NotSubsetf(list any, subset any, msg string, args ...any)
- func (a *Assertions) NotZero(i any, msgAndArgs ...any)
- func (a *Assertions) NotZerof(i any, msg string, args ...any)
- func (a *Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...any)
- func (a *Assertions) PanicsWithError(errString string, f assert.PanicTestFunc, msgAndArgs ...any)
- func (a *Assertions) PanicsWithErrorf(errString string, f assert.PanicTestFunc, msg string, args ...any)
- func (a *Assertions) PanicsWithValue(expected any, f assert.PanicTestFunc, msgAndArgs ...any)
- func (a *Assertions) PanicsWithValuef(expected any, f assert.PanicTestFunc, msg string, args ...any)
- func (a *Assertions) Panicsf(f assert.PanicTestFunc, msg string, args ...any)
- func (a *Assertions) Positive(e any, msgAndArgs ...any)
- func (a *Assertions) Positivef(e any, msg string, args ...any)
- func (a *Assertions) Regexp(rx any, str any, msgAndArgs ...any)
- func (a *Assertions) Regexpf(rx any, str any, msg string, args ...any)
- func (a *Assertions) Same(expected any, actual any, msgAndArgs ...any)
- func (a *Assertions) Samef(expected any, actual any, msg string, args ...any)
- func (a *Assertions) Subset(list any, subset any, msgAndArgs ...any)
- func (a *Assertions) Subsetf(list any, subset any, msg string, args ...any)
- func (a *Assertions) True(value bool, msgAndArgs ...any)
- func (a *Assertions) Truef(value bool, msg string, args ...any)
- func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any)
- func (a *Assertions) WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, ...)
- func (a *Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...any)
- func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ...any)
- func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...any)
- func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...any)
- func (a *Assertions) Zero(i any, msgAndArgs ...any)
- func (a *Assertions) Zerof(i any, msg string, args ...any)
type BoolAssertionFunc
type ComparisonAssertionFunc
type ErrorAssertionFunc
type TestingT
type ValueAssertionFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Condition ¶

func Condition(t TestingT, comp assert.Comparison, msgAndArgs ...any)

Condition uses a Comparison to assert a complex condition.

func Conditionf ¶

func Conditionf(t TestingT, comp assert.Comparison, msg string, args ...any)

Conditionf uses a Comparison to assert a complex condition.

func Contains ¶

func Contains(t TestingT, s any, contains any, msgAndArgs ...any)

Contains asserts that the specified string, list(array, slice...) or map contains the specified substring or element.

require.Contains(t, "Hello World", "World")
require.Contains(t, ["Hello", "World"], "World")
require.Contains(t, {"Hello": "World"}, "Hello")

func Containsf ¶

func Containsf(t TestingT, s any, contains any, msg string, args ...any)

Containsf asserts that the specified string, list(array, slice...) or map contains the specified substring or element.

require.Containsf(t, "Hello World", "World", "error message %s", "formatted")
require.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted")
require.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted")

func DirExists ¶

func DirExists(t TestingT, path string, msgAndArgs ...any)

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 ¶

func DirExistsf(t TestingT, path string, msg string, args ...any)

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 ¶

func ElementsMatch(t TestingT, listA any, listB any, msgAndArgs ...any)

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.

require.ElementsMatch(t, [1, 3, 2, 3], [1, 3, 3, 2])

func ElementsMatchf ¶

func ElementsMatchf(t TestingT, listA any, listB any, msg string, args ...any)

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.

require.ElementsMatchf(t, [1, 3, 2, 3], [1, 3, 3, 2], "error message %s", "formatted")

func Empty ¶

func Empty(t TestingT, object any, msgAndArgs ...any)

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".

require.Empty(t, obj)

func Emptyf ¶

func Emptyf(t TestingT, object any, msg string, args ...any)

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".

require.Emptyf(t, obj, "error message %s", "formatted")

func Equal ¶

func Equal(t TestingT, expected any, actual any, msgAndArgs ...any)

Equal asserts that two objects are equal.

require.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 ¶

func EqualError(t TestingT, theError error, errString string, msgAndArgs ...any)

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()
require.EqualError(t, err,  expectedErrorString)

func EqualErrorf ¶

func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...any)

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()
require.EqualErrorf(t, err,  expectedErrorString, "error message %s", "formatted")

func EqualExportedValues ¶

func EqualExportedValues(t TestingT, expected any, actual any, msgAndArgs ...any)

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
 }
 require.EqualExportedValues(t, S{1, 2}, S{1, 3}) => true
 require.EqualExportedValues(t, S{1, 2}, S{2, 3}) => false

func EqualExportedValuesf ¶

func EqualExportedValuesf(t TestingT, expected any, actual any, msg string, args ...any)

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
 }
 require.EqualExportedValuesf(t, S{1, 2}, S{1, 3}, "error message %s", "formatted") => true
 require.EqualExportedValuesf(t, S{1, 2}, S{2, 3}, "error message %s", "formatted") => false

func EqualValues ¶

func EqualValues(t TestingT, expected any, actual any, msgAndArgs ...any)

EqualValues asserts that two objects are equal or convertible to the larger type and equal.

require.EqualValues(t, uint32(123), int32(123))

func EqualValuesf ¶

func EqualValuesf(t TestingT, expected any, actual any, msg string, args ...any)

EqualValuesf asserts that two objects are equal or convertible to the larger type and equal.

require.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted")

func Equalf ¶

func Equalf(t TestingT, expected any, actual any, msg string, args ...any)

Equalf asserts that two objects are equal.

require.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 ¶

func Error(t TestingT, err error, msgAndArgs ...any)

Error asserts that a function returned a non-nil error (ie. an error).

actualObj, err := SomeFunction()
require.Error(t, err)

func ErrorAs ¶

func ErrorAs(t TestingT, err error, target any, msgAndArgs ...any)

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 ¶

func ErrorAsf(t TestingT, err error, target any, msg string, args ...any)

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 ¶

func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...any)

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()
require.ErrorContains(t, err,  expectedErrorSubString)

func ErrorContainsf ¶

func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...any)

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()
require.ErrorContainsf(t, err,  expectedErrorSubString, "error message %s", "formatted")

func ErrorIs ¶

func ErrorIs(t TestingT, err error, target error, msgAndArgs ...any)

ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.

func ErrorIsf ¶

func ErrorIsf(t TestingT, err error, target error, msg string, args ...any)

ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is.

func Errorf ¶

func Errorf(t TestingT, err error, msg string, args ...any)

Errorf asserts that a function returned a non-nil error (ie. an error).

actualObj, err := SomeFunction()
require.Errorf(t, err, "error message %s", "formatted")

func Eventually ¶

func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...any)

Eventually asserts that given condition will be met in waitFor time, periodically checking target function each tick.

require.Eventually(t, func() bool { return true; }, time.Second, 10*time.Millisecond)

func EventuallyWithT ¶

func EventuallyWithT(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...any)

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
}()
require.EventuallyWithT(t, func(c *require.CollectT) {
	// add assertions as needed; any assertion failure will fail the current tick
	require.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 *assert.CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...any)

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
}()
require.EventuallyWithTf(t, func(c *require.CollectT, "error message %s", "formatted") {
	// add assertions as needed; any assertion failure will fail the current tick
	require.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)

Eventuallyf asserts that given condition will be met in waitFor time, periodically checking target function each tick.

require.Eventuallyf(t, func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")

func Exactly ¶

func Exactly(t TestingT, expected any, actual any, msgAndArgs ...any)

Exactly asserts that two objects are equal in value and type.

require.Exactly(t, int32(123), int64(123))

func Exactlyf ¶

func Exactlyf(t TestingT, expected any, actual any, msg string, args ...any)

Exactlyf asserts that two objects are equal in value and type.

require.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted")

func Fail ¶

func Fail(t TestingT, failureMessage string, msgAndArgs ...any)

Fail reports a failure through

func FailNow ¶

func FailNow(t TestingT, failureMessage string, msgAndArgs ...any)

FailNow fails test

func FailNowf ¶

func FailNowf(t TestingT, failureMessage string, msg string, args ...any)

FailNowf fails test

func Failf ¶

func Failf(t TestingT, failureMessage string, msg string, args ...any)

Failf reports a failure through

func False ¶

func False(t TestingT, value bool, msgAndArgs ...any)

False asserts that the specified value is false.

require.False(t, myBool)

func Falsef ¶

func Falsef(t TestingT, value bool, msg string, args ...any)

Falsef asserts that the specified value is false.

require.Falsef(t, myBool, "error message %s", "formatted")

func FileExists ¶

func FileExists(t TestingT, path string, msgAndArgs ...any)

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 ¶

func FileExistsf(t TestingT, path string, msg string, args ...any)

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 ¶

func Greater(t TestingT, e1 any, e2 any, msgAndArgs ...any)

Greater asserts that the first element is greater than the second

require.Greater(t, 2, 1)
require.Greater(t, float64(2), float64(1))
require.Greater(t, "b", "a")

func GreaterOrEqual ¶

func GreaterOrEqual(t TestingT, e1 any, e2 any, msgAndArgs ...any)

GreaterOrEqual asserts that the first element is greater than or equal to the second

require.GreaterOrEqual(t, 2, 1)
require.GreaterOrEqual(t, 2, 2)
require.GreaterOrEqual(t, "b", "a")
require.GreaterOrEqual(t, "b", "b")

func GreaterOrEqualf ¶

func GreaterOrEqualf(t TestingT, e1 any, e2 any, msg string, args ...any)

GreaterOrEqualf asserts that the first element is greater than or equal to the second

require.GreaterOrEqualf(t, 2, 1, "error message %s", "formatted")
require.GreaterOrEqualf(t, 2, 2, "error message %s", "formatted")
require.GreaterOrEqualf(t, "b", "a", "error message %s", "formatted")
require.GreaterOrEqualf(t, "b", "b", "error message %s", "formatted")

func Greaterf ¶

func Greaterf(t TestingT, e1 any, e2 any, msg string, args ...any)

Greaterf asserts that the first element is greater than the second

require.Greaterf(t, 2, 1, "error message %s", "formatted")
require.Greaterf(t, float64(2), float64(1), "error message %s", "formatted")
require.Greaterf(t, "b", "a", "error message %s", "formatted")

func HTTPBodyContains ¶

func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str any, msgAndArgs ...any)

HTTPBodyContains asserts that a specified handler returns a body that contains a string.

require.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)

HTTPBodyContainsf asserts that a specified handler returns a body that contains a string.

require.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 string, url string, values url.Values, str any, msgAndArgs ...any)

HTTPBodyNotContains asserts that a specified handler returns a body that does not contain a string.

require.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)

HTTPBodyNotContainsf asserts that a specified handler returns a body that does not contain a string.

require.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 string, url string, values url.Values, msgAndArgs ...any)

HTTPError asserts that a specified handler returns an error status code.

require.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)

HTTPErrorf asserts that a specified handler returns an error status code.

require.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 string, url string, values url.Values, msgAndArgs ...any)

HTTPRedirect asserts that a specified handler returns a redirect status code.

require.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)

HTTPRedirectf asserts that a specified handler returns a redirect status code.

require.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 string, url string, values url.Values, statuscode int, msgAndArgs ...any)

HTTPStatusCode asserts that a specified handler returns a specified status code.

require.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)

HTTPStatusCodef asserts that a specified handler returns a specified status code.

require.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 string, url string, values url.Values, msgAndArgs ...any)

HTTPSuccess asserts that a specified handler returns a success status code.

require.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)

HTTPSuccessf asserts that a specified handler returns a success status code.

require.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 ¶

func Implements(t TestingT, interfaceObject any, object any, msgAndArgs ...any)

Implements asserts that an object is implemented by the specified interface.

require.Implements(t, (*MyInterface)(nil), new(MyObject))

func Implementsf ¶

func Implementsf(t TestingT, interfaceObject any, object any, msg string, args ...any)

Implementsf asserts that an object is implemented by the specified interface.

require.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")

func InDelta ¶

func InDelta(t TestingT, expected any, actual any, delta float64, msgAndArgs ...any)

InDelta asserts that the two numerals are within delta of each other.

require.InDelta(t, math.Pi, 22/7.0, 0.01)

func InDeltaMapValues ¶

func InDeltaMapValues(t TestingT, expected any, actual any, delta float64, msgAndArgs ...any)

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)

InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.

func InDeltaSlice ¶

func InDeltaSlice(t TestingT, expected any, actual any, delta float64, msgAndArgs ...any)

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)

InDeltaSlicef is the same as InDelta, except it compares two slices.

func InDeltaf ¶

func InDeltaf(t TestingT, expected any, actual any, delta float64, msg string, args ...any)

InDeltaf asserts that the two numerals are within delta of each other.

require.InDeltaf(t, math.Pi, 22/7.0, 0.01, "error message %s", "formatted")

func InEpsilon ¶

func InEpsilon(t TestingT, expected any, actual any, epsilon float64, msgAndArgs ...any)

InEpsilon asserts that expected and actual have a relative error less than epsilon

func InEpsilonSlice ¶

func InEpsilonSlice(t TestingT, expected any, actual any, epsilon float64, msgAndArgs ...any)

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)

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)

InEpsilonf asserts that expected and actual have a relative error less than epsilon

func IsDecreasing ¶

func IsDecreasing(t TestingT, object any, msgAndArgs ...any)

IsDecreasing asserts that the collection is decreasing

require.IsDecreasing(t, []int{2, 1, 0})
require.IsDecreasing(t, []float{2, 1})
require.IsDecreasing(t, []string{"b", "a"})

func IsDecreasingf ¶

func IsDecreasingf(t TestingT, object any, msg string, args ...any)

IsDecreasingf asserts that the collection is decreasing

require.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted")
require.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted")
require.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted")

func IsIncreasing ¶

func IsIncreasing(t TestingT, object any, msgAndArgs ...any)

IsIncreasing asserts that the collection is increasing

require.IsIncreasing(t, []int{1, 2, 3})
require.IsIncreasing(t, []float{1, 2})
require.IsIncreasing(t, []string{"a", "b"})

func IsIncreasingf ¶

func IsIncreasingf(t TestingT, object any, msg string, args ...any)

IsIncreasingf asserts that the collection is increasing

require.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted")
require.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted")
require.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted")

func IsNonDecreasing ¶

func IsNonDecreasing(t TestingT, object any, msgAndArgs ...any)

IsNonDecreasing asserts that the collection is not decreasing

require.IsNonDecreasing(t, []int{1, 1, 2})
require.IsNonDecreasing(t, []float{1, 2})
require.IsNonDecreasing(t, []string{"a", "b"})

func IsNonDecreasingf ¶

func IsNonDecreasingf(t TestingT, object any, msg string, args ...any)

IsNonDecreasingf asserts that the collection is not decreasing

require.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted")
require.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted")
require.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted")

func IsNonIncreasing ¶

func IsNonIncreasing(t TestingT, object any, msgAndArgs ...any)

IsNonIncreasing asserts that the collection is not increasing

require.IsNonIncreasing(t, []int{2, 1, 1})
require.IsNonIncreasing(t, []float{2, 1})
require.IsNonIncreasing(t, []string{"b", "a"})

func IsNonIncreasingf ¶

func IsNonIncreasingf(t TestingT, object any, msg string, args ...any)

IsNonIncreasingf asserts that the collection is not increasing

require.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted")
require.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted")
require.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted")

func IsNotType ¶

func IsNotType(t TestingT, theType any, object any, msgAndArgs ...any)

IsNotType asserts that the specified objects are not of the same type.

require.IsNotType(t, &NotMyStruct{}, &MyStruct{})

func IsNotTypef ¶

func IsNotTypef(t TestingT, theType any, object any, msg string, args ...any)

IsNotTypef asserts that the specified objects are not of the same type.

require.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")

func IsType ¶

func IsType(t TestingT, expectedType any, object any, msgAndArgs ...any)

IsType asserts that the specified objects are of the same type.

require.IsType(t, &MyStruct{}, &MyStruct{})

func IsTypef ¶

func IsTypef(t TestingT, expectedType any, object any, msg string, args ...any)

IsTypef asserts that the specified objects are of the same type.

require.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted")

func JSONEq ¶

func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...any)

JSONEq asserts that two JSON strings are equivalent.

require.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)

func JSONEqBytes ¶ added in v2.0.2

func JSONEqBytes(t TestingT, expected []byte, actual []byte, msgAndArgs ...any)

JSONEqBytes asserts that two JSON byte slices are equivalent.

require.JSONEqBytes(t, []byte(`{"hello": "world", "foo": "bar"}`), []byte(`{"foo": "bar", "hello": "world"}`))

func JSONEqBytesf ¶ added in v2.0.2

func JSONEqBytesf(t TestingT, expected []byte, actual []byte, msg string, args ...any)

JSONEqBytesf asserts that two JSON byte slices are equivalent.

require.JSONEqBytesf(t, []byte(`{"hello": "world", "foo": "bar"}`), []byte(`{"foo": "bar", "hello": "world"}`), "error message %s", "formatted")

func JSONEqf ¶

func JSONEqf(t TestingT, expected string, actual string, msg string, args ...any)

JSONEqf asserts that two JSON strings are equivalent.

require.JSONEqf(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted")

func Len ¶

func Len(t TestingT, object any, length int, msgAndArgs ...any)

Len asserts that the specified object has specific length. Len also fails if the object has a type that len() not accept.

require.Len(t, mySlice, 3)

func Lenf ¶

func Lenf(t TestingT, object any, length int, msg string, args ...any)

Lenf asserts that the specified object has specific length. Lenf also fails if the object has a type that len() not accept.

require.Lenf(t, mySlice, 3, "error message %s", "formatted")

func Less ¶

func Less(t TestingT, e1 any, e2 any, msgAndArgs ...any)

Less asserts that the first element is less than the second

require.Less(t, 1, 2)
require.Less(t, float64(1), float64(2))
require.Less(t, "a", "b")

func LessOrEqual ¶

func LessOrEqual(t TestingT, e1 any, e2 any, msgAndArgs ...any)

LessOrEqual asserts that the first element is less than or equal to the second

require.LessOrEqual(t, 1, 2)
require.LessOrEqual(t, 2, 2)
require.LessOrEqual(t, "a", "b")
require.LessOrEqual(t, "b", "b")

func LessOrEqualf ¶

func LessOrEqualf(t TestingT, e1 any, e2 any, msg string, args ...any)

LessOrEqualf asserts that the first element is less than or equal to the second

require.LessOrEqualf(t, 1, 2, "error message %s", "formatted")
require.LessOrEqualf(t, 2, 2, "error message %s", "formatted")
require.LessOrEqualf(t, "a", "b", "error message %s", "formatted")
require.LessOrEqualf(t, "b", "b", "error message %s", "formatted")

func Lessf ¶

func Lessf(t TestingT, e1 any, e2 any, msg string, args ...any)

Lessf asserts that the first element is less than the second

require.Lessf(t, 1, 2, "error message %s", "formatted")
require.Lessf(t, float64(1), float64(2), "error message %s", "formatted")
require.Lessf(t, "a", "b", "error message %s", "formatted")

func Negative ¶

func Negative(t TestingT, e any, msgAndArgs ...any)

Negative asserts that the specified element is negative

require.Negative(t, -1)
require.Negative(t, -1.23)

func Negativef ¶

func Negativef(t TestingT, e any, msg string, args ...any)

Negativef asserts that the specified element is negative

require.Negativef(t, -1, "error message %s", "formatted")
require.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)

Never asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick.

require.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)

Neverf asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick.

require.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")

func Nil ¶

func Nil(t TestingT, object any, msgAndArgs ...any)

Nil asserts that the specified object is nil.

require.Nil(t, err)

func Nilf ¶

func Nilf(t TestingT, object any, msg string, args ...any)

Nilf asserts that the specified object is nil.

require.Nilf(t, err, "error message %s", "formatted")

func NoDirExists ¶

func NoDirExists(t TestingT, path string, msgAndArgs ...any)

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 ¶

func NoDirExistsf(t TestingT, path string, msg string, args ...any)

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 ¶

func NoError(t TestingT, err error, msgAndArgs ...any)

NoError asserts that a function returned a nil error (ie. no error).

  actualObj, err := SomeFunction()
  if require.NoError(t, err) {
	   require.Equal(t, expectedObj, actualObj)
  }

func NoErrorf ¶

func NoErrorf(t TestingT, err error, msg string, args ...any)

NoErrorf asserts that a function returned a nil error (ie. no error).

  actualObj, err := SomeFunction()
  if require.NoErrorf(t, err, "error message %s", "formatted") {
	   require.Equal(t, expectedObj, actualObj)
  }

func NoFileExists ¶

func NoFileExists(t TestingT, path string, msgAndArgs ...any)

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 ¶

func NoFileExistsf(t TestingT, path string, msg string, args ...any)

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 ¶

func NotContains(t TestingT, s any, contains any, msgAndArgs ...any)

NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element.

require.NotContains(t, "Hello World", "Earth")
require.NotContains(t, ["Hello", "World"], "Earth")
require.NotContains(t, {"Hello": "World"}, "Earth")

func NotContainsf ¶

func NotContainsf(t TestingT, s any, contains any, msg string, args ...any)

NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element.

require.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted")
require.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted")
require.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted")

func NotElementsMatch ¶

func NotElementsMatch(t TestingT, listA any, listB any, msgAndArgs ...any)

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.

require.NotElementsMatch(t, [1, 1, 2, 3], [1, 1, 2, 3]) -> false

require.NotElementsMatch(t, [1, 1, 2, 3], [1, 2, 3]) -> true

require.NotElementsMatch(t, [1, 2, 3], [1, 2, 4]) -> true

func NotElementsMatchf ¶

func NotElementsMatchf(t TestingT, listA any, listB any, msg string, args ...any)

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.

require.NotElementsMatchf(t, [1, 1, 2, 3], [1, 1, 2, 3], "error message %s", "formatted") -> false

require.NotElementsMatchf(t, [1, 1, 2, 3], [1, 2, 3], "error message %s", "formatted") -> true

require.NotElementsMatchf(t, [1, 2, 3], [1, 2, 4], "error message %s", "formatted") -> true

func NotEmpty ¶

func NotEmpty(t TestingT, object any, msgAndArgs ...any)

NotEmpty asserts that the specified object is NOT Empty.

if require.NotEmpty(t, obj) {
  require.Equal(t, "two", obj[1])
}

func NotEmptyf ¶

func NotEmptyf(t TestingT, object any, msg string, args ...any)

NotEmptyf asserts that the specified object is NOT Empty.

if require.NotEmptyf(t, obj, "error message %s", "formatted") {
  require.Equal(t, "two", obj[1])
}

func NotEqual ¶

func NotEqual(t TestingT, expected any, actual any, msgAndArgs ...any)

NotEqual asserts that the specified values are NOT equal.

require.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 ¶

func NotEqualValues(t TestingT, expected any, actual any, msgAndArgs ...any)

NotEqualValues asserts that two objects are not equal even when converted to the same type

require.NotEqualValues(t, obj1, obj2)

func NotEqualValuesf ¶

func NotEqualValuesf(t TestingT, expected any, actual any, msg string, args ...any)

NotEqualValuesf asserts that two objects are not equal even when converted to the same type

require.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted")

func NotEqualf ¶

func NotEqualf(t TestingT, expected any, actual any, msg string, args ...any)

NotEqualf asserts that the specified values are NOT equal.

require.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 ¶

func NotErrorAs(t TestingT, err error, target any, msgAndArgs ...any)

NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.

func NotErrorAsf ¶

func NotErrorAsf(t TestingT, err error, target any, msg string, args ...any)

NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value.

func NotErrorIs ¶

func NotErrorIs(t TestingT, err error, target error, msgAndArgs ...any)

NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.

func NotErrorIsf ¶

func NotErrorIsf(t TestingT, err error, target error, msg string, args ...any)

NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.

func NotImplements ¶

func NotImplements(t TestingT, interfaceObject any, object any, msgAndArgs ...any)

NotImplements asserts that an object does not implement the specified interface.

require.NotImplements(t, (*MyInterface)(nil), new(MyObject))

func NotImplementsf ¶

func NotImplementsf(t TestingT, interfaceObject any, object any, msg string, args ...any)

NotImplementsf asserts that an object does not implement the specified interface.

require.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")

func NotNil ¶

func NotNil(t TestingT, object any, msgAndArgs ...any)

NotNil asserts that the specified object is not nil.

require.NotNil(t, err)

func NotNilf ¶

func NotNilf(t TestingT, object any, msg string, args ...any)

NotNilf asserts that the specified object is not nil.

require.NotNilf(t, err, "error message %s", "formatted")

func NotPanics ¶

func NotPanics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...any)

NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.

require.NotPanics(t, func(){ RemainCalm() })

func NotPanicsf ¶

func NotPanicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...any)

NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.

require.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted")

func NotRegexp ¶

func NotRegexp(t TestingT, rx any, str any, msgAndArgs ...any)

NotRegexp asserts that a specified regexp does not match a string.

require.NotRegexp(t, regexp.MustCompile("starts"), "it's starting")
require.NotRegexp(t, "^start", "it's not starting")

func NotRegexpf ¶

func NotRegexpf(t TestingT, rx any, str any, msg string, args ...any)

NotRegexpf asserts that a specified regexp does not match a string.

require.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted")
require.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted")

func NotSame ¶

func NotSame(t TestingT, expected any, actual any, msgAndArgs ...any)

NotSame asserts that two pointers do not reference the same object.

require.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 ¶

func NotSamef(t TestingT, expected any, actual any, msg string, args ...any)

NotSamef asserts that two pointers do not reference the same object.

require.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 ¶

func NotSubset(t TestingT, list any, subset any, msgAndArgs ...any)

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.

require.NotSubset(t, [1, 3, 4], [1, 2])
require.NotSubset(t, {"x": 1, "y": 2}, {"z": 3})
require.NotSubset(t, [1, 3, 4], {1: "one", 2: "two"})
require.NotSubset(t, {"x": 1, "y": 2}, ["z"])

func NotSubsetf ¶

func NotSubsetf(t TestingT, list any, subset any, msg string, args ...any)

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.

require.NotSubsetf(t, [1, 3, 4], [1, 2], "error message %s", "formatted")
require.NotSubsetf(t, {"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted")
require.NotSubsetf(t, [1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted")
require.NotSubsetf(t, {"x": 1, "y": 2}, ["z"], "error message %s", "formatted")

func NotZero ¶

func NotZero(t TestingT, i any, msgAndArgs ...any)

NotZero asserts that i is not the zero value for its type.

func NotZerof ¶

func NotZerof(t TestingT, i any, msg string, args ...any)

NotZerof asserts that i is not the zero value for its type.

func Panics ¶

func Panics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...any)

Panics asserts that the code inside the specified PanicTestFunc panics.

require.Panics(t, func(){ GoCrazy() })

func PanicsWithError ¶

func PanicsWithError(t TestingT, errString string, f assert.PanicTestFunc, msgAndArgs ...any)

PanicsWithError asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison.

require.PanicsWithError(t, "crazy error", func(){ GoCrazy() })

func PanicsWithErrorf ¶

func PanicsWithErrorf(t TestingT, errString string, f assert.PanicTestFunc, msg string, args ...any)

PanicsWithErrorf asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison.

require.PanicsWithErrorf(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")

func PanicsWithValue ¶

func PanicsWithValue(t TestingT, expected any, f assert.PanicTestFunc, msgAndArgs ...any)

PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value.

require.PanicsWithValue(t, "crazy error", func(){ GoCrazy() })

func PanicsWithValuef ¶

func PanicsWithValuef(t TestingT, expected any, f assert.PanicTestFunc, msg string, args ...any)

PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value.

require.PanicsWithValuef(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")

func Panicsf ¶

func Panicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...any)

Panicsf asserts that the code inside the specified PanicTestFunc panics.

require.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")

func Positive ¶

func Positive(t TestingT, e any, msgAndArgs ...any)

Positive asserts that the specified element is positive

require.Positive(t, 1)
require.Positive(t, 1.23)

func Positivef ¶

func Positivef(t TestingT, e any, msg string, args ...any)

Positivef asserts that the specified element is positive

require.Positivef(t, 1, "error message %s", "formatted")
require.Positivef(t, 1.23, "error message %s", "formatted")

func Regexp ¶

func Regexp(t TestingT, rx any, str any, msgAndArgs ...any)

Regexp asserts that a specified regexp matches a string.

require.Regexp(t, regexp.MustCompile("start"), "it's starting")
require.Regexp(t, "start...$", "it's not starting")

func Regexpf ¶

func Regexpf(t TestingT, rx any, str any, msg string, args ...any)

Regexpf asserts that a specified regexp matches a string.

require.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted")
require.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted")

func Same ¶

func Same(t TestingT, expected any, actual any, msgAndArgs ...any)

Same asserts that two pointers reference the same object.

require.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 ¶

func Samef(t TestingT, expected any, actual any, msg string, args ...any)

Samef asserts that two pointers reference the same object.

require.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 ¶

func Subset(t TestingT, list any, subset any, msgAndArgs ...any)

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.

require.Subset(t, [1, 2, 3], [1, 2])
require.Subset(t, {"x": 1, "y": 2}, {"x": 1})
require.Subset(t, [1, 2, 3], {1: "one", 2: "two"})
require.Subset(t, {"x": 1, "y": 2}, ["x"])

func Subsetf ¶

func Subsetf(t TestingT, list any, subset any, msg string, args ...any)

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.

require.Subsetf(t, [1, 2, 3], [1, 2], "error message %s", "formatted")
require.Subsetf(t, {"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted")
require.Subsetf(t, [1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted")
require.Subsetf(t, {"x": 1, "y": 2}, ["x"], "error message %s", "formatted")

func True ¶

func True(t TestingT, value bool, msgAndArgs ...any)

True asserts that the specified value is true.

require.True(t, myBool)

func Truef ¶

func Truef(t TestingT, value bool, msg string, args ...any)

Truef asserts that the specified value is true.

require.Truef(t, myBool, "error message %s", "formatted")

func WithinDuration ¶

func WithinDuration(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any)

WithinDuration asserts that the two times are within duration delta of each other.

require.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)

WithinDurationf asserts that the two times are within duration delta of each other.

require.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted")

func WithinRange ¶

func WithinRange(t TestingT, actual time.Time, start time.Time, end time.Time, msgAndArgs ...any)

WithinRange asserts that a time is within a time range (inclusive).

require.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)

WithinRangef asserts that a time is within a time range (inclusive).

require.WithinRangef(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted")

func YAMLEq ¶

func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...any)

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
`
require.YAMLEq(t, expected, actual)

func YAMLEqf ¶

func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...any)

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
`
require.YAMLEqf(t, expected, actual, "error message %s", "formatted")

func Zero ¶

func Zero(t TestingT, i any, msgAndArgs ...any)

Zero asserts that i is the zero value for its type.

func Zerof ¶

func Zerof(t TestingT, i any, msg string, args ...any)

Zerof asserts that i is the zero value for its type.

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 assert.Comparison, msgAndArgs ...any)

Condition uses a Comparison to assert a complex condition.

func (*Assertions) Conditionf ¶

func (a *Assertions) Conditionf(comp assert.Comparison, msg string, args ...any)

Conditionf uses a Comparison to assert a complex condition.

func (*Assertions) Contains ¶

func (a *Assertions) Contains(s any, contains any, msgAndArgs ...any)

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 ¶

func (a *Assertions) Containsf(s any, contains any, msg string, args ...any)

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)

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)

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)

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 ¶

func (a *Assertions) ElementsMatchf(listA any, listB any, msg string, args ...any)

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)

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)

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)

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)

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 ¶

func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...any)

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)

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 ¶

func (a *Assertions) EqualExportedValuesf(expected any, actual any, msg string, args ...any)

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)

EqualValues asserts that two objects are equal or convertible to the larger type and equal.

a.EqualValues(uint32(123), int32(123))

func (*Assertions) EqualValuesf ¶

func (a *Assertions) EqualValuesf(expected any, actual any, msg string, args ...any)

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 ¶

func (a *Assertions) Equalf(expected any, actual any, msg string, args ...any)

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)

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)

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 ¶

func (a *Assertions) ErrorAsf(err error, target any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...any)

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)

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 ¶

func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...any)

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)

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)

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 *assert.CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...any)

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 *assert.CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...any)

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)

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)

Exactly asserts that two objects are equal in value and type.

a.Exactly(int32(123), int64(123))

func (*Assertions) Exactlyf ¶

func (a *Assertions) Exactlyf(expected any, actual any, msg string, args ...any)

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)

Fail reports a failure through

func (*Assertions) FailNow ¶

func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...any)

FailNow fails test

func (*Assertions) FailNowf ¶

func (a *Assertions) FailNowf(failureMessage string, msg string, args ...any)

FailNowf fails test

func (*Assertions) Failf ¶

func (a *Assertions) Failf(failureMessage string, msg string, args ...any)

Failf reports a failure through

func (*Assertions) False ¶

func (a *Assertions) False(value bool, msgAndArgs ...any)

False asserts that the specified value is false.

a.False(myBool)

func (*Assertions) Falsef ¶

func (a *Assertions) Falsef(value bool, msg string, args ...any)

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)

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)

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)

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)

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 ¶

func (a *Assertions) GreaterOrEqualf(e1 any, e2 any, msg string, args ...any)

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 ¶

func (a *Assertions) Greaterf(e1 any, e2 any, msg string, args ...any)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

Implements asserts that an object is implemented by the specified interface.

a.Implements((*MyInterface)(nil), new(MyObject))

func (*Assertions) Implementsf ¶

func (a *Assertions) Implementsf(interfaceObject any, object any, msg string, args ...any)

Implementsf asserts that an object is implemented by the specified interface.

a.Implementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted")

func (*Assertions) InDelta ¶

func (a *Assertions) InDelta(expected any, actual any, delta float64, msgAndArgs ...any)

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)

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)

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 ¶

func (a *Assertions) InDeltaSlice(expected any, actual any, delta float64, msgAndArgs ...any)

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)

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)

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 ¶

func (a *Assertions) InEpsilon(expected any, actual any, epsilon float64, msgAndArgs ...any)

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)

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)

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)

InEpsilonf asserts that expected and actual have a relative error less than epsilon

func (*Assertions) IsDecreasing ¶

func (a *Assertions) IsDecreasing(object any, msgAndArgs ...any)

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)

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)

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)

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)

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)

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)

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)

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)

IsNotType asserts that the specified objects are not of the same type.

a.IsNotType(&NotMyStruct{}, &MyStruct{})

func (*Assertions) IsNotTypef ¶

func (a *Assertions) IsNotTypef(theType any, object any, msg string, args ...any)

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)

IsType asserts that the specified objects are of the same type.

a.IsType(&MyStruct{}, &MyStruct{})

func (*Assertions) IsTypef ¶

func (a *Assertions) IsTypef(expectedType any, object any, msg string, args ...any)

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)

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)

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

func (a *Assertions) JSONEqBytesf(expected []byte, actual []byte, msg string, args ...any)

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 ¶

func (a *Assertions) JSONEqf(expected string, actual string, msg string, args ...any)

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)

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 ¶

func (a *Assertions) Lenf(object any, length int, msg string, args ...any)

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)

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)

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 ¶

func (a *Assertions) LessOrEqualf(e1 any, e2 any, msg string, args ...any)

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 ¶

func (a *Assertions) Lessf(e1 any, e2 any, msg string, args ...any)

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)

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)

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)

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)

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)

Nil asserts that the specified object is nil.

a.Nil(err)

func (*Assertions) Nilf ¶

func (a *Assertions) Nilf(object any, msg string, args ...any)

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)

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)

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)

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)

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)

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)

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)

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 ¶

func (a *Assertions) NotContainsf(s any, contains any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) NotElementsMatchf(listA any, listB any, msg string, args ...any)

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)

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)

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)

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)

NotEqualValues asserts that two objects are not equal even when converted to the same type

a.NotEqualValues(obj1, obj2)

func (*Assertions) NotEqualValuesf ¶

func (a *Assertions) NotEqualValuesf(expected any, actual any, msg string, args ...any)

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 ¶

func (a *Assertions) NotEqualf(expected any, actual any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) NotErrorAsf(err error, target any, msg string, args ...any)

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)

NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is.

func (*Assertions) NotErrorIsf ¶

func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...any)

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)

NotImplements asserts that an object does not implement the specified interface.

a.NotImplements((*MyInterface)(nil), new(MyObject))

func (*Assertions) NotImplementsf ¶

func (a *Assertions) NotImplementsf(interfaceObject any, object any, msg string, args ...any)

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)

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)

NotNilf asserts that the specified object is not nil.

a.NotNilf(err, "error message %s", "formatted")

func (*Assertions) NotPanics ¶

func (a *Assertions) NotPanics(f assert.PanicTestFunc, msgAndArgs ...any)

NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.

a.NotPanics(func(){ RemainCalm() })

func (*Assertions) NotPanicsf ¶

func (a *Assertions) NotPanicsf(f assert.PanicTestFunc, msg string, args ...any)

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)

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 ¶

func (a *Assertions) NotRegexpf(rx any, str any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) NotSamef(expected any, actual any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) NotSubsetf(list any, subset any, msg string, args ...any)

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)

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)

NotZerof asserts that i is not the zero value for its type.

func (*Assertions) Panics ¶

func (a *Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...any)

Panics asserts that the code inside the specified PanicTestFunc panics.

a.Panics(func(){ GoCrazy() })

func (*Assertions) PanicsWithError ¶

func (a *Assertions) PanicsWithError(errString string, f assert.PanicTestFunc, msgAndArgs ...any)

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 assert.PanicTestFunc, msg string, args ...any)

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 assert.PanicTestFunc, msgAndArgs ...any)

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 assert.PanicTestFunc, msg string, args ...any)

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 assert.PanicTestFunc, msg string, args ...any)

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)

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)

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)

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 ¶

func (a *Assertions) Regexpf(rx any, str any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) Samef(expected any, actual any, msg string, args ...any)

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)

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 ¶

func (a *Assertions) Subsetf(list any, subset any, msg string, args ...any)

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)

True asserts that the specified value is true.

a.True(myBool)

func (*Assertions) Truef ¶

func (a *Assertions) Truef(value bool, msg string, args ...any)

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)

WithinDuration asserts that the two times are within duration delta of each other.

a.WithinDuration(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)

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)

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)

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)

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 ¶

func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...any)

YAMLEqf asserts that the first documents in the two YAML strings are equivalent.

expected := `---
key: value
---
key: this is a second document, it is not evaluated
`
actual := `---
key: value
---
key: this is a subsequent document, it is not evaluated
`
a.YAMLEqf(expected, actual, "error message %s", "formatted")

func (*Assertions) Zero ¶

func (a *Assertions) Zero(i any, msgAndArgs ...any)

Zero asserts that i is the zero value for its type.

func (*Assertions) Zerof ¶

func (a *Assertions) Zerof(i any, msg string, args ...any)

Zerof asserts that i is the zero value for its type.

type BoolAssertionFunc ¶

type BoolAssertionFunc func(TestingT, bool, ...any)

BoolAssertionFunc is a common function prototype when validating a bool value. Can be useful for table driven tests.

Example ¶

package main

import (
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := &testing.T{} // provided by test

	t.Run("example", func(t *testing.T) {
		isOkay := func(x int) bool {
			return x >= 42
		}

		tests := []struct {
			name      string
			arg       int
			assertion require.BoolAssertionFunc
		}{
			{"-1 is bad", -1, require.False},
			{"42 is good", 42, require.True},
			{"41 is bad", 41, require.False},
			{"45 is cool", 45, require.True},
		}

		for _, tt := range tests {
			t.Run(tt.name, func(t *testing.T) {
				tt.assertion(t, isOkay(tt.arg))
			})
		}
	})
}

type ComparisonAssertionFunc ¶

type ComparisonAssertionFunc func(TestingT, any, any, ...any)

ComparisonAssertionFunc is a common function prototype when comparing two values. Can be useful for table driven tests.

Example ¶

package main

import (
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := &testing.T{} // provided by test

	t.Run("example", func(t *testing.T) {
		adder := func(x, y int) int {
			return x + y
		}

		type args struct {
			x int
			y int
		}

		tests := []struct {
			name      string
			args      args
			expect    int
			assertion require.ComparisonAssertionFunc
		}{
			{"2+2=4", args{2, 2}, 4, require.Equal},
			{"2+2!=5", args{2, 2}, 5, require.NotEqual},
			{"2+3==5", args{2, 3}, 5, require.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 ¶

type ErrorAssertionFunc func(TestingT, error, ...any)

ErrorAssertionFunc is a common function prototype when validating an error value. Can be useful for table driven tests.

Example ¶

package main

import (
	"encoding/json"
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := &testing.T{} // provided by test

	dumbParseNum := func(input string, v any) error {
		return json.Unmarshal([]byte(input), v)
	}

	t.Run("example", func(t *testing.T) {
		tests := []struct {
			name      string
			arg       string
			assertion require.ErrorAssertionFunc
		}{
			{"1.2 is number", "1.2", require.NoError},
			{"1.2.3 not number", "1.2.3", require.Error},
			{"true is not number", "true", require.Error},
			{"3 is number", "3", require.NoError},
		}

		for _, tt := range tests {
			t.Run(tt.name, func(t *testing.T) {
				var x float64
				tt.assertion(t, dumbParseNum(tt.arg, &x))
			})
		}
	})
}

type TestingT ¶

type TestingT interface {
	Errorf(format string, args ...any)
	FailNow()
}

TestingT is an interface wrapper around *testing.T

type ValueAssertionFunc ¶

type ValueAssertionFunc func(TestingT, any, ...any)

ValueAssertionFunc is a common function prototype when validating a single value. Can be useful for table driven tests.

Example ¶

package main

import (
	"encoding/json"
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := &testing.T{} // provided by test

	t.Run("example", func(t *testing.T) {
		dumbParse := func(input string) any {
			var x any
			_ = json.Unmarshal([]byte(input), &x)
			return x
		}

		tests := []struct {
			name      string
			arg       string
			assertion require.ValueAssertionFunc
		}{
			{"true is not nil", "true", require.NotNil},
			{"empty string is nil", "", require.Nil},
			{"zero is not nil", "0", require.NotNil},
			{"zero is zero", "0", require.Zero},
			{"false is zero", "false", require.Zero},
		}

		for _, tt := range tests {
			t.Run(tt.name, func(t *testing.T) {
				tt.assertion(t, dumbParse(tt.arg))
			})
		}
	})
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL