44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
# is [](http://godoc.org/github.com/matryer/is) [](https://goreportcard.com/report/github.com/matryer/is) [](https://travis-ci.org/matryer/is)
|
|
Professional lightweight testing mini-framework for Go.
|
|
|
|
* Easy to write and read
|
|
* [Beautifully simple API](https://pkg.go.dev/github.com/matryer/is) with everything you need: `is.Equal`, `is.True`, `is.NoErr`, and `is.Fail`
|
|
* Use comments to add descriptions (which show up when tests fail)
|
|
|
|
Failures are very easy to read:
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
The following code shows a range of useful ways you can use
|
|
the helper methods:
|
|
|
|
```go
|
|
func Test(t *testing.T) {
|
|
|
|
is := is.New(t)
|
|
|
|
signedin, err := isSignedIn(ctx)
|
|
is.NoErr(err) // isSignedIn error
|
|
is.Equal(signedin, true) // must be signed in
|
|
|
|
body := readBody(r)
|
|
is.True(strings.Contains(body, "Hi there"))
|
|
|
|
}
|
|
```
|
|
|
|
## Color
|
|
|
|
To turn off the colors, run `go test` with the `-nocolor` flag,
|
|
or with the env var [`NO_COLOR` (with any value)](https://no-color.org).
|
|
|
|
```
|
|
go test -nocolor
|
|
```
|
|
|
|
```
|
|
NO_COLOR=1 go test
|
|
```
|