1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
|
# Assert
Simple test assertions for Go. This is a fork of a fork of a [bmizerany/assert][original]
with improved support for things like nil pointers, etc.
[Documentation][docs]
[original]: http://github.com/bmizerany/assert
[docs]: http://godoc.org/github.com/bruth/assert
Installation
------------
$ go get github.com/bruth/assert
API
---
func Equal(t *testing.T, expected, got interface{}, messages ...interface{})
func NotEqual(t *testing.T, expected, got interface{}, messages ...interface{})
func True(t *testing.T, got interface{}, messages ...interface{})
func False(t *testing.T, got interface{}, messages ...interface{})
func Nil(t *testing.T, got interface{}, messages ...interface{})
func NotNil(t *testing.T, got interface{}, messages ...interface{})
func Contains(t *testing.T, expected string, got string, messages ...interface{})
func NotContains(t *testing.T, unexpected string, got string, messages ...interface{})
func Panic(t *testing.T, err interface{}, fn func(), messages ...interface{})
Example
-------
```go
package main
import "github.com/bruth/assert"
type CoolStruct struct{}
func TestThings(t *testing.T) {
myString := "cool"
assert.Equal(t, "cool", myString, "myString should be equal")
assert.NotEqual(t, "nope", myString)
var myStruct CoolStruct
assert.Nil(t, myStruct)
}
```
See [assert_test.go][assert_test] for more usage examples.
Output
------
You can add extra information to test failures by passing in any number of extra
arguments:
```go
assert.Equal(t, "foo", myString, "Should set up a proper foo string")
```
```console
% go test
--- FAIL: TestImportantFeature (0.00 seconds)
assert.go:18: /Users/tyson/go/src/github.com/foo/bar/main_test.go:31
assert.go:38: 💩 Unexpected: "foo"
assert.go:40: 💩 - Should set up a proper foo string
FAIL
exit status 1
FAIL github.com/foo/bar 0.017s
```
[assert_test]: https://github.com/bruth/assert/blob/master/assert_test.go
License
-------
Copyright Blake Mizerany and Keith Rarick. Licensed under the [MIT
license](http://opensource.org/licenses/MIT). Additional modifications by
Stovepipe Studios.
|