Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/powerman/check
Helpers to complement Go testing package
https://github.com/powerman/check
go golang golang-library unit-testing
Last synced: 6 days ago
JSON representation
Helpers to complement Go testing package
- Host: GitHub
- URL: https://github.com/powerman/check
- Owner: powerman
- License: mit
- Created: 2017-12-21T08:46:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T07:04:12.000Z (24 days ago)
- Last Synced: 2024-10-23T10:07:54.840Z (23 days ago)
- Topics: go, golang, golang-library, unit-testing
- Language: Go
- Homepage: https://godoc.org/github.com/powerman/check
- Size: 356 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# check
[](https://pkg.go.dev/github.com/powerman/check)
[](https://github.com/powerman/check/actions/workflows/CI&CD.yml)
[](https://coveralls.io/github/powerman/check?branch=master)
[](https://goreportcard.com/report/github.com/powerman/check)
[](https://github.com/powerman/check/releases/latest)
Helpers to complement Go [testing](https://golang.org/pkg/testing/)
package.
Write tests with ease and fun!
This package is like
[testify/assert](https://godoc.org/github.com/test-go/testify/assert)
on steroids. :)
## Features
- Compelling output from failed tests:
- Very easy-to-read dumps for expected and actual values.
- Same text diff you loved in testify/assert.
- Also visual diff in [GoConvey](http://goconvey.co/) web UI, if you
use it (recommended).
- Statistics with amount of passed/failed checks.
- Colored output in terminal.
- 100% compatible with testing package - check package just provide
convenient wrappers for `*testing.T` methods and doesn't introduce new
concepts like BDD, custom test suite or unusual execution flow.
- All checks you may ever need! :)
- Very easy to add your own check functions.
- Concise, handy and consistent API, without dot-import!
## Quickstart
Just wrap each (including subtests) `*testing.T` using `check.T()` and write
tests as usually with testing package. Call new methods provided by this
package to have more clean/concise test code and cool dump/diff.
```go
import "github.com/powerman/check"
func TestSomething(tt *testing.T) {
t := check.T(tt)
t.Equal(2, 2)
t.Log("You can use new t just like usual *testing.T")
t.Run("Subtests/Parallel example", func(tt *testing.T) {
t := check.T(tt)
t.Parallel()
t.NotEqual(2, 3, "should not be 3!")
obj, err := NewObj()
if t.Nil(err) {
t.Match(obj.field, `^\d+$`)
}
})
}
```
To get optional statistics about executed checkers add:
```go
func TestMain(m *testing.M) { check.TestMain(m) }
```
When use goconvey tool, to get nice diff in web UI
[add](https://github.com/smartystreets/goconvey/issues/513):
```go
import _ "github.com/smartystreets/goconvey/convey"
```
## Installation
Require [Go 1.9](https://golang.org/doc/go1.9#test-helper).
```sh
go get github.com/powerman/check
```
## TODO
- Doc:
- [ ] Add testable examples.
- [ ] Show how text diff and stats looks like (both text and screenshot with colors).
- [ ] Show how `goconvey` diff looks like.
- Questionable:
- [ ] Support custom checkers from gocheck etc.?
- [ ] Provide a way to force binary dump for utf8.Valid `string`/`[]byte`?
- [ ] Count skipped tests (will have to overload `Skip`, `Skipf`, `SkipNow`)?
- Complicated:
- [ ] Show line of source_test.go with failed test (like gocheck).
- [ ] Auto-detect missed `t:=check.T(tt)` - try to intercept `Run()` and
`Parallel()` for detecting using wrong `t` (looks like golangci-lint's
tparallel catch at least `Parallel()` case).