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/mock/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/mock/doc.go')
-rw-r--r-- | vendor/github.com/stretchr/testify/mock/doc.go | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/vendor/github.com/stretchr/testify/mock/doc.go b/vendor/github.com/stretchr/testify/mock/doc.go new file mode 100644 index 000000000..7324128ef --- /dev/null +++ b/vendor/github.com/stretchr/testify/mock/doc.go @@ -0,0 +1,44 @@ +// Package mock provides a system by which it is possible to mock your objects +// and verify calls are happening as expected. +// +// Example Usage +// +// The mock package provides an object, Mock, that tracks activity on another object. It is usually +// embedded into a test object as shown below: +// +// type MyTestObject struct { +// // add a Mock object instance +// mock.Mock +// +// // other fields go here as normal +// } +// +// When implementing the methods of an interface, you wire your functions up +// to call the Mock.Called(args...) method, and return the appropriate values. +// +// For example, to mock a method that saves the name and age of a person and returns +// the year of their birth or an error, you might write this: +// +// func (o *MyTestObject) SavePersonDetails(firstname, lastname string, age int) (int, error) { +// args := o.Called(firstname, lastname, age) +// return args.Int(0), args.Error(1) +// } +// +// The Int, Error and Bool methods are examples of strongly typed getters that take the argument +// index position. Given this argument list: +// +// (12, true, "Something") +// +// You could read them out strongly typed like this: +// +// args.Int(0) +// args.Bool(1) +// args.String(2) +// +// For objects of your own type, use the generic Arguments.Get(index) method and make a type assertion: +// +// return args.Get(0).(*MyObject), args.Get(1).(*AnotherObjectOfMine) +// +// This may cause a panic if the object you are getting is nil (the type assertion will fail), in those +// cases you should check for nil first. +package mock |