package require

Import Path
	github.com/stretchr/testify/require (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files Package require implements the same assertions as the `assert` package but stops test execution when a test fails. # Example Usage The following is a complete example using require in a standard test function: import ( "testing" "github.com/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.") } # Assertions The `require` package have same global functions as in the `assert` package, but instead of returning a boolean result they call `t.FailNow()`. A consequence of this is that it must be called from the goroutine running the test function, not from other goroutines created during the test. Every assertion function also takes an optional string message as the final argument, allowing custom error messages to be appended to the message the assertion method outputs. forward_requirements.go require.go require_forward.go requirements.go
Package-Level Type Names (total 6)
/* sort by: | */
Assertions provides assertion methods around the TestingT interface. Condition uses a Comparison to assert a complex condition. Conditionf uses a Comparison to assert a complex condition. 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") 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. 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]) 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") Empty asserts that the given value is "empty". [Zero values] are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". a.Empty(obj) Emptyf asserts that the given value is "empty". [Zero values] are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". a.Emptyf(obj, "error message %s", "formatted") 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") 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 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 EqualValues asserts that two objects are equal or convertible to the larger type and equal. a.EqualValues(uint32(123), int32(123)) 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") 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() a.Error(err) 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() a.Errorf(err, "error message %s", "formatted") 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") Exactly asserts that two objects are equal in value and type. a.Exactly(int32(123), int64(123)) 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 FailNow fails test FailNowf fails test 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. 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") 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") 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") 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). Implements asserts that an object is implemented by the specified interface. a.Implements((*MyInterface)(nil), new(MyObject)) Implementsf asserts that an object is implemented by the specified interface. a.Implementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted") InDelta asserts that the two numerals are within delta of each other. a.InDelta(math.Pi, 22/7.0, 0.01) InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys. InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys. InDeltaSlice is the same as InDelta, except it compares two slices. InDeltaSlicef is the same as InDelta, except it compares two slices. 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") InEpsilon asserts that expected and actual have a relative error less than epsilon InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices. InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices. InEpsilonf asserts that expected and actual have a relative error less than epsilon IsDecreasing asserts that the collection is decreasing a.IsDecreasing([]int{2, 1, 0}) a.IsDecreasing([]float{2, 1}) a.IsDecreasing([]string{"b", "a"}) 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") IsIncreasing asserts that the collection is increasing a.IsIncreasing([]int{1, 2, 3}) a.IsIncreasing([]float{1, 2}) a.IsIncreasing([]string{"a", "b"}) 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") IsNonDecreasing asserts that the collection is not decreasing a.IsNonDecreasing([]int{1, 1, 2}) a.IsNonDecreasing([]float{1, 2}) a.IsNonDecreasing([]string{"a", "b"}) 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") IsNonIncreasing asserts that the collection is not increasing a.IsNonIncreasing([]int{2, 1, 1}) a.IsNonIncreasing([]float{2, 1}) a.IsNonIncreasing([]string{"b", "a"}) 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") IsNotType asserts that the specified objects are not of the same type. a.IsNotType(&NotMyStruct{}, &MyStruct{}) IsNotTypef asserts that the specified objects are not of the same type. a.IsNotTypef(&NotMyStruct{}, &MyStruct{}, "error message %s", "formatted") IsType asserts that the specified objects are of the same type. a.IsType(&MyStruct{}, &MyStruct{}) IsTypef asserts that the specified objects are of the same type. a.IsTypef(&MyStruct{}, &MyStruct{}, "error message %s", "formatted") 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") 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") 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") 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") 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") 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") 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") 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. 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") 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") 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 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 NotEmpty asserts that the specified object is NOT [Empty]. if a.NotEmpty(obj) { assert.Equal(t, "two", obj[1]) } NotEmptyf asserts that the specified object is NOT [Empty]. if a.NotEmptyf(obj, "error message %s", "formatted") { assert.Equal(t, "two", obj[1]) } 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). NotEqualValues asserts that two objects are not equal even when converted to the same type a.NotEqualValues(obj1, obj2) NotEqualValuesf asserts that two objects are not equal even when converted to the same type a.NotEqualValuesf(obj1, obj2, "error message %s", "formatted") 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). 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. NotImplements asserts that an object does not implement the specified interface. a.NotImplements((*MyInterface)(nil), new(MyObject)) NotImplementsf asserts that an object does not implement the specified interface. a.NotImplementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted") NotNil asserts that the specified object is not nil. a.NotNil(err) 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") 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") 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") 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. 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. NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.NotSubset([1, 3, 4], [1, 2]) a.NotSubset({"x": 1, "y": 2}, {"z": 3}) a.NotSubset([1, 3, 4], {1: "one", 2: "two"}) a.NotSubset({"x": 1, "y": 2}, ["z"]) NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.NotSubsetf([1, 3, 4], [1, 2], "error message %s", "formatted") a.NotSubsetf({"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted") a.NotSubsetf([1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted") a.NotSubsetf({"x": 1, "y": 2}, ["z"], "error message %s", "formatted") 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") 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") Regexp asserts that a specified regexp matches a string. a.Regexp(regexp.MustCompile("start"), "it's starting") a.Regexp("start...$", "it's not starting") 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") 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. 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. Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.Subset([1, 2, 3], [1, 2]) a.Subset({"x": 1, "y": 2}, {"x": 1}) a.Subset([1, 2, 3], {1: "one", 2: "two"}) a.Subset({"x": 1, "y": 2}, ["x"]) Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.Subsetf([1, 2, 3], [1, 2], "error message %s", "formatted") a.Subsetf({"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted") a.Subsetf([1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted") a.Subsetf({"x": 1, "y": 2}, ["x"], "error message %s", "formatted") 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. Zero asserts that i is the zero value for its type. Zerof asserts that i is the zero value for its type. func New(t TestingT) *Assertions
BoolAssertionFunc is a common function prototype when validating a bool value. Can be useful for table driven tests.
ComparisonAssertionFunc is a common function prototype when comparing two values. Can be useful for table driven tests.
ErrorAssertionFunc is a common function prototype when validating an error value. Can be useful for table driven tests.
TestingT is an interface wrapper around *testing.T ( TestingT) Errorf(format string, args ...interface{}) ( TestingT) FailNow() *github.com/stretchr/testify/assert.CollectT github.com/efficientgo/core/testutil.TB (interface) *testing.B *testing.F *testing.T testing.TB (interface) TestingT : github.com/stretchr/testify/assert.TestingT 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, args ...interface{}) 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, args ...interface{}) 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{}, msgAndArgs ...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{}, msgAndArgs ...interface{}) func EqualExportedValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) func Equalf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) func EqualValues(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) 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 Errorf(t TestingT, err error, 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 Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) func EventuallyWithT(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) func EventuallyWithTf(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) func Exactly(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) func Failf(t TestingT, failureMessage string, msg string, args ...interface{}) func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) func FailNowf(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 Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) func HTTPError(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) func HTTPRedirect(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) func HTTPSuccess(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) func InDelta(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) func InDeltaMapValues(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) func InDeltaMapValuesf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) func InDeltaSlice(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) func InDeltaSlicef(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) func InEpsilon(t TestingT, expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) func InEpsilonf(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) func InEpsilonSlice(t TestingT, expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) func InEpsilonSlicef(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) 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 IsNotType(t TestingT, theType interface{}, object interface{}, msgAndArgs ...interface{}) func IsNotTypef(t TestingT, theType interface{}, object interface{}, msg string, args ...interface{}) func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg string, args ...interface{}) 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 Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) func LessOrEqualf(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, msgAndArgs ...interface{}) func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) func New(t TestingT) *Assertions 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, args ...interface{}) func NotElementsMatch(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{}) func NotElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) 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{}, msgAndArgs ...interface{}) func NotEqualf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) func NotEqualValues(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) 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{}, msgAndArgs ...interface{}) func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) 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{}, msgAndArgs ...interface{}) func NotSamef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) func NotSubset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{}) func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) 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 Panicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{}) func PanicsWithError(t TestingT, errString string, f assert.PanicTestFunc, msgAndArgs ...interface{}) func PanicsWithErrorf(t TestingT, errString string, f assert.PanicTestFunc, msg string, args ...interface{}) func PanicsWithValue(t TestingT, expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{}) func PanicsWithValuef(t TestingT, expected interface{}, 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{}, msgAndArgs ...interface{}) func Samef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) func Subset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{}) func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) 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, msgAndArgs ...interface{}) func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) func WithinRange(t TestingT, actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{}) func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) 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{})
ValueAssertionFunc is a common function prototype when validating a single value. Can be useful for table driven tests.
Package-Level Functions (total 153)
Condition uses a Comparison to assert a complex condition.
Conditionf uses a Comparison to assert a complex condition.
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")
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.
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])
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")
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)
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")
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")
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
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
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.
EqualValues asserts that two objects are equal or convertible to the larger type and equal. require.EqualValues(t, uint32(123), int32(123))
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")
Error asserts that a function returned an error (i.e. not `nil`). actualObj, err := SomeFunction() require.Error(t, err)
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")
Errorf asserts that a function returned an error (i.e. not `nil`). actualObj, err := SomeFunction() require.Errorf(t, err, "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.
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)
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")
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")
Exactly asserts that two objects are equal in value and type. require.Exactly(t, int32(123), int64(123))
Exactlyf asserts that two objects are equal in value and type. require.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted")
Fail reports a failure through
Failf reports a failure through
FailNow fails test
FailNowf fails test
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.
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")
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")
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")
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")
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).
Implements asserts that an object is implemented by the specified interface. require.Implements(t, (*MyInterface)(nil), new(MyObject))
Implementsf asserts that an object is implemented by the specified interface. require.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
InDelta asserts that the two numerals are within delta of each other. require.InDelta(t, math.Pi, 22/7.0, 0.01)
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")
InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
InDeltaSlice is the same as InDelta, except it compares two slices.
InDeltaSlicef is the same as InDelta, except it compares two slices.
InEpsilon asserts that expected and actual have a relative error less than epsilon
InEpsilonf asserts that expected and actual have a relative error less than epsilon
InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices.
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"})
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")
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"})
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")
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"})
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")
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"})
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")
IsNotType asserts that the specified objects are not of the same type. require.IsNotType(t, &NotMyStruct{}, &MyStruct{})
IsNotTypef asserts that the specified objects are not of the same type. require.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")
IsType asserts that the specified objects are of the same type. require.IsType(t, &MyStruct{}, &MyStruct{})
IsTypef asserts that the specified objects are of the same type. require.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted")
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")
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)
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")
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")
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")
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")
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")
Negative asserts that the specified element is negative require.Negative(t, -1) require.Negative(t, -1.23)
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")
New makes a new Assertions object for the specified TestingT.
Nil asserts that the specified object is nil. require.Nil(t, err)
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.
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")
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")
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
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
NotEmpty asserts that the specified object is NOT [Empty]. if require.NotEmpty(t, obj) { require.Equal(t, "two", obj[1]) }
NotEmptyf asserts that the specified object is NOT [Empty]. if require.NotEmptyf(t, obj, "error message %s", "formatted") { require.Equal(t, "two", obj[1]) }
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).
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).
NotEqualValues asserts that two objects are not equal even when converted to the same type require.NotEqualValues(t, obj1, obj2)
NotEqualValuesf asserts that two objects are not equal even when converted to the same type require.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted")
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.
NotImplements asserts that an object does not implement the specified interface. require.NotImplements(t, (*MyInterface)(nil), new(MyObject))
NotImplementsf asserts that an object does not implement the specified interface. require.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
NotNil asserts that the specified object is not nil. require.NotNil(t, err)
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")
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")
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")
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.
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.
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"])
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")
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. require.Panics(t, func(){ GoCrazy() })
Panicsf asserts that the code inside the specified PanicTestFunc panics. require.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")
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")
Positive asserts that the specified element is positive require.Positive(t, 1) require.Positive(t, 1.23)
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")
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")
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")
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.
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.
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"])
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")
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.
Zero asserts that i is the zero value for its type.
Zerof asserts that i is the zero value for its type.