1# gotest.tools
2
3A collection of packages to augment `testing` and support common patterns.
4
5[](https://pkg.go.dev/gotest.tools/v3)
6[](https://circleci.com/gh/gotestyourself/gotest.tools/tree/main)
7[](https://goreportcard.com/report/gotest.tools/v3)
8
9## Usage
10
11With Go modules enabled
12
13```
14$ go get gotest.tools/v3
15```
16
17```
18import "gotest.tools/v3/assert"
19```
20
21## Packages
22
23* [assert](http://pkg.go.dev/gotest.tools/v3/assert) -
24 compare values and fail the test when a comparison fails
25* [env](http://pkg.go.dev/gotest.tools/v3/env) -
26 test code which uses environment variables
27* [fs](http://pkg.go.dev/gotest.tools/v3/fs) -
28 create temporary files and compare a filesystem tree to an expected value
29* [golden](http://pkg.go.dev/gotest.tools/v3/golden) -
30 compare large multi-line strings against values frozen in golden files
31* [icmd](http://pkg.go.dev/gotest.tools/v3/icmd) -
32 execute binaries and test the output
33* [poll](http://pkg.go.dev/gotest.tools/v3/poll) -
34 test asynchronous code by polling until a desired state is reached
35* [skip](http://pkg.go.dev/gotest.tools/v3/skip) -
36 skip a test and print the source code of the condition used to skip the test
37
38## Related
39
40* [gotest.tools/gotestsum](https://github.com/gotestyourself/gotestsum) -
41 go test runner with custom output
42* [go testing patterns](https://github.com/gotestyourself/gotest.tools/wiki/Go-Testing-Patterns) -
43 zero-dependency patterns for organizing test cases
44* [test doubles and patching](https://github.com/gotestyourself/gotest.tools/wiki/Test-Doubles-And-Patching) -
45 zero-dependency test doubles (fakes, spies, stubs, and mocks) and monkey patching patterns
46
47## Contributing
48
49See [CONTRIBUTING.md](CONTRIBUTING.md).
View as plain text