assert

package module

v0.5.0 Latest Latest Go to latest Published: Dec 11, 2024 License: MIT Imports: 7 Imported by: 10

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/negrel/assert

Links

Open Source Insights

README ¶

`assert` - Zero cost debug assertions.

This package provides zero cost debug assertions to your Go programs. It is based on the excellent github.com/stretchr/testify/assert package and provide the same API (minus t testing.T parameter).

Why?

This is a complete rewrite of debuggo that aims to be up to date and more maintainable.

It aims to provide the same API as github.com/stretchr/testify/assert.

Prints friendly, easy to read failure descriptions
Allows for very readable code
Optionally annotate each assertion with a message
No performance impact on production build (see benchmarks)

Debug assertions main use is to assert invariant that can't be encoded in the type systems. For example, a method that should be called only when mutex is locked:

package mypkg

import (
	"sync"
	"github.com/negrel/assert"
)

type myType struct {
	mu sync.Mutex
	// other fields...
}

// doWork perform internal work. Caller must hold mutex while calling this
// function.
func (mt *myType) doWork(k string) {
	assert.Locked(&mt.mu) // panic if assertions are enabled and mutex isn't locked

	// Do work...
}

How does it works?

Read my blog post about to understand how assert works and why it is designed that way.

Getting started

Here is our example program:

package main

import (
	"github.com/negrel/assert"
)

func main() {
	assert.True(false)
	println("Hello world!")
}

A simple go run . will simply print Hello world! as all assert functions are removed by the compiler.

Now, if we compile and run it with assertions enabled go run -tags assert ., it will output something like:

panic:
        Error Trace:    /home/anegrel/code/go/assert/example/main.go:8
                                                /usr/share/go/src/runtime/proc.go:267
                                                /usr/share/go/src/runtime/asm_amd64.s:1650
        Error:          Should be true


goroutine 1 [running]:
github.com/negrel/assert.Fail({0x568dc2, 0xe}, {0x0, 0x0, 0x0})
        /home/anegrel/code/go/assert/assertions.go:349 +0x168
github.com/negrel/assert.True(...)
        /home/anegrel/code/go/assert/assertions.go:754
main.main()
        /home/anegrel/code/go/assert/example/main.go:8 +0x27
exit status 2

Note that most go subcommands (build, run, test, ...) supports -tags flag. You may want to set GOFLAGS environment variable to -tags assert make it permanent and avoid specifying it on each command.

Benchmarks

As we've seen previously, assertions are hidden behind a compilation flag. If the flag is absent, all assertions functions will be empty/noop function that the compiler will optimize.

WITH -tags assert:

goos: linux
goarch: amd64
pkg: github.com/negrel/assert/tests
cpu: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz
BenchmarkSliceIndexWithoutBoundCheckAssertions
BenchmarkSliceIndexWithoutBoundCheckAssertions-8        728439501                1.407 ns/op
BenchmarkSliceIndexWithBoundCheckAssertions
BenchmarkSliceIndexWithBoundCheckAssertions-8           27423670                40.80 ns/op
PASS
ok      github.com/negrel/assert/tests  3.338s

WITHOUT -tags assert:

goos: linux
goarch: amd64
pkg: github.com/negrel/assert/tests
cpu: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz
BenchmarkSliceIndexWithoutBoundCheckAssertions
BenchmarkSliceIndexWithoutBoundCheckAssertions-8        772181695                1.399 ns/op
BenchmarkSliceIndexWithBoundCheckAssertions
BenchmarkSliceIndexWithBoundCheckAssertions-8           802181890                1.412 ns/op
PASS
ok      github.com/negrel/assert/tests  2.531s

However, keep in mind that assert may slightly increase binary size (~100 KiB) as it imports net/http and reflect.

Contributing

If you want to contribute to assert to add a feature or improve the code contact me at negrel.dev@protonmail.com, open an issue or make a pull request.

🌠 Show your support

Please give a ⭐ if this project helped you!

📜 License

MIT © Alexandre Negrel

Documentation ¶

Overview ¶

Package assert provides a set of comprehensive debug assertions.

Example Usage ¶

The following is a complete example using assert in a function:

import (
  "github.com/negrel/assert"
)

func Divide(a, b int) int {
  assert.NotEqual(b, 0, "Can't divide by 0.")
  return a / b
}

Debug Assertions ¶

Debug assertions are programming statements that help developers catch logical errors during development by verifying assumptions about the program's state. They're typically used to check conditions that should always be true during normal program execution. If the condition is false, the assertions is either wrong or there is a programming error. In both case, program panics if it was compiled with the `assert` tags (`go build -tags assert ./path/to/my/package`)

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 ¶

Variables
func CallerInfo()
func Condition(comp Comparison, msgAndArgs ...interface{})
func Conditionf(comp Comparison, msg string, args ...interface{})
func Contains(s, contains interface{}, msgAndArgs ...interface{})
func Containsf(s interface{}, contains interface{}, msg string, args ...interface{})
func DirExists(path string, msgAndArgs ...interface{})
func DirExistsf(path string, msg string, args ...interface{})
func ElementsMatch(listA, listB interface{}, msgAndArgs ...interface{})
func ElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{})
func Empty(object interface{}, msgAndArgs ...interface{})
func Emptyf(object interface{}, msg string, args ...interface{})
func Equal(expected, actual interface{}, msgAndArgs ...interface{})
func EqualError(theError error, errString string, msgAndArgs ...interface{})
func EqualErrorf(theError error, errString string, msg string, args ...interface{})
func EqualExportedValues(expected, actual interface{}, msgAndArgs ...interface{})
func EqualExportedValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})
func EqualValues(expected, actual interface{}, msgAndArgs ...interface{})
func EqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})
func Equalf(expected interface{}, actual interface{}, msg string, args ...interface{})
func Error(err error, msgAndArgs ...interface{})
func ErrorAs(err error, target interface{}, msgAndArgs ...interface{})
func ErrorAsf(err error, target interface{}, msg string, args ...interface{})
func ErrorContains(theError error, contains string, msgAndArgs ...interface{})
func ErrorContainsf(theError error, contains string, msg string, args ...interface{})
func ErrorIs(err, target error, msgAndArgs ...interface{})
func ErrorIsf(err error, target error, msg string, args ...interface{})
func Errorf(err error, msg string, args ...interface{})
func Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, ...)
func Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, ...)
func Exactly(expected, actual interface{}, msgAndArgs ...interface{})
func Exactlyf(expected interface{}, actual interface{}, msg string, args ...interface{})
func Fail(failureMessage string, msgAndArgs ...interface{})
func FailNow(failureMessage string, msgAndArgs ...interface{})
func FailNowf(failureMessage string, msg string, args ...interface{})
func Failf(failureMessage string, msg string, args ...interface{})
func False(value bool, msgAndArgs ...interface{})
func Falsef(value bool, msg string, args ...interface{})
func FileExists(path string, msgAndArgs ...interface{})
func FileExistsf(path string, msg string, args ...interface{})
func Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
func GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
func GreaterOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
func Greaterf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values)
func HTTPBodyContains(handler http.HandlerFunc, method, url string, values url.Values, ...)
func HTTPBodyContainsf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
func HTTPBodyNotContains(handler http.HandlerFunc, method, url string, values url.Values, ...)
func HTTPBodyNotContainsf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
func HTTPError(handler http.HandlerFunc, method, url string, values url.Values, ...)
func HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
func HTTPRedirect(handler http.HandlerFunc, method, url string, values url.Values, ...)
func HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
func HTTPStatusCode(handler http.HandlerFunc, method, url string, values url.Values, ...)
func HTTPStatusCodef(handler http.HandlerFunc, method string, url string, values url.Values, ...)
func HTTPSuccess(handler http.HandlerFunc, method, url string, values url.Values, ...)
func HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, ...)
func Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})
func Implementsf(interfaceObject interface{}, object interface{}, msg string, ...)
func InDelta(expected, actual interface{}, delta float64, msgAndArgs ...interface{})
func InDeltaMapValues(expected, actual interface{}, delta float64, msgAndArgs ...interface{})
func InDeltaMapValuesf(expected interface{}, actual interface{}, delta float64, msg string, ...)
func InDeltaSlice(expected, actual interface{}, delta float64, msgAndArgs ...interface{})
func InDeltaSlicef(expected interface{}, actual interface{}, delta float64, msg string, ...)
func InDeltaf(expected interface{}, actual interface{}, delta float64, msg string, ...)
func InEpsilon(expected, actual interface{}, epsilon float64, msgAndArgs ...interface{})
func InEpsilonSlice(expected, actual interface{}, epsilon float64, msgAndArgs ...interface{})
func InEpsilonSlicef(expected interface{}, actual interface{}, epsilon float64, msg string, ...)
func InEpsilonf(expected interface{}, actual interface{}, epsilon float64, msg string, ...)
func IsDecreasing(object interface{}, msgAndArgs ...interface{})
func IsDecreasingf(object interface{}, msg string, args ...interface{})
func IsIncreasing(object interface{}, msgAndArgs ...interface{})
func IsIncreasingf(object interface{}, msg string, args ...interface{})
func IsNonDecreasing(object interface{}, msgAndArgs ...interface{})
func IsNonDecreasingf(object interface{}, msg string, args ...interface{})
func IsNonIncreasing(object interface{}, msgAndArgs ...interface{})
func IsNonIncreasingf(object interface{}, msg string, args ...interface{})
func IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{})
func IsTypef(expectedType interface{}, object interface{}, msg string, args ...interface{})
func JSONEq(expected string, actual string, msgAndArgs ...interface{})
func JSONEqf(expected string, actual string, msg string, args ...interface{})
func Len(object interface{}, length int, msgAndArgs ...interface{})
func Lenf(object interface{}, length int, msg string, args ...interface{})
func Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
func LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
func LessOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
func Lessf(e1 interface{}, e2 interface{}, msg string, args ...interface{})
func Locked(locker TryLocker, msgAndArgs ...any)
func Lockedf(locker TryLocker, msg string, args ...any)
func Negative(e interface{}, msgAndArgs ...interface{})
func Negativef(e interface{}, msg string, args ...interface{})
func Never(condition func() bool, waitFor time.Duration, tick time.Duration, ...)
func Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, ...)
func Nil(object interface{}, msgAndArgs ...interface{})
func Nilf(object interface{}, msg string, args ...interface{})
func NoDirExists(path string, msgAndArgs ...interface{})
func NoDirExistsf(path string, msg string, args ...interface{})
func NoError(err error, msgAndArgs ...interface{})
func NoErrorf(err error, msg string, args ...interface{})
func NoFileExists(path string, msgAndArgs ...interface{})
func NoFileExistsf(path string, msg string, args ...interface{})
func NotContains(s, contains interface{}, msgAndArgs ...interface{})
func NotContainsf(s interface{}, contains interface{}, msg string, args ...interface{})
func NotElementsMatch(listA, listB interface{}, msgAndArgs ...interface{})
func NotElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{})
func NotEmpty(object interface{}, msgAndArgs ...interface{})
func NotEmptyf(object interface{}, msg string, args ...interface{})
func NotEqual(expected, actual interface{}, msgAndArgs ...interface{})
func NotEqualValues(expected, actual interface{}, msgAndArgs ...interface{})
func NotEqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})
func NotEqualf(expected interface{}, actual interface{}, msg string, args ...interface{})
func NotErrorAs(err error, target interface{}, msgAndArgs ...interface{})
func NotErrorAsf(err error, target interface{}, msg string, args ...interface{})
func NotErrorIs(err, target error, msgAndArgs ...interface{})
func NotErrorIsf(err error, target error, msg string, args ...interface{})
func NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})
func NotImplementsf(interfaceObject interface{}, object interface{}, msg string, ...)
func NotNil(object interface{}, msgAndArgs ...interface{})
func NotNilf(object interface{}, msg string, args ...interface{})
func NotPanics(f PanicTestFunc, msgAndArgs ...interface{})
func NotPanicsf(f PanicTestFunc, msg string, args ...interface{})
func NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{})
func NotRegexpf(rx interface{}, str interface{}, msg string, args ...interface{})
func NotSame(expected, actual interface{}, msgAndArgs ...interface{})
func NotSamef(expected interface{}, actual interface{}, msg string, args ...interface{})
func NotSubset(list, subset interface{}, msgAndArgs ...interface{})
func NotSubsetf(list interface{}, subset interface{}, msg string, args ...interface{})
func NotZero(i interface{}, msgAndArgs ...interface{})
func NotZerof(i interface{}, msg string, args ...interface{})
func ObjectsAreEqual(expected, actual interface{})
func ObjectsAreEqualValues(expected, actual interface{})
func ObjectsExportedFieldsAreEqual(expected, actual interface{})deprecated
func Panics(f PanicTestFunc, msgAndArgs ...interface{})
func PanicsWithError(errString string, f PanicTestFunc, msgAndArgs ...interface{})
func PanicsWithErrorf(errString string, f PanicTestFunc, msg string, args ...interface{})
func PanicsWithValue(expected interface{}, f PanicTestFunc, msgAndArgs ...interface{})
func PanicsWithValuef(expected interface{}, f PanicTestFunc, msg string, args ...interface{})
func Panicsf(f PanicTestFunc, msg string, args ...interface{})
func Positive(e interface{}, msgAndArgs ...interface{})
func Positivef(e interface{}, msg string, args ...interface{})
func Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{})
func Regexpf(rx interface{}, str interface{}, msg string, args ...interface{})
func Same(expected, actual interface{}, msgAndArgs ...interface{})
func Samef(expected interface{}, actual interface{}, msg string, args ...interface{})
func Subset(list, subset interface{}, msgAndArgs ...interface{})
func Subsetf(list interface{}, subset interface{}, msg string, args ...interface{})
func True(value bool, msgAndArgs ...interface{})
func Truef(value bool, msg string, args ...interface{})
func Unlocked(locker TryLocker, msgAndArgs ...any)
func Unlockedf(locker TryLocker, msg string, args ...any)
func WithinDuration(expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{})
func WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, ...)
func WithinRange(actual, start, end time.Time, msgAndArgs ...interface{})
func WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, ...)
func Zero(i interface{}, msgAndArgs ...interface{})
func Zerof(i interface{}, msg string, args ...interface{})
type BoolAssertionFunc
type CollectT
- func (*CollectT) Copy(TestingT)deprecated
- func (c *CollectT) Errorf(format string, args ...interface{})
- func (c *CollectT) FailNow()
- func (*CollectT) Reset()deprecated
type CompareTypedeprecated
type Comparison
type ComparisonAssertionFunc
type ErrorAssertionFunc
type PanicAssertionFunc
type PanicTestFunc
type TestingT
type TryLocker
type ValueAssertionFunc

Constants ¶

This section is empty.

Variables ¶

View Source

var AnError = errors.New("assert.AnError general error for testing")

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.

Functions ¶

func CallerInfo ¶

func CallerInfo()

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.

func Condition ¶

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

Condition uses a Comparison to assert a complex condition.

func Conditionf ¶

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

Conditionf uses a Comparison to assert a complex condition.

func Contains ¶

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

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

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

func Containsf ¶

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

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

func DirExists ¶

func 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 DirExistsf ¶

func 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 ElementsMatch ¶

func ElementsMatch(listA, 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([1, 3, 2, 3], [1, 3, 3, 2])

func ElementsMatchf ¶

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

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

func Empty ¶

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

assert.Empty(obj)

func Emptyf ¶

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

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

func Equal ¶

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

Equal asserts that two objects are equal.

assert.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 EqualError ¶

func 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()
assert.EqualError(err,  expectedErrorString)

func EqualErrorf ¶

func 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()
assert.EqualErrorf(err,  expectedErrorString, "error message %s", "formatted")

func EqualExportedValues ¶

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

EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ.

 type S struct {
	Exported     	int
	notExported   	int
 }
 assert.EqualExportedValues(S{1, 2}, S{1, 3}) => true
 assert.EqualExportedValues(S{1, 2}, S{2, 3}) => false

func EqualExportedValuesf ¶

func EqualExportedValuesf(expected interface{}, actual interface{}, msg string, args ...interface{})

EqualExportedValuesf asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ.

 type S struct {
	Exported     	int
	notExported   	int
 }
 assert.EqualExportedValuesf(S{1, 2}, S{1, 3}, "error message %s", "formatted") => true
 assert.EqualExportedValuesf(S{1, 2}, S{2, 3}, "error message %s", "formatted") => false

func EqualValues ¶

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

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

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

func EqualValuesf ¶

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

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

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

func Equalf ¶

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

Equalf asserts that two objects are equal.

assert.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 Error ¶

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

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

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

func ErrorAs ¶

func 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 ErrorAsf ¶

func 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 ErrorContains ¶

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

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

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

func ErrorContainsf ¶

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

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

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

func ErrorIs ¶

func ErrorIs(err, 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(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(err error, msg string, args ...interface{})

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

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

func Eventually ¶

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

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

func Eventuallyf ¶

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

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

func Exactly ¶

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

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

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

func Exactlyf ¶

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

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

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

func Fail ¶

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

Fail reports a failure through

func FailNow ¶

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

FailNow fails test

func FailNowf ¶

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

FailNowf fails test

func Failf ¶

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

Failf reports a failure through

func False ¶

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

False asserts that the specified value is false.

assert.False(myBool)

func Falsef ¶

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

Falsef asserts that the specified value is false.

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

func FileExists ¶

func 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 FileExistsf ¶

func 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 Greater ¶

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

Greater asserts that the first element is greater than the second

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

func GreaterOrEqual ¶

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

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

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

func GreaterOrEqualf ¶

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

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

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

func Greaterf ¶

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

Greaterf asserts that the first element is greater than the second

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

func HTTPBody ¶

func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values)

HTTPBody is a helper that returns HTTP body of the response. It returns empty string if building a new request fails.