# gotest.tools

A collection of packages to augment `testing` and support common patterns.

[![GoDoc](https://godoc.org/gotest.tools?status.svg)](http://gotest.tools)
[![CircleCI](https://circleci.com/gh/gotestyourself/gotest.tools/tree/master.svg?style=shield)](https://circleci.com/gh/gotestyourself/gotest.tools/tree/master)
[![Go Reportcard](https://goreportcard.com/badge/gotest.tools)](https://goreportcard.com/report/gotest.tools)

## Usage

With Go modules enabled (go1.11+)

```
$ go get gotest.tools/v3
```

```
import "gotest.tools/v3/assert"
```

To use `gotest.tools` with an older version of Go that does not understand Go
module paths pin to version `v2.3.0`.


## Packages

* [assert](http://gotest.tools/assert) -
  compare values and fail the test when a comparison fails
* [env](http://gotest.tools/env) -
  test code which uses environment variables
* [fs](http://gotest.tools/fs) -
  create temporary files and compare a filesystem tree to an expected value
* [golden](http://gotest.tools/golden) -
  compare large multi-line strings against values frozen in golden files
* [icmd](http://gotest.tools/icmd) -
  execute binaries and test the output
* [poll](http://gotest.tools/poll) -
  test asynchronous code by polling until a desired state is reached
* [skip](http://gotest.tools/skip) -
  skip a test and print the source code of the condition used to skip the test

## Related

* [gotest.tools/gotestsum](https://github.com/gotestyourself/gotestsum) - go test runner with custom output
* [maxbrunsfeld/counterfeiter](https://github.com/maxbrunsfeld/counterfeiter) - generate fakes for interfaces
* [jonboulle/clockwork](https://github.com/jonboulle/clockwork) - a fake clock for testing code that uses `time`

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).