diff options
author | Chris <ccbrown112@gmail.com> | 2017-08-08 17:40:46 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-08-08 17:40:46 -0500 |
commit | 6b741c4cea36f54b8f20c4a3e5871f00123db185 (patch) | |
tree | a10eeddd277c4eba48a27431ead816561a20f159 /vendor/github.com/stretchr/testify/assert/doc.go | |
parent | c42510a7f4cf87d1dd7f7339633f06df86f25cce (diff) | |
download | chat-6b741c4cea36f54b8f20c4a3e5871f00123db185.tar.gz chat-6b741c4cea36f54b8f20c4a3e5871f00123db185.tar.bz2 chat-6b741c4cea36f54b8f20c4a3e5871f00123db185.zip |
testify (#7116)
Diffstat (limited to 'vendor/github.com/stretchr/testify/assert/doc.go')
-rw-r--r-- | vendor/github.com/stretchr/testify/assert/doc.go | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/vendor/github.com/stretchr/testify/assert/doc.go b/vendor/github.com/stretchr/testify/assert/doc.go new file mode 100644 index 000000000..c9dccc4d6 --- /dev/null +++ b/vendor/github.com/stretchr/testify/assert/doc.go @@ -0,0 +1,45 @@ +// Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. +// +// Example Usage +// +// The following is a complete example using assert in a standard test function: +// import ( +// "testing" +// "github.com/stretchr/testify/assert" +// ) +// +// func TestSomething(t *testing.T) { +// +// var a string = "Hello" +// var b string = "Hello" +// +// assert.Equal(t, a, b, "The two words should be the same.") +// +// } +// +// if you assert many times, use the format below: +// +// import ( +// "testing" +// "github.com/stretchr/testify/assert" +// ) +// +// func TestSomething(t *testing.T) { +// assert := assert.New(t) +// +// var a string = "Hello" +// var b string = "Hello" +// +// assert.Equal(a, b, "The two words should be the same.") +// } +// +// Assertions +// +// Assertions allow you to easily write test code, and are global funcs in the `assert` package. +// All assertion functions take, as the first argument, the `*testing.T` object provided by the +// testing framework. This allows the assertion funcs to write the failings and other details to +// the correct place. +// +// Every assertion function also takes an optional string message as the final argument, +// allowing custom error messages to be appended to the message the assertion method outputs. +package assert |