Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the readme for gotest.tools, and better text
- Loading branch information
Showing
3 changed files
with
24 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,31 @@ | ||
# Go Test Yourself | ||
# gotest.tools | ||
|
||
A collection of packages compatible with `go test` to support common testing | ||
patterns. | ||
A collection of packages to augment `testing` and support common patterns. | ||
|
||
[![GoDoc](https://godoc.org/github.com/gotestyourself/gotestyourself?status.svg)](https://godoc.org/github.com/gotestyourself/gotestyourself) | ||
[![GoDoc](https://godoc.org/gotest.tools?status.svg)](https://godoc.org/gotest.tools) | ||
[![CircleCI](https://circleci.com/gh/gotestyourself/gotestyourself/tree/master.svg?style=shield)](https://circleci.com/gh/gotestyourself/gotestyourself/tree/master) | ||
[![Go Reportcard](https://goreportcard.com/badge/github.com/gotestyourself/gotestyourself)](https://goreportcard.com/report/github.com/gotestyourself/gotestyourself) | ||
[![Go Reportcard](https://goreportcard.com/badge/gotest.tools)](https://goreportcard.com/report/gotest.tools) | ||
|
||
|
||
## Packages | ||
|
||
* [assert](http://godoc.org/github.com/gotestyourself/gotestyourself/assert) - | ||
compare values and fail the test when the comparison fails | ||
* [env](http://godoc.org/github.com/gotestyourself/gotestyourself/env) - | ||
test code that uses environment variables | ||
* [fs](http://godoc.org/github.com/gotestyourself/gotestyourself/fs) - | ||
create test files and compare directories structures | ||
* [golden](http://godoc.org/github.com/gotestyourself/gotestyourself/golden) - | ||
compare large multi-line strings | ||
* [icmd](http://godoc.org/github.com/gotestyourself/gotestyourself/icmd) - | ||
* [assert](http://godoc.org/gotest.tools/assert) - | ||
compare values and fail the test when a comparison fails | ||
* [env](http://godoc.org/gotest.tools/env) - | ||
test code which uses environment variables | ||
* [fs](http://godoc.org/gotest.tools/fs) - | ||
create temporary files and compare a filesystem tree to an expected value | ||
* [golden](http://godoc.org/gotest.tools/golden) - | ||
compare large multi-line strings against values frozen in golden files | ||
* [icmd](http://godoc.org/gotest.tools/icmd) - | ||
execute binaries and test the output | ||
* [poll](http://godoc.org/github.com/gotestyourself/gotestyourself/poll) - | ||
* [poll](http://godoc.org/gotest.tools/poll) - | ||
test asynchronous code by polling until a desired state is reached | ||
* [skip](http://godoc.org/github.com/gotestyourself/gotestyourself/skip) - | ||
skip tests based on conditions | ||
* [skip](http://godoc.org/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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
package gotestyourself | ||
/*Package gotesttools is a collection of packages to augment `testing` and | ||
support common patterns. | ||
*/ | ||
package gotesttools // import "gotest.tools" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters