README
¶
Testify/v2
The v2 our tests wanted
A set of go packages that provide tools for testifying (verifying) that your code behaves as you intended.
This is the go-openapi fork of the great testify package.
[!NOTE] This is the home of
github.com/go-openapi/testify/v2, an active, opinionated fork ofgithub.com/stretchr/testify.
Main features:
- zero external dependencies
- opt-in dependencies for extra features (e.g. asserting YAML, colorized output)
- assertions using generic types (see a basic example). Read the fully story with generics
- searchable documentation
Announcements
- 2025-12-19 : new community chat on discord
- a new discord community channel is available to be notified of changes and support users
- our venerable Slack channel remains open, and will be eventually discontinued on 2026-03-31
You may join the discord community by clicking the invite link on the discord badge (also above).
Or join our Slack channel: 
Status
Design and exploration phase. Feedback, contributions and proposals are welcome.
Recent news
✅ Fully refactored how assertions are generated and documented.
Fixes
✅ Fixed hangs & panics when using
spew. Fuzzedspew. Fixed deterministic order of keys in diff.✅ Fixed go routine leaks with
EventuallyWithand co.✅ Fixed wrong logic with
IsNonIncreasing,InNonDecreasing✅ Fixed edge cases with
InDelta,InEpsilon✅ Fixed edge cases with
EqualValuesAdditions
✅ Introduced generics: ~ 40 new type-safe assertions with generic types (doc: added usage guide, examples and benchmark)
✅ Added
Kind&NotKind,Consistently,NoGoRoutineLeak,NoFileDescriptorLeak✅ Added opt-in support for colorized output
✅ Added migration tool
See also our ROADMAP.
Getting started
Import this library in your project like so.
go get github.com/go-openapi/testify/v2
... and start writing tests. Look at our examples.
Basic usage
testify simplifies your test assertions like so.
import (
"testing"
)
...
const expected = "expected result"
result := printImports(input)
if result != expected {
t.Errorf(
"Expected: %s. Got: %s", expected, result,
)
return
}
Becomes:
import (
"testing"
"github.com/go-openapi/testify/v2/require"
)
...
const expected = "expected result"
require.Equalf(t,
expected, printImports(input), "Expected: %s. Got: %s",
expected, result,
)
Usage at go-openapi and go-swagger
This fork now fully replaces the original project for all go-openapi projects, thus reducing their dependencies footprint.
Go-swagger will be adapted over Q1 2026.
Features will be added to support our main use cases there.
Change log
See https://github.com/go-openapi/testify/releases
Licensing
SPDX-FileCopyrightText: Copyright 2025 go-swagger maintainers
This library ships under the SPDX-License-Identifier: Apache-2.0.
See the license NOTICE, which recalls the licensing terms of all the pieces of software distributed with this fork, including internalized libraries.
Other documentation
Cutting a new release
Maintainers can cut a new release by either:
- running this workflow (recommended)
- or :
- preparing go.mod files with the next tag, merge
- pushing a semver tag
- signed tags are preferred
- The tag message is prepended to release notes
Documentation
¶
Overview ¶
Package testify provides comprehensive assertion packages for Go testing.
Overview ¶
This is the go-openapi fork of testify, designed with zero external dependencies and a focus on maintainability. The codebase uses code generation more extensively than the original testify. This helps maintain consistency across all assertion variants.
Packages ¶
The assert package provides a comprehensive set of assertion functions that integrate with Go's testing framework. Assertions return boolean values allowing tests to continue after failures.
The require package provides the same assertions but with fatal checks that stop test execution immediately on failure via testing.T.FailNow.
Key Differences from stretchr/testify ¶
This fork prioritizes:
- Zero external dependencies: spew and difflib are internalized
- Removed mock and suite packages (favor the use mockery or similar specialized tools instead)
- Optional features via enable packages (e.g., enable/yaml for YAML assertions)
- Code generation ensures consistency across many assertion functions × 4 to 8 variants
Optional Features ¶
YAML assertions require importing the enable package:
import _ "github.com/go-openapi/testify/v2/enable/yaml"
Without this import, assert.YAMLEq and require.YAMLEq will panic loudly with a helpful error message.
Note on testifylint ¶
testifylint is a linter compatible with golangci-lint. It is designed for stretchr/testify and will not work with this fork as it checks only for the original dependency.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package assert provides a set of testing tools for use with the standard Go testing system.
|
Package assert provides a set of testing tools for use with the standard Go testing system. |
|
Package enable contains go modules with extra-dependencies.
|
Package enable contains go modules with extra-dependencies. |
|
stubs
Package stubs provides public APIs for enabling optional features in testify.
|
Package stubs provides public APIs for enabling optional features in testify. |
|
stubs/colors
Package colors is an indirection to handle colorized output.
|
Package colors is an indirection to handle colorized output. |
|
stubs/yaml
Package yaml is an indirection to the internal implementation that handles YAML deserialization.
|
Package yaml is an indirection to the internal implementation that handles YAML deserialization. |
|
internal
|
|
|
assertions
Package assertions holds the internal implementation of all the assertion and helper functions exposed by testify.
|
Package assertions holds the internal implementation of all the assertion and helper functions exposed by testify. |
|
assertions/enable
Package enable allows to register extra features.
|
Package enable allows to register extra features. |
|
assertions/enable/yaml
Package yaml is an indirection to handle YAML serialization/deserialization.
|
Package yaml is an indirection to handle YAML serialization/deserialization. |
|
assertions/unsafetests
Package unsafetests exists only to isolate tests that reference the unsafe package.
|
Package unsafetests exists only to isolate tests that reference the unsafe package. |
|
difflib
Package difflib is a partial port of [Python difflib module].
|
Package difflib is a partial port of [Python difflib module]. |
|
fdleak
Package fdleak provides file descriptor leak detection.
|
Package fdleak provides file descriptor leak detection. |
|
leak
Package leak provide goroutine leak detection using pprof labels instead of stack-trace heuristics.
|
Package leak provide goroutine leak detection using pprof labels instead of stack-trace heuristics. |
|
spew
Package spew implements a deep pretty printer for Go data structures to aid in debugging.
|
Package spew implements a deep pretty printer for Go data structures to aid in debugging. |
|
spew/testsrc
Package testsrc is a package for testing spew with cgo.
|
Package testsrc is a package for testing spew with cgo. |
|
Package require implements the same assertions as the assert package but stops test execution when a test fails.
|
Package require implements the same assertions as the assert package but stops test execution when a test fails. |