require

func Condition ¶

func Condition(t TestingT, comp assert.Comparison, msgAndArgs ...interface{})

Condition uses a Comparison to assert a complex condition.

func Conditionf ¶

func Conditionf(t TestingT, comp assert.Comparison, msg string, args ...interface{})

Conditionf uses a Comparison to assert a complex condition.

func Contains ¶

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 ¶

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

func DirExists ¶

func DirExists(t TestingT, path string, msgAndArgs ...interface{})

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

func DirExistsf ¶

func DirExistsf(t TestingT, path string, msg string, args ...interface{})

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

func ElementsMatch ¶

func ElementsMatch(t TestingT, listA 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 ¶

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 ¶

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

Empty asserts that the given value is "empty".

Zero values are "empty".

Arrays are "empty" if every element is the zero value of the type (stricter than "empty").

Slices, maps and channels with zero length are "empty".

Pointer values are "empty" if the pointer is nil or if the pointed value is "empty".

require.Empty(t, obj)

func Emptyf ¶

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

Emptyf asserts that the given value is "empty".

Zero values are "empty".

Arrays are "empty" if every element is the zero value of the type (stricter than "empty").

Slices, maps and channels with zero length are "empty".

Pointer values are "empty" if the pointer is nil or if the pointed value is "empty".

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

func Equal ¶

func Equal(t TestingT, expected 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.

func EqualError ¶

func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{})

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)

func EqualErrorf ¶

func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{})

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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.

func Error ¶

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

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

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

func ErrorAs ¶

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.

func ErrorAsf ¶

func ErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{})

ErrorAsf asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As.

func ErrorContains ¶

func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...interface{})

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)

func ErrorContainsf ¶

func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{})

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

func ErrorIs ¶

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

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

func ErrorIsf ¶

func ErrorIsf(t TestingT, err error, target error, msg string, args ...interface{})

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

func Errorf ¶

func Errorf(t TestingT, err error, msg string, args ...interface{})

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

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

func Eventually ¶

func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{})

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

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

func EventuallyWithT ¶

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

EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t.

externalValue := false
go func() {
	time.Sleep(8*time.Second)
	externalValue = true
}()
require.EventuallyWithT(t, func(c *require.CollectT) {
	// add assertions as needed; any assertion failure will fail the current tick
	require.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")

func EventuallyWithTf ¶

func EventuallyWithTf(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{})

EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t.

externalValue := false
go func() {
	time.Sleep(8*time.Second)
	externalValue = true
}()
require.EventuallyWithTf(t, func(c *require.CollectT, "error message %s", "formatted") {
	// add assertions as needed; any assertion failure will fail the current tick
	require.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")

func Eventuallyf ¶

func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{})

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

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

func Exactly ¶

func Exactly(t TestingT, expected 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 ¶

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 ¶

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

Fail reports a failure through

func FailNow ¶

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

FailNow fails test

func FailNowf ¶

func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{})

FailNowf fails test

func Failf ¶

func Failf(t TestingT, failureMessage string, msg string, args ...interface{})

Failf reports a failure through

func False ¶

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

False asserts that the specified value is false.

require.False(t, myBool)

func Falsef ¶

func Falsef(t TestingT, value bool, msg string, args ...interface{})

Falsef asserts that the specified value is false.

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

func FileExists ¶

func FileExists(t TestingT, path string, msgAndArgs ...interface{})

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

func FileExistsf ¶

func FileExistsf(t TestingT, path string, msg string, args ...interface{})

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

func Greater ¶

func Greater(t TestingT, e1 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 ¶

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 ¶

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 ¶

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

func HTTPBodyContains ¶

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

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

require.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")

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

func HTTPBodyContainsf ¶

func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{})

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

require.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")

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

func HTTPBodyNotContains ¶

func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{})

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

require.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")

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

func HTTPBodyNotContainsf ¶

func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{})

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

require.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")

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

func HTTPError ¶

func HTTPError(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{})

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

require.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}

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

func HTTPErrorf ¶

func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{})

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

require.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}

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

func HTTPRedirect ¶

func HTTPRedirect(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{})

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

require.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}

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

func HTTPRedirectf ¶

func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{})

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

require.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}

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

func HTTPStatusCode ¶

func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msgAndArgs ...interface{})

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

require.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501)

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

func HTTPStatusCodef ¶

func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{})

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

require.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted")

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

func HTTPSuccess ¶

func HTTPSuccess(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{})

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

require.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil)

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

func HTTPSuccessf ¶

func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{})

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

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

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

func Implements ¶

func Implements(t TestingT, interfaceObject 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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 IsNotType ¶

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

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

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

func IsNotTypef ¶

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

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

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

func IsType ¶

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

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

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

func IsTypef ¶

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

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

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

func JSONEq ¶

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

JSONEq asserts that two JSON strings are equivalent.

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

func JSONEqf ¶

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

JSONEqf asserts that two JSON strings are equivalent.

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

func Len ¶

func Len(t TestingT, object 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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

func Never ¶

func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{})

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

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

func Neverf ¶

func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{})

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

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

func Nil ¶

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

Nil asserts that the specified object is nil.

require.Nil(t, err)

func Nilf ¶

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

func NoDirExists ¶

func NoDirExists(t TestingT, path string, msgAndArgs ...interface{})

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

func NoDirExistsf ¶

func NoDirExistsf(t TestingT, path string, msg string, args ...interface{})

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

func NoError ¶

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

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

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

func NoErrorf ¶

func NoErrorf(t TestingT, err error, msg string, args ...interface{})

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

func NoFileExists ¶

func NoFileExists(t TestingT, path string, msgAndArgs ...interface{})

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

func NoFileExistsf ¶

func NoFileExistsf(t TestingT, path string, msg string, args ...interface{})

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

func NotContains ¶

func NotContains(t TestingT, s 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 ¶

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 ¶

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 ¶

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 ¶

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

NotEmpty asserts that the specified object is NOT Empty.

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

func NotEmptyf ¶

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

NotEmptyf asserts that the specified object is NOT Empty.

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

func NotEqual ¶

func NotEqual(t TestingT, expected 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 ¶

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 ¶

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 ¶

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 ¶

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.

func NotErrorAsf ¶

func NotErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{})

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

func NotErrorIs ¶

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

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

func NotErrorIsf ¶

func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{})

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

func NotImplements ¶

func NotImplements(t TestingT, interfaceObject 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 ¶

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 ¶

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

NotNil asserts that the specified object is not nil.

require.NotNil(t, err)

func NotNilf ¶

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

func NotPanics ¶

func NotPanics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{})

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

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

func NotPanicsf ¶

func NotPanicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{})

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

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

func NotRegexp ¶

func NotRegexp(t TestingT, rx 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 ¶

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 ¶

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 ¶

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 ¶

func NotSubset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{})

NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.

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

func NotSubsetf ¶

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

NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.

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

func NotZero ¶

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

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

func NotZerof ¶

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

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

func Panics ¶

func Panics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{})

Panics asserts that the code inside the specified PanicTestFunc panics.

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

func PanicsWithError ¶

func PanicsWithError(t TestingT, errString string, f assert.PanicTestFunc, msgAndArgs ...interface{})

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

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

func PanicsWithErrorf ¶

func PanicsWithErrorf(t TestingT, errString string, f assert.PanicTestFunc, msg string, args ...interface{})

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

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

func PanicsWithValue ¶

func PanicsWithValue(t TestingT, expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{})

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

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

func PanicsWithValuef ¶

func PanicsWithValuef(t TestingT, expected interface{}, f assert.PanicTestFunc, msg string, args ...interface{})

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

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

func Panicsf ¶

func Panicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{})

Panicsf asserts that the code inside the specified PanicTestFunc panics.

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

func Positive ¶

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

Positive asserts that the specified element is positive

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

func Positivef ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

func Subset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{})

Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.

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

func Subsetf ¶

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

Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.

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

func True ¶

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

True asserts that the specified value is true.

require.True(t, myBool)

func Truef ¶

func Truef(t TestingT, value bool, msg string, args ...interface{})

Truef asserts that the specified value is true.

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

func WithinDuration ¶

func WithinDuration(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...interface{})

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

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

func WithinDurationf ¶

func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{})

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

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

func WithinRange ¶

func WithinRange(t TestingT, actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{})

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

require.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second))

func WithinRangef ¶

func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...interface{})

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

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

func YAMLEq ¶

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

YAMLEq asserts that two YAML strings are equivalent.

func YAMLEqf ¶

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

YAMLEqf asserts that two YAML strings are equivalent.

func Zero ¶

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

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

func Zerof ¶

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

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