Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://pkg.go.dev/github.com/stretchr/testify/require below:

require package - github.com/stretchr/testify/require - Go Packages

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

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

import (
  "testing"
  "github.com/stretchr/testify/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.")

}

The `require` package have same global functions as in the `assert` package, but instead of returning a boolean result they call `t.FailNow()`.

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.

• func Condition(t TestingT, comp assert.Comparison, msgAndArgs ...interface{})
• func Conditionf(t TestingT, comp assert.Comparison, msg string, args ...interface{})
• func Contains(t TestingT, s interface{}, contains interface{}, msgAndArgs ...interface{})
• func Containsf(t TestingT, s interface{}, contains interface{}, msg string, ...)
• func DirExists(t TestingT, path string, msgAndArgs ...interface{})
• func DirExistsf(t TestingT, path string, msg string, args ...interface{})
• func ElementsMatch(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{})
• func ElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, ...)
• func Empty(t TestingT, object interface{}, msgAndArgs ...interface{})
• func Emptyf(t TestingT, object interface{}, msg string, args ...interface{})
• func Equal(t TestingT, expected interface{}, actual interface{}, ...)
• func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{})
• func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{})
• func EqualExportedValues(t TestingT, expected interface{}, actual interface{}, ...)
• func EqualExportedValuesf(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func EqualValues(t TestingT, expected interface{}, actual interface{}, ...)
• func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func Equalf(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func Error(t TestingT, err error, msgAndArgs ...interface{})
• func ErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{})
• func ErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{})
• func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...interface{})
• func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{})
• func ErrorIs(t TestingT, err error, target error, msgAndArgs ...interface{})
• func ErrorIsf(t TestingT, err error, target error, msg string, args ...interface{})
• func Errorf(t TestingT, err error, msg string, args ...interface{})
• 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 interface{}, actual interface{}, ...)
• func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{})
• func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{})
• func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{})
• func Failf(t TestingT, failureMessage string, msg string, args ...interface{})
• func False(t TestingT, value bool, msgAndArgs ...interface{})
• func Falsef(t TestingT, value bool, msg string, args ...interface{})
• func FileExists(t TestingT, path string, msgAndArgs ...interface{})
• func FileExistsf(t TestingT, path string, msg string, args ...interface{})
• func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
• func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
• func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})
• func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})
• 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 interface{}, object interface{}, ...)
• func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, ...)
• func InDelta(t TestingT, expected interface{}, actual interface{}, delta float64, ...)
• func InDeltaMapValues(t TestingT, expected interface{}, actual interface{}, delta float64, ...)
• func InDeltaMapValuesf(t TestingT, expected interface{}, actual interface{}, delta float64, ...)
• func InDeltaSlice(t TestingT, expected interface{}, actual interface{}, delta float64, ...)
• func InDeltaSlicef(t TestingT, expected interface{}, actual interface{}, delta float64, ...)
• func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, ...)
• func InEpsilon(t TestingT, expected interface{}, actual interface{}, epsilon float64, ...)
• func InEpsilonSlice(t TestingT, expected interface{}, actual interface{}, epsilon float64, ...)
• func InEpsilonSlicef(t TestingT, expected interface{}, actual interface{}, epsilon float64, ...)
• func InEpsilonf(t TestingT, expected interface{}, actual interface{}, epsilon float64, ...)
• func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{})
• func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface{})
• func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{})
• func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface{})
• func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{})
• func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interface{})
• func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{})
• func IsNonIncreasingf(t TestingT, object interface{}, msg string, args ...interface{})
• func IsType(t TestingT, expectedType interface{}, object interface{}, ...)
• func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg string, ...)
• func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...interface{})
• func JSONEqf(t TestingT, expected string, actual string, msg string, args ...interface{})
• func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{})
• func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{})
• func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
• func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
• func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})
• func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})
• func Negative(t TestingT, e interface{}, msgAndArgs ...interface{})
• func Negativef(t TestingT, e interface{}, msg string, args ...interface{})
• 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 interface{}, msgAndArgs ...interface{})
• func Nilf(t TestingT, object interface{}, msg string, args ...interface{})
• func NoDirExists(t TestingT, path string, msgAndArgs ...interface{})
• func NoDirExistsf(t TestingT, path string, msg string, args ...interface{})
• func NoError(t TestingT, err error, msgAndArgs ...interface{})
• func NoErrorf(t TestingT, err error, msg string, args ...interface{})
• func NoFileExists(t TestingT, path string, msgAndArgs ...interface{})
• func NoFileExistsf(t TestingT, path string, msg string, args ...interface{})
• func NotContains(t TestingT, s interface{}, contains interface{}, msgAndArgs ...interface{})
• func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, ...)
• func NotElementsMatch(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{})
• func NotElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, ...)
• func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{})
• func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{})
• func NotEqual(t TestingT, expected interface{}, actual interface{}, ...)
• func NotEqualValues(t TestingT, expected interface{}, actual interface{}, ...)
• func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func NotEqualf(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func NotErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{})
• func NotErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{})
• func NotErrorIs(t TestingT, err error, target error, msgAndArgs ...interface{})
• func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{})
• func NotImplements(t TestingT, interfaceObject interface{}, object interface{}, ...)
• func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, ...)
• func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{})
• func NotNilf(t TestingT, object interface{}, msg string, args ...interface{})
• func NotPanics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{})
• func NotPanicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{})
• func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{})
• func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{})
• func NotSame(t TestingT, expected interface{}, actual interface{}, ...)
• func NotSamef(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func NotSubset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{})
• func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, ...)
• func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{})
• func NotZerof(t TestingT, i interface{}, msg string, args ...interface{})
• func Panics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{})
• func PanicsWithError(t TestingT, errString string, f assert.PanicTestFunc, ...)
• func PanicsWithErrorf(t TestingT, errString string, f assert.PanicTestFunc, msg string, ...)
• func PanicsWithValue(t TestingT, expected interface{}, f assert.PanicTestFunc, ...)
• func PanicsWithValuef(t TestingT, expected interface{}, f assert.PanicTestFunc, msg string, ...)
• func Panicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{})
• func Positive(t TestingT, e interface{}, msgAndArgs ...interface{})
• func Positivef(t TestingT, e interface{}, msg string, args ...interface{})
• func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{})
• func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{})
• func Same(t TestingT, expected interface{}, actual interface{}, ...)
• func Samef(t TestingT, expected interface{}, actual interface{}, msg string, ...)
• func Subset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{})
• func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, ...)
• func True(t TestingT, value bool, msgAndArgs ...interface{})
• func Truef(t TestingT, value bool, msg string, args ...interface{})
• 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 ...interface{})
• func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...interface{})
• func Zero(t TestingT, i interface{}, msgAndArgs ...interface{})
• func Zerof(t TestingT, i interface{}, msg string, args ...interface{})
• type Assertions
• • func New(t TestingT) *Assertions
• • func (a *Assertions) Condition(comp assert.Comparison, msgAndArgs ...interface{})
  • func (a *Assertions) Conditionf(comp assert.Comparison, msg string, args ...interface{})
  • func (a *Assertions) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Containsf(s interface{}, contains interface{}, msg string, args ...interface{})
  • func (a *Assertions) DirExists(path string, msgAndArgs ...interface{})
  • func (a *Assertions) DirExistsf(path string, msg string, args ...interface{})
  • func (a *Assertions) ElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) ElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{})
  • func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Emptyf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{})
  • func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...interface{})
  • func (a *Assertions) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) EqualExportedValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) EqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) Equalf(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) Error(err error, msgAndArgs ...interface{})
  • func (a *Assertions) ErrorAs(err error, target interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) ErrorAsf(err error, target interface{}, msg string, args ...interface{})
  • func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...interface{})
  • func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...interface{})
  • func (a *Assertions) ErrorIs(err error, target error, msgAndArgs ...interface{})
  • func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...interface{})
  • func (a *Assertions) Errorf(err error, msg string, args ...interface{})
  • 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 interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Exactlyf(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{})
  • func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...interface{})
  • func (a *Assertions) FailNowf(failureMessage string, msg string, args ...interface{})
  • func (a *Assertions) Failf(failureMessage string, msg string, args ...interface{})
  • func (a *Assertions) False(value bool, msgAndArgs ...interface{})
  • func (a *Assertions) Falsef(value bool, msg string, args ...interface{})
  • func (a *Assertions) FileExists(path string, msgAndArgs ...interface{})
  • func (a *Assertions) FileExistsf(path string, msg string, args ...interface{})
  • func (a *Assertions) Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) GreaterOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
  • func (a *Assertions) Greaterf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
  • 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 interface{}, object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Implementsf(interfaceObject interface{}, object interface{}, msg string, ...)
  • func (a *Assertions) InDelta(expected interface{}, actual interface{}, delta float64, ...)
  • func (a *Assertions) InDeltaMapValues(expected interface{}, actual interface{}, delta float64, ...)
  • func (a *Assertions) InDeltaMapValuesf(expected interface{}, actual interface{}, delta float64, msg string, ...)
  • func (a *Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, ...)
  • func (a *Assertions) InDeltaSlicef(expected interface{}, actual interface{}, delta float64, msg string, ...)
  • func (a *Assertions) InDeltaf(expected interface{}, actual interface{}, delta float64, msg string, ...)
  • func (a *Assertions) InEpsilon(expected interface{}, actual interface{}, epsilon float64, ...)
  • func (a *Assertions) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, ...)
  • func (a *Assertions) InEpsilonSlicef(expected interface{}, actual interface{}, epsilon float64, msg string, ...)
  • func (a *Assertions) InEpsilonf(expected interface{}, actual interface{}, epsilon float64, msg string, ...)
  • func (a *Assertions) IsDecreasing(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) IsDecreasingf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) IsIncreasing(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) IsIncreasingf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) IsNonDecreasing(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) IsNonDecreasingf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) IsNonIncreasing(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) IsNonIncreasingf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) IsTypef(expectedType interface{}, object interface{}, msg string, args ...interface{})
  • func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...interface{})
  • func (a *Assertions) JSONEqf(expected string, actual string, msg string, args ...interface{})
  • func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{})
  • func (a *Assertions) Lenf(object interface{}, length int, msg string, args ...interface{})
  • func (a *Assertions) Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) LessOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
  • func (a *Assertions) Lessf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
  • func (a *Assertions) Negative(e interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Negativef(e interface{}, msg string, args ...interface{})
  • 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 interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Nilf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) NoDirExists(path string, msgAndArgs ...interface{})
  • func (a *Assertions) NoDirExistsf(path string, msg string, args ...interface{})
  • func (a *Assertions) NoError(err error, msgAndArgs ...interface{})
  • func (a *Assertions) NoErrorf(err error, msg string, args ...interface{})
  • func (a *Assertions) NoFileExists(path string, msgAndArgs ...interface{})
  • func (a *Assertions) NoFileExistsf(path string, msg string, args ...interface{})
  • func (a *Assertions) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotContainsf(s interface{}, contains interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotEmptyf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotEqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotEqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotEqualf(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotErrorAsf(err error, target interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...interface{})
  • func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...interface{})
  • func (a *Assertions) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotImplementsf(interfaceObject interface{}, object interface{}, msg string, ...)
  • func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotNilf(object interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotPanics(f assert.PanicTestFunc, msgAndArgs ...interface{})
  • func (a *Assertions) NotPanicsf(f assert.PanicTestFunc, msg string, args ...interface{})
  • func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotRegexpf(rx interface{}, str interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotSame(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotSamef(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotSubsetf(list interface{}, subset interface{}, msg string, args ...interface{})
  • func (a *Assertions) NotZero(i interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{})
  • func (a *Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...interface{})
  • func (a *Assertions) PanicsWithError(errString string, f assert.PanicTestFunc, msgAndArgs ...interface{})
  • func (a *Assertions) PanicsWithErrorf(errString string, f assert.PanicTestFunc, msg string, args ...interface{})
  • func (a *Assertions) PanicsWithValue(expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{})
  • func (a *Assertions) PanicsWithValuef(expected interface{}, f assert.PanicTestFunc, msg string, args ...interface{})
  • func (a *Assertions) Panicsf(f assert.PanicTestFunc, msg string, args ...interface{})
  • func (a *Assertions) Positive(e interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Positivef(e interface{}, msg string, args ...interface{})
  • func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Regexpf(rx interface{}, str interface{}, msg string, args ...interface{})
  • func (a *Assertions) Same(expected interface{}, actual interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Samef(expected interface{}, actual interface{}, msg string, args ...interface{})
  • func (a *Assertions) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Subsetf(list interface{}, subset interface{}, msg string, args ...interface{})
  • func (a *Assertions) True(value bool, msgAndArgs ...interface{})
  • func (a *Assertions) Truef(value bool, msg string, args ...interface{})
  • func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, ...)
  • 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 ...interface{})
  • func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, ...)
  • func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...interface{})
  • func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...interface{})
  • func (a *Assertions) Zero(i interface{}, msgAndArgs ...interface{})
  • func (a *Assertions) Zerof(i interface{}, msg string, args ...interface{})
• type BoolAssertionFunc
• type ComparisonAssertionFunc
• type ErrorAssertionFunc
• type TestingT
• type ValueAssertionFunc

• BoolAssertionFunc
• ComparisonAssertionFunc
• ErrorAssertionFunc
• ValueAssertionFunc

This section is empty.

This section is empty.

Condition uses a Comparison to assert a complex condition.

Conditionf uses a Comparison to assert a complex condition.

func Contains(t TestingT, s interface{}, contains interface{}, msgAndArgs ...interface{})

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(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{})

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

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.

DirExistsf checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists.

func ElementsMatch(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{})

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(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{})

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(t TestingT, object interface{}, msgAndArgs ...interface{})

Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or either a slice or a channel with len == 0.

require.Empty(t, obj)

func Emptyf(t TestingT, object interface{}, msg string, args ...interface{})

Emptyf asserts that the specified object is empty. I.e. nil, "", false, 0 or either a slice or a channel with len == 0.

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

func Equal(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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.

EqualError asserts that a function returned an error (i.e. not `nil`) and that it is equal to the provided error.

actualObj, err := SomeFunction()
require.EqualError(t, err,  expectedErrorString)

EqualErrorf asserts that a function returned an error (i.e. not `nil`) and that it is equal to the provided error.

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

func EqualExportedValues(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

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

func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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.

Error asserts that a function returned an error (i.e. not `nil`).

  actualObj, err := SomeFunction()
  if require.Error(t, err) {
	   require.Equal(t, expectedError, err)
  }

func ErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{})

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.

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.

ErrorContains asserts that a function returned an error (i.e. not `nil`) and that the error contains the specified substring.

actualObj, err := SomeFunction()
require.ErrorContains(t, err,  expectedErrorSubString)

ErrorContainsf asserts that a function returned an error (i.e. not `nil`) and that the error contains the specified substring.

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

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

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

Errorf asserts that a function returned an error (i.e. not `nil`).

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

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)

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

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

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(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

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

func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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

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

func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{})

Fail reports a failure through

func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{})

FailNow fails test

Failf reports a failure through

func False(t TestingT, value bool, msgAndArgs ...interface{})

False asserts that the specified value is false.

require.False(t, myBool)

Falsef asserts that the specified value is false.

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

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.

FileExistsf checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file.

func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

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

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

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

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

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

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

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

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

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

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

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

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

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(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})

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

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

func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{})

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

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

func InDelta(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{})

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

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

func InDeltaMapValues(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{})

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

func InDeltaMapValuesf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{})

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

func InDeltaSlice(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{})

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

func InDeltaSlicef(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{})

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

func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{})

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(t TestingT, expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{})

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

func InEpsilonSlice(t TestingT, expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{})

InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.

func InEpsilonSlicef(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{})

InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.

func InEpsilonf(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{})

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

func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{})

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(t TestingT, object interface{}, msg string, args ...interface{})

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(t TestingT, object interface{}, msgAndArgs ...interface{})

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(t TestingT, object interface{}, msg string, args ...interface{})

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(t TestingT, object interface{}, msgAndArgs ...interface{})

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(t TestingT, object interface{}, msg string, args ...interface{})

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(t TestingT, object interface{}, msgAndArgs ...interface{})

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(t TestingT, object interface{}, msg string, args ...interface{})

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 IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{})

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

func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg string, args ...interface{})

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

JSONEq asserts that two JSON strings are equivalent.

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

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(t TestingT, object interface{}, length int, msgAndArgs ...interface{})

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(t TestingT, object interface{}, length int, msg string, args ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

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(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

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(t TestingT, e interface{}, msgAndArgs ...interface{})

Negative asserts that the specified element is negative

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

func Negativef(t TestingT, e interface{}, msg string, args ...interface{})

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

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)

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(t TestingT, object interface{}, msgAndArgs ...interface{})

Nil asserts that the specified object is nil.

require.Nil(t, err)

func Nilf(t TestingT, object interface{}, msg string, args ...interface{})

Nilf asserts that the specified object is nil.

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

NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.

NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.

NoError asserts that a function returned no error (i.e. `nil`).

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

NoErrorf asserts that a function returned no error (i.e. `nil`).

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

NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.

NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.

func NotContains(t TestingT, s interface{}, contains interface{}, msgAndArgs ...interface{})

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(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{})

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(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{})

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(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{})

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(t TestingT, object interface{}, msgAndArgs ...interface{})

NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either a slice or a channel with len == 0.

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

func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{})

NotEmptyf asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either a slice or a channel with len == 0.

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

func NotEqual(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

require.NotEqualValues(t, obj1, obj2)

func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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(t TestingT, err error, target interface{}, msgAndArgs ...interface{})

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

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

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

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

func NotImplements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})

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

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

func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{})

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

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

func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{})

NotNil asserts that the specified object is not nil.

require.NotNil(t, err)

func NotNilf(t TestingT, object interface{}, msg string, args ...interface{})

NotNilf asserts that the specified object is not nil.

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

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

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

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

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

func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{})

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(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{})

NotSubset asserts that the specified list(array, slice...) or map does NOT contain all elements given in the specified subset list(array, slice...) or map.

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

func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{})

NotSubsetf asserts that the specified list(array, slice...) or map does NOT contain all elements given in the specified subset list(array, slice...) or map.

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

func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{})

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

func NotZerof(t TestingT, i interface{}, msg string, args ...interface{})

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

Panics asserts that the code inside the specified PanicTestFunc panics.

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

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() })

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

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() })

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

Panicsf asserts that the code inside the specified PanicTestFunc panics.

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

func Positive(t TestingT, e interface{}, msgAndArgs ...interface{})

Positive asserts that the specified element is positive

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

func Positivef(t TestingT, e interface{}, msg string, args ...interface{})

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(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{})

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(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{})

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(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{})

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(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{})

Subset asserts that the specified list(array, slice...) or map contains all elements given in the specified subset list(array, slice...) or map.

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

func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{})

Subsetf asserts that the specified list(array, slice...) or map contains all elements given in the specified subset list(array, slice...) or map.

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

func True(t TestingT, value bool, msgAndArgs ...interface{})

True asserts that the specified value is true.

require.True(t, myBool)

Truef asserts that the specified value is true.

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

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

require.WithinDuration(t, time.Now(), time.Now(), 10*time.Second)

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

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

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

YAMLEq asserts that two YAML strings are equivalent.

YAMLEqf asserts that two YAML strings are equivalent.

func Zero(t TestingT, i interface{}, msgAndArgs ...interface{})

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

func Zerof(t TestingT, i interface{}, msg string, args ...interface{})

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

type Assertions struct {
	
}

Assertions provides assertion methods around the TestingT interface.

New makes a new Assertions object for the specified TestingT.

Condition uses a Comparison to assert a complex condition.

Conditionf uses a Comparison to assert a complex condition.

func (a *Assertions) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) Containsf(s interface{}, contains interface{}, msg string, args ...interface{})

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

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.

DirExistsf checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists.

func (a *Assertions) ElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{})

ElementsMatch asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.

a.ElementsMatch([1, 3, 2, 3], [1, 3, 3, 2])

func (a *Assertions) ElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{})

ElementsMatchf asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.

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

func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{})

Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or either a slice or a channel with len == 0.

a.Empty(obj)

func (a *Assertions) Emptyf(object interface{}, msg string, args ...interface{})

Emptyf asserts that the specified object is empty. I.e. nil, "", false, 0 or either a slice or a channel with len == 0.

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

func (a *Assertions) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{})

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.

EqualError asserts that a function returned an error (i.e. not `nil`) and that it is equal to the provided error.

actualObj, err := SomeFunction()
a.EqualError(err,  expectedErrorString)

EqualErrorf asserts that a function returned an error (i.e. not `nil`) and that it is equal to the provided error.

actualObj, err := SomeFunction()
a.EqualErrorf(err,  expectedErrorString, "error message %s", "formatted")

func (a *Assertions) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})

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 (a *Assertions) EqualExportedValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})

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 (a *Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) EqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) Equalf(expected interface{}, actual interface{}, msg string, args ...interface{})

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.

Error asserts that a function returned an error (i.e. not `nil`).

  actualObj, err := SomeFunction()
  if a.Error(err) {
	   assert.Equal(t, expectedError, err)
  }

func (a *Assertions) ErrorAs(err error, target interface{}, msgAndArgs ...interface{})

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.

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.

ErrorContains asserts that a function returned an error (i.e. not `nil`) and that the error contains the specified substring.

actualObj, err := SomeFunction()
a.ErrorContains(err,  expectedErrorSubString)

ErrorContainsf asserts that a function returned an error (i.e. not `nil`) and that the error contains the specified substring.

actualObj, err := SomeFunction()
a.ErrorContainsf(err,  expectedErrorSubString, "error message %s", "formatted")

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

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

Errorf asserts that a function returned an error (i.e. not `nil`).

  actualObj, err := SomeFunction()
  if a.Errorf(err, "error message %s", "formatted") {
	   assert.Equal(t, expectedErrorf, err)
  }

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)

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

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

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

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

func (a *Assertions) Exactly(expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) Exactlyf(expected interface{}, actual interface{}, msg string, args ...interface{})

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

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

Fail reports a failure through

Failf reports a failure through

False asserts that the specified value is false.

a.False(myBool)

Falsef asserts that the specified value is false.

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

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.

FileExistsf checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file.

func (a *Assertions) Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

Greater asserts that the first element is greater than the second

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

func (a *Assertions) GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) GreaterOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) Greaterf(e1 interface{}, e2 interface{}, msg string, args ...interface{})

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

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

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

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

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

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

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

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

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

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

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

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

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

a.HTTPSuccessf(myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted")

Returns whether the assertion was successful (true) or not (false).

func (a *Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) Implementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) InDelta(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{})

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

a.InDelta(math.Pi, 22/7.0, 0.01)

func (a *Assertions) InDeltaMapValues(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{})

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

func (a *Assertions) InDeltaMapValuesf(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{})

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

func (a *Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{})

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

func (a *Assertions) InDeltaSlicef(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{})

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

func (a *Assertions) InDeltaf(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{})

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

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

func (a *Assertions) InEpsilon(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{})

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

func (a *Assertions) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{})

InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.

func (a *Assertions) InEpsilonSlicef(expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{})

InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.

func (a *Assertions) InEpsilonf(expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{})

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

func (a *Assertions) IsDecreasing(object interface{}, msgAndArgs ...interface{})

IsDecreasing asserts that the collection is decreasing

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

func (a *Assertions) IsDecreasingf(object interface{}, msg string, args ...interface{})

IsDecreasingf asserts that the collection is decreasing

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

func (a *Assertions) IsIncreasing(object interface{}, msgAndArgs ...interface{})

IsIncreasing asserts that the collection is increasing

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

func (a *Assertions) IsIncreasingf(object interface{}, msg string, args ...interface{})

IsIncreasingf asserts that the collection is increasing

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

func (a *Assertions) IsNonDecreasing(object interface{}, msgAndArgs ...interface{})

IsNonDecreasing asserts that the collection is not decreasing

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

func (a *Assertions) IsNonDecreasingf(object interface{}, msg string, args ...interface{})

IsNonDecreasingf asserts that the collection is not decreasing

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

func (a *Assertions) IsNonIncreasing(object interface{}, msgAndArgs ...interface{})

IsNonIncreasing asserts that the collection is not increasing

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

func (a *Assertions) IsNonIncreasingf(object interface{}, msg string, args ...interface{})

IsNonIncreasingf asserts that the collection is not increasing

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

func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{})

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

func (a *Assertions) IsTypef(expectedType interface{}, object interface{}, msg string, args ...interface{})

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

JSONEq asserts that two JSON strings are equivalent.

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

JSONEqf asserts that two JSON strings are equivalent.

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

func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{})

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)

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

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

func (a *Assertions) Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

Less asserts that the first element is less than the second

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

func (a *Assertions) LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) LessOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) Lessf(e1 interface{}, e2 interface{}, msg string, args ...interface{})

Lessf asserts that the first element is less than the second

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

func (a *Assertions) Negative(e interface{}, msgAndArgs ...interface{})

Negative asserts that the specified element is negative

a.Negative(-1)
a.Negative(-1.23)

Negativef asserts that the specified element is negative

a.Negativef(-1, "error message %s", "formatted")
a.Negativef(-1.23, "error message %s", "formatted")

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)

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

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

func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{})

Nil asserts that the specified object is nil.

a.Nil(err)

Nilf asserts that the specified object is nil.

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

NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.

NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing _directory_ only.

NoError asserts that a function returned no error (i.e. `nil`).

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

NoErrorf asserts that a function returned no error (i.e. `nil`).

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

NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.

NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing _file_ only.

func (a *Assertions) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) NotContainsf(s interface{}, contains interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{})

NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.

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

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

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

func (a *Assertions) NotElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{})

NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.

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

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

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

func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{})

NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either a slice or a channel with len == 0.

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

func (a *Assertions) NotEmptyf(object interface{}, msg string, args ...interface{})

NotEmptyf asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either a slice or a channel with len == 0.

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

func (a *Assertions) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{})

NotEqual asserts that the specified values are NOT equal.

a.NotEqual(obj1, obj2)

Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses).

func (a *Assertions) NotEqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

a.NotEqualValues(obj1, obj2)

func (a *Assertions) NotEqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) NotEqualf(expected interface{}, actual interface{}, msg string, args ...interface{})

NotEqualf asserts that the specified values are NOT equal.

a.NotEqualf(obj1, obj2, "error message %s", "formatted")

Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses).

func (a *Assertions) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{})

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

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

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

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

func (a *Assertions) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) NotImplementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{})

NotNil asserts that the specified object is not nil.

a.NotNil(err)

func (a *Assertions) NotNilf(object interface{}, msg string, args ...interface{})

NotNilf asserts that the specified object is not nil.

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

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

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

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

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

func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{})

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

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

func (a *Assertions) NotRegexpf(rx interface{}, str interface{}, msg string, args ...interface{})

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

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

func (a *Assertions) NotSame(expected interface{}, actual interface{}, msgAndArgs ...interface{})

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

a.NotSame(ptr1, ptr2)

Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.

func (a *Assertions) NotSamef(expected interface{}, actual interface{}, msg string, args ...interface{})

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

a.NotSamef(ptr1, ptr2, "error message %s", "formatted")

Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.

func (a *Assertions) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{})

NotSubset asserts that the specified list(array, slice...) or map does NOT contain all elements given in the specified subset list(array, slice...) or map.

a.NotSubset([1, 3, 4], [1, 2])
a.NotSubset({"x": 1, "y": 2}, {"z": 3})

func (a *Assertions) NotSubsetf(list interface{}, subset interface{}, msg string, args ...interface{})

NotSubsetf asserts that the specified list(array, slice...) or map does NOT contain all elements given in the specified subset list(array, slice...) or map.

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

func (a *Assertions) NotZero(i interface{}, msgAndArgs ...interface{})

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

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

Panics asserts that the code inside the specified PanicTestFunc panics.

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

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() })

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

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() })

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

Panicsf asserts that the code inside the specified PanicTestFunc panics.

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

func (a *Assertions) Positive(e interface{}, msgAndArgs ...interface{})

Positive asserts that the specified element is positive

a.Positive(1)
a.Positive(1.23)

Positivef asserts that the specified element is positive

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

func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{})

Regexp asserts that a specified regexp matches a string.

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

func (a *Assertions) Regexpf(rx interface{}, str interface{}, msg string, args ...interface{})

Regexpf asserts that a specified regexp matches a string.

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

func (a *Assertions) Same(expected interface{}, actual interface{}, msgAndArgs ...interface{})

Same asserts that two pointers reference the same object.

a.Same(ptr1, ptr2)

Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.

func (a *Assertions) Samef(expected interface{}, actual interface{}, msg string, args ...interface{})

Samef asserts that two pointers reference the same object.

a.Samef(ptr1, ptr2, "error message %s", "formatted")

Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.

func (a *Assertions) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{})

Subset asserts that the specified list(array, slice...) or map contains all elements given in the specified subset list(array, slice...) or map.

a.Subset([1, 2, 3], [1, 2])
a.Subset({"x": 1, "y": 2}, {"x": 1})

func (a *Assertions) Subsetf(list interface{}, subset interface{}, msg string, args ...interface{})

Subsetf asserts that the specified list(array, slice...) or map contains all elements given in the specified subset list(array, slice...) or map.

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

True asserts that the specified value is true.

a.True(myBool)

Truef asserts that the specified value is true.

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

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

a.WithinDuration(time.Now(), time.Now(), 10*time.Second)

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

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

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

YAMLEq asserts that two YAML strings are equivalent.

YAMLEqf asserts that two YAML strings are equivalent.

func (a *Assertions) Zero(i interface{}, msgAndArgs ...interface{})

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

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

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

t := &testing.T{} // provided by test

isOkay := func(x int) bool {
	return x >= 42
}

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

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

type ComparisonAssertionFunc func(TestingT, interface{}, interface{}, ...interface{})

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

t := &testing.T{} // provided by test

adder := func(x, y int) int {
	return x + y
}

type args struct {
	x int
	y int
}

tests := []struct {
	name      string
	args      args
	expect    int
	assertion ComparisonAssertionFunc
}{
	{"2+2=4", args{2, 2}, 4, Equal},
	{"2+2!=5", args{2, 2}, 5, NotEqual},
	{"2+3==5", args{2, 3}, 5, Exactly},
}

for _, tt := range tests {
	t.Run(tt.name, func(t *testing.T) {
		tt.assertion(t, tt.expect, adder(tt.args.x, tt.args.y))
	})
}

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

t := &testing.T{} // provided by test

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

tests := []struct {
	name      string
	arg       string
	assertion ErrorAssertionFunc
}{
	{"1.2 is number", "1.2", NoError},
	{"1.2.3 not number", "1.2.3", Error},
	{"true is not number", "true", Error},
	{"3 is number", "3", NoError},
}

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

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

TestingT is an interface wrapper around *testing.T

type ValueAssertionFunc func(TestingT, interface{}, ...interface{})

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

t := &testing.T{} // provided by test

dumbParse := func(input string) interface{} {
	var x interface{}
	json.Unmarshal([]byte(input), &x)
	return x
}

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

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4