Involved Source Filesassertion_compare.goassertion_format.goassertion_forward.goassertion_order.goassertions.go Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
# Note
All functions in this package return a bool value indicating whether the assertion has passed.
# Example Usage
The following is a complete example using assert in a standard test function:
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestSomething(t *testing.T) {
var a string = "Hello"
var b string = "Hello"
assert.Equal(t, a, b, "The two words should be the same.")
}
if you assert many times, use the format below:
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestSomething(t *testing.T) {
assert := assert.New(t)
var a string = "Hello"
var b string = "Hello"
assert.Equal(a, b, "The two words should be the same.")
}
# Assertions
Assertions allow you to easily write test code, and are global funcs in the `assert` package.
All assertion functions take, as the first argument, the `*testing.T` object provided by the
testing framework. This allows the assertion funcs to write the failings and other details to
the correct place.
Every assertion function also takes an optional string message as the final argument,
allowing custom error messages to be appended to the message the assertion method outputs.errors.goforward_assertions.gohttp_assertions.go
Package-Level Type Names (total 11)
/* 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.
CollectT implements the TestingT interface and collects all errors. Deprecated: That was a method for internal usage that should not have been published. Now just panics. Errorf collects the error. FailNow stops execution by calling runtime.Goexit. Helper is like [testing.T.Helper] but does nothing. Deprecated: That was a method for internal usage that should not have been published. Now just panics.
*CollectT : TestingT
*CollectT : github.com/stretchr/testify/require.TestingT
*CollectT : github.com/apache/arrow-go/v18/arrow/memory.TestingT
Deprecated: CompareType has only ever been for internal use and has accidentally been published since v1.6.0. Do not use it.
ValueAssertionFunc is a common function prototype when validating a single value. Can be useful
for table driven tests.
Package-Level Functions (total 158)
CallerInfo returns an array of strings containing the file and line number
of each stack frame leading from the current test to the assert call that
failed.
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.
assert.Contains(t, "Hello World", "World")
assert.Contains(t, ["Hello", "World"], "World")
assert.Contains(t, {"Hello": "World"}, "Hello")
Containsf asserts that the specified string, list(array, slice...) or map contains the
specified substring or element.
assert.Containsf(t, "Hello World", "World", "error message %s", "formatted")
assert.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted")
assert.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted")
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.
assert.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.
assert.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".
assert.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".
assert.Emptyf(t, obj, "error message %s", "formatted")
Equal asserts that two objects are equal.
assert.Equal(t, 123, 123)
Pointer variable equality is determined based on the equality of the
referenced values (as opposed to the memory addresses). Function equality
cannot be determined and will always fail.
EqualError asserts that a function returned an error (i.e. not `nil`)
and that it is equal to the provided error.
actualObj, err := SomeFunction()
assert.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()
assert.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
}
assert.EqualExportedValues(t, S{1, 2}, S{1, 3}) => true
assert.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
}
assert.EqualExportedValuesf(t, S{1, 2}, S{1, 3}, "error message %s", "formatted") => true
assert.EqualExportedValuesf(t, S{1, 2}, S{2, 3}, "error message %s", "formatted") => false
Equalf asserts that two objects are equal.
assert.Equalf(t, 123, 123, "error message %s", "formatted")
Pointer variable equality is determined based on the equality of the
referenced values (as opposed to the memory addresses). Function equality
cannot be determined and will always fail.
EqualValues asserts that two objects are equal or convertible to the larger
type and equal.
assert.EqualValues(t, uint32(123), int32(123))
EqualValuesf asserts that two objects are equal or convertible to the larger
type and equal.
assert.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted")
Error asserts that a function returned an error (i.e. not `nil`).
actualObj, err := SomeFunction()
assert.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()
assert.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()
assert.ErrorContainsf(t, err, expectedErrorSubString, "error message %s", "formatted")
Errorf asserts that a function returned an error (i.e. not `nil`).
actualObj, err := SomeFunction()
assert.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.
assert.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.
assert.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
}()
assert.EventuallyWithT(t, func(c *assert.CollectT) {
// add assertions as needed; any assertion failure will fail the current tick
assert.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")
EventuallyWithTf asserts that given condition will be met in waitFor time,
periodically checking target function each tick. In contrast to Eventually,
it supplies a CollectT to the condition function, so that the condition
function can use the CollectT to call other assertions.
The condition is considered "met" if no errors are raised in a tick.
The supplied CollectT collects all errors from one tick (if there are any).
If the condition is not met before waitFor, the collected errors of
the last tick are copied to t.
externalValue := false
go func() {
time.Sleep(8*time.Second)
externalValue = true
}()
assert.EventuallyWithTf(t, func(c *assert.CollectT, "error message %s", "formatted") {
// add assertions as needed; any assertion failure will fail the current tick
assert.True(c, externalValue, "expected 'externalValue' to be true")
}, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")
Exactly asserts that two objects are equal in value and type.
assert.Exactly(t, int32(123), int64(123))
Exactlyf asserts that two objects are equal in value and type.
assert.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.
assert.False(t, myBool)
Falsef asserts that the specified value is false.
assert.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
assert.Greater(t, 2, 1)
assert.Greater(t, float64(2), float64(1))
assert.Greater(t, "b", "a")
Greaterf asserts that the first element is greater than the second
assert.Greaterf(t, 2, 1, "error message %s", "formatted")
assert.Greaterf(t, float64(2), float64(1), "error message %s", "formatted")
assert.Greaterf(t, "b", "a", "error message %s", "formatted")
GreaterOrEqual asserts that the first element is greater than or equal to the second
assert.GreaterOrEqual(t, 2, 1)
assert.GreaterOrEqual(t, 2, 2)
assert.GreaterOrEqual(t, "b", "a")
assert.GreaterOrEqual(t, "b", "b")
GreaterOrEqualf asserts that the first element is greater than or equal to the second
assert.GreaterOrEqualf(t, 2, 1, "error message %s", "formatted")
assert.GreaterOrEqualf(t, 2, 2, "error message %s", "formatted")
assert.GreaterOrEqualf(t, "b", "a", "error message %s", "formatted")
assert.GreaterOrEqualf(t, "b", "b", "error message %s", "formatted")
HTTPBody is a helper that returns HTTP body of the response. It returns
empty string if building a new request fails.
HTTPBodyContains asserts that a specified handler returns a
body that contains a string.
assert.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")
Returns whether the assertion was successful (true) or not (false).
HTTPBodyContainsf asserts that a specified handler returns a
body that contains a string.
assert.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")
Returns whether the assertion was successful (true) or not (false).
HTTPBodyNotContains asserts that a specified handler returns a
body that does not contain a string.
assert.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")
Returns whether the assertion was successful (true) or not (false).
HTTPBodyNotContainsf asserts that a specified handler returns a
body that does not contain a string.
assert.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")
Returns whether the assertion was successful (true) or not (false).
HTTPError asserts that a specified handler returns an error status code.
assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
Returns whether the assertion was successful (true) or not (false).
HTTPErrorf asserts that a specified handler returns an error status code.
assert.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
Returns whether the assertion was successful (true) or not (false).
HTTPRedirect asserts that a specified handler returns a redirect status code.
assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
Returns whether the assertion was successful (true) or not (false).
HTTPRedirectf asserts that a specified handler returns a redirect status code.
assert.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
Returns whether the assertion was successful (true) or not (false).
HTTPStatusCode asserts that a specified handler returns a specified status code.
assert.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501)
Returns whether the assertion was successful (true) or not (false).
HTTPStatusCodef asserts that a specified handler returns a specified status code.
assert.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted")
Returns whether the assertion was successful (true) or not (false).
HTTPSuccess asserts that a specified handler returns a success status code.
assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil)
Returns whether the assertion was successful (true) or not (false).
HTTPSuccessf asserts that a specified handler returns a success status code.
assert.HTTPSuccessf(t, myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted")
Returns whether the assertion was successful (true) or not (false).
Implements asserts that an object is implemented by the specified interface.
assert.Implements(t, (*MyInterface)(nil), new(MyObject))
Implementsf asserts that an object is implemented by the specified interface.
assert.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
InDelta asserts that the two numerals are within delta of each other.
assert.InDelta(t, math.Pi, 22/7.0, 0.01)
InDeltaf asserts that the two numerals are within delta of each other.
assert.InDeltaf(t, math.Pi, 22/7.0, 0.01, "error message %s", "formatted")
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
assert.IsDecreasing(t, []int{2, 1, 0})
assert.IsDecreasing(t, []float{2, 1})
assert.IsDecreasing(t, []string{"b", "a"})
IsDecreasingf asserts that the collection is decreasing
assert.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted")
assert.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted")
assert.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted")
IsIncreasing asserts that the collection is increasing
assert.IsIncreasing(t, []int{1, 2, 3})
assert.IsIncreasing(t, []float{1, 2})
assert.IsIncreasing(t, []string{"a", "b"})
IsIncreasingf asserts that the collection is increasing
assert.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted")
assert.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted")
assert.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted")
IsNonDecreasing asserts that the collection is not decreasing
assert.IsNonDecreasing(t, []int{1, 1, 2})
assert.IsNonDecreasing(t, []float{1, 2})
assert.IsNonDecreasing(t, []string{"a", "b"})
IsNonDecreasingf asserts that the collection is not decreasing
assert.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted")
assert.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted")
assert.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted")
IsNonIncreasing asserts that the collection is not increasing
assert.IsNonIncreasing(t, []int{2, 1, 1})
assert.IsNonIncreasing(t, []float{2, 1})
assert.IsNonIncreasing(t, []string{"b", "a"})
IsNonIncreasingf asserts that the collection is not increasing
assert.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted")
assert.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted")
assert.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted")
IsNotType asserts that the specified objects are not of the same type.
assert.IsNotType(t, &NotMyStruct{}, &MyStruct{})
IsNotTypef asserts that the specified objects are not of the same type.
assert.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted")
IsType asserts that the specified objects are of the same type.
assert.IsType(t, &MyStruct{}, &MyStruct{})
IsTypef asserts that the specified objects are of the same type.
assert.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted")
JSONEq asserts that two JSON strings are equivalent.
assert.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)
JSONEqf asserts that two JSON strings are equivalent.
assert.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.
assert.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.
assert.Lenf(t, mySlice, 3, "error message %s", "formatted")
Less asserts that the first element is less than the second
assert.Less(t, 1, 2)
assert.Less(t, float64(1), float64(2))
assert.Less(t, "a", "b")
Lessf asserts that the first element is less than the second
assert.Lessf(t, 1, 2, "error message %s", "formatted")
assert.Lessf(t, float64(1), float64(2), "error message %s", "formatted")
assert.Lessf(t, "a", "b", "error message %s", "formatted")
LessOrEqual asserts that the first element is less than or equal to the second
assert.LessOrEqual(t, 1, 2)
assert.LessOrEqual(t, 2, 2)
assert.LessOrEqual(t, "a", "b")
assert.LessOrEqual(t, "b", "b")
LessOrEqualf asserts that the first element is less than or equal to the second
assert.LessOrEqualf(t, 1, 2, "error message %s", "formatted")
assert.LessOrEqualf(t, 2, 2, "error message %s", "formatted")
assert.LessOrEqualf(t, "a", "b", "error message %s", "formatted")
assert.LessOrEqualf(t, "b", "b", "error message %s", "formatted")
Negative asserts that the specified element is negative
assert.Negative(t, -1)
assert.Negative(t, -1.23)
Negativef asserts that the specified element is negative
assert.Negativef(t, -1, "error message %s", "formatted")
assert.Negativef(t, -1.23, "error message %s", "formatted")
Never asserts that the given condition doesn't satisfy in waitFor time,
periodically checking the target function each tick.
assert.Never(t, func() bool { return false; }, time.Second, 10*time.Millisecond)
Neverf asserts that the given condition doesn't satisfy in waitFor time,
periodically checking the target function each tick.
assert.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")
New makes a new Assertions object for the specified TestingT.
Nil asserts that the specified object is nil.
assert.Nil(t, err)
Nilf asserts that the specified object is nil.
assert.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 assert.NoError(t, err) {
assert.Equal(t, expectedObj, actualObj)
}
NoErrorf asserts that a function returned no error (i.e. `nil`).
actualObj, err := SomeFunction()
if assert.NoErrorf(t, 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.
assert.NotContains(t, "Hello World", "Earth")
assert.NotContains(t, ["Hello", "World"], "Earth")
assert.NotContains(t, {"Hello": "World"}, "Earth")
NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the
specified substring or element.
assert.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted")
assert.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted")
assert.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted")
NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified
listB(array, slice...) ignoring the order of the elements. If there are duplicate elements,
the number of appearances of each of them in both lists should not match.
This is an inverse of ElementsMatch.
assert.NotElementsMatch(t, [1, 1, 2, 3], [1, 1, 2, 3]) -> false
assert.NotElementsMatch(t, [1, 1, 2, 3], [1, 2, 3]) -> true
assert.NotElementsMatch(t, [1, 2, 3], [1, 2, 4]) -> true
NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified
listB(array, slice...) ignoring the order of the elements. If there are duplicate elements,
the number of appearances of each of them in both lists should not match.
This is an inverse of ElementsMatch.
assert.NotElementsMatchf(t, [1, 1, 2, 3], [1, 1, 2, 3], "error message %s", "formatted") -> false
assert.NotElementsMatchf(t, [1, 1, 2, 3], [1, 2, 3], "error message %s", "formatted") -> true
assert.NotElementsMatchf(t, [1, 2, 3], [1, 2, 4], "error message %s", "formatted") -> true
NotEmpty asserts that the specified object is NOT [Empty].
if assert.NotEmpty(t, obj) {
assert.Equal(t, "two", obj[1])
}
NotEmptyf asserts that the specified object is NOT [Empty].
if assert.NotEmptyf(t, obj, "error message %s", "formatted") {
assert.Equal(t, "two", obj[1])
}
NotEqual asserts that the specified values are NOT equal.
assert.NotEqual(t, obj1, obj2)
Pointer variable equality is determined based on the equality of the
referenced values (as opposed to the memory addresses).
NotEqualf asserts that the specified values are NOT equal.
assert.NotEqualf(t, obj1, obj2, "error message %s", "formatted")
Pointer variable equality is determined based on the equality of the
referenced values (as opposed to the memory addresses).
NotEqualValues asserts that two objects are not equal even when converted to the same type
assert.NotEqualValues(t, obj1, obj2)
NotEqualValuesf asserts that two objects are not equal even when converted to the same type
assert.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.
assert.NotImplements(t, (*MyInterface)(nil), new(MyObject))
NotImplementsf asserts that an object does not implement the specified interface.
assert.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
NotNil asserts that the specified object is not nil.
assert.NotNil(t, err)
NotNilf asserts that the specified object is not nil.
assert.NotNilf(t, err, "error message %s", "formatted")
NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanics(t, func(){ RemainCalm() })
NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
assert.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted")
NotRegexp asserts that a specified regexp does not match a string.
assert.NotRegexp(t, regexp.MustCompile("starts"), "it's starting")
assert.NotRegexp(t, "^start", "it's not starting")
NotRegexpf asserts that a specified regexp does not match a string.
assert.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted")
assert.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted")
NotSame asserts that two pointers do not reference the same object.
assert.NotSame(t, ptr1, ptr2)
Both arguments must be pointer variables. Pointer variable sameness is
determined based on the equality of both type and value.
NotSamef asserts that two pointers do not reference the same object.
assert.NotSamef(t, ptr1, ptr2, "error message %s", "formatted")
Both arguments must be pointer variables. Pointer variable sameness is
determined based on the equality of both type and value.
NotSubset asserts that the list (array, slice, or map) does NOT contain all
elements given in the subset (array, slice, or map).
Map elements are key-value pairs unless compared with an array or slice where
only the map key is evaluated.
assert.NotSubset(t, [1, 3, 4], [1, 2])
assert.NotSubset(t, {"x": 1, "y": 2}, {"z": 3})
assert.NotSubset(t, [1, 3, 4], {1: "one", 2: "two"})
assert.NotSubset(t, {"x": 1, "y": 2}, ["z"])
NotSubsetf asserts that the list (array, slice, or map) does NOT contain all
elements given in the subset (array, slice, or map).
Map elements are key-value pairs unless compared with an array or slice where
only the map key is evaluated.
assert.NotSubsetf(t, [1, 3, 4], [1, 2], "error message %s", "formatted")
assert.NotSubsetf(t, {"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted")
assert.NotSubsetf(t, [1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted")
assert.NotSubsetf(t, {"x": 1, "y": 2}, ["z"], "error message %s", "formatted")
NotZero asserts that i is not the zero value for its type.
NotZerof asserts that i is not the zero value for its type.
ObjectsAreEqual determines if two objects are considered equal.
This function does no assertion of any kind.
ObjectsAreEqualValues gets whether two objects are equal, or if their
values are equal.
ObjectsExportedFieldsAreEqual determines if the exported (public) fields of two objects are
considered equal. This comparison of only exported fields is applied recursively to nested data
structures.
This function does no assertion of any kind.
Deprecated: Use [EqualExportedValues] instead.
Panics asserts that the code inside the specified PanicTestFunc panics.
assert.Panics(t, func(){ GoCrazy() })
Panicsf asserts that the code inside the specified PanicTestFunc panics.
assert.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.
assert.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.
assert.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.
assert.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.
assert.PanicsWithValuef(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")
Positive asserts that the specified element is positive
assert.Positive(t, 1)
assert.Positive(t, 1.23)
Positivef asserts that the specified element is positive
assert.Positivef(t, 1, "error message %s", "formatted")
assert.Positivef(t, 1.23, "error message %s", "formatted")
Regexp asserts that a specified regexp matches a string.
assert.Regexp(t, regexp.MustCompile("start"), "it's starting")
assert.Regexp(t, "start...$", "it's not starting")
Regexpf asserts that a specified regexp matches a string.
assert.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted")
assert.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted")
Same asserts that two pointers reference the same object.
assert.Same(t, ptr1, ptr2)
Both arguments must be pointer variables. Pointer variable sameness is
determined based on the equality of both type and value.
Samef asserts that two pointers reference the same object.
assert.Samef(t, ptr1, ptr2, "error message %s", "formatted")
Both arguments must be pointer variables. Pointer variable sameness is
determined based on the equality of both type and value.
Subset asserts that the list (array, slice, or map) contains all elements
given in the subset (array, slice, or map).
Map elements are key-value pairs unless compared with an array or slice where
only the map key is evaluated.
assert.Subset(t, [1, 2, 3], [1, 2])
assert.Subset(t, {"x": 1, "y": 2}, {"x": 1})
assert.Subset(t, [1, 2, 3], {1: "one", 2: "two"})
assert.Subset(t, {"x": 1, "y": 2}, ["x"])
Subsetf asserts that the list (array, slice, or map) contains all elements
given in the subset (array, slice, or map).
Map elements are key-value pairs unless compared with an array or slice where
only the map key is evaluated.
assert.Subsetf(t, [1, 2, 3], [1, 2], "error message %s", "formatted")
assert.Subsetf(t, {"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted")
assert.Subsetf(t, [1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted")
assert.Subsetf(t, {"x": 1, "y": 2}, ["x"], "error message %s", "formatted")
True asserts that the specified value is true.
assert.True(t, myBool)
Truef asserts that the specified value is true.
assert.Truef(t, myBool, "error message %s", "formatted")
WithinDuration asserts that the two times are within duration delta of each other.
assert.WithinDuration(t, time.Now(), time.Now(), 10*time.Second)
WithinDurationf asserts that the two times are within duration delta of each other.
assert.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted")
WithinRange asserts that a time is within a time range (inclusive).
assert.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second))
WithinRangef asserts that a time is within a time range (inclusive).
assert.WithinRangef(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted")
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.
Package-Level Variables (only one)
AnError is an error instance useful for testing. If the code does not care
about error specifics, and only needs to return the error for example, this
error should be used to make the test code more readable.
The pages are generated with Goldsv0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.
