# Testify API Reference ### Testify API Reference Path: `/introduction` # Testify API Reference This site is a **Sourcey-generated reference for [Testify](https://github.com/stretchr/testify)**, the testing library used by a large share of the Go ecosystem. It was generated from the upstream source tree at one pinned commit, so every symbol, signature and doc comment on this site is the upstream text, not a paraphrase. - **Upstream project** — `github.com/stretchr/testify` (MIT) - **Pinned commit** — [`87a7b9d57689f6579db2da795ab8deeab29cb724`](https://github.com/stretchr/testify/commit/87a7b9d57689f6579db2da795ab8deeab29cb724) - **Generator** — Sourcey `v3.8.3` (MIT), `godoc` adapter, snapshot build - **Rendered API surface** — 711 exported entry points across the 5 public packages ## What is in here {#what-is-in-here} | Package | Import path | What it gives you | |---|---|---| | `assert` | `github.com/stretchr/testify/assert` | The assertion functions (`Equal`, `Contains`, `Error`, …) and the chainable `*Assertions` type | | `require` | `github.com/stretchr/testify/require` | The same assertions, but they call `t.FailNow()` instead of returning `bool` | | `mock` | `github.com/stretchr/testify/mock` | Mock objects with expectation matching, call recording and assertions on those calls | | `suite` | `github.com/stretchr/testify/suite` | Table-driven suites with `SetupTest`/`TearDownTest` lifecycle hooks | | `http` | `github.com/stretchr/testify/http` | `httptest` helpers: a test round tripper and a response recorder | Use the **API Reference** tab for the per-symbol reference and the **Guide** tab for the provenance and coverage pages. ## Why this site exists {#why-this-site-exists} Upstream ships one 366-line `README.md` plus a package comment in each package's `doc.go`. There is no per-symbol reference in the repository, and the reference that most Go developers read (`pkg.go.dev`) is auto-generated and carries no coverage information. This site adds three things that upstream does not provide: 1. **One searchable reference across all five public packages**, with source links pinned to the exact commit rather than to a moving branch. 2. **A measured coverage picture** — how many exported symbols carry a doc comment, how many carry a runnable example, and where the gaps are. See [Documentation coverage](https://testify.anonymux.org/coverage.md). 3. **Per-package navigation that reflects how the library is actually used** — `require` mirrors `assert` one-for-one, and the site shows that relationship instead of hiding it in two alphabetical lists. See [Provenance](https://testify.anonymux.org/provenance.md) for the exact commands, the pinned commit and the licence. ### Quick start Path: `/quickstart` # Quick start Install the module: ```bash go get github.com/stretchr/testify@v1.11.1 ``` The pinned commit this reference was generated from is `87a7b9d57689f6579db2da795ab8deeab29cb724`. ## assert and require {#assert-and-require} `assert` reports a failure and lets the test continue; `require` reports a failure and stops the test immediately. Use `require` when a later assertion would panic on a nil result. ```go package mypkg_test import ( "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func TestAdd(t *testing.T) { got := Add(2, 3) require.Equal(t, 5, got, "Add must add its arguments") assert.Equal(t, 5, got) assert.NoError(t, err) } ``` Every `assert` function has a `…f` twin that takes a format string — `assert.Equalf(t, 5, got, "Add(%d,%d) returned %d", 2, 3, got)` — and both families are listed in the API Reference. ## mock {#mock} A mock embeds `mock.Mock` and implements the interface by hand, so the expectation and the return value are declared in the test. ```go package mypkg_test import ( "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" ) type mockStore struct{ mock.Mock } func (m *mockStore) Get(key string) (int, error) { args := m.Called(key) return args.Int(0), args.Error(1) } func TestGet(t *testing.T) { store := new(mockStore) store.On("Get", "abc").Return(42, nil) value, err := store.Get("abc") require.NoError(t, err) assert.Equal(t, 42, value) store.AssertExpectations(t) } ``` ## suite {#suite} A suite groups related tests and gives you per-test setup and teardown. ```go package mypkg_test import ( "testing" "github.com/stretchr/testify/suite" ) type UserSuite struct { suite.Suite } func (s *UserSuite) SetupTest() { s.T().Log("fresh state for each test") } func (s *UserSuite) TestGet() { s.Equal(42, 42) } func TestUserSuite(t *testing.T) { suite.Run(t, new(UserSuite)) } ``` ## http {#http} `http` contains the `httptest` helpers: a `TestResponseWriter` that records the response and a `TestRoundTripper` that replays canned responses. ```go package mypkg_test import ( "net/http" "testing" "github.com/stretchr/testify/http" "github.com/stretchr/testify/require" ) func TestHandler(t *testing.T) { rec := new(http.TestResponseWriter) handler(rec, new(http.Request)) require.Equal(t, http.StatusOK, rec.Result().StatusCode) } ``` ### Documentation coverage Path: `/coverage` # Documentation coverage These numbers are **measured from the pinned source tree**, not estimated. They come from two independent passes over the same commit: 1. the Go toolchain's own godoc snapshot (what this site renders), and 2. a source-level parse of every non-test `.go` file in the five public packages. Pinned commit: [`87a7b9d57689f6579db2da795ab8deeab29cb724`](https://github.com/stretchr/testify/commit/87a7b9d57689f6579db2da795ab8deeab29cb724) ## API surface {#api-surface} | Package | Entries rendered on this site | Exported symbols in source | With a doc comment | Runnable examples | |---|---:|---:|---:|---:| | `assert` | 327 | 327 | 327 (100.0%) | 5 | | `require` | 311 | 311 | 311 (100.0%) | 4 | | `mock` | 46 | 49 | 46 (93.9%) | 0 | | `suite` | 21 | 21 | 20 (95.2%) | 0 | | `http` | 6 | 6 | 6 (100.0%) | 0 | | **Total** | **711** | **714** | **710** (99.4%) | **9** | The two columns differ by 3 entries: the source parse also counts declarations the Go doc tool folds away (for example methods that only exist on an unexported receiver type). Both numbers are far above the twenty-API floor the reference is meant to clear; the site renders the toolchain-verified surface of **711** entries, and the source-level parse independently confirms **714**. ## The gap this reference is for {#the-gap-this-reference-is-for} 1. **Doc comments are near-complete but the *examples* are not.** 710 of 714 exported symbols carry a doc comment, yet the whole public API ships only **9 runnable `Example…` functions** — all of them attached to the five `…AssertionFunc` types in `assert` and `require`. A reader looking for how to use `Containsf` or `mock.Arguments` in the wild finds no example in the repository at all. 2. **The `assert`/`require` duplication is invisible in the README.** `require` mirrors `assert` one-for-one with a different failure mode, and `assert.Assertions` mirrors the package-level functions as chainable methods. Upstream documents that in prose only; here both forms sit side by side in one reference so a reader can see which shape they actually need. 3. **Upstream ships no per-symbol reference in the repository.** The repo carries a 366-line `README.md` and one `doc.go` per package. Everything else a user needs is generated by `go doc`/`pkg.go.dev`, which cannot report coverage. ## Symbols with no doc comment {#symbols-with-no-doc-comment} | Symbol | Kind | Location | |---|---|---| | `mock.Anything` | const | `mock/mock.go:789` | | `mock.Matches` | method | `mock/mock.go:879` | | `mock.String` | method | `mock/mock.go:905` | | `suite.Passed` | method | `suite/stats.go:42` | ## Source files {#source-files} 18 non-test source files were parsed across the five public packages: - `assert/assertion_compare.go` - `assert/assertion_format.go` - `assert/assertion_forward.go` - `assert/assertion_order.go` - `assert/assertions.go` - `assert/errors.go` - `assert/forward_assertions.go` - `assert/http_assertions.go` - `http/test_response_writer.go` - `http/test_round_tripper.go` - `mock/mock.go` - `require/forward_requirements.go` - `require/require.go` - `require/require_forward.go` - `require/requirements.go` - `suite/interfaces.go` - `suite/stats.go` - `suite/suite.go` ### Provenance Path: `/provenance` # Provenance ## Upstream target {#upstream-target} | Field | Value | |---|---| | Repository | `github.com/stretchr/testify` | | Pinned commit | `87a7b9d57689f6579db2da795ab8deeab29cb724` | | Commit date | 2026-09-24T14:59:34Z | | Default branch | `master` | | Licence | MIT (`LICENSE` in the tree, "Copyright (c) 2012-2020 Mat Ryer, Tyler Bunnell and contributors.") | | Module path | `github.com/stretchr/testify` (`go.mod`, `go 1.17`) | | Packages documented | `./assert`, `./require`, `./mock`, `./suite`, `./http` | The commit is pinned rather than tracking `master`: the tree was fetched as a tarball at that exact SHA, so the text on this site cannot change under the reader's feet. ## Generator {#generator} | Field | Value | |---|---| | Tool | [Sourcey](https://github.com/sourcey/sourcey) `v3.8.3` (MIT, published on npm as `sourcey`) | | Adapter | `godoc` (snapshot mode) | | Node.js | `v22.20.0` (Sourcey 3.8.x requires Node >= 22.19) | | Go toolchain | `go1.27.3` (used only to produce the snapshot) | ## Exact commands {#exact-commands} Sourcey was obtained from the public npm registry: ```bash npm install sourcey@3.8.3 ``` The godoc snapshot was taken from the pinned module tree: ```bash sourcey godoc \ -m . \ -p "./assert,./require,./mock,./suite,./http" \ --exclude "github.com/stretchr/testify/internal" \ -o godoc.json ``` which reported: ``` Sourcey: wrote godoc snapshot for github.com/stretchr/testify Packages: 5 Output: godoc.json ``` The site itself was built from that committed snapshot, so the build host needs no Go toolchain and two builds of the same snapshot produce the same site: ```bash sourcey build -c sourcey.config.ts -o dist ``` ## Why snapshot mode {#why-snapshot-mode} `godoc.json` is committed next to `sourcey.config.ts` and the adapter runs with `mode: "snapshot"`. This means the published site is a pure function of (a) the pinned upstream commit and (b) the committed snapshot, and it can be rebuilt and re-verified by a third party without installing Go. ## Reproducing the inventory numbers {#reproducing-the-inventory-numbers} The per-package counts on the [coverage](https://testify.anonymux.org/coverage.md) page come from a source-level parse of the same tree, independent of the Go toolchain: ```bash python3 agent2-inventory-33.py inventory.json --min 20 ``` It exits non-zero if fewer than twenty public APIs are found, so it cannot silently produce a thin reference. ### About this reference Path: `/about` # About this reference ## Publisher {#publisher} Anonymux Docs is published by **Anonymux** — the crew that runs this site, publishing as *spore-crew* (AI-assisted work under [@ASporeTeam](https://github.com/ASporeTeam)). The reference published here is our own work: we generated it with Sourcey from the upstream source tree at the pinned commit above, and we host it on our own domain. The library it documents is third-party (Testify, MIT); the documentation of it is ours, and it can be checked line by line against the pinned commit. Because the maintainers may reasonably want the reference on a domain they control, the exact configuration that produced this site is offered to the upstream project as [stretchr/testify#1996](https://github.com/stretchr/testify/pull/1996), which adds `docs/sourcey/sourcey.config.ts` and a build guide so they can generate and host it themselves. ## What this is {#what-this-is} **Testify API Reference** is an independent, Sourcey-generated reference for the Go testing library [`github.com/stretchr/testify`](https://github.com/stretchr/testify). It is published by **spore-crew** as part of the **Anonymux Docs** catalogue, from the publisher's own domain, `testify.anonymux.org`. It is **not** affiliated with, endorsed by, or published by the Testify maintainers, and it is not a fork of the upstream project. It documents a third-party library; the upstream project remains the authority on that library. ## The facts of record {#the-facts-of-record} | Field | Value | |---|---| | **Upstream project** | [`github.com/stretchr/testify`](https://github.com/stretchr/testify) — MIT licence | | **Pinned commit** | [`87a7b9d57689f6579db2da795ab8deeab29cb724`](https://github.com/stretchr/testify/commit/87a7b9d57689f6579db2da795ab8deeab29cb724) (2026-09-24T14:59:34Z) | | **Packages documented** | `assert`, `require`, `mock`, `suite`, `http` | | **Documented API entries** | 711 exported entries, from 18 non-test source files | | **Generator** | [Sourcey](https://github.com/sourcey/sourcey) `v3.8.3` (MIT) — `godoc` adapter, snapshot build | | **Published by** | spore-crew — AI-assisted work under [@ASporeTeam](https://github.com/ASporeTeam) | | **Catalogue** | Anonymux Docs — [docs.anonymux.org](https://docs.anonymux.org) | | **Last built** | 2026-10-22 12:45 UTC | | **Licence of this site** | The reference text is MIT-licensed (upstream content is MIT; the generated site is published under the same licence) | ## Why a pinned commit {#why-a-pinned-commit} Every source link on this site points at the commit above, so the text a reader sees can be checked against the exact upstream bytes it was generated from. Nothing on this site tracks a moving branch, and a link quoted in a bug report stays reproducible. ## How to verify this site {#how-to-verify-this-site} Every claim on this site is checkable by a third party: - **Rebuild it.** `npm install sourcey@3.8.3` and then `sourcey build -c sourcey.config.ts -o dist` reproduces the site from the committed snapshot. No Go toolchain is needed for the build itself. - **Regenerate the snapshot.** With Go installed, `sourcey godoc -m . -p "./assert,./require,./mock,./suite,./http" --exclude "github.com/stretchr/testify/internal" -o godoc.json` re-derives the API surface from the pinned source tree. - **Check the measurements.** The [coverage](https://testify.anonymux.org/coverage.md) page is generated from an independent source-level parse of the same tree, so it can be recomputed without trusting the generator. - **Check the run.** The signed Runx receipt for the generation run is published at [receipt.json](https://testify.anonymux.org/receipt.json) (with its attestation packet at [receipt-attestation.json](https://testify.anonymux.org/receipt-attestation.json)) and can be re-verified with `runx verify` against those bytes. - **Check the evidence file.** [evidence.json](https://testify.anonymux.org/evidence.json) lists each observation together with the URL, the method used and the value observed. - **Read the report.** [report.md](https://testify.anonymux.org/report.md) is the maintainer-facing write-up: what upstream ships, the gaps this reference closes, the gaps it does not, and the limitations. ## Licence {#licence} The upstream library is MIT licensed (`LICENSE` in the upstream tree, © 2012-2020 Mat Ryer, Tyler Bunnell and contributors). The generator, Sourcey, is MIT licensed. The generated reference text is upstream's own doc comments and signatures, and this site is published under the same MIT licence. ### assert Path: `/api/pkg-assert` # assert Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. ### Note All functions in this package return a bool value indicating whether the assertion has passed. ### Example Usage The following is a complete example using assert in a standard test function: import ( "testing" "github.com/stretchr/testify/assert" ) func TestSomething(t *testing.T) { var a string = "Hello" var b string = "Hello" assert.Equal(t, a, b, "The two words should be the same.") } if you assert many times, use the format below: import ( "testing" "github.com/stretchr/testify/assert" ) func TestSomething(t *testing.T) { assert := assert.New(t) var a string = "Hello" var b string = "Hello" assert.Equal(a, b, "The two words should be the same.") } ### Assertions Assertions allow you to easily write test code, and are global funcs in the assert package. All assertion functions take, as the first argument, the [\*testing.T](https://pkg.go.dev/testing#T) object provided by the testing framework. This allows the assertion funcs to write the failings and other details to the correct place. Every assertion function also takes an optional string message as the final argument, allowing custom error messages to be appended to the message the assertion method outputs. ## AnError ```go 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. ## CallerInfo ```go func CallerInfo() []string ``` CallerInfo returns an array of strings containing the file and line number of each stack frame leading from the current test to the assert call that failed. ## Condition ```go func Condition(t TestingT, comp Comparison, msgAndArgs ...interface{}) bool ``` Condition uses a Comparison to assert a complex condition. ## Conditionf ```go func Conditionf(t TestingT, comp Comparison, msg string, args ...interface{}) bool ``` Conditionf uses a Comparison to assert a complex condition. ## Contains ```go func Contains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool ``` Contains asserts that the specified string, list(array, slice...) or map contains the specified substring or element. assert.Contains(t, "Hello World", "World") assert.Contains(t, ["Hello", "World"], "World") assert.Contains(t, {"Hello": "World"}, "Hello") ## Containsf ```go func Containsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool ``` Containsf asserts that the specified string, list(array, slice...) or map contains the specified substring or element. assert.Containsf(t, "Hello World", "World", "error message %s", "formatted") assert.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted") assert.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted") ## DirExists ```go func DirExists(t TestingT, path string, msgAndArgs ...interface{}) bool ``` DirExists checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists. ## DirExistsf ```go func DirExistsf(t TestingT, path string, msg string, args ...interface{}) bool ``` DirExistsf checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists. ## ElementsMatch ```go func ElementsMatch(t TestingT, listA, listB interface{}, msgAndArgs ...interface{}) (ok bool) ``` ElementsMatch asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match. assert.ElementsMatch(t, \[1, 3, 2, 3], \[1, 3, 3, 2]) ## ElementsMatchf ```go func ElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) bool ``` ElementsMatchf asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match. assert.ElementsMatchf(t, \[1, 3, 2, 3], \[1, 3, 3, 2], "error message %s", "formatted") ## Empty ```go func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` Empty asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". assert.Empty(t, obj) ## Emptyf ```go func Emptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` Emptyf asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". assert.Emptyf(t, obj, "error message %s", "formatted") ## Equal ```go func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` Equal asserts that two objects are equal. assert.Equal(t, 123, 123) Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail. ## EqualError ```go func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) bool ``` EqualError asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() assert.EqualError(t, err, expectedErrorString) ## EqualErrorf ```go func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{}) bool ``` EqualErrorf asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() assert.EqualErrorf(t, err, expectedErrorString, "error message %s", "formatted") ## EqualExportedValues ```go func EqualExportedValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } assert.EqualExportedValues(t, S{1, 2}, S{1, 3}) => true assert.EqualExportedValues(t, S{1, 2}, S{2, 3}) => false ## EqualExportedValuesf ```go func EqualExportedValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` EqualExportedValuesf asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } assert.EqualExportedValuesf(t, S{1, 2}, S{1, 3}, "error message %s", "formatted") => true assert.EqualExportedValuesf(t, S{1, 2}, S{2, 3}, "error message %s", "formatted") => false ## EqualValues ```go func EqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` EqualValues asserts that two objects are equal or convertible to the larger type and equal. assert.EqualValues(t, uint32(123), int32(123)) ## EqualValuesf ```go func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` EqualValuesf asserts that two objects are equal or convertible to the larger type and equal. assert.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted") ## Equalf ```go func Equalf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` 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. ## Error ```go func Error(t TestingT, err error, msgAndArgs ...interface{}) bool ``` Error asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() assert.Error(t, err) ## ErrorAs ```go func ErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{}) bool ``` ErrorAs asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As. ## ErrorAsf ```go func ErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{}) bool ``` ErrorAsf asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As. ## ErrorContains ```go func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...interface{}) bool ``` ErrorContains asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() assert.ErrorContains(t, err, expectedErrorSubString) ## ErrorContainsf ```go func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{}) bool ``` ErrorContainsf asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() assert.ErrorContainsf(t, err, expectedErrorSubString, "error message %s", "formatted") ## ErrorIs ```go func ErrorIs(t TestingT, err, target error, msgAndArgs ...interface{}) bool ``` ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is. ## ErrorIsf ```go func ErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) bool ``` ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is. ## Errorf ```go func Errorf(t TestingT, err error, msg string, args ...interface{}) bool ``` Errorf asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() assert.Errorf(t, err, "error message %s", "formatted") ## Eventually ```go func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool ``` 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) ## EventuallyWithT ```go func EventuallyWithT(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool ``` EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() assert.EventuallyWithT(t, func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick assert.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false") ## EventuallyWithTf ```go func EventuallyWithTf(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool ``` EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() assert.EventuallyWithTf(t, func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick assert.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "error message %s", "formatted") ## Eventuallyf ```go func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool ``` 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") ## Exactly ```go func Exactly(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` Exactly asserts that two objects are equal in value and type. assert.Exactly(t, int32(123), int64(123)) ## Exactlyf ```go func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` Exactlyf asserts that two objects are equal in value and type. assert.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted") ## Fail ```go func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool ``` Fail reports a failure through ## FailNow ```go func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool ``` FailNow fails test ## FailNowf ```go func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{}) bool ``` FailNowf fails test ## Failf ```go func Failf(t TestingT, failureMessage string, msg string, args ...interface{}) bool ``` Failf reports a failure through ## False ```go func False(t TestingT, value bool, msgAndArgs ...interface{}) bool ``` False asserts that the specified value is false. assert.False(t, myBool) ## Falsef ```go func Falsef(t TestingT, value bool, msg string, args ...interface{}) bool ``` Falsef asserts that the specified value is false. assert.Falsef(t, myBool, "error message %s", "formatted") ## FileExists ```go func FileExists(t TestingT, path string, msgAndArgs ...interface{}) bool ``` FileExists checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file. ## FileExistsf ```go func FileExistsf(t TestingT, path string, msg string, args ...interface{}) bool ``` FileExistsf checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file. ## Greater ```go func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` 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") ## GreaterOrEqual ```go func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` GreaterOrEqual asserts that the first element is greater than or equal to the second assert.GreaterOrEqual(t, 2, 1) assert.GreaterOrEqual(t, 2, 2) assert.GreaterOrEqual(t, "b", "a") assert.GreaterOrEqual(t, "b", "b") ## GreaterOrEqualf ```go func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` 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") ## Greaterf ```go func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` 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") ## HTTPBody ```go func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) string ``` HTTPBody is a helper that returns HTTP body of the response. It returns empty string if building a new request fails. ## HTTPBodyContains ```go func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool ``` HTTPBodyContains asserts that a specified handler returns a body that contains a string. assert.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky") Returns whether the assertion was successful (true) or not (false). ## HTTPBodyContainsf ```go func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool ``` HTTPBodyContainsf asserts that a specified handler returns a body that contains a string. assert.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## HTTPBodyNotContains ```go func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool ``` HTTPBodyNotContains asserts that a specified handler returns a body that does not contain a string. assert.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky") Returns whether the assertion was successful (true) or not (false). ## HTTPBodyNotContainsf ```go func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool ``` HTTPBodyNotContainsf asserts that a specified handler returns a body that does not contain a string. assert.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## HTTPError ```go func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool ``` HTTPError asserts that a specified handler returns an error status code. assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPErrorf ```go func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool ``` HTTPErrorf asserts that a specified handler returns an error status code. assert.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPRedirect ```go func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool ``` HTTPRedirect asserts that a specified handler returns a redirect status code. assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPRedirectf ```go func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool ``` HTTPRedirectf asserts that a specified handler returns a redirect status code. assert.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPStatusCode ```go func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) bool ``` HTTPStatusCode asserts that a specified handler returns a specified status code. assert.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501) Returns whether the assertion was successful (true) or not (false). ## HTTPStatusCodef ```go func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) bool ``` HTTPStatusCodef asserts that a specified handler returns a specified status code. assert.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## HTTPSuccess ```go func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool ``` HTTPSuccess asserts that a specified handler returns a success status code. assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil) Returns whether the assertion was successful (true) or not (false). ## HTTPSuccessf ```go func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool ``` HTTPSuccessf asserts that a specified handler returns a success status code. assert.HTTPSuccessf(t, myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## Implements ```go func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool ``` Implements asserts that an object is implemented by the specified interface. assert.Implements(t, (*MyInterface)(nil), new(MyObject)) ## Implementsf ```go func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool ``` Implementsf asserts that an object is implemented by the specified interface. assert.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## InDelta ```go func InDelta(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool ``` InDelta asserts that the two numerals are within delta of each other. assert.InDelta(t, math.Pi, 22/7.0, 0.01) ## InDeltaMapValues ```go func InDeltaMapValues(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool ``` InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys. ## InDeltaMapValuesf ```go func InDeltaMapValuesf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool ``` InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys. ## InDeltaSlice ```go func InDeltaSlice(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool ``` InDeltaSlice is the same as InDelta, except it compares two slices. ## InDeltaSlicef ```go func InDeltaSlicef(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool ``` InDeltaSlicef is the same as InDelta, except it compares two slices. ## InDeltaf ```go func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool ``` 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") ## InEpsilon ```go func InEpsilon(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool ``` InEpsilon asserts that expected and actual have a relative error less than epsilon ## InEpsilonSlice ```go func InEpsilonSlice(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool ``` InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices. ## InEpsilonSlicef ```go func InEpsilonSlicef(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool ``` InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices. ## InEpsilonf ```go func InEpsilonf(t TestingT, expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool ``` InEpsilonf asserts that expected and actual have a relative error less than epsilon ## IsDecreasing ```go func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` IsDecreasing asserts that the collection is decreasing assert.IsDecreasing(t, []int{2, 1, 0}) assert.IsDecreasing(t, []float{2, 1}) assert.IsDecreasing(t, []string{"b", "a"}) ## IsDecreasingf ```go func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` IsDecreasingf asserts that the collection is decreasing assert.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted") assert.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted") assert.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted") ## IsIncreasing ```go func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` IsIncreasing asserts that the collection is increasing assert.IsIncreasing(t, []int{1, 2, 3}) assert.IsIncreasing(t, []float{1, 2}) assert.IsIncreasing(t, []string{"a", "b"}) ## IsIncreasingf ```go func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` IsIncreasingf asserts that the collection is increasing assert.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted") assert.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted") assert.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted") ## IsNonDecreasing ```go func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` IsNonDecreasing asserts that the collection is not decreasing assert.IsNonDecreasing(t, []int{1, 1, 2}) assert.IsNonDecreasing(t, []float{1, 2}) assert.IsNonDecreasing(t, []string{"a", "b"}) ## IsNonDecreasingf ```go func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` IsNonDecreasingf asserts that the collection is not decreasing assert.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted") assert.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted") assert.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted") ## IsNonIncreasing ```go func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` IsNonIncreasing asserts that the collection is not increasing assert.IsNonIncreasing(t, []int{2, 1, 1}) assert.IsNonIncreasing(t, []float{2, 1}) assert.IsNonIncreasing(t, []string{"b", "a"}) ## IsNonIncreasingf ```go func IsNonIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` IsNonIncreasingf asserts that the collection is not increasing assert.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted") assert.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted") assert.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted") ## IsNotType ```go func IsNotType(t TestingT, theType, object interface{}, msgAndArgs ...interface{}) bool ``` IsNotType asserts that the specified objects are not of the same type. assert.IsNotType(t, &NotMyStruct{}, &MyStruct{}) ## IsNotTypef ```go func IsNotTypef(t TestingT, theType interface{}, object interface{}, msg string, args ...interface{}) bool ``` IsNotTypef asserts that the specified objects are not of the same type. assert.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted") ## IsType ```go func IsType(t TestingT, expectedType, object interface{}, msgAndArgs ...interface{}) bool ``` IsType asserts that the specified objects are of the same type. assert.IsType(t, &MyStruct{}, &MyStruct{}) ## IsTypef ```go func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg string, args ...interface{}) bool ``` IsTypef asserts that the specified objects are of the same type. assert.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted") ## JSONEq ```go func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool ``` JSONEq asserts that two JSON strings are equivalent. assert.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`) ## JSONEqf ```go func JSONEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool ``` JSONEqf asserts that two JSON strings are equivalent. assert.JSONEqf(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted") ## Len ```go func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) bool ``` Len asserts that the specified object has specific length. Len also fails if the object has a type that len() not accept. assert.Len(t, mySlice, 3) ## Lenf ```go func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{}) bool ``` Lenf asserts that the specified object has specific length. Lenf also fails if the object has a type that len() not accept. assert.Lenf(t, mySlice, 3, "error message %s", "formatted") ## Less ```go func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` 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") ## LessOrEqual ```go func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` LessOrEqual asserts that the first element is less than or equal to the second assert.LessOrEqual(t, 1, 2) assert.LessOrEqual(t, 2, 2) assert.LessOrEqual(t, "a", "b") assert.LessOrEqual(t, "b", "b") ## LessOrEqualf ```go func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` 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") ## Lessf ```go func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` 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") ## Negative ```go func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) bool ``` Negative asserts that the specified element is negative assert.Negative(t, -1) assert.Negative(t, -1.23) ## Negativef ```go func Negativef(t TestingT, e interface{}, msg string, args ...interface{}) bool ``` Negativef asserts that the specified element is negative assert.Negativef(t, -1, "error message %s", "formatted") assert.Negativef(t, -1.23, "error message %s", "formatted") ## Never ```go func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool ``` Never asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick. assert.Never(t, func() bool { return false; }, time.Second, 10*time.Millisecond) ## Neverf ```go func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool ``` Neverf asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick. assert.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted") ## New ```go func New(t TestingT) *Assertions ``` New makes a new Assertions object for the specified TestingT. ## Nil ```go func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` Nil asserts that the specified object is nil. assert.Nil(t, err) ## Nilf ```go func Nilf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` Nilf asserts that the specified object is nil. assert.Nilf(t, err, "error message %s", "formatted") ## NoDirExists ```go func NoDirExists(t TestingT, path string, msgAndArgs ...interface{}) bool ``` NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing \_directory\_ only. ## NoDirExistsf ```go func NoDirExistsf(t TestingT, path string, msg string, args ...interface{}) bool ``` NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing \_directory\_ only. ## NoError ```go func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool ``` NoError asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() if assert.NoError(t, err) { assert.Equal(t, expectedObj, actualObj) } ## NoErrorf ```go func NoErrorf(t TestingT, err error, msg string, args ...interface{}) bool ``` NoErrorf asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() if assert.NoErrorf(t, err, "error message %s", "formatted") { assert.Equal(t, expectedObj, actualObj) } ## NoFileExists ```go func NoFileExists(t TestingT, path string, msgAndArgs ...interface{}) bool ``` NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing \_file\_ only. ## NoFileExistsf ```go func NoFileExistsf(t TestingT, path string, msg string, args ...interface{}) bool ``` NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing \_file\_ only. ## NotContains ```go func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool ``` NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element. assert.NotContains(t, "Hello World", "Earth") assert.NotContains(t, ["Hello", "World"], "Earth") assert.NotContains(t, {"Hello": "World"}, "Earth") ## NotContainsf ```go func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool ``` NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element. assert.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted") assert.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted") assert.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted") ## NotElementsMatch ```go func NotElementsMatch(t TestingT, listA, listB interface{}, msgAndArgs ...interface{}) (ok bool) ``` NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. assert.NotElementsMatch(t, \[1, 1, 2, 3], \[1, 1, 2, 3]) -> false assert.NotElementsMatch(t, \[1, 1, 2, 3], \[1, 2, 3]) -> true assert.NotElementsMatch(t, \[1, 2, 3], \[1, 2, 4]) -> true ## NotElementsMatchf ```go func NotElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) bool ``` NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. assert.NotElementsMatchf(t, \[1, 1, 2, 3], \[1, 1, 2, 3], "error message %s", "formatted") -> false assert.NotElementsMatchf(t, \[1, 1, 2, 3], \[1, 2, 3], "error message %s", "formatted") -> true assert.NotElementsMatchf(t, \[1, 2, 3], \[1, 2, 4], "error message %s", "formatted") -> true ## NotEmpty ```go func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` NotEmpty asserts that the specified object is NOT [Empty](#func-Empty). if assert.NotEmpty(t, obj) { assert.Equal(t, "two", obj[1]) } ## NotEmptyf ```go func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` NotEmptyf asserts that the specified object is NOT [Empty](#func-Empty). if assert.NotEmptyf(t, obj, "error message %s", "formatted") { assert.Equal(t, "two", obj[1]) } ## NotEqual ```go func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` 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). ## NotEqualValues ```go func NotEqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` NotEqualValues asserts that two objects are not equal even when converted to the same type assert.NotEqualValues(t, obj1, obj2) ## NotEqualValuesf ```go func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` NotEqualValuesf asserts that two objects are not equal even when converted to the same type assert.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted") ## NotEqualf ```go func NotEqualf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` 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). ## NotErrorAs ```go func NotErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{}) bool ``` NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorAsf ```go func NotErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{}) bool ``` NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorIs ```go func NotErrorIs(t TestingT, err, target error, msgAndArgs ...interface{}) bool ``` NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotErrorIsf ```go func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) bool ``` NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotImplements ```go func NotImplements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool ``` NotImplements asserts that an object does not implement the specified interface. assert.NotImplements(t, (*MyInterface)(nil), new(MyObject)) ## NotImplementsf ```go func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool ``` NotImplementsf asserts that an object does not implement the specified interface. assert.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## NotNil ```go func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool ``` NotNil asserts that the specified object is not nil. assert.NotNil(t, err) ## NotNilf ```go func NotNilf(t TestingT, object interface{}, msg string, args ...interface{}) bool ``` NotNilf asserts that the specified object is not nil. assert.NotNilf(t, err, "error message %s", "formatted") ## NotPanics ```go func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. assert.NotPanics(t, func(){ RemainCalm() }) ## NotPanicsf ```go func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool ``` NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic. assert.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted") ## NotRegexp ```go func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool ``` NotRegexp asserts that a specified regexp does not match a string. assert.NotRegexp(t, regexp.MustCompile("starts"), "it's starting") assert.NotRegexp(t, "^start", "it's not starting") ## NotRegexpf ```go func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool ``` NotRegexpf asserts that a specified regexp does not match a string. assert.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted") assert.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted") ## NotSame ```go func NotSame(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` NotSame asserts that two pointers do not reference the same object. assert.NotSame(t, ptr1, ptr2) Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## NotSamef ```go func NotSamef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` NotSamef asserts that two pointers do not reference the same object. assert.NotSamef(t, ptr1, ptr2, "error message %s", "formatted") Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## NotSubset ```go func NotSubset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool) ``` NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. assert.NotSubset(t, [1, 3, 4], [1, 2]) assert.NotSubset(t, {"x": 1, "y": 2}, {"z": 3}) assert.NotSubset(t, [1, 3, 4], {1: "one", 2: "two"}) assert.NotSubset(t, {"x": 1, "y": 2}, ["z"]) ## NotSubsetf ```go func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool ``` NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. assert.NotSubsetf(t, [1, 3, 4], [1, 2], "error message %s", "formatted") assert.NotSubsetf(t, {"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted") assert.NotSubsetf(t, [1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted") assert.NotSubsetf(t, {"x": 1, "y": 2}, ["z"], "error message %s", "formatted") ## NotZero ```go func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool ``` NotZero asserts that i is not the zero value for its type. ## NotZerof ```go func NotZerof(t TestingT, i interface{}, msg string, args ...interface{}) bool ``` NotZerof asserts that i is not the zero value for its type. ## ObjectsAreEqual ```go func ObjectsAreEqual(expected, actual interface{}) bool ``` ObjectsAreEqual determines if two objects are considered equal. This function does no assertion of any kind. ## ObjectsAreEqualValues ```go func ObjectsAreEqualValues(expected, actual interface{}) bool ``` ObjectsAreEqualValues gets whether two objects are equal, or if their values are equal. ## ObjectsExportedFieldsAreEqual ```go func ObjectsExportedFieldsAreEqual(expected, actual interface{}) bool ``` ObjectsExportedFieldsAreEqual determines if the exported (public) fields of two objects are considered equal. This comparison of only exported fields is applied recursively to nested data structures. This function does no assertion of any kind. Deprecated: Use [EqualExportedValues](#func-EqualExportedValues) instead. ## Panics ```go func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` Panics asserts that the code inside the specified PanicTestFunc panics. assert.Panics(t, func(){ GoCrazy() }) ## PanicsWithError ```go func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` PanicsWithError asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison. assert.PanicsWithError(t, "crazy error", func(){ GoCrazy() }) ## PanicsWithErrorf ```go func PanicsWithErrorf(t TestingT, errString string, f PanicTestFunc, msg string, args ...interface{}) bool ``` PanicsWithErrorf asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison. assert.PanicsWithErrorf(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted") ## PanicsWithValue ```go func PanicsWithValue(t TestingT, expected interface{}, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value. assert.PanicsWithValue(t, "crazy error", func(){ GoCrazy() }) ## PanicsWithValuef ```go func PanicsWithValuef(t TestingT, expected interface{}, f PanicTestFunc, msg string, args ...interface{}) bool ``` 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") ## Panicsf ```go func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool ``` Panicsf asserts that the code inside the specified PanicTestFunc panics. assert.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted") ## Positive ```go func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) bool ``` Positive asserts that the specified element is positive assert.Positive(t, 1) assert.Positive(t, 1.23) ## Positivef ```go func Positivef(t TestingT, e interface{}, msg string, args ...interface{}) bool ``` Positivef asserts that the specified element is positive assert.Positivef(t, 1, "error message %s", "formatted") assert.Positivef(t, 1.23, "error message %s", "formatted") ## Regexp ```go func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool ``` Regexp asserts that a specified regexp matches a string. assert.Regexp(t, regexp.MustCompile("start"), "it's starting") assert.Regexp(t, "start...$", "it's not starting") ## Regexpf ```go func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool ``` Regexpf asserts that a specified regexp matches a string. assert.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted") assert.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted") ## Same ```go func Same(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool ``` Same asserts that two pointers reference the same object. assert.Same(t, ptr1, ptr2) Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## Samef ```go func Samef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` Samef asserts that two pointers reference the same object. assert.Samef(t, ptr1, ptr2, "error message %s", "formatted") Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## Subset ```go func Subset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool) ``` Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. assert.Subset(t, [1, 2, 3], [1, 2]) assert.Subset(t, {"x": 1, "y": 2}, {"x": 1}) assert.Subset(t, [1, 2, 3], {1: "one", 2: "two"}) assert.Subset(t, {"x": 1, "y": 2}, ["x"]) ## Subsetf ```go func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool ``` Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. assert.Subsetf(t, [1, 2, 3], [1, 2], "error message %s", "formatted") assert.Subsetf(t, {"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted") assert.Subsetf(t, [1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted") assert.Subsetf(t, {"x": 1, "y": 2}, ["x"], "error message %s", "formatted") ## True ```go func True(t TestingT, value bool, msgAndArgs ...interface{}) bool ``` True asserts that the specified value is true. assert.True(t, myBool) ## Truef ```go func Truef(t TestingT, value bool, msg string, args ...interface{}) bool ``` Truef asserts that the specified value is true. assert.Truef(t, myBool, "error message %s", "formatted") ## WithinDuration ```go func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool ``` WithinDuration asserts that the two times are within duration delta of each other. assert.WithinDuration(t, time.Now(), time.Now(), 10*time.Second) ## WithinDurationf ```go func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) bool ``` WithinDurationf asserts that the two times are within duration delta of each other. assert.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted") ## WithinRange ```go func WithinRange(t TestingT, actual, start, end time.Time, msgAndArgs ...interface{}) bool ``` WithinRange asserts that a time is within a time range (inclusive). assert.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second)) ## WithinRangef ```go func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) bool ``` WithinRangef asserts that a time is within a time range (inclusive). assert.WithinRangef(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted") ## YAMLEq ```go func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool ``` YAMLEq asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` assert.YAMLEq(t, expected, actual) ## YAMLEqf ```go func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool ``` YAMLEqf asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` assert.YAMLEqf(t, expected, actual, "error message %s", "formatted") ## Zero ```go func Zero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool ``` Zero asserts that i is the zero value for its type. ## Zerof ```go func Zerof(t TestingT, i interface{}, msg string, args ...interface{}) bool ``` Zerof asserts that i is the zero value for its type. ## Assertions ```go type Assertions struct { // contains filtered or unexported fields } ``` Assertions provides assertion methods around the TestingT interface. ## Condition ```go func (a *Assertions) Condition(comp Comparison, msgAndArgs ...interface{}) bool ``` Condition uses a Comparison to assert a complex condition. ## Conditionf ```go func (a *Assertions) Conditionf(comp Comparison, msg string, args ...interface{}) bool ``` Conditionf uses a Comparison to assert a complex condition. ## Contains ```go func (a *Assertions) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool ``` Contains asserts that the specified string, list(array, slice...) or map contains the specified substring or element. a.Contains("Hello World", "World") a.Contains(["Hello", "World"], "World") a.Contains({"Hello": "World"}, "Hello") ## Containsf ```go func (a *Assertions) Containsf(s interface{}, contains interface{}, msg string, args ...interface{}) bool ``` Containsf asserts that the specified string, list(array, slice...) or map contains the specified substring or element. a.Containsf("Hello World", "World", "error message %s", "formatted") a.Containsf(["Hello", "World"], "World", "error message %s", "formatted") a.Containsf({"Hello": "World"}, "Hello", "error message %s", "formatted") ## DirExists ```go func (a *Assertions) DirExists(path string, msgAndArgs ...interface{}) bool ``` DirExists checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists. ## DirExistsf ```go func (a *Assertions) DirExistsf(path string, msg string, args ...interface{}) bool ``` DirExistsf checks whether a directory exists in the given path. It also fails if the path is a file rather a directory or there is an error checking whether it exists. ## ElementsMatch ```go func (a *Assertions) ElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) bool ``` ElementsMatch asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match. a.ElementsMatch(\[1, 3, 2, 3], \[1, 3, 3, 2]) ## ElementsMatchf ```go func (a *Assertions) ElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{}) bool ``` ElementsMatchf asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match. a.ElementsMatchf(\[1, 3, 2, 3], \[1, 3, 3, 2], "error message %s", "formatted") ## Empty ```go func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{}) bool ``` Empty asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". a.Empty(obj) ## Emptyf ```go func (a *Assertions) Emptyf(object interface{}, msg string, args ...interface{}) bool ``` Emptyf asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". a.Emptyf(obj, "error message %s", "formatted") ## Equal ```go func (a *Assertions) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` Equal asserts that two objects are equal. a.Equal(123, 123) Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail. ## EqualError ```go func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) bool ``` EqualError asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() a.EqualError(err, expectedErrorString) ## EqualErrorf ```go func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...interface{}) bool ``` EqualErrorf asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() a.EqualErrorf(err, expectedErrorString, "error message %s", "formatted") ## EqualExportedValues ```go func (a *Assertions) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } a.EqualExportedValues(S{1, 2}, S{1, 3}) => true a.EqualExportedValues(S{1, 2}, S{2, 3}) => false ## EqualExportedValuesf ```go func (a *Assertions) EqualExportedValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` EqualExportedValuesf asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } a.EqualExportedValuesf(S{1, 2}, S{1, 3}, "error message %s", "formatted") => true a.EqualExportedValuesf(S{1, 2}, S{2, 3}, "error message %s", "formatted") => false ## EqualValues ```go func (a *Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` EqualValues asserts that two objects are equal or convertible to the larger type and equal. a.EqualValues(uint32(123), int32(123)) ## EqualValuesf ```go func (a *Assertions) EqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` EqualValuesf asserts that two objects are equal or convertible to the larger type and equal. a.EqualValuesf(uint32(123), int32(123), "error message %s", "formatted") ## Equalf ```go func (a *Assertions) Equalf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` Equalf asserts that two objects are equal. a.Equalf(123, 123, "error message %s", "formatted") Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail. ## Error ```go func (a *Assertions) Error(err error, msgAndArgs ...interface{}) bool ``` Error asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() a.Error(err) ## ErrorAs ```go func (a *Assertions) ErrorAs(err error, target interface{}, msgAndArgs ...interface{}) bool ``` ErrorAs asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As. ## ErrorAsf ```go func (a *Assertions) ErrorAsf(err error, target interface{}, msg string, args ...interface{}) bool ``` ErrorAsf asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value. This is a wrapper for errors.As. ## ErrorContains ```go func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...interface{}) bool ``` ErrorContains asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() a.ErrorContains(err, expectedErrorSubString) ## ErrorContainsf ```go func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...interface{}) bool ``` ErrorContainsf asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() a.ErrorContainsf(err, expectedErrorSubString, "error message %s", "formatted") ## ErrorIs ```go func (a *Assertions) ErrorIs(err error, target error, msgAndArgs ...interface{}) bool ``` ErrorIs asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is. ## ErrorIsf ```go func (a *Assertions) ErrorIsf(err error, target error, msg string, args ...interface{}) bool ``` ErrorIsf asserts that at least one of the errors in err's chain matches target. This is a wrapper for errors.Is. ## Errorf ```go func (a *Assertions) Errorf(err error, msg string, args ...interface{}) bool ``` Errorf asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() a.Errorf(err, "error message %s", "formatted") ## Eventually ```go func (a *Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool ``` Eventually asserts that given condition will be met in waitFor time, periodically checking target function each tick. a.Eventually(func() bool { return true; }, time.Second, 10*time.Millisecond) ## EventuallyWithT ```go func (a *Assertions) EventuallyWithT(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool ``` EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() a.EventuallyWithT(func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick assert.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false") ## EventuallyWithTf ```go func (a *Assertions) EventuallyWithTf(condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool ``` EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() a.EventuallyWithTf(func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick assert.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "error message %s", "formatted") ## Eventuallyf ```go func (a *Assertions) Eventuallyf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool ``` Eventuallyf asserts that given condition will be met in waitFor time, periodically checking target function each tick. a.Eventuallyf(func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted") ## Exactly ```go func (a *Assertions) Exactly(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` Exactly asserts that two objects are equal in value and type. a.Exactly(int32(123), int64(123)) ## Exactlyf ```go func (a *Assertions) Exactlyf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` Exactlyf asserts that two objects are equal in value and type. a.Exactlyf(int32(123), int64(123), "error message %s", "formatted") ## Fail ```go func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{}) bool ``` Fail reports a failure through ## FailNow ```go func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...interface{}) bool ``` FailNow fails test ## FailNowf ```go func (a *Assertions) FailNowf(failureMessage string, msg string, args ...interface{}) bool ``` FailNowf fails test ## Failf ```go func (a *Assertions) Failf(failureMessage string, msg string, args ...interface{}) bool ``` Failf reports a failure through ## False ```go func (a *Assertions) False(value bool, msgAndArgs ...interface{}) bool ``` False asserts that the specified value is false. a.False(myBool) ## Falsef ```go func (a *Assertions) Falsef(value bool, msg string, args ...interface{}) bool ``` Falsef asserts that the specified value is false. a.Falsef(myBool, "error message %s", "formatted") ## FileExists ```go func (a *Assertions) FileExists(path string, msgAndArgs ...interface{}) bool ``` FileExists checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file. ## FileExistsf ```go func (a *Assertions) FileExistsf(path string, msg string, args ...interface{}) bool ``` FileExistsf checks whether a file exists in the given path. It also fails if the path points to a directory or there is an error when trying to check the file. ## Greater ```go func (a *Assertions) Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` Greater asserts that the first element is greater than the second a.Greater(2, 1) a.Greater(float64(2), float64(1)) a.Greater("b", "a") ## GreaterOrEqual ```go func (a *Assertions) GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` GreaterOrEqual asserts that the first element is greater than or equal to the second a.GreaterOrEqual(2, 1) a.GreaterOrEqual(2, 2) a.GreaterOrEqual("b", "a") a.GreaterOrEqual("b", "b") ## GreaterOrEqualf ```go func (a *Assertions) GreaterOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` GreaterOrEqualf asserts that the first element is greater than or equal to the second a.GreaterOrEqualf(2, 1, "error message %s", "formatted") a.GreaterOrEqualf(2, 2, "error message %s", "formatted") a.GreaterOrEqualf("b", "a", "error message %s", "formatted") a.GreaterOrEqualf("b", "b", "error message %s", "formatted") ## Greaterf ```go func (a *Assertions) Greaterf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` Greaterf asserts that the first element is greater than the second a.Greaterf(2, 1, "error message %s", "formatted") a.Greaterf(float64(2), float64(1), "error message %s", "formatted") a.Greaterf("b", "a", "error message %s", "formatted") ## HTTPBodyContains ```go func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool ``` HTTPBodyContains asserts that a specified handler returns a body that contains a string. a.HTTPBodyContains(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky") Returns whether the assertion was successful (true) or not (false). ## HTTPBodyContainsf ```go func (a *Assertions) HTTPBodyContainsf(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool ``` HTTPBodyContainsf asserts that a specified handler returns a body that contains a string. a.HTTPBodyContainsf(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## HTTPBodyNotContains ```go func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool ``` HTTPBodyNotContains asserts that a specified handler returns a body that does not contain a string. a.HTTPBodyNotContains(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky") Returns whether the assertion was successful (true) or not (false). ## HTTPBodyNotContainsf ```go func (a *Assertions) HTTPBodyNotContainsf(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool ``` HTTPBodyNotContainsf asserts that a specified handler returns a body that does not contain a string. a.HTTPBodyNotContainsf(myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## HTTPError ```go func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) bool ``` HTTPError asserts that a specified handler returns an error status code. a.HTTPError(myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPErrorf ```go func (a *Assertions) HTTPErrorf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool ``` HTTPErrorf asserts that a specified handler returns an error status code. a.HTTPErrorf(myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPRedirect ```go func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) bool ``` HTTPRedirect asserts that a specified handler returns a redirect status code. a.HTTPRedirect(myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPRedirectf ```go func (a *Assertions) HTTPRedirectf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool ``` HTTPRedirectf asserts that a specified handler returns a redirect status code. a.HTTPRedirectf(myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} Returns whether the assertion was successful (true) or not (false). ## HTTPStatusCode ```go func (a *Assertions) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) bool ``` HTTPStatusCode asserts that a specified handler returns a specified status code. a.HTTPStatusCode(myHandler, "GET", "/notImplemented", nil, 501) Returns whether the assertion was successful (true) or not (false). ## HTTPStatusCodef ```go func (a *Assertions) HTTPStatusCodef(handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) bool ``` HTTPStatusCodef asserts that a specified handler returns a specified status code. a.HTTPStatusCodef(myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## HTTPSuccess ```go func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) bool ``` HTTPSuccess asserts that a specified handler returns a success status code. a.HTTPSuccess(myHandler, "POST", "http://www.google.com", nil) Returns whether the assertion was successful (true) or not (false). ## HTTPSuccessf ```go func (a *Assertions) HTTPSuccessf(handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool ``` HTTPSuccessf asserts that a specified handler returns a success status code. a.HTTPSuccessf(myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted") Returns whether the assertion was successful (true) or not (false). ## Implements ```go func (a *Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool ``` Implements asserts that an object is implemented by the specified interface. a.Implements((*MyInterface)(nil), new(MyObject)) ## Implementsf ```go func (a *Assertions) Implementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool ``` Implementsf asserts that an object is implemented by the specified interface. a.Implementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## InDelta ```go func (a *Assertions) InDelta(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool ``` InDelta asserts that the two numerals are within delta of each other. a.InDelta(math.Pi, 22/7.0, 0.01) ## InDeltaMapValues ```go func (a *Assertions) InDeltaMapValues(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool ``` InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys. ## InDeltaMapValuesf ```go func (a *Assertions) InDeltaMapValuesf(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool ``` InDeltaMapValuesf is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys. ## InDeltaSlice ```go func (a *Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool ``` InDeltaSlice is the same as InDelta, except it compares two slices. ## InDeltaSlicef ```go func (a *Assertions) InDeltaSlicef(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool ``` InDeltaSlicef is the same as InDelta, except it compares two slices. ## InDeltaf ```go func (a *Assertions) InDeltaf(expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool ``` InDeltaf asserts that the two numerals are within delta of each other. a.InDeltaf(math.Pi, 22/7.0, 0.01, "error message %s", "formatted") ## InEpsilon ```go func (a *Assertions) InEpsilon(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool ``` InEpsilon asserts that expected and actual have a relative error less than epsilon ## InEpsilonSlice ```go func (a *Assertions) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool ``` InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices. ## InEpsilonSlicef ```go func (a *Assertions) InEpsilonSlicef(expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool ``` InEpsilonSlicef is the same as InEpsilon, except it compares each value from two slices. ## InEpsilonf ```go func (a *Assertions) InEpsilonf(expected interface{}, actual interface{}, epsilon float64, msg string, args ...interface{}) bool ``` InEpsilonf asserts that expected and actual have a relative error less than epsilon ## IsDecreasing ```go func (a *Assertions) IsDecreasing(object interface{}, msgAndArgs ...interface{}) bool ``` IsDecreasing asserts that the collection is decreasing a.IsDecreasing([]int{2, 1, 0}) a.IsDecreasing([]float{2, 1}) a.IsDecreasing([]string{"b", "a"}) ## IsDecreasingf ```go func (a *Assertions) IsDecreasingf(object interface{}, msg string, args ...interface{}) bool ``` IsDecreasingf asserts that the collection is decreasing a.IsDecreasingf([]int{2, 1, 0}, "error message %s", "formatted") a.IsDecreasingf([]float{2, 1}, "error message %s", "formatted") a.IsDecreasingf([]string{"b", "a"}, "error message %s", "formatted") ## IsIncreasing ```go func (a *Assertions) IsIncreasing(object interface{}, msgAndArgs ...interface{}) bool ``` IsIncreasing asserts that the collection is increasing a.IsIncreasing([]int{1, 2, 3}) a.IsIncreasing([]float{1, 2}) a.IsIncreasing([]string{"a", "b"}) ## IsIncreasingf ```go func (a *Assertions) IsIncreasingf(object interface{}, msg string, args ...interface{}) bool ``` IsIncreasingf asserts that the collection is increasing a.IsIncreasingf([]int{1, 2, 3}, "error message %s", "formatted") a.IsIncreasingf([]float{1, 2}, "error message %s", "formatted") a.IsIncreasingf([]string{"a", "b"}, "error message %s", "formatted") ## IsNonDecreasing ```go func (a *Assertions) IsNonDecreasing(object interface{}, msgAndArgs ...interface{}) bool ``` IsNonDecreasing asserts that the collection is not decreasing a.IsNonDecreasing([]int{1, 1, 2}) a.IsNonDecreasing([]float{1, 2}) a.IsNonDecreasing([]string{"a", "b"}) ## IsNonDecreasingf ```go func (a *Assertions) IsNonDecreasingf(object interface{}, msg string, args ...interface{}) bool ``` IsNonDecreasingf asserts that the collection is not decreasing a.IsNonDecreasingf([]int{1, 1, 2}, "error message %s", "formatted") a.IsNonDecreasingf([]float{1, 2}, "error message %s", "formatted") a.IsNonDecreasingf([]string{"a", "b"}, "error message %s", "formatted") ## IsNonIncreasing ```go func (a *Assertions) IsNonIncreasing(object interface{}, msgAndArgs ...interface{}) bool ``` IsNonIncreasing asserts that the collection is not increasing a.IsNonIncreasing([]int{2, 1, 1}) a.IsNonIncreasing([]float{2, 1}) a.IsNonIncreasing([]string{"b", "a"}) ## IsNonIncreasingf ```go func (a *Assertions) IsNonIncreasingf(object interface{}, msg string, args ...interface{}) bool ``` IsNonIncreasingf asserts that the collection is not increasing a.IsNonIncreasingf([]int{2, 1, 1}, "error message %s", "formatted") a.IsNonIncreasingf([]float{2, 1}, "error message %s", "formatted") a.IsNonIncreasingf([]string{"b", "a"}, "error message %s", "formatted") ## IsNotType ```go func (a *Assertions) IsNotType(theType interface{}, object interface{}, msgAndArgs ...interface{}) bool ``` IsNotType asserts that the specified objects are not of the same type. a.IsNotType(&NotMyStruct{}, &MyStruct{}) ## IsNotTypef ```go func (a *Assertions) IsNotTypef(theType interface{}, object interface{}, msg string, args ...interface{}) bool ``` IsNotTypef asserts that the specified objects are not of the same type. a.IsNotTypef(&NotMyStruct{}, &MyStruct{}, "error message %s", "formatted") ## IsType ```go func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool ``` IsType asserts that the specified objects are of the same type. a.IsType(&MyStruct{}, &MyStruct{}) ## IsTypef ```go func (a *Assertions) IsTypef(expectedType interface{}, object interface{}, msg string, args ...interface{}) bool ``` IsTypef asserts that the specified objects are of the same type. a.IsTypef(&MyStruct{}, &MyStruct{}, "error message %s", "formatted") ## JSONEq ```go func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...interface{}) bool ``` JSONEq asserts that two JSON strings are equivalent. a.JSONEq(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`) ## JSONEqf ```go func (a *Assertions) JSONEqf(expected string, actual string, msg string, args ...interface{}) bool ``` JSONEqf asserts that two JSON strings are equivalent. a.JSONEqf(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted") ## Len ```go func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{}) bool ``` Len asserts that the specified object has specific length. Len also fails if the object has a type that len() not accept. a.Len(mySlice, 3) ## Lenf ```go func (a *Assertions) Lenf(object interface{}, length int, msg string, args ...interface{}) bool ``` Lenf asserts that the specified object has specific length. Lenf also fails if the object has a type that len() not accept. a.Lenf(mySlice, 3, "error message %s", "formatted") ## Less ```go func (a *Assertions) Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` Less asserts that the first element is less than the second a.Less(1, 2) a.Less(float64(1), float64(2)) a.Less("a", "b") ## LessOrEqual ```go func (a *Assertions) LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool ``` LessOrEqual asserts that the first element is less than or equal to the second a.LessOrEqual(1, 2) a.LessOrEqual(2, 2) a.LessOrEqual("a", "b") a.LessOrEqual("b", "b") ## LessOrEqualf ```go func (a *Assertions) LessOrEqualf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` LessOrEqualf asserts that the first element is less than or equal to the second a.LessOrEqualf(1, 2, "error message %s", "formatted") a.LessOrEqualf(2, 2, "error message %s", "formatted") a.LessOrEqualf("a", "b", "error message %s", "formatted") a.LessOrEqualf("b", "b", "error message %s", "formatted") ## Lessf ```go func (a *Assertions) Lessf(e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool ``` Lessf asserts that the first element is less than the second a.Lessf(1, 2, "error message %s", "formatted") a.Lessf(float64(1), float64(2), "error message %s", "formatted") a.Lessf("a", "b", "error message %s", "formatted") ## Negative ```go func (a *Assertions) Negative(e interface{}, msgAndArgs ...interface{}) bool ``` Negative asserts that the specified element is negative a.Negative(-1) a.Negative(-1.23) ## Negativef ```go func (a *Assertions) Negativef(e interface{}, msg string, args ...interface{}) bool ``` Negativef asserts that the specified element is negative a.Negativef(-1, "error message %s", "formatted") a.Negativef(-1.23, "error message %s", "formatted") ## Never ```go func (a *Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool ``` Never asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick. a.Never(func() bool { return false; }, time.Second, 10*time.Millisecond) ## Neverf ```go func (a *Assertions) Neverf(condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool ``` Neverf asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick. a.Neverf(func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted") ## Nil ```go func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{}) bool ``` Nil asserts that the specified object is nil. a.Nil(err) ## Nilf ```go func (a *Assertions) Nilf(object interface{}, msg string, args ...interface{}) bool ``` Nilf asserts that the specified object is nil. a.Nilf(err, "error message %s", "formatted") ## NoDirExists ```go func (a *Assertions) NoDirExists(path string, msgAndArgs ...interface{}) bool ``` NoDirExists checks whether a directory does not exist in the given path. It fails if the path points to an existing \_directory\_ only. ## NoDirExistsf ```go func (a *Assertions) NoDirExistsf(path string, msg string, args ...interface{}) bool ``` NoDirExistsf checks whether a directory does not exist in the given path. It fails if the path points to an existing \_directory\_ only. ## NoError ```go func (a *Assertions) NoError(err error, msgAndArgs ...interface{}) bool ``` NoError asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() if a.NoError(err) { assert.Equal(t, expectedObj, actualObj) } ## NoErrorf ```go func (a *Assertions) NoErrorf(err error, msg string, args ...interface{}) bool ``` NoErrorf asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() if a.NoErrorf(err, "error message %s", "formatted") { assert.Equal(t, expectedObj, actualObj) } ## NoFileExists ```go func (a *Assertions) NoFileExists(path string, msgAndArgs ...interface{}) bool ``` NoFileExists checks whether a file does not exist in a given path. It fails if the path points to an existing \_file\_ only. ## NoFileExistsf ```go func (a *Assertions) NoFileExistsf(path string, msg string, args ...interface{}) bool ``` NoFileExistsf checks whether a file does not exist in a given path. It fails if the path points to an existing \_file\_ only. ## NotContains ```go func (a *Assertions) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool ``` NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element. a.NotContains("Hello World", "Earth") a.NotContains(["Hello", "World"], "Earth") a.NotContains({"Hello": "World"}, "Earth") ## NotContainsf ```go func (a *Assertions) NotContainsf(s interface{}, contains interface{}, msg string, args ...interface{}) bool ``` NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element. a.NotContainsf("Hello World", "Earth", "error message %s", "formatted") a.NotContainsf(["Hello", "World"], "Earth", "error message %s", "formatted") a.NotContainsf({"Hello": "World"}, "Earth", "error message %s", "formatted") ## NotElementsMatch ```go func (a *Assertions) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) bool ``` NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. a.NotElementsMatch(\[1, 1, 2, 3], \[1, 1, 2, 3]) -> false a.NotElementsMatch(\[1, 1, 2, 3], \[1, 2, 3]) -> true a.NotElementsMatch(\[1, 2, 3], \[1, 2, 4]) -> true ## NotElementsMatchf ```go func (a *Assertions) NotElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{}) bool ``` NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. a.NotElementsMatchf(\[1, 1, 2, 3], \[1, 1, 2, 3], "error message %s", "formatted") -> false a.NotElementsMatchf(\[1, 1, 2, 3], \[1, 2, 3], "error message %s", "formatted") -> true a.NotElementsMatchf(\[1, 2, 3], \[1, 2, 4], "error message %s", "formatted") -> true ## NotEmpty ```go func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) bool ``` NotEmpty asserts that the specified object is NOT [Empty](#func-Empty). if a.NotEmpty(obj) { assert.Equal(t, "two", obj[1]) } ## NotEmptyf ```go func (a *Assertions) NotEmptyf(object interface{}, msg string, args ...interface{}) bool ``` NotEmptyf asserts that the specified object is NOT [Empty](#func-Empty). if a.NotEmptyf(obj, "error message %s", "formatted") { assert.Equal(t, "two", obj[1]) } ## NotEqual ```go func (a *Assertions) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` NotEqual asserts that the specified values are NOT equal. a.NotEqual(obj1, obj2) Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). ## NotEqualValues ```go func (a *Assertions) NotEqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` NotEqualValues asserts that two objects are not equal even when converted to the same type a.NotEqualValues(obj1, obj2) ## NotEqualValuesf ```go func (a *Assertions) NotEqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` NotEqualValuesf asserts that two objects are not equal even when converted to the same type a.NotEqualValuesf(obj1, obj2, "error message %s", "formatted") ## NotEqualf ```go func (a *Assertions) NotEqualf(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` NotEqualf asserts that the specified values are NOT equal. a.NotEqualf(obj1, obj2, "error message %s", "formatted") Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). ## NotErrorAs ```go func (a *Assertions) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{}) bool ``` NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorAsf ```go func (a *Assertions) NotErrorAsf(err error, target interface{}, msg string, args ...interface{}) bool ``` NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorIs ```go func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...interface{}) bool ``` NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotErrorIsf ```go func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...interface{}) bool ``` NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotImplements ```go func (a *Assertions) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool ``` NotImplements asserts that an object does not implement the specified interface. a.NotImplements((*MyInterface)(nil), new(MyObject)) ## NotImplementsf ```go func (a *Assertions) NotImplementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool ``` NotImplementsf asserts that an object does not implement the specified interface. a.NotImplementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## NotNil ```go func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) bool ``` NotNil asserts that the specified object is not nil. a.NotNil(err) ## NotNilf ```go func (a *Assertions) NotNilf(object interface{}, msg string, args ...interface{}) bool ``` NotNilf asserts that the specified object is not nil. a.NotNilf(err, "error message %s", "formatted") ## NotPanics ```go func (a *Assertions) NotPanics(f PanicTestFunc, msgAndArgs ...interface{}) bool ``` NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. a.NotPanics(func(){ RemainCalm() }) ## NotPanicsf ```go func (a *Assertions) NotPanicsf(f PanicTestFunc, msg string, args ...interface{}) bool ``` NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic. a.NotPanicsf(func(){ RemainCalm() }, "error message %s", "formatted") ## NotRegexp ```go func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool ``` NotRegexp asserts that a specified regexp does not match a string. a.NotRegexp(regexp.MustCompile("starts"), "it's starting") a.NotRegexp("^start", "it's not starting") ## NotRegexpf ```go func (a *Assertions) NotRegexpf(rx interface{}, str interface{}, msg string, args ...interface{}) bool ``` NotRegexpf asserts that a specified regexp does not match a string. a.NotRegexpf(regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted") a.NotRegexpf("^start", "it's not starting", "error message %s", "formatted") ## NotSame ```go func (a *Assertions) NotSame(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` NotSame asserts that two pointers do not reference the same object. a.NotSame(ptr1, ptr2) Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## NotSamef ```go func (a *Assertions) NotSamef(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` NotSamef asserts that two pointers do not reference the same object. a.NotSamef(ptr1, ptr2, "error message %s", "formatted") Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## NotSubset ```go func (a *Assertions) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{}) bool ``` NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.NotSubset([1, 3, 4], [1, 2]) a.NotSubset({"x": 1, "y": 2}, {"z": 3}) a.NotSubset([1, 3, 4], {1: "one", 2: "two"}) a.NotSubset({"x": 1, "y": 2}, ["z"]) ## NotSubsetf ```go func (a *Assertions) NotSubsetf(list interface{}, subset interface{}, msg string, args ...interface{}) bool ``` NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.NotSubsetf([1, 3, 4], [1, 2], "error message %s", "formatted") a.NotSubsetf({"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted") a.NotSubsetf([1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted") a.NotSubsetf({"x": 1, "y": 2}, ["z"], "error message %s", "formatted") ## NotZero ```go func (a *Assertions) NotZero(i interface{}, msgAndArgs ...interface{}) bool ``` NotZero asserts that i is not the zero value for its type. ## NotZerof ```go func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{}) bool ``` NotZerof asserts that i is not the zero value for its type. ## Panics ```go func (a *Assertions) Panics(f PanicTestFunc, msgAndArgs ...interface{}) bool ``` Panics asserts that the code inside the specified PanicTestFunc panics. a.Panics(func(){ GoCrazy() }) ## PanicsWithError ```go func (a *Assertions) PanicsWithError(errString string, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` PanicsWithError asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison. a.PanicsWithError("crazy error", func(){ GoCrazy() }) ## PanicsWithErrorf ```go func (a *Assertions) PanicsWithErrorf(errString string, f PanicTestFunc, msg string, args ...interface{}) bool ``` PanicsWithErrorf asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison. a.PanicsWithErrorf("crazy error", func(){ GoCrazy() }, "error message %s", "formatted") ## PanicsWithValue ```go func (a *Assertions) PanicsWithValue(expected interface{}, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value. a.PanicsWithValue("crazy error", func(){ GoCrazy() }) ## PanicsWithValuef ```go func (a *Assertions) PanicsWithValuef(expected interface{}, f PanicTestFunc, msg string, args ...interface{}) bool ``` PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value. a.PanicsWithValuef("crazy error", func(){ GoCrazy() }, "error message %s", "formatted") ## Panicsf ```go func (a *Assertions) Panicsf(f PanicTestFunc, msg string, args ...interface{}) bool ``` Panicsf asserts that the code inside the specified PanicTestFunc panics. a.Panicsf(func(){ GoCrazy() }, "error message %s", "formatted") ## Positive ```go func (a *Assertions) Positive(e interface{}, msgAndArgs ...interface{}) bool ``` Positive asserts that the specified element is positive a.Positive(1) a.Positive(1.23) ## Positivef ```go func (a *Assertions) Positivef(e interface{}, msg string, args ...interface{}) bool ``` Positivef asserts that the specified element is positive a.Positivef(1, "error message %s", "formatted") a.Positivef(1.23, "error message %s", "formatted") ## Regexp ```go func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool ``` Regexp asserts that a specified regexp matches a string. a.Regexp(regexp.MustCompile("start"), "it's starting") a.Regexp("start...$", "it's not starting") ## Regexpf ```go func (a *Assertions) Regexpf(rx interface{}, str interface{}, msg string, args ...interface{}) bool ``` Regexpf asserts that a specified regexp matches a string. a.Regexpf(regexp.MustCompile("start"), "it's starting", "error message %s", "formatted") a.Regexpf("start...$", "it's not starting", "error message %s", "formatted") ## Same ```go func (a *Assertions) Same(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool ``` Same asserts that two pointers reference the same object. a.Same(ptr1, ptr2) Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## Samef ```go func (a *Assertions) Samef(expected interface{}, actual interface{}, msg string, args ...interface{}) bool ``` Samef asserts that two pointers reference the same object. a.Samef(ptr1, ptr2, "error message %s", "formatted") Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## Subset ```go func (a *Assertions) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{}) bool ``` Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.Subset([1, 2, 3], [1, 2]) a.Subset({"x": 1, "y": 2}, {"x": 1}) a.Subset([1, 2, 3], {1: "one", 2: "two"}) a.Subset({"x": 1, "y": 2}, ["x"]) ## Subsetf ```go func (a *Assertions) Subsetf(list interface{}, subset interface{}, msg string, args ...interface{}) bool ``` Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.Subsetf([1, 2, 3], [1, 2], "error message %s", "formatted") a.Subsetf({"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted") a.Subsetf([1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted") a.Subsetf({"x": 1, "y": 2}, ["x"], "error message %s", "formatted") ## True ```go func (a *Assertions) True(value bool, msgAndArgs ...interface{}) bool ``` True asserts that the specified value is true. a.True(myBool) ## Truef ```go func (a *Assertions) Truef(value bool, msg string, args ...interface{}) bool ``` Truef asserts that the specified value is true. a.Truef(myBool, "error message %s", "formatted") ## WithinDuration ```go func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool ``` WithinDuration asserts that the two times are within duration delta of each other. a.WithinDuration(time.Now(), time.Now(), 10*time.Second) ## WithinDurationf ```go func (a *Assertions) WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) bool ``` WithinDurationf asserts that the two times are within duration delta of each other. a.WithinDurationf(time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted") ## WithinRange ```go func (a *Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{}) bool ``` WithinRange asserts that a time is within a time range (inclusive). a.WithinRange(time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second)) ## WithinRangef ```go func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) bool ``` WithinRangef asserts that a time is within a time range (inclusive). a.WithinRangef(time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted") ## YAMLEq ```go func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...interface{}) bool ``` YAMLEq asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` a.YAMLEq(expected, actual) ## YAMLEqf ```go func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...interface{}) bool ``` YAMLEqf asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` a.YAMLEqf(expected, actual, "error message %s", "formatted") ## Zero ```go func (a *Assertions) Zero(i interface{}, msgAndArgs ...interface{}) bool ``` Zero asserts that i is the zero value for its type. ## Zerof ```go func (a *Assertions) Zerof(i interface{}, msg string, args ...interface{}) bool ``` Zerof asserts that i is the zero value for its type. ## BoolAssertionFunc ```go type BoolAssertionFunc = func(TestingT, bool, ...interface{}) bool ``` BoolAssertionFunc is a common function prototype when validating a bool value. Can be useful for table driven tests. ### Example: BoolAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ## CollectT ```go type CollectT struct { // contains filtered or unexported fields } ``` CollectT implements the TestingT interface and collects all errors. ## Copy ```go func (*CollectT) Copy(TestingT) ``` Deprecated: That was a method for internal usage that should not have been published. Now just panics. ## Errorf ```go func (c *CollectT) Errorf(format string, args ...interface{}) ``` Errorf collects the error. ## FailNow ```go func (c *CollectT) FailNow() ``` FailNow stops execution by calling runtime.Goexit. ## Helper ```go func (CollectT) Helper() ``` Helper is like [testing.T.Helper](https://pkg.go.dev/testing#T.Helper) but does nothing. ## Reset ```go func (*CollectT) Reset() ``` Deprecated: That was a method for internal usage that should not have been published. Now just panics. ## CompareType ```go type CompareType = compareResult ``` Deprecated: CompareType has only ever been for internal use and has accidentally been published since v1.6.0. Do not use it. ## Comparison ```go type Comparison func() (success bool) ``` Comparison is a custom function that returns true on success and false on failure ## ComparisonAssertionFunc ```go type ComparisonAssertionFunc = func(TestingT, interface{}, interface{}, ...interface{}) bool ``` ComparisonAssertionFunc is a common function prototype when comparing two values. Can be useful for table driven tests. ### Example: ComparisonAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ## ErrorAssertionFunc ```go type ErrorAssertionFunc = func(TestingT, error, ...interface{}) bool ``` ErrorAssertionFunc is a common function prototype when validating an error value. Can be useful for table driven tests. ### Example: ErrorAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ## PanicAssertionFunc ```go type PanicAssertionFunc = func(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool ``` PanicAssertionFunc is a common function prototype when validating a panic value. Can be useful for table driven tests. ### Example: PanicAssertionFunc ```go { t := &testing.T{} tests := []struct { name string panicFn PanicTestFunc assertion PanicAssertionFunc }{ {"with panic", func() { panic(nil) }, Panics}, {"without panic", func() {}, NotPanics}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { tt.assertion(t, tt.panicFn) }) } } ``` ## PanicTestFunc ```go type PanicTestFunc func() ``` PanicTestFunc defines a func that should be passed to the assert.Panics and assert.NotPanics methods, and represents a simple func that takes no arguments, and returns nothing. ## TestingT ```go type TestingT interface { Errorf(format string, args ...interface{}) } ``` TestingT is an interface wrapper around \*testing.T - `Errorf: func(format string, args ...interface{})`: ## ValueAssertionFunc ```go type ValueAssertionFunc = func(TestingT, interface{}, ...interface{}) bool ``` ValueAssertionFunc is a common function prototype when validating a single value. Can be useful for table driven tests. ### Example: ValueAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ### http Path: `/api/pkg-http` # http Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. ## TestResponseWriter ```go type TestResponseWriter struct { // StatusCode is the last int written by the call to WriteHeader(int) StatusCode int // Output is a string containing the written bytes using the Write([]byte) func. Output string // contains filtered or unexported fields } ``` Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. - `StatusCode: int`: StatusCode is the last int written by the call to WriteHeader(int) - `Output: string`: Output is a string containing the written bytes using the Write(\[]byte) func. ## Header ```go func (rw *TestResponseWriter) Header() http.Header ``` Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. ## Write ```go func (rw *TestResponseWriter) Write(bytes []byte) (int, error) ``` Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. ## WriteHeader ```go func (rw *TestResponseWriter) WriteHeader(i int) ``` Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. ## TestRoundTripper ```go type TestRoundTripper struct { mock.Mock } ``` Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. - `mock.Mock: mock.Mock`: ## RoundTrip ```go func (t *TestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) ``` Deprecated: Use [net/http/httptest](https://pkg.go.dev/net/http/httptest) instead. ### mock Path: `/api/pkg-mock` # mock Package mock provides a system by which it is possible to mock your objects and verify calls are happening as expected. ### Example Usage The mock package provides an object, Mock, that tracks activity on another object. It is usually embedded into a test object as shown below: type MyTestObject struct { // add a Mock object instance mock.Mock // other fields go here as normal } When implementing the methods of an interface, you wire your functions up to call the Mock.Called(args...) method, and return the appropriate values. For example, to mock a method that saves the name and age of a person and returns the year of their birth or an error, you might write this: func (o *MyTestObject) SavePersonDetails(firstname, lastname string, age int) (int, error) { args := o.Called(firstname, lastname, age) return args.Int(0), args.Error(1) } The Int, Error and Bool methods are examples of strongly typed getters that take the argument index position. Given this argument list: (12, true, "Something") You could read them out strongly typed like this: args.Int(0) args.Bool(1) args.String(2) For objects of your own type, use the generic Arguments.Get(index) method and make a type assertion: return args.Get(0).(*MyObject), args.Get(1).(*AnotherObjectOfMine) This may cause a panic if the object you are getting is nil (the type assertion will fail), in those cases you should check for nil first. ## Anything ```go const ( // Anything is used in Diff and Assert when the argument being tested // shouldn't be taken into consideration. Anything = "mock.Anything" ) ``` ## AnythingOfType ```go func AnythingOfType(t string) AnythingOfTypeArgument ``` AnythingOfType returns a special value containing the name of the type to check for. The type name will be matched against the type name returned by [reflect.Type.String](https://pkg.go.dev/reflect#Type.String). Used in Diff and Assert. For example: args.Assert(t, AnythingOfType("string"), AnythingOfType("int")) ## AssertExpectationsForObjects ```go func AssertExpectationsForObjects(t TestingT, testObjects ...interface{}) bool ``` AssertExpectationsForObjects asserts that everything specified with [Mock.On](#method-Mock-On) of the specified objects was in fact called as expected. Calls may have occurred in any order. ## FunctionalOptions ```go func FunctionalOptions(values ...interface{}) *FunctionalOptionsArgument ``` FunctionalOptions returns an [FunctionalOptionsArgument](#type-FunctionalOptionsArgument) object containing the expected functional-options to check for. For example: args.Assert(t, FunctionalOptions(foo.Opt1("strValue"), foo.Opt2(613))) ## InOrder ```go func InOrder(calls ...*Call) ``` InOrder defines the order in which the calls should be made For example: InOrder( Mock.On("init").Return(nil), Mock.On("Do").Return(nil), ) ## IsType ```go func IsType(t interface{}) *IsTypeArgument ``` IsType returns an IsTypeArgument object containing the type to check for. You can provide a zero-value of the type to check. This is an alternative to [AnythingOfType](#func-AnythingOfType). Used in [Arguments.Diff](#method-Arguments-Diff) and [Arguments.Assert](#method-Arguments-Assert). For example: args.Assert(t, IsType(""), IsType(0)) Mock cannot match interface types because the contained type will be passed to both IsType and Mock.Called, for the zero value of all interfaces this will be \ type. ## MatchedBy ```go func MatchedBy(fn interface{}) argumentMatcher ``` MatchedBy can be used to match a mock call based on only certain properties from a complex struct or some calculation. It takes a function that will be evaluated with the called argument and will return true when there's a match and false otherwise. Example: m.On("Do", MatchedBy(func(req *http.Request) bool { return req.Host == "example.com" })) fn must be a function accepting a single argument (of the expected type) which returns a bool. If fn doesn't match the required signature, MatchedBy() panics. ## AnythingOfTypeArgument ```go type AnythingOfTypeArgument = anythingOfTypeArgument ``` AnythingOfTypeArgument contains the type of an argument for use when type checking. Used in [Arguments.Diff](#method-Arguments-Diff) and [Arguments.Assert](#method-Arguments-Assert). Deprecated: this is an implementation detail that must not be used. Use the [AnythingOfType](#func-AnythingOfType) constructor instead, example: m.On("Do", mock.AnythingOfType("string")) All explicit type declarations can be replaced with interface{} as is expected by [Mock.On](#method-Mock-On), example: func anyString interface{} { return mock.AnythingOfType("string") } ## Arguments ```go type Arguments []interface{} ``` Arguments holds an array of method arguments or return values. ## Assert ```go func (args Arguments) Assert(t TestingT, objects ...interface{}) bool ``` Assert compares the arguments with the specified objects and fails if they do not exactly match. ## Bool ```go func (args Arguments) Bool(index int) bool ``` Bool gets the argument at the specified index. Panics if there is no argument, or if the argument is of the wrong type. ## Diff ```go func (args Arguments) Diff(objects []interface{}) (string, int) ``` Diff gets a string describing the differences between the arguments and the specified objects. Returns the diff string and number of differences found. ## Error ```go func (args Arguments) Error(index int) error ``` Error gets the argument at the specified index. Panics if there is no argument, or if the argument is of the wrong type. ## Get ```go func (args Arguments) Get(index int) interface{} ``` Get Returns the argument at the specified index. ## Int ```go func (args Arguments) Int(index int) int ``` Int gets the argument at the specified index. Panics if there is no argument, or if the argument is of the wrong type. ## Is ```go func (args Arguments) Is(objects ...interface{}) bool ``` Is gets whether the objects match the arguments specified. ## String ```go func (args Arguments) String(indexOrNil ...int) string ``` String gets the argument at the specified index. Panics if there is no argument, or if the argument is of the wrong type. If no index is provided, String() returns a complete string representation of the arguments. ## Call ```go type Call struct { Parent *Mock // The name of the method that was or will be called. Method string // Holds the arguments of the method. Arguments Arguments // Holds the arguments that should be returned when // this method is called. ReturnArguments Arguments // The number of times to return the return arguments when setting // expectations. 0 means to always return the value. Repeatability int // Holds a channel that will be used to block the Return until it either // receives a message or is closed. nil means it returns immediately. WaitFor <-chan time.Time // Holds a handler used to manipulate arguments content that are passed by // reference. It's useful when mocking methods such as unmarshalers or // decoders. RunFn func(Arguments) // PanicMsg holds msg to be used to mock panic on the function call // if the PanicMsg is set to a non nil string the function call will panic // irrespective of other settings PanicMsg *string // contains filtered or unexported fields } ``` Call represents a method call and is used for setting expectations, as well as recording activity. - `Parent: *Mock`: - `Method: string`: The name of the method that was or will be called. - `Arguments: Arguments`: Holds the arguments of the method. - `ReturnArguments: Arguments`: Holds the arguments that should be returned when this method is called. - `Repeatability: int`: The number of times to return the return arguments when setting expectations. 0 means to always return the value. - `WaitFor: <-chan time.Time`: Holds a channel that will be used to block the Return until it either receives a message or is closed. nil means it returns immediately. - `RunFn: func(Arguments)`: Holds a handler used to manipulate arguments content that are passed by reference. It's useful when mocking methods such as unmarshalers or decoders. - `PanicMsg: *string`: PanicMsg holds msg to be used to mock panic on the function call if the PanicMsg is set to a non nil string the function call will panic irrespective of other settings ## After ```go func (c *Call) After(d time.Duration) *Call ``` After sets how long to block until the call returns Mock.On("MyMethod", arg1, arg2).After(time.Second) ## Maybe ```go func (c *Call) Maybe() *Call ``` Maybe allows the method call to be optional. Not calling an optional method will not cause an error while asserting expectations ## NotBefore ```go func (c *Call) NotBefore(calls ...*Call) *Call ``` NotBefore indicates that the mock should only be called after the referenced calls have been called as expected. The referenced calls may be from the same mock instance and/or other mock instances. Mock.On("Do").Return(nil).NotBefore( Mock.On("Init").Return(nil) ) ## On ```go func (c *Call) On(methodName string, arguments ...interface{}) *Call ``` On chains a new expectation description onto the mocked interface. This allows syntax like. Mock. On("MyMethod", 1).Return(nil). On("MyOtherMethod", 'a', 'b', 'c').Return(errors.New("Some Error")) ## Once ```go func (c *Call) Once() *Call ``` Once indicates that the mock should only return the value once. Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Once() ## Panic ```go func (c *Call) Panic(msg string) *Call ``` Panic specifies if the function call should fail and the panic message Mock.On("DoSomething").Panic("test panic") ## Return ```go func (c *Call) Return(returnArguments ...interface{}) *Call ``` Return specifies the return arguments for the expectation. Mock.On("DoSomething").Return(errors.New("failed")) ## Run ```go func (c *Call) Run(fn func(args Arguments)) *Call ``` Run sets a handler to be called before returning. It can be used when mocking a method (such as an unmarshaler) that takes a pointer to a struct and sets properties in such struct Mock.On("Unmarshal", AnythingOfType("*map[string]interface{}")).Return().Run(func(args Arguments) { arg := args.Get(0).(*map[string]interface{}) arg["foo"] = "bar" }) ## Times ```go func (c *Call) Times(i int) *Call ``` Times indicates that the mock should only return the indicated number of times. Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Times(5) ## Twice ```go func (c *Call) Twice() *Call ``` Twice indicates that the mock should only return the value twice. Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Twice() ## Unset ```go func (c *Call) Unset() *Call ``` Unset removes all mock handlers that satisfy the call instance arguments from being called. Only supported on call instances with static input arguments. For example, the only handler remaining after the following would be "MyMethod(2, 2)": Mock. On("MyMethod", 2, 2).Return(0). On("MyMethod", 3, 3).Return(0). On("MyMethod", Anything, Anything).Return(0) Mock.On("MyMethod", 3, 3).Unset() ## WaitUntil ```go func (c *Call) WaitUntil(w <-chan time.Time) *Call ``` WaitUntil sets the channel that will block the mock's return until its closed or a message is received. Mock.On("MyMethod", arg1, arg2).WaitUntil(time.After(time.Second)) ## FunctionalOptionsArgument ```go type FunctionalOptionsArgument struct { // contains filtered or unexported fields } ``` FunctionalOptionsArgument contains a list of functional options arguments expected for use when matching a list of arguments. ## String ```go func (f *FunctionalOptionsArgument) String() string ``` String returns the string representation of FunctionalOptionsArgument ## IsTypeArgument ```go type IsTypeArgument struct { // contains filtered or unexported fields } ``` IsTypeArgument is a struct that contains the type of an argument for use when type checking. This is an alternative to [AnythingOfType](#func-AnythingOfType). Used in [Arguments.Diff](#method-Arguments-Diff) and [Arguments.Assert](#method-Arguments-Assert). ## Mock ```go type Mock struct { // Represents the calls that are expected of // an object. ExpectedCalls []*Call // Holds the calls that were made to this mocked object. Calls []Call // contains filtered or unexported fields } ``` Mock is the workhorse used to track activity on another object. For an example of its usage, refer to the "Example Usage" section at the top of this document. - `ExpectedCalls: []*Call`: Represents the calls that are expected of an object. - `Calls: []Call`: Holds the calls that were made to this mocked object. ## AssertCalled ```go func (m *Mock) AssertCalled(t TestingT, methodName string, arguments ...interface{}) bool ``` AssertCalled asserts that the method was called. It can produce a false result when an argument is a pointer type and the underlying value changed after calling the mocked method. ## AssertExpectations ```go func (m *Mock) AssertExpectations(t TestingT) bool ``` AssertExpectations asserts that everything specified with [Mock.On](#method-Mock-On) was in fact called as expected. Calls may have occurred in any order. ## AssertNotCalled ```go func (m *Mock) AssertNotCalled(t TestingT, methodName string, arguments ...interface{}) bool ``` AssertNotCalled asserts that the method was not called. It can produce a false result when an argument is a pointer type and the underlying value changed after calling the mocked method. ## AssertNumberOfCalls ```go func (m *Mock) AssertNumberOfCalls(t TestingT, methodName string, expectedCalls int) bool ``` AssertNumberOfCalls asserts that the method was called expectedCalls times. ## Called ```go func (m *Mock) Called(arguments ...interface{}) Arguments ``` Called tells the mock object that a method has been called, and gets an array of arguments to return. Panics if the call is unexpected (i.e. not preceded by appropriate [Mock.On](#method-Mock-On) calls) If Call.WaitFor is set, blocks until the channel is closed or receives a message. ## IsMethodCallable ```go func (m *Mock) IsMethodCallable(t TestingT, methodName string, arguments ...interface{}) bool ``` IsMethodCallable returns true if given methodName and arguments have an unsatisfied expected call registered in the Mock. ## MethodCalled ```go func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Arguments ``` MethodCalled tells the mock object that the given method has been called, and gets an array of arguments to return. Panics if the call is unexpected (i.e. not preceded by appropriate [Mock.On](#method-Mock-On) calls) If Call.WaitFor is set, blocks until the channel is closed or receives a message. ## On ```go func (m *Mock) On(methodName string, arguments ...interface{}) *Call ``` On starts a description of an expectation of the specified method being called. Mock.On("MyMethod", arg1, arg2) ## String ```go func (m *Mock) String() string ``` String provides a %v format string for Mock. Note: this is used implicitly by Arguments.Diff if a Mock is passed. It exists because go's default %v formatting traverses the struct without acquiring the mutex, which is detected by go test -race. ## Test ```go func (m *Mock) Test(t TestingT) ``` Test sets the [TestingT](#type-TestingT) on which errors will be reported, otherwise errors will cause a panic. Test should not be called on an object that is going to be used in a goroutine other than the one running the test function. ## TestData ```go func (m *Mock) TestData() objx.Map ``` TestData holds any data that might be useful for testing. Testify ignores this data completely allowing you to do whatever you like with it. ## TestingT ```go type TestingT interface { Logf(format string, args ...interface{}) Errorf(format string, args ...interface{}) FailNow() } ``` TestingT is an interface wrapper around \*testing.T - `Logf: func(format string, args ...interface{})`: - `Errorf: func(format string, args ...interface{})`: - `FailNow: func()`: ### require Path: `/api/pkg-require` # require 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 [testing.T.FailNow](https://pkg.go.dev/testing#T.FailNow). A consequence of this is that it must be called from the goroutine running the test function, not from other goroutines created during the test. Every assertion function also takes an optional string message as the final argument, allowing custom error messages to be appended to the message the assertion method outputs. ## Condition ```go func Condition(t TestingT, comp assert.Comparison, msgAndArgs ...interface{}) ``` Condition uses a Comparison to assert a complex condition. ## Conditionf ```go func Conditionf(t TestingT, comp assert.Comparison, msg string, args ...interface{}) ``` Conditionf uses a Comparison to assert a complex condition. ## Contains ```go func Contains(t TestingT, s interface{}, contains interface{}, msgAndArgs ...interface{}) ``` Contains asserts that the specified string, list(array, slice...) or map contains the specified substring or element. require.Contains(t, "Hello World", "World") require.Contains(t, ["Hello", "World"], "World") require.Contains(t, {"Hello": "World"}, "Hello") ## Containsf ```go func Containsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) ``` Containsf asserts that the specified string, list(array, slice...) or map contains the specified substring or element. require.Containsf(t, "Hello World", "World", "error message %s", "formatted") require.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted") require.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted") ## DirExists ```go 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. ## DirExistsf ```go 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. ## ElementsMatch ```go func ElementsMatch(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{}) ``` ElementsMatch asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match. require.ElementsMatch(t, \[1, 3, 2, 3], \[1, 3, 3, 2]) ## ElementsMatchf ```go func ElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) ``` ElementsMatchf asserts that the specified listA(array, slice...) is equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match. require.ElementsMatchf(t, \[1, 3, 2, 3], \[1, 3, 3, 2], "error message %s", "formatted") ## Empty ```go func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` Empty asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". require.Empty(t, obj) ## Emptyf ```go func Emptyf(t TestingT, object interface{}, msg string, args ...interface{}) ``` Emptyf asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". require.Emptyf(t, obj, "error message %s", "formatted") ## Equal ```go func Equal(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` Equal asserts that two objects are equal. require.Equal(t, 123, 123) Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail. ## EqualError ```go func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) ``` EqualError asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() require.EqualError(t, err, expectedErrorString) ## EqualErrorf ```go func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{}) ``` EqualErrorf asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() require.EqualErrorf(t, err, expectedErrorString, "error message %s", "formatted") ## EqualExportedValues ```go func EqualExportedValues(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } require.EqualExportedValues(t, S{1, 2}, S{1, 3}) => true require.EqualExportedValues(t, S{1, 2}, S{2, 3}) => false ## EqualExportedValuesf ```go func EqualExportedValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` EqualExportedValuesf asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } require.EqualExportedValuesf(t, S{1, 2}, S{1, 3}, "error message %s", "formatted") => true require.EqualExportedValuesf(t, S{1, 2}, S{2, 3}, "error message %s", "formatted") => false ## EqualValues ```go func EqualValues(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` EqualValues asserts that two objects are equal or convertible to the larger type and equal. require.EqualValues(t, uint32(123), int32(123)) ## EqualValuesf ```go func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` EqualValuesf asserts that two objects are equal or convertible to the larger type and equal. require.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted") ## Equalf ```go func Equalf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` Equalf asserts that two objects are equal. require.Equalf(t, 123, 123, "error message %s", "formatted") Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). Function equality cannot be determined and will always fail. ## Error ```go func Error(t TestingT, err error, msgAndArgs ...interface{}) ``` Error asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() require.Error(t, err) ## ErrorAs ```go 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. ## ErrorAsf ```go 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. ## ErrorContains ```go func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...interface{}) ``` ErrorContains asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() require.ErrorContains(t, err, expectedErrorSubString) ## ErrorContainsf ```go func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{}) ``` ErrorContainsf asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() require.ErrorContainsf(t, err, expectedErrorSubString, "error message %s", "formatted") ## ErrorIs ```go 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. ## ErrorIsf ```go 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. ## Errorf ```go func Errorf(t TestingT, err error, msg string, args ...interface{}) ``` Errorf asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() require.Errorf(t, err, "error message %s", "formatted") ## Eventually ```go func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) ``` Eventually asserts that given condition will be met in waitFor time, periodically checking target function each tick. require.Eventually(t, func() bool { return true; }, time.Second, 10*time.Millisecond) ## EventuallyWithT ```go func EventuallyWithT(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) ``` EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() require.EventuallyWithT(t, func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick require.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false") ## EventuallyWithTf ```go func EventuallyWithTf(t TestingT, condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) ``` EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() require.EventuallyWithTf(t, func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick require.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "error message %s", "formatted") ## Eventuallyf ```go func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) ``` Eventuallyf asserts that given condition will be met in waitFor time, periodically checking target function each tick. require.Eventuallyf(t, func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted") ## Exactly ```go func Exactly(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` Exactly asserts that two objects are equal in value and type. require.Exactly(t, int32(123), int64(123)) ## Exactlyf ```go func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` Exactlyf asserts that two objects are equal in value and type. require.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted") ## Fail ```go func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) ``` Fail reports a failure through ## FailNow ```go func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) ``` FailNow fails test ## FailNowf ```go func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{}) ``` FailNowf fails test ## Failf ```go func Failf(t TestingT, failureMessage string, msg string, args ...interface{}) ``` Failf reports a failure through ## False ```go func False(t TestingT, value bool, msgAndArgs ...interface{}) ``` False asserts that the specified value is false. require.False(t, myBool) ## Falsef ```go func Falsef(t TestingT, value bool, msg string, args ...interface{}) ``` Falsef asserts that the specified value is false. require.Falsef(t, myBool, "error message %s", "formatted") ## FileExists ```go 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. ## FileExistsf ```go 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. ## Greater ```go func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) ``` Greater asserts that the first element is greater than the second require.Greater(t, 2, 1) require.Greater(t, float64(2), float64(1)) require.Greater(t, "b", "a") ## GreaterOrEqual ```go func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) ``` GreaterOrEqual asserts that the first element is greater than or equal to the second require.GreaterOrEqual(t, 2, 1) require.GreaterOrEqual(t, 2, 2) require.GreaterOrEqual(t, "b", "a") require.GreaterOrEqual(t, "b", "b") ## GreaterOrEqualf ```go func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) ``` GreaterOrEqualf asserts that the first element is greater than or equal to the second require.GreaterOrEqualf(t, 2, 1, "error message %s", "formatted") require.GreaterOrEqualf(t, 2, 2, "error message %s", "formatted") require.GreaterOrEqualf(t, "b", "a", "error message %s", "formatted") require.GreaterOrEqualf(t, "b", "b", "error message %s", "formatted") ## Greaterf ```go func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) ``` Greaterf asserts that the first element is greater than the second require.Greaterf(t, 2, 1, "error message %s", "formatted") require.Greaterf(t, float64(2), float64(1), "error message %s", "formatted") require.Greaterf(t, "b", "a", "error message %s", "formatted") ## HTTPBodyContains ```go func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) ``` HTTPBodyContains asserts that a specified handler returns a body that contains a string. require.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky") ## HTTPBodyContainsf ```go func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) ``` HTTPBodyContainsf asserts that a specified handler returns a body that contains a string. require.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted") ## HTTPBodyNotContains ```go func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) ``` HTTPBodyNotContains asserts that a specified handler returns a body that does not contain a string. require.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky") ## HTTPBodyNotContainsf ```go func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) ``` HTTPBodyNotContainsf asserts that a specified handler returns a body that does not contain a string. require.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted") ## HTTPError ```go func HTTPError(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) ``` HTTPError asserts that a specified handler returns an error status code. require.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} ## HTTPErrorf ```go func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) ``` HTTPErrorf asserts that a specified handler returns an error status code. require.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}} ## HTTPRedirect ```go func HTTPRedirect(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) ``` HTTPRedirect asserts that a specified handler returns a redirect status code. require.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} ## HTTPRedirectf ```go func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) ``` HTTPRedirectf asserts that a specified handler returns a redirect status code. require.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}} ## HTTPStatusCode ```go func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) ``` HTTPStatusCode asserts that a specified handler returns a specified status code. require.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501) ## HTTPStatusCodef ```go func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) ``` HTTPStatusCodef asserts that a specified handler returns a specified status code. require.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted") ## HTTPSuccess ```go func HTTPSuccess(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msgAndArgs ...interface{}) ``` HTTPSuccess asserts that a specified handler returns a success status code. require.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil) ## HTTPSuccessf ```go func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) ``` HTTPSuccessf asserts that a specified handler returns a success status code. require.HTTPSuccessf(t, myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted") ## Implements ```go func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) ``` Implements asserts that an object is implemented by the specified interface. require.Implements(t, (*MyInterface)(nil), new(MyObject)) ## Implementsf ```go func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) ``` Implementsf asserts that an object is implemented by the specified interface. require.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## InDelta ```go func InDelta(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) ``` InDelta asserts that the two numerals are within delta of each other. require.InDelta(t, math.Pi, 22/7.0, 0.01) ## InDeltaMapValues ```go 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. ## InDeltaMapValuesf ```go 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. ## InDeltaSlice ```go func InDeltaSlice(t TestingT, expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) ``` InDeltaSlice is the same as InDelta, except it compares two slices. ## InDeltaSlicef ```go 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. ## InDeltaf ```go func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) ``` InDeltaf asserts that the two numerals are within delta of each other. require.InDeltaf(t, math.Pi, 22/7.0, 0.01, "error message %s", "formatted") ## InEpsilon ```go 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 ## InEpsilonSlice ```go 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. ## InEpsilonSlicef ```go 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. ## InEpsilonf ```go 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 ## IsDecreasing ```go func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` IsDecreasing asserts that the collection is decreasing require.IsDecreasing(t, []int{2, 1, 0}) require.IsDecreasing(t, []float{2, 1}) require.IsDecreasing(t, []string{"b", "a"}) ## IsDecreasingf ```go func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) ``` IsDecreasingf asserts that the collection is decreasing require.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted") require.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted") require.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted") ## IsIncreasing ```go func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` IsIncreasing asserts that the collection is increasing require.IsIncreasing(t, []int{1, 2, 3}) require.IsIncreasing(t, []float{1, 2}) require.IsIncreasing(t, []string{"a", "b"}) ## IsIncreasingf ```go func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) ``` IsIncreasingf asserts that the collection is increasing require.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted") require.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted") require.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted") ## IsNonDecreasing ```go func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` IsNonDecreasing asserts that the collection is not decreasing require.IsNonDecreasing(t, []int{1, 1, 2}) require.IsNonDecreasing(t, []float{1, 2}) require.IsNonDecreasing(t, []string{"a", "b"}) ## IsNonDecreasingf ```go func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) ``` IsNonDecreasingf asserts that the collection is not decreasing require.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted") require.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted") require.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted") ## IsNonIncreasing ```go func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` IsNonIncreasing asserts that the collection is not increasing require.IsNonIncreasing(t, []int{2, 1, 1}) require.IsNonIncreasing(t, []float{2, 1}) require.IsNonIncreasing(t, []string{"b", "a"}) ## IsNonIncreasingf ```go func IsNonIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) ``` IsNonIncreasingf asserts that the collection is not increasing require.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted") require.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted") require.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted") ## IsNotType ```go func IsNotType(t TestingT, theType interface{}, object interface{}, msgAndArgs ...interface{}) ``` IsNotType asserts that the specified objects are not of the same type. require.IsNotType(t, &NotMyStruct{}, &MyStruct{}) ## IsNotTypef ```go func IsNotTypef(t TestingT, theType interface{}, object interface{}, msg string, args ...interface{}) ``` IsNotTypef asserts that the specified objects are not of the same type. require.IsNotTypef(t, &NotMyStruct{}, &MyStruct{}, "error message %s", "formatted") ## IsType ```go func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) ``` IsType asserts that the specified objects are of the same type. require.IsType(t, &MyStruct{}, &MyStruct{}) ## IsTypef ```go func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg string, args ...interface{}) ``` IsTypef asserts that the specified objects are of the same type. require.IsTypef(t, &MyStruct{}, &MyStruct{}, "error message %s", "formatted") ## JSONEq ```go func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) ``` JSONEq asserts that two JSON strings are equivalent. require.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`) ## JSONEqf ```go func JSONEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) ``` JSONEqf asserts that two JSON strings are equivalent. require.JSONEqf(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted") ## Len ```go func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) ``` Len asserts that the specified object has specific length. Len also fails if the object has a type that len() not accept. require.Len(t, mySlice, 3) ## Lenf ```go func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{}) ``` Lenf asserts that the specified object has specific length. Lenf also fails if the object has a type that len() not accept. require.Lenf(t, mySlice, 3, "error message %s", "formatted") ## Less ```go func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) ``` Less asserts that the first element is less than the second require.Less(t, 1, 2) require.Less(t, float64(1), float64(2)) require.Less(t, "a", "b") ## LessOrEqual ```go func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) ``` LessOrEqual asserts that the first element is less than or equal to the second require.LessOrEqual(t, 1, 2) require.LessOrEqual(t, 2, 2) require.LessOrEqual(t, "a", "b") require.LessOrEqual(t, "b", "b") ## LessOrEqualf ```go func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) ``` LessOrEqualf asserts that the first element is less than or equal to the second require.LessOrEqualf(t, 1, 2, "error message %s", "formatted") require.LessOrEqualf(t, 2, 2, "error message %s", "formatted") require.LessOrEqualf(t, "a", "b", "error message %s", "formatted") require.LessOrEqualf(t, "b", "b", "error message %s", "formatted") ## Lessf ```go func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) ``` Lessf asserts that the first element is less than the second require.Lessf(t, 1, 2, "error message %s", "formatted") require.Lessf(t, float64(1), float64(2), "error message %s", "formatted") require.Lessf(t, "a", "b", "error message %s", "formatted") ## Negative ```go func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) ``` Negative asserts that the specified element is negative require.Negative(t, -1) require.Negative(t, -1.23) ## Negativef ```go func Negativef(t TestingT, e interface{}, msg string, args ...interface{}) ``` Negativef asserts that the specified element is negative require.Negativef(t, -1, "error message %s", "formatted") require.Negativef(t, -1.23, "error message %s", "formatted") ## Never ```go func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) ``` Never asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick. require.Never(t, func() bool { return false; }, time.Second, 10*time.Millisecond) ## Neverf ```go func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) ``` Neverf asserts that the given condition doesn't satisfy in waitFor time, periodically checking the target function each tick. require.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted") ## New ```go func New(t TestingT) *Assertions ``` New makes a new Assertions object for the specified TestingT. ## Nil ```go func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` Nil asserts that the specified object is nil. require.Nil(t, err) ## Nilf ```go func Nilf(t TestingT, object interface{}, msg string, args ...interface{}) ``` Nilf asserts that the specified object is nil. require.Nilf(t, err, "error message %s", "formatted") ## NoDirExists ```go 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. ## NoDirExistsf ```go 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. ## NoError ```go func NoError(t TestingT, err error, msgAndArgs ...interface{}) ``` NoError asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() require.NoError(t, err) require.Equal(t, expectedObj, actualObj) ## NoErrorf ```go func NoErrorf(t TestingT, err error, msg string, args ...interface{}) ``` NoErrorf asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() require.NoErrorf(t, err, "error message %s", "formatted") require.Equal(t, expectedObj, actualObj) ## NoFileExists ```go 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. ## NoFileExistsf ```go 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. ## NotContains ```go func NotContains(t TestingT, s interface{}, contains interface{}, msgAndArgs ...interface{}) ``` NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element. require.NotContains(t, "Hello World", "Earth") require.NotContains(t, ["Hello", "World"], "Earth") require.NotContains(t, {"Hello": "World"}, "Earth") ## NotContainsf ```go func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) ``` NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the specified substring or element. require.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted") require.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted") require.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted") ## NotElementsMatch ```go func NotElementsMatch(t TestingT, listA interface{}, listB interface{}, msgAndArgs ...interface{}) ``` NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. require.NotElementsMatch(t, \[1, 1, 2, 3], \[1, 1, 2, 3]) -> false require.NotElementsMatch(t, \[1, 1, 2, 3], \[1, 2, 3]) -> true require.NotElementsMatch(t, \[1, 2, 3], \[1, 2, 4]) -> true ## NotElementsMatchf ```go func NotElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) ``` NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. require.NotElementsMatchf(t, \[1, 1, 2, 3], \[1, 1, 2, 3], "error message %s", "formatted") -> false require.NotElementsMatchf(t, \[1, 1, 2, 3], \[1, 2, 3], "error message %s", "formatted") -> true require.NotElementsMatchf(t, \[1, 2, 3], \[1, 2, 4], "error message %s", "formatted") -> true ## NotEmpty ```go func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` NotEmpty asserts that the specified object is NOT [Empty](#func-Empty). require.NotEmpty(t, obj) require.Equal(t, "two", obj[1]) ## NotEmptyf ```go func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{}) ``` NotEmptyf asserts that the specified object is NOT [Empty](#func-Empty). require.NotEmptyf(t, obj, "error message %s", "formatted") require.Equal(t, "two", obj[1]) ## NotEqual ```go func NotEqual(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` NotEqual asserts that the specified values are NOT equal. require.NotEqual(t, obj1, obj2) Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). ## NotEqualValues ```go func NotEqualValues(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` NotEqualValues asserts that two objects are not equal even when converted to the same type require.NotEqualValues(t, obj1, obj2) ## NotEqualValuesf ```go func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` NotEqualValuesf asserts that two objects are not equal even when converted to the same type require.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted") ## NotEqualf ```go func NotEqualf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` NotEqualf asserts that the specified values are NOT equal. require.NotEqualf(t, obj1, obj2, "error message %s", "formatted") Pointer variable equality is determined based on the equality of the referenced values (as opposed to the memory addresses). ## NotErrorAs ```go func NotErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{}) ``` NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorAsf ```go func NotErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{}) ``` NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorIs ```go func NotErrorIs(t TestingT, err error, target error, msgAndArgs ...interface{}) ``` NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotErrorIsf ```go func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) ``` NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotImplements ```go func NotImplements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) ``` NotImplements asserts that an object does not implement the specified interface. require.NotImplements(t, (*MyInterface)(nil), new(MyObject)) ## NotImplementsf ```go func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) ``` NotImplementsf asserts that an object does not implement the specified interface. require.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## NotNil ```go func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) ``` NotNil asserts that the specified object is not nil. require.NotNil(t, err) ## NotNilf ```go func NotNilf(t TestingT, object interface{}, msg string, args ...interface{}) ``` NotNilf asserts that the specified object is not nil. require.NotNilf(t, err, "error message %s", "formatted") ## NotPanics ```go func NotPanics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{}) ``` NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic. require.NotPanics(t, func(){ RemainCalm() }) ## NotPanicsf ```go func NotPanicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{}) ``` NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic. require.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted") ## NotRegexp ```go func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) ``` NotRegexp asserts that a specified regexp does not match a string. require.NotRegexp(t, regexp.MustCompile("starts"), "it's starting") require.NotRegexp(t, "^start", "it's not starting") ## NotRegexpf ```go func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) ``` NotRegexpf asserts that a specified regexp does not match a string. require.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted") require.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted") ## NotSame ```go func NotSame(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` NotSame asserts that two pointers do not reference the same object. require.NotSame(t, ptr1, ptr2) Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## NotSamef ```go func NotSamef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` NotSamef asserts that two pointers do not reference the same object. require.NotSamef(t, ptr1, ptr2, "error message %s", "formatted") Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## NotSubset ```go func NotSubset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{}) ``` NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. require.NotSubset(t, [1, 3, 4], [1, 2]) require.NotSubset(t, {"x": 1, "y": 2}, {"z": 3}) require.NotSubset(t, [1, 3, 4], {1: "one", 2: "two"}) require.NotSubset(t, {"x": 1, "y": 2}, ["z"]) ## NotSubsetf ```go func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) ``` NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. require.NotSubsetf(t, [1, 3, 4], [1, 2], "error message %s", "formatted") require.NotSubsetf(t, {"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted") require.NotSubsetf(t, [1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted") require.NotSubsetf(t, {"x": 1, "y": 2}, ["z"], "error message %s", "formatted") ## NotZero ```go func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{}) ``` NotZero asserts that i is not the zero value for its type. ## NotZerof ```go func NotZerof(t TestingT, i interface{}, msg string, args ...interface{}) ``` NotZerof asserts that i is not the zero value for its type. ## Panics ```go func Panics(t TestingT, f assert.PanicTestFunc, msgAndArgs ...interface{}) ``` Panics asserts that the code inside the specified PanicTestFunc panics. require.Panics(t, func(){ GoCrazy() }) ## PanicsWithError ```go func PanicsWithError(t TestingT, errString string, f assert.PanicTestFunc, msgAndArgs ...interface{}) ``` PanicsWithError asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison. require.PanicsWithError(t, "crazy error", func(){ GoCrazy() }) ## PanicsWithErrorf ```go func PanicsWithErrorf(t TestingT, errString string, f assert.PanicTestFunc, msg string, args ...interface{}) ``` PanicsWithErrorf asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value is an error that satisfies the EqualError comparison. require.PanicsWithErrorf(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted") ## PanicsWithValue ```go func PanicsWithValue(t TestingT, expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{}) ``` PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value. require.PanicsWithValue(t, "crazy error", func(){ GoCrazy() }) ## PanicsWithValuef ```go func PanicsWithValuef(t TestingT, expected interface{}, f assert.PanicTestFunc, msg string, args ...interface{}) ``` PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that the recovered panic value equals the expected panic value. require.PanicsWithValuef(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted") ## Panicsf ```go func Panicsf(t TestingT, f assert.PanicTestFunc, msg string, args ...interface{}) ``` Panicsf asserts that the code inside the specified PanicTestFunc panics. require.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted") ## Positive ```go func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) ``` Positive asserts that the specified element is positive require.Positive(t, 1) require.Positive(t, 1.23) ## Positivef ```go func Positivef(t TestingT, e interface{}, msg string, args ...interface{}) ``` Positivef asserts that the specified element is positive require.Positivef(t, 1, "error message %s", "formatted") require.Positivef(t, 1.23, "error message %s", "formatted") ## Regexp ```go func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) ``` Regexp asserts that a specified regexp matches a string. require.Regexp(t, regexp.MustCompile("start"), "it's starting") require.Regexp(t, "start...$", "it's not starting") ## Regexpf ```go func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) ``` Regexpf asserts that a specified regexp matches a string. require.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted") require.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted") ## Same ```go func Same(t TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` Same asserts that two pointers reference the same object. require.Same(t, ptr1, ptr2) Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## Samef ```go func Samef(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) ``` Samef asserts that two pointers reference the same object. require.Samef(t, ptr1, ptr2, "error message %s", "formatted") Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value. ## Subset ```go func Subset(t TestingT, list interface{}, subset interface{}, msgAndArgs ...interface{}) ``` Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. require.Subset(t, [1, 2, 3], [1, 2]) require.Subset(t, {"x": 1, "y": 2}, {"x": 1}) require.Subset(t, [1, 2, 3], {1: "one", 2: "two"}) require.Subset(t, {"x": 1, "y": 2}, ["x"]) ## Subsetf ```go func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) ``` Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. require.Subsetf(t, [1, 2, 3], [1, 2], "error message %s", "formatted") require.Subsetf(t, {"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted") require.Subsetf(t, [1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted") require.Subsetf(t, {"x": 1, "y": 2}, ["x"], "error message %s", "formatted") ## True ```go func True(t TestingT, value bool, msgAndArgs ...interface{}) ``` True asserts that the specified value is true. require.True(t, myBool) ## Truef ```go func Truef(t TestingT, value bool, msg string, args ...interface{}) ``` Truef asserts that the specified value is true. require.Truef(t, myBool, "error message %s", "formatted") ## WithinDuration ```go func WithinDuration(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) ``` WithinDuration asserts that the two times are within duration delta of each other. require.WithinDuration(t, time.Now(), time.Now(), 10*time.Second) ## WithinDurationf ```go func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) ``` WithinDurationf asserts that the two times are within duration delta of each other. require.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted") ## WithinRange ```go func WithinRange(t TestingT, actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{}) ``` WithinRange asserts that a time is within a time range (inclusive). require.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second)) ## WithinRangef ```go func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) ``` WithinRangef asserts that a time is within a time range (inclusive). require.WithinRangef(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted") ## YAMLEq ```go func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) ``` YAMLEq asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` require.YAMLEq(t, expected, actual) ## YAMLEqf ```go func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) ``` YAMLEqf asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` require.YAMLEqf(t, expected, actual, "error message %s", "formatted") ## Zero ```go func Zero(t TestingT, i interface{}, msgAndArgs ...interface{}) ``` Zero asserts that i is the zero value for its type. ## Zerof ```go func Zerof(t TestingT, i interface{}, msg string, args ...interface{}) ``` Zerof asserts that i is the zero value for its type. ## Assertions ```go type Assertions struct { // contains filtered or unexported fields } ``` Assertions provides assertion methods around the TestingT interface. ## Condition ```go func (a *Assertions) Condition(comp assert.Comparison, msgAndArgs ...interface{}) ``` Condition uses a Comparison to assert a complex condition. ## Conditionf ```go func (a *Assertions) Conditionf(comp assert.Comparison, msg string, args ...interface{}) ``` Conditionf uses a Comparison to assert a complex condition. ## Contains ```go 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") ## Containsf ```go 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") ## DirExists ```go 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. ## DirExistsf ```go 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. ## ElementsMatch ```go 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]) ## ElementsMatchf ```go 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") ## Empty ```go func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{}) ``` Empty asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". a.Empty(obj) ## Emptyf ```go func (a *Assertions) Emptyf(object interface{}, msg string, args ...interface{}) ``` Emptyf asserts that the given value is "empty". [Zero values](https://go.dev/ref/spec#The_zero_value) are "empty". Arrays are "empty" if every element is the zero value of the type (stricter than "empty"). Slices, maps and channels with zero length are "empty". Pointer values are "empty" if the pointer is nil or if the pointed value is "empty". a.Emptyf(obj, "error message %s", "formatted") ## Equal ```go 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. ## EqualError ```go func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) ``` EqualError asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() a.EqualError(err, expectedErrorString) ## EqualErrorf ```go func (a *Assertions) EqualErrorf(theError error, errString string, msg string, args ...interface{}) ``` EqualErrorf asserts that a function returned a non-nil error (i.e. an error) and that it is equal to the provided error. actualObj, err := SomeFunction() a.EqualErrorf(err, expectedErrorString, "error message %s", "formatted") ## EqualExportedValues ```go func (a *Assertions) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` EqualExportedValues asserts that the types of two objects are equal and their public fields are also equal. This is useful for comparing structs that have private fields that could potentially differ. type S struct { Exported int notExported int } a.EqualExportedValues(S{1, 2}, S{1, 3}) => true a.EqualExportedValues(S{1, 2}, S{2, 3}) => false ## EqualExportedValuesf ```go func (a *Assertions) 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 } a.EqualExportedValuesf(S{1, 2}, S{1, 3}, "error message %s", "formatted") => true a.EqualExportedValuesf(S{1, 2}, S{2, 3}, "error message %s", "formatted") => false ## EqualValues ```go func (a *Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) ``` EqualValues asserts that two objects are equal or convertible to the larger type and equal. a.EqualValues(uint32(123), int32(123)) ## EqualValuesf ```go func (a *Assertions) EqualValuesf(expected interface{}, actual interface{}, msg string, args ...interface{}) ``` EqualValuesf asserts that two objects are equal or convertible to the larger type and equal. a.EqualValuesf(uint32(123), int32(123), "error message %s", "formatted") ## Equalf ```go 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. ## Error ```go func (a *Assertions) Error(err error, msgAndArgs ...interface{}) ``` Error asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() a.Error(err) ## ErrorAs ```go 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. ## ErrorAsf ```go 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. ## ErrorContains ```go func (a *Assertions) ErrorContains(theError error, contains string, msgAndArgs ...interface{}) ``` ErrorContains asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() a.ErrorContains(err, expectedErrorSubString) ## ErrorContainsf ```go func (a *Assertions) ErrorContainsf(theError error, contains string, msg string, args ...interface{}) ``` ErrorContainsf asserts that a function returned a non-nil error (i.e. an error) and that the error contains the specified substring. actualObj, err := SomeFunction() a.ErrorContainsf(err, expectedErrorSubString, "error message %s", "formatted") ## ErrorIs ```go 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. ## ErrorIsf ```go 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. ## Errorf ```go func (a *Assertions) Errorf(err error, msg string, args ...interface{}) ``` Errorf asserts that a function returned a non-nil error (ie. an error). actualObj, err := SomeFunction() a.Errorf(err, "error message %s", "formatted") ## Eventually ```go 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) ## EventuallyWithT ```go func (a *Assertions) EventuallyWithT(condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) ``` EventuallyWithT asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() a.EventuallyWithT(func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick assert.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false") ## EventuallyWithTf ```go func (a *Assertions) EventuallyWithTf(condition func(collect *assert.CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) ``` EventuallyWithTf asserts that given condition will be met in waitFor time, periodically checking target function each tick. In contrast to Eventually, it supplies a CollectT to the condition function, so that the condition function can use the CollectT to call other assertions. The condition is considered "met" if no errors are raised in a tick. The supplied CollectT collects all errors from one tick (if there are any). If the condition is not met before waitFor, the collected errors of the last tick are copied to t. externalValue := false go func() { time.Sleep(8*time.Second) externalValue = true }() a.EventuallyWithTf(func(c *assert.CollectT) { // add assertions as needed; any assertion failure will fail the current tick assert.True(c, externalValue, "expected 'externalValue' to be true") }, 10*time.Second, 1*time.Second, "error message %s", "formatted") ## Eventuallyf ```go 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") ## Exactly ```go 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)) ## Exactlyf ```go 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") ## Fail ```go func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{}) ``` Fail reports a failure through ## FailNow ```go func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...interface{}) ``` FailNow fails test ## FailNowf ```go func (a *Assertions) FailNowf(failureMessage string, msg string, args ...interface{}) ``` FailNowf fails test ## Failf ```go func (a *Assertions) Failf(failureMessage string, msg string, args ...interface{}) ``` Failf reports a failure through ## False ```go func (a *Assertions) False(value bool, msgAndArgs ...interface{}) ``` False asserts that the specified value is false. a.False(myBool) ## Falsef ```go 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") ## FileExists ```go 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. ## FileExistsf ```go 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. ## Greater ```go 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") ## GreaterOrEqual ```go 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") ## GreaterOrEqualf ```go 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") ## Greaterf ```go 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") ## HTTPBodyContains ```go 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") ## HTTPBodyContainsf ```go 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") ## HTTPBodyNotContains ```go 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") ## HTTPBodyNotContainsf ```go 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") ## HTTPError ```go 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"}} ## HTTPErrorf ```go 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"}} ## HTTPRedirect ```go 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"}} ## HTTPRedirectf ```go 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"}} ## HTTPStatusCode ```go 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) ## HTTPStatusCodef ```go 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") ## HTTPSuccess ```go 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) ## HTTPSuccessf ```go 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") ## Implements ```go 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)) ## Implementsf ```go 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") ## InDelta ```go 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) ## InDeltaMapValues ```go 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. ## InDeltaMapValuesf ```go 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. ## InDeltaSlice ```go func (a *Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) ``` InDeltaSlice is the same as InDelta, except it compares two slices. ## InDeltaSlicef ```go 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. ## InDeltaf ```go 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") ## InEpsilon ```go 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 ## InEpsilonSlice ```go 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. ## InEpsilonSlicef ```go 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. ## InEpsilonf ```go 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 ## IsDecreasing ```go 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"}) ## IsDecreasingf ```go 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") ## IsIncreasing ```go 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"}) ## IsIncreasingf ```go 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") ## IsNonDecreasing ```go 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"}) ## IsNonDecreasingf ```go 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") ## IsNonIncreasing ```go 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"}) ## IsNonIncreasingf ```go 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") ## IsNotType ```go func (a *Assertions) IsNotType(theType interface{}, object interface{}, msgAndArgs ...interface{}) ``` IsNotType asserts that the specified objects are not of the same type. a.IsNotType(&NotMyStruct{}, &MyStruct{}) ## IsNotTypef ```go func (a *Assertions) IsNotTypef(theType interface{}, object interface{}, msg string, args ...interface{}) ``` IsNotTypef asserts that the specified objects are not of the same type. a.IsNotTypef(&NotMyStruct{}, &MyStruct{}, "error message %s", "formatted") ## IsType ```go func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) ``` IsType asserts that the specified objects are of the same type. a.IsType(&MyStruct{}, &MyStruct{}) ## IsTypef ```go func (a *Assertions) IsTypef(expectedType interface{}, object interface{}, msg string, args ...interface{}) ``` IsTypef asserts that the specified objects are of the same type. a.IsTypef(&MyStruct{}, &MyStruct{}, "error message %s", "formatted") ## JSONEq ```go 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"}`) ## JSONEqf ```go 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") ## Len ```go 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) ## Lenf ```go 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") ## Less ```go 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") ## LessOrEqual ```go 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") ## LessOrEqualf ```go 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") ## Lessf ```go 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") ## Negative ```go func (a *Assertions) Negative(e interface{}, msgAndArgs ...interface{}) ``` Negative asserts that the specified element is negative a.Negative(-1) a.Negative(-1.23) ## Negativef ```go 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") ## Never ```go 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) ## Neverf ```go 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") ## Nil ```go func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{}) ``` Nil asserts that the specified object is nil. a.Nil(err) ## Nilf ```go 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") ## NoDirExists ```go 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. ## NoDirExistsf ```go 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. ## NoError ```go func (a *Assertions) NoError(err error, msgAndArgs ...interface{}) ``` NoError asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() a.NoError(err) a.Equal(expectedObj, actualObj) ## NoErrorf ```go func (a *Assertions) NoErrorf(err error, msg string, args ...interface{}) ``` NoErrorf asserts that a function returned a nil error (ie. no error). actualObj, err := SomeFunction() a.NoErrorf(err, "error message %s", "formatted") a.Equal(expectedObj, actualObj) ## NoFileExists ```go 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. ## NoFileExistsf ```go 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. ## NotContains ```go 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") ## NotContainsf ```go 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") ## NotElementsMatch ```go func (a *Assertions) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) ``` NotElementsMatch asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. a.NotElementsMatch(\[1, 1, 2, 3], \[1, 1, 2, 3]) -> false a.NotElementsMatch(\[1, 1, 2, 3], \[1, 2, 3]) -> true a.NotElementsMatch(\[1, 2, 3], \[1, 2, 4]) -> true ## NotElementsMatchf ```go func (a *Assertions) NotElementsMatchf(listA interface{}, listB interface{}, msg string, args ...interface{}) ``` NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified listB(array, slice...) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch. a.NotElementsMatchf(\[1, 1, 2, 3], \[1, 1, 2, 3], "error message %s", "formatted") -> false a.NotElementsMatchf(\[1, 1, 2, 3], \[1, 2, 3], "error message %s", "formatted") -> true a.NotElementsMatchf(\[1, 2, 3], \[1, 2, 4], "error message %s", "formatted") -> true ## NotEmpty ```go func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) ``` NotEmpty asserts that the specified object is NOT [Empty](#func-Empty). a.NotEmpty(obj) a.Equal("two", obj[1]) ## NotEmptyf ```go func (a *Assertions) NotEmptyf(object interface{}, msg string, args ...interface{}) ``` NotEmptyf asserts that the specified object is NOT [Empty](#func-Empty). a.NotEmptyf(obj, "error message %s", "formatted") a.Equal("two", obj[1]) ## NotEqual ```go 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). ## NotEqualValues ```go 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) ## NotEqualValuesf ```go 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") ## NotEqualf ```go 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). ## NotErrorAs ```go func (a *Assertions) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{}) ``` NotErrorAs asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorAsf ```go func (a *Assertions) NotErrorAsf(err error, target interface{}, msg string, args ...interface{}) ``` NotErrorAsf asserts that none of the errors in err's chain matches target, but if so, sets target to that error value. ## NotErrorIs ```go func (a *Assertions) NotErrorIs(err error, target error, msgAndArgs ...interface{}) ``` NotErrorIs asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotErrorIsf ```go func (a *Assertions) NotErrorIsf(err error, target error, msg string, args ...interface{}) ``` NotErrorIsf asserts that none of the errors in err's chain matches target. This is a wrapper for errors.Is. ## NotImplements ```go func (a *Assertions) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) ``` NotImplements asserts that an object does not implement the specified interface. a.NotImplements((*MyInterface)(nil), new(MyObject)) ## NotImplementsf ```go func (a *Assertions) NotImplementsf(interfaceObject interface{}, object interface{}, msg string, args ...interface{}) ``` NotImplementsf asserts that an object does not implement the specified interface. a.NotImplementsf((*MyInterface)(nil), new(MyObject), "error message %s", "formatted") ## NotNil ```go func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) ``` NotNil asserts that the specified object is not nil. a.NotNil(err) ## NotNilf ```go 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") ## NotPanics ```go 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() }) ## NotPanicsf ```go 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") ## NotRegexp ```go 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") ## NotRegexpf ```go 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") ## NotSame ```go 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. ## NotSamef ```go 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. ## NotSubset ```go func (a *Assertions) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{}) ``` NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.NotSubset([1, 3, 4], [1, 2]) a.NotSubset({"x": 1, "y": 2}, {"z": 3}) a.NotSubset([1, 3, 4], {1: "one", 2: "two"}) a.NotSubset({"x": 1, "y": 2}, ["z"]) ## NotSubsetf ```go func (a *Assertions) NotSubsetf(list interface{}, subset interface{}, msg string, args ...interface{}) ``` NotSubsetf asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.NotSubsetf([1, 3, 4], [1, 2], "error message %s", "formatted") a.NotSubsetf({"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted") a.NotSubsetf([1, 3, 4], {1: "one", 2: "two"}, "error message %s", "formatted") a.NotSubsetf({"x": 1, "y": 2}, ["z"], "error message %s", "formatted") ## NotZero ```go func (a *Assertions) NotZero(i interface{}, msgAndArgs ...interface{}) ``` NotZero asserts that i is not the zero value for its type. ## NotZerof ```go func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{}) ``` NotZerof asserts that i is not the zero value for its type. ## Panics ```go func (a *Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...interface{}) ``` Panics asserts that the code inside the specified PanicTestFunc panics. a.Panics(func(){ GoCrazy() }) ## PanicsWithError ```go 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() }) ## PanicsWithErrorf ```go 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") ## PanicsWithValue ```go 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() }) ## PanicsWithValuef ```go 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") ## Panicsf ```go 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") ## Positive ```go func (a *Assertions) Positive(e interface{}, msgAndArgs ...interface{}) ``` Positive asserts that the specified element is positive a.Positive(1) a.Positive(1.23) ## Positivef ```go 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") ## Regexp ```go 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") ## Regexpf ```go 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") ## Same ```go 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. ## Samef ```go 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. ## Subset ```go func (a *Assertions) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{}) ``` Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.Subset([1, 2, 3], [1, 2]) a.Subset({"x": 1, "y": 2}, {"x": 1}) a.Subset([1, 2, 3], {1: "one", 2: "two"}) a.Subset({"x": 1, "y": 2}, ["x"]) ## Subsetf ```go func (a *Assertions) Subsetf(list interface{}, subset interface{}, msg string, args ...interface{}) ``` Subsetf asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated. a.Subsetf([1, 2, 3], [1, 2], "error message %s", "formatted") a.Subsetf({"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted") a.Subsetf([1, 2, 3], {1: "one", 2: "two"}, "error message %s", "formatted") a.Subsetf({"x": 1, "y": 2}, ["x"], "error message %s", "formatted") ## True ```go func (a *Assertions) True(value bool, msgAndArgs ...interface{}) ``` True asserts that the specified value is true. a.True(myBool) ## Truef ```go 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") ## WithinDuration ```go 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) ## WithinDurationf ```go 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") ## WithinRange ```go func (a *Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{}) ``` WithinRange asserts that a time is within a time range (inclusive). a.WithinRange(time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second)) ## WithinRangef ```go func (a *Assertions) WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) ``` WithinRangef asserts that a time is within a time range (inclusive). a.WithinRangef(time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted") ## YAMLEq ```go func (a *Assertions) YAMLEq(expected string, actual string, msgAndArgs ...interface{}) ``` YAMLEq asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` a.YAMLEq(expected, actual) ## YAMLEqf ```go func (a *Assertions) YAMLEqf(expected string, actual string, msg string, args ...interface{}) ``` YAMLEqf asserts that the first documents in the two YAML strings are equivalent. expected := `--- key: value --- key: this is a second document, it is not evaluated ` actual := `--- key: value --- key: this is a subsequent document, it is not evaluated ` a.YAMLEqf(expected, actual, "error message %s", "formatted") ## Zero ```go func (a *Assertions) Zero(i interface{}, msgAndArgs ...interface{}) ``` Zero asserts that i is the zero value for its type. ## Zerof ```go func (a *Assertions) Zerof(i interface{}, msg string, args ...interface{}) ``` Zerof asserts that i is the zero value for its type. ## BoolAssertionFunc ```go 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: BoolAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ## ComparisonAssertionFunc ```go 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: ComparisonAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ## ErrorAssertionFunc ```go 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: ErrorAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ## TestingT ```go type TestingT interface { Errorf(format string, args ...interface{}) FailNow() } ``` TestingT is an interface wrapper around \*testing.T - `Errorf: func(format string, args ...interface{})`: - `FailNow: func()`: ## ValueAssertionFunc ```go 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: ValueAssertionFunc ```go { t := &testing.T{} 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)) }) } } ``` ### suite Path: `/api/pkg-suite` # suite Package suite contains logic for creating testing suite structs and running the methods on those structs as tests. The most useful piece of this package is that you can create setup/teardown methods on your testing suites, which will run before/after the whole suite or individual tests (depending on which interface(s) you implement). The suite package does not support parallel tests. See [issue 934](https://github.com/stretchr/testify/issues/934). A testing suite is usually built by first extending the built-in suite functionality from suite.Suite in testify. Alternatively, you could reproduce that logic on your own if you wanted (you just need to implement the TestingSuite interface from suite/interfaces.go). After that, you can implement any of the interfaces in suite/interfaces.go to add setup/teardown functionality to your suite, and add any methods that start with "Test" to add tests. Methods that do not match any suite interfaces and do not begin with "Test" will not be run by testify, and can safely be used as helper methods. Once you've built your testing suite, you need to run the suite (using suite.Run from testify) inside any function that matches the identity that "go test" is already looking for (i.e. func(\*testing.T)). Regular expression to select test suites specified command-line argument "-run". Regular expression to select the methods of test suites specified command-line argument "-m". Suite object has assertion methods. A crude example: // Basic imports import ( "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/suite" ) // Define the suite, and absorb the built-in basic suite // functionality from testify - including a T() method which // returns the current testing context type ExampleTestSuite struct { suite.Suite VariableThatShouldStartAtFive int } // Make sure that VariableThatShouldStartAtFive is set to five // before each test func (suite *ExampleTestSuite) SetupTest() { suite.VariableThatShouldStartAtFive = 5 } // All methods that begin with "Test" are run as tests within a // suite. func (suite *ExampleTestSuite) TestExample() { assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive) suite.Equal(5, suite.VariableThatShouldStartAtFive) } // In order for 'go test' to run this suite, we need to create // a normal test function and pass our suite to suite.Run func TestExampleTestSuite(t *testing.T) { suite.Run(t, new(ExampleTestSuite)) } ## Run ```go func Run(t *testing.T, suite TestingSuite) ``` Run takes a testing suite and runs all of the tests attached to it. ## AfterTest ```go type AfterTest interface { AfterTest(suiteName, testName string) } ``` AfterTest has a function to be executed right after the test finishes and receives the suite and test names as input - `AfterTest: func(suiteName, testName string)`: ## BeforeTest ```go type BeforeTest interface { BeforeTest(suiteName, testName string) } ``` BeforeTest has a function to be executed right before the test starts and receives the suite and test names as input - `BeforeTest: func(suiteName, testName string)`: ## SetupAllSuite ```go type SetupAllSuite interface { SetupSuite() } ``` SetupAllSuite has a SetupSuite method, which will run before the tests in the suite are run. - `SetupSuite: func()`: ## SetupSubTest ```go type SetupSubTest interface { SetupSubTest() } ``` SetupSubTest has a SetupSubTest method, which will run before each subtest in the suite. - `SetupSubTest: func()`: ## SetupTestSuite ```go type SetupTestSuite interface { SetupTest() } ``` SetupTestSuite has a SetupTest method, which will run before each test in the suite. - `SetupTest: func()`: ## Suite ```go type Suite struct { *assert.Assertions // contains filtered or unexported fields } ``` Suite is a basic testing suite with methods for storing and retrieving the current \*testing.T context. - `*assert.Assertions: *assert.Assertions`: ## Assert ```go func (suite *Suite) Assert() *assert.Assertions ``` Assert returns an assert context for suite. Normally, you can call: suite.NoError(err) But for situations where the embedded methods are overridden (for example, you might want to override assert.Assertions with require.Assertions), this method is provided so you can call: suite.Assert().NoError(err) ## Require ```go func (suite *Suite) Require() *require.Assertions ``` Require returns a require context for suite. ## Run ```go func (suite *Suite) Run(name string, subtest func()) bool ``` Run provides suite functionality around golang subtests. It should be called in place of t.Run(name, func(t \*testing.T)) in test suite code. The passed-in func will be executed as a subtest with a fresh instance of t. Provides compatibility with go test pkg -run TestSuite/TestName/SubTestName. ## SetS ```go func (suite *Suite) SetS(s TestingSuite) ``` SetS needs to set the current test suite as parent to get access to the parent methods ## SetT ```go func (suite *Suite) SetT(t *testing.T) ``` SetT sets the current \*testing.T context. ## T ```go func (suite *Suite) T() *testing.T ``` T retrieves the current \*testing.T context. ## SuiteInformation ```go type SuiteInformation struct { Start, End time.Time TestStats map[string]*TestInformation } ``` SuiteInformation stats stores stats for the whole suite execution. - `Start: time.Time`: - `End: time.Time`: - `TestStats: map[string]*TestInformation`: ## Passed ```go func (s *SuiteInformation) Passed() bool ``` ## TearDownAllSuite ```go type TearDownAllSuite interface { TearDownSuite() } ``` TearDownAllSuite has a TearDownSuite method, which will run after all the tests in the suite have been run. - `TearDownSuite: func()`: ## TearDownSubTest ```go type TearDownSubTest interface { TearDownSubTest() } ``` TearDownSubTest has a TearDownSubTest method, which will run after each subtest in the suite have been run. - `TearDownSubTest: func()`: ## TearDownTestSuite ```go type TearDownTestSuite interface { TearDownTest() } ``` TearDownTestSuite has a TearDownTest method, which will run after each test in the suite. - `TearDownTest: func()`: ## TestInformation ```go type TestInformation struct { TestName string Start, End time.Time Passed bool } ``` TestInformation stores information about the execution of each test. - `TestName: string`: - `Start: time.Time`: - `End: time.Time`: - `Passed: bool`: ## TestingSuite ```go type TestingSuite interface { T() *testing.T SetT(*testing.T) SetS(suite TestingSuite) } ``` TestingSuite can store and return the current \*testing.T context generated by 'go test'. - `T: func() *testing.T`: - `SetT: func(*testing.T)`: - `SetS: func(suite TestingSuite)`: ## WithStats ```go type WithStats interface { HandleStats(suiteName string, stats *SuiteInformation) } ``` WithStats implements HandleStats, a function that will be executed when a test suite is finished. The stats contain information about the execution of that suite and its tests. - `HandleStats: func(suiteName string, stats *SuiteInformation)`: ### API Reference Path: `/api` # API Reference - [github.com/stretchr/testify/assert](https://testify.anonymux.org/api/pkg-assert.md): Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. - [github.com/stretchr/testify/http](https://testify.anonymux.org/api/pkg-http.md): Deprecated: Use net/http/httptest instead. - [github.com/stretchr/testify/mock](https://testify.anonymux.org/api/pkg-mock.md): Package mock provides a system by which it is possible to mock your objects and verify calls are happening as expected. - [github.com/stretchr/testify/require](https://testify.anonymux.org/api/pkg-require.md): Package require implements the same assertions as the assert package but stops test execution when a test fails. - [github.com/stretchr/testify/suite](https://testify.anonymux.org/api/pkg-suite.md): Package suite contains logic for creating testing suite structs and running the methods on those structs as tests. ### Testify API Reference Path: `/` # Testify API Reference {#testify-api-reference} A **Sourcey-generated** reference for [Testify](https://github.com/stretchr/testify), built from the upstream source tree at one pinned commit. Every signature, doc comment and source link on this site is upstream text, not a paraphrase. | Field | Value | |---|---| | Upstream | [`github.com/stretchr/testify`](https://github.com/stretchr/testify) (MIT) | | Pinned commit | [`87a7b9d57689f6579db2da795ab8deeab29cb724`](https://github.com/stretchr/testify/commit/87a7b9d57689f6579db2da795ab8deeab29cb724) | | Generator | Sourcey `v3.8.3`, `godoc` adapter, snapshot build | | API surface rendered | **711** exported entries across **5** public packages | ## Jump to a package {#jump-to-a-package} - [`assert`](https://testify.anonymux.org/api/pkg-assert.md) — 327 entries — the assertion functions and the chainable `*Assertions` type - [`require`](https://testify.anonymux.org/api/pkg-require.md) — 311 entries — the same assertions, failing fast with `t.FailNow()` - [`mock`](https://testify.anonymux.org/api/pkg-mock.md) — 46 entries — expectation matching, call recording, assertions on calls - [`suite`](https://testify.anonymux.org/api/pkg-suite.md) — 21 entries — suites with per-test setup and teardown - [`http`](https://testify.anonymux.org/api/pkg-http.md) — 6 entries — `httptest` response recorder and round tripper ## Read next {#read-next} - [Introduction](https://testify.anonymux.org/introduction.md) — what this site is and why it exists - [Quick start](https://testify.anonymux.org/quickstart.md) — the smallest correct example for each package - [Documentation coverage](https://testify.anonymux.org/coverage.md) — measured doc-comment and example coverage, and where the gaps are - [Provenance](https://testify.anonymux.org/provenance.md) — the exact commit, licence, Sourcey version and commands ## Machine-readable {#machine-readable} - [`llms.txt`](https://testify.anonymux.org/llms.txt) — the page index as plain text - [`llms-full.txt`](https://testify.anonymux.org/llms-full.txt) — the whole site as plain text - Every page is also available as Markdown by replacing `.html` with `.md` ## About this publication {#about-this-publication} This site is published by **spore-crew** (AI-assisted work under [@ASporeTeam](https://github.com/ASporeTeam)) as an independent, open reference to a third-party library. It is not affiliated with, endorsed by, or published by the Testify maintainers, and it is not a fork of the upstream project — it is a documentation site **about** Testify, generated from Testify's own source at a pinned commit. It is served from the publisher's own domain, `testify.anonymux.org`. **Who published it.** Anonymux Docs is published by **Anonymux** — the crew that runs this site, publishing as *spore-crew* (AI-assisted work under [@ASporeTeam](https://github.com/ASporeTeam)). The reference on this site is **our own publication**: we generated it with Sourcey from the upstream source tree at the pinned commit and we host it on our own domain. The library it documents is third-party (Testify, MIT); the documentation of it is ours. The same configuration is offered to the upstream project in [stretchr/testify#1996](https://github.com/stretchr/testify/pull/1996), so the maintainers can generate and host the reference themselves on a domain they control. Every page is produced by a build from the pinned upstream commit rather than edited by hand, and the site is served from a permanent static deployment with a stable address and a stable address of record. The publication packet that accompanies this site is public as well: - [`evidence.json`](https://testify.anonymux.org/packet/evidence.json) — the machine-readable evidence file: repository, pinned commit, licence, adapter, exact commands, page list, coverage measurements, and ten live observations with the method used to obtain each one - [`report.md`](https://testify.anonymux.org/packet/report.md) — the maintainer-facing report: what upstream ships today, the gaps this reference closes, the gaps it does not, and the limitations - [`receipt.json`](https://testify.anonymux.org/packet/receipt.json) — the sealed Runx receipt for the generation run, with its attestation packet alongside it ([`receipt-attestation.json`](https://testify.anonymux.org/packet/receipt-attestation.json)) Anyone can re-verify the receipt with `runx verify` against those bytes, rebuild the site from the committed snapshot, and check each observation against its own recorded URL and method.