Documentation

Overview

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

Example Usage

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

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

Every assertion function also takes an optional string message as the final argument, allowing custom error messages to be appended to the message the assertion method outputs.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Condition

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

Condition uses a Comparison to assert a complex condition.

func Conditionf

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

Conditionf uses a Comparison to assert a complex condition.

func Contains

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

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

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

func Containsf

func Containsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{})

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

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

func DirExists

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

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

func DirExistsf

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

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

func ElementsMatch

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

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

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

func ElementsMatchf

func ElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{})

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

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

func Empty

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

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

assert.Empty(t, obj)

func Emptyf

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

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

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

func Equal

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

Equal asserts that two objects are equal.

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.

func EqualError

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

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

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

func EqualErrorf

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

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

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

func EqualValues

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

EqualValues asserts that two objects are equal or convertable to the same types and equal.

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

func EqualValuesf

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

EqualValuesf asserts that two objects are equal or convertable to the same types and equal.

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

func Equalf

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

Equalf asserts that two objects are equal.

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.

func Error

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

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

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

func ErrorAs

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

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

func ErrorAsf

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

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

func ErrorIs

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

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

func ErrorIsf

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

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

func Errorf

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

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

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

func Eventually

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

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

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

func Eventuallyf

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

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

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

func Exactly

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

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

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

func Exactlyf

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

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

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

func Fail

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

Fail reports a failure through

func FailNow

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

FailNow fails test

func FailNowf

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

FailNowf fails test

func Failf

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

Failf reports a failure through

func False

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

False asserts that the specified value is false.

assert.False(t, myBool)

func Falsef

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

Falsef asserts that the specified value is false.

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

func FileExists

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

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

func FileExistsf

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

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

func Greater

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

Greater asserts that the first element is greater than the second

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

func GreaterOrEqual

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

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

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

func GreaterOrEqualf

func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

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

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

func Greaterf

func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

Greaterf asserts that the first element is greater than the second

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

func HTTPBodyContains

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

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

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

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

func HTTPBodyContainsf

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

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

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

func HTTPBodyNotContains

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

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

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

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

func HTTPBodyNotContainsf

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

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

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

func HTTPError

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

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

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

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

func HTTPErrorf

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

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

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

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

func HTTPRedirect

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

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

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

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

func HTTPRedirectf

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

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

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

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

func HTTPStatusCode

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

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

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

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

func HTTPStatusCodef

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

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

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

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

func HTTPSuccess

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

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

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

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

func HTTPSuccessf

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

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

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

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

func Implements

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

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

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

func Implementsf

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

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

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

func InDelta

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

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

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

func InDeltaMapValues

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

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

func InDeltaMapValuesf

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

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

func InDeltaSlice

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

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

func InDeltaSlicef

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

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

func InDeltaf

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

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

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

func InEpsilon

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

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

func InEpsilonSlice

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

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

func InEpsilonSlicef

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

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

func InEpsilonf

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

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

func IsDecreasing

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

IsDecreasing asserts that the collection is decreasing

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

func IsDecreasingf

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

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

func IsIncreasing

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

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

func IsIncreasingf

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

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

func IsNonDecreasing

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

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

func IsNonDecreasingf

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

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

func IsNonIncreasing

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

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

func IsNonIncreasingf

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

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

func IsType

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

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

func IsTypef

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

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

func JSONEq

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

JSONEq asserts that two JSON strings are equivalent.

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

func JSONEqf

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

JSONEqf asserts that two JSON strings are equivalent.

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

func Len

func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{})

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

assert.Len(t, mySlice, 3)

func Lenf

func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{})

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

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

func Less

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

Less asserts that the first element is less than the second

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

func LessOrEqual

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

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

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

func LessOrEqualf

func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

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

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

func Lessf

func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{})

Lessf asserts that the first element is less than the second

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

func Negative

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

Negative asserts that the specified element is negative

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

func Negativef

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

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

func Never

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

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

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

func Neverf

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

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

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

func Nil

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

Nil asserts that the specified object is nil.

assert.Nil(t, err)

func Nilf

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

Nilf asserts that the specified object is nil.

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

func NoDirExists

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

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

func NoDirExistsf

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

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

func NoError

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

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

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

func NoErrorf

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

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

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

func NoFileExists

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

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

func NoFileExistsf

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

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

func NotContains

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

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

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

func NotContainsf

func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{})

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

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

func NotEmpty

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

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

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

func NotEmptyf

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

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

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

func NotEqual

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

NotEqual asserts that the specified values are NOT equal.

assert.NotEqual(t, obj1, obj2)

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

func NotEqualValues

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

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

assert.NotEqualValues(t, obj1, obj2)

func NotEqualValuesf

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

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

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

func NotEqualf

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

NotEqualf asserts that the specified values are NOT equal.

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

func NotErrorIs

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

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

func NotErrorIsf

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

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

func NotNil

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

NotNil asserts that the specified object is not nil.

assert.NotNil(t, err)

func NotNilf

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

NotNilf asserts that the specified object is not nil.

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

func NotPanics

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

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

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

func NotPanicsf

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

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

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

func NotRegexp

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

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

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

func NotRegexpf

func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{})

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

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

func NotSame

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

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.

func NotSamef

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

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

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.

func NotSubset

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

NotSubset asserts that the specified list(array, slice...) contains not all elements given in the specified subset(array, slice...).

assert.NotSubset(t, [1, 3, 4], [1, 2], "But [1, 3, 4] does not contain [1, 2]")

func NotSubsetf

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

NotSubsetf asserts that the specified list(array, slice...) contains not all elements given in the specified subset(array, slice...).

assert.NotSubsetf(t, [1, 3, 4], [1, 2], "But [1, 3, 4] does not contain [1, 2]", "error message %s", "formatted")

func NotZero

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

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

func NotZerof

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

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

func Panics

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

Panics asserts that the code inside the specified PanicTestFunc panics.

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

func PanicsWithError

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

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

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

func PanicsWithErrorf

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

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

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

func PanicsWithValue

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

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

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

func PanicsWithValuef

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

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

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

func Panicsf

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

Panicsf asserts that the code inside the specified PanicTestFunc panics.

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

func Positive

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

Positive asserts that the specified element is positive

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

func Positivef

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

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

func Regexp

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

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

func Regexpf

func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{})

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

func Same

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

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.

func Samef

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

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.

func Subset

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

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

assert.Subset(t, [1, 2, 3], [1, 2], "But [1, 2, 3] does contain [1, 2]")

func Subsetf

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

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

assert.Subsetf(t, [1, 2, 3], [1, 2], "But [1, 2, 3] does contain [1, 2]", "error message %s", "formatted")

func True

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

True asserts that the specified value is true.

assert.True(t, myBool)

func Truef

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

Truef asserts that the specified value is true.

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

func WithinDuration

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

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

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

func WithinDurationf

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

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

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

func YAMLEq

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

YAMLEq asserts that two YAML strings are equivalent.

func YAMLEqf

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

YAMLEqf asserts that two YAML strings are equivalent.

func Zero

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

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

func Zerof

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

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

Types

type Assertions

type Assertions struct {
	// contains filtered or unexported fields
}

Assertions provides assertion methods around the TestingT interface.

func New

func New(t TestingT) *Assertions

New makes a new Assertions object for the specified TestingT.

func (*Assertions) Condition

func (a *Assertions) Condition(comp assert.Comparison, msgAndArgs ...interface{})

Condition uses a Comparison to assert a complex condition.

func (*Assertions) Conditionf

func (a *Assertions) Conditionf(comp assert.Comparison, msg string, args ...interface{})

Conditionf uses a Comparison to assert a complex condition.

func (*Assertions) Contains

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

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

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

func (*Assertions) Containsf

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

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

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

func (*Assertions) DirExists

func (a *Assertions) DirExists(path string, msgAndArgs ...interface{})

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

func (*Assertions) DirExistsf

func (a *Assertions) DirExistsf(path string, msg string, args ...interface{})

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

func (*Assertions) ElementsMatch

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

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

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

func (*Assertions) ElementsMatchf

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

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

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

func (*Assertions) Empty

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

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

a.Empty(obj)

func (*Assertions) Emptyf

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

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

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

func (*Assertions) Equal

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

Equal asserts that two objects are equal.

a.Equal(123, 123)

Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail.

func (*Assertions) EqualError

func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{})

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

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

func (*Assertions) EqualErrorf

func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...interface{})

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

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

func (*Assertions) EqualValues

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

EqualValues asserts that two objects are equal or convertable to the same types and equal.

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

func (*Assertions) EqualValuesf

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

EqualValuesf asserts that two objects are equal or convertable to the same types and equal.

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

func (*Assertions) Equalf

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

Equalf asserts that two objects are equal.

a.Equalf(123, 123, "error message %s", "formatted")

Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail.

func (*Assertions) Error

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

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

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

func (*Assertions) ErrorAs

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

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

func (*Assertions) ErrorAsf

func (a *Assertions) ErrorAsf(err error, target interface{}, msg string, args ...interface{})

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

func (*Assertions) ErrorIs

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

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

func (*Assertions) ErrorIsf

func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...interface{})

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

func (*Assertions) Errorf

func (a *Assertions) Errorf(err error, msg string, args ...interface{})

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

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

func (*Assertions) Eventually

func (a *Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{})

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

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

func (*Assertions) Eventuallyf

func (a *Assertions) Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{})

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

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

func (*Assertions) Exactly

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

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

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

func (*Assertions) Exactlyf

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

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

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

func (*Assertions) Fail

func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{})

Fail reports a failure through

func (*Assertions) FailNow

func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...interface{})

FailNow fails test

func (*Assertions) FailNowf

func (a *Assertions) FailNowf(failureMessage string, msg string, args ...interface{})

FailNowf fails test

func (*Assertions) Failf

func (a *Assertions) Failf(failureMessage string, msg string, args ...interface{})

Failf reports a failure through

func (*Assertions) False

func (a *Assertions) False(value bool, msgAndArgs ...interface{})

False asserts that the specified value is false.

a.False(myBool)

func (*Assertions) Falsef

func (a *Assertions) Falsef(value bool, msg string, args ...interface{})

Falsef asserts that the specified value is false.

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

func (*Assertions) FileExists

func (a *Assertions) FileExists(path string, msgAndArgs ...interface{})

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

func (*Assertions) FileExistsf

func (a *Assertions) FileExistsf(path string, msg string, args ...interface{})

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

func (*Assertions) Greater

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

Greater asserts that the first element is greater than the second

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

func (*Assertions) GreaterOrEqual

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

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

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

func (*Assertions) GreaterOrEqualf

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

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

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

func (*Assertions) Greaterf

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

Greaterf asserts that the first element is greater than the second

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

func (*Assertions) HTTPBodyContains

func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{})

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

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

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

func (*Assertions) HTTPBodyContainsf

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

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

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

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

func (*Assertions) HTTPBodyNotContains

func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{})

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

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

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

func (*Assertions) HTTPBodyNotContainsf

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

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

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

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

func (*Assertions) HTTPError

func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{})

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

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

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

func (*Assertions) HTTPErrorf

func (a *Assertions) HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{})

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

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

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

func (*Assertions) HTTPRedirect

func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{})

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

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

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

func (*Assertions) HTTPRedirectf

func (a *Assertions) HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{})

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

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

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

func (*Assertions) HTTPStatusCode

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

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

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

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

func (*Assertions) HTTPStatusCodef

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

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

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

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

func (*Assertions) HTTPSuccess

func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{})

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

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

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

func (*Assertions) HTTPSuccessf

func (a *Assertions) HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{})

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

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

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

func (*Assertions) Implements

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

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

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

func (*Assertions) Implementsf

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

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

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

func (*Assertions) InDelta

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

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

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

func (*Assertions) InDeltaMapValues

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

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

func (*Assertions) InDeltaMapValuesf

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

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

func (*Assertions) InDeltaSlice

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

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

func (*Assertions) InDeltaSlicef

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

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

func (*Assertions) InDeltaf

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

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

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

func (*Assertions) InEpsilon

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

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

func (*Assertions) InEpsilonSlice

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

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

func (*Assertions) InEpsilonSlicef

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

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

func (*Assertions) InEpsilonf

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

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

func (*Assertions) IsDecreasing

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

IsDecreasing asserts that the collection is decreasing

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

func (*Assertions) IsDecreasingf

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

IsDecreasingf asserts that the collection is decreasing

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

func (*Assertions) IsIncreasing

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

IsIncreasing asserts that the collection is increasing

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

func (*Assertions) IsIncreasingf

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

IsIncreasingf asserts that the collection is increasing

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

func (*Assertions) IsNonDecreasing

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

IsNonDecreasing asserts that the collection is not decreasing

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

func (*Assertions) IsNonDecreasingf

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

IsNonDecreasingf asserts that the collection is not decreasing

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

func (*Assertions) IsNonIncreasing

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

IsNonIncreasing asserts that the collection is not increasing

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

func (*Assertions) IsNonIncreasingf

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

IsNonIncreasingf asserts that the collection is not increasing

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

func (*Assertions) IsType

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

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

func (*Assertions) IsTypef

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

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

func (*Assertions) JSONEq

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

JSONEq asserts that two JSON strings are equivalent.

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

func (*Assertions) JSONEqf

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

JSONEqf asserts that two JSON strings are equivalent.

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

func (*Assertions) Len

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

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

a.Len(mySlice, 3)

func (*Assertions) Lenf

func (a *Assertions) Lenf(object interface{}, length int, msg string, args ...interface{})

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

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

func (*Assertions) Less

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

Less asserts that the first element is less than the second

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

func (*Assertions) LessOrEqual

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

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

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

func (*Assertions) LessOrEqualf

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

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

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

func (*Assertions) Lessf

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

Lessf asserts that the first element is less than the second

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

func (*Assertions) Negative

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

Negative asserts that the specified element is negative

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

func (*Assertions) Negativef

func (a *Assertions) Negativef(e interface{}, msg string, args ...interface{})

Negativef asserts that the specified element is negative

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

func (*Assertions) Never

func (a *Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{})

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

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

func (*Assertions) Neverf

func (a *Assertions) Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{})

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

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

func (*Assertions) Nil

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

Nil asserts that the specified object is nil.

a.Nil(err)

func (*Assertions) Nilf

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

Nilf asserts that the specified object is nil.

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

func (*Assertions) NoDirExists

func (a *Assertions) NoDirExists(path string, msgAndArgs ...interface{})

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

func (*Assertions) NoDirExistsf

func (a *Assertions) NoDirExistsf(path string, msg string, args ...interface{})

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

func (*Assertions) NoError

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

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

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

func (*Assertions) NoErrorf

func (a *Assertions) NoErrorf(err error, msg string, args ...interface{})

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

func (*Assertions) NoFileExists

func (a *Assertions) NoFileExists(path string, msgAndArgs ...interface{})

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

func (*Assertions) NoFileExistsf

func (a *Assertions) NoFileExistsf(path string, msg string, args ...interface{})

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

func (*Assertions) NotContains

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

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

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

func (*Assertions) NotContainsf

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

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

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

func (*Assertions) NotEmpty

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

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

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

func (*Assertions) NotEmptyf

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

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

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

func (*Assertions) NotEqual

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

NotEqual asserts that the specified values are NOT equal.

a.NotEqual(obj1, obj2)

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

func (*Assertions) NotEqualValues

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

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

a.NotEqualValues(obj1, obj2)

func (*Assertions) NotEqualValuesf

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

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

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

func (*Assertions) NotEqualf

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

NotEqualf asserts that the specified values are NOT equal.

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

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

func (*Assertions) NotErrorIs

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

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

func (*Assertions) NotErrorIsf

func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...interface{})

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

func (*Assertions) NotNil

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

NotNil asserts that the specified object is not nil.

a.NotNil(err)

func (*Assertions) NotNilf

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

NotNilf asserts that the specified object is not nil.

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

func (*Assertions) NotPanics

func (a *Assertions) NotPanics(f assert.PanicTestFunc, msgAndArgs ...interface{})

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

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

func (*Assertions) NotPanicsf

func (a *Assertions) NotPanicsf(f assert.PanicTestFunc, msg string, args ...interface{})

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

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

func (*Assertions) NotRegexp

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

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

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

func (*Assertions) NotRegexpf

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

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

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

func (*Assertions) NotSame

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

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

a.NotSame(ptr1, ptr2)

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

func (*Assertions) NotSamef

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

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

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

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

func (*Assertions) NotSubset

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

NotSubset asserts that the specified list(array, slice...) contains not all elements given in the specified subset(array, slice...).

a.NotSubset([1, 3, 4], [1, 2], "But [1, 3, 4] does not contain [1, 2]")

func (*Assertions) NotSubsetf

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

NotSubsetf asserts that the specified list(array, slice...) contains not all elements given in the specified subset(array, slice...).

a.NotSubsetf([1, 3, 4], [1, 2], "But [1, 3, 4] does not contain [1, 2]", "error message %s", "formatted")

func (*Assertions) NotZero

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

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

func (*Assertions) NotZerof

func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{})

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

func (*Assertions) Panics

func (a *Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...interface{})

Panics asserts that the code inside the specified PanicTestFunc panics.

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

func (*Assertions) PanicsWithError

func (a *Assertions) PanicsWithError(errString string, f assert.PanicTestFunc, msgAndArgs ...interface{})

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

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

func (*Assertions) PanicsWithErrorf

func (a *Assertions) PanicsWithErrorf(errString string, f assert.PanicTestFunc, msg string, args ...interface{})

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

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

func (*Assertions) PanicsWithValue

func (a *Assertions) PanicsWithValue(expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{})

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

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

func (*Assertions) PanicsWithValuef

func (a *Assertions) PanicsWithValuef(expected interface{}, f assert.PanicTestFunc, msg string, args ...interface{})

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

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

func (*Assertions) Panicsf

func (a *Assertions) Panicsf(f assert.PanicTestFunc, msg string, args ...interface{})

Panicsf asserts that the code inside the specified PanicTestFunc panics.

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

func (*Assertions) Positive

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

Positive asserts that the specified element is positive

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

func (*Assertions) Positivef

func (a *Assertions) Positivef(e interface{}, msg string, args ...interface{})

Positivef asserts that the specified element is positive

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

func (*Assertions) Regexp

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

Regexp asserts that a specified regexp matches a string.

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

func (*Assertions) Regexpf

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

Regexpf asserts that a specified regexp matches a string.

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

func (*Assertions) Same

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

Same asserts that two pointers reference the same object.

a.Same(ptr1, ptr2)

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

func (*Assertions) Samef

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

Samef asserts that two pointers reference the same object.

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

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

func (*Assertions) Subset

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

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

a.Subset([1, 2, 3], [1, 2], "But [1, 2, 3] does contain [1, 2]")

func (*Assertions) Subsetf

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

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

a.Subsetf([1, 2, 3], [1, 2], "But [1, 2, 3] does contain [1, 2]", "error message %s", "formatted")

func (*Assertions) True

func (a *Assertions) True(value bool, msgAndArgs ...interface{})

True asserts that the specified value is true.

a.True(myBool)

func (*Assertions) Truef

func (a *Assertions) Truef(value bool, msg string, args ...interface{})

Truef asserts that the specified value is true.

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

func (*Assertions) WithinDuration

func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...interface{})

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

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

func (*Assertions) WithinDurationf

func (a *Assertions) WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{})

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

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

func (*Assertions) YAMLEq

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

YAMLEq asserts that two YAML strings are equivalent.

func (*Assertions) YAMLEqf

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

YAMLEqf asserts that two YAML strings are equivalent.

func (*Assertions) Zero

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

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

func (*Assertions) Zerof

func (a *Assertions) Zerof(i interface{}, msg string, args ...interface{})

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

type BoolAssertionFunc

type BoolAssertionFunc func(TestingT, bool, ...interface{})

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

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

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

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

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

type ComparisonAssertionFunc

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

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

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

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

type args struct {
	x int
	y int
}

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

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

type ErrorAssertionFunc

type ErrorAssertionFunc func(TestingT, error, ...interface{})

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

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

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

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

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

type TestingT

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

TestingT is an interface wrapper around *testing.T

type ValueAssertionFunc

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

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

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

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

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

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