mock: Index | Files | Directories

package gomock

import ""

GoMock - a mock framework for Go.

Standard usage:

(1) Define an interface that you wish to mock.
      type MyInterface interface {
        SomeMethod(x int64, y string)
(2) Use mockgen to generate a mock from the interface.
(3) Use the mock in a test:
      func TestMyThing(t *testing.T) {
        mockCtrl := gomock.NewController(t)
        defer mockCtrl.Finish()

        mockObj := something.NewMockMyInterface(mockCtrl)
        mockObj.EXPECT().SomeMethod(4, "blah")
        // pass mockObj to a real object and play with it.

By default, expected calls are not enforced to run in any particular order. Call order dependency can be enforced by use of InOrder and/or Call.After. Call.After can create more varied call order dependencies, but InOrder is often more convenient.

The following examples create equivalent call order dependencies.

Example of using Call.After to chain expected call order:

firstCall := mockObj.EXPECT().SomeMethod(1, "first")
secondCall := mockObj.EXPECT().SomeMethod(2, "second").After(firstCall)
mockObj.EXPECT().SomeMethod(3, "third").After(secondCall)

Example of using InOrder to declare expected call order:

    mockObj.EXPECT().SomeMethod(1, "first"),
    mockObj.EXPECT().SomeMethod(2, "second"),
    mockObj.EXPECT().SomeMethod(3, "third"),


- Handle different argument/return types (e.g. ..., chan, map, interface).


Package Files

call.go callset.go controller.go matchers.go

func InOrder Uses

func InOrder(calls ...*Call)

InOrder declares that the given calls should occur in order.

type Call Uses

type Call struct {
    // contains filtered or unexported fields

Call represents an expected call to a mock.

func (*Call) After Uses

func (c *Call) After(preReq *Call) *Call

After declares that the call may only match after preReq has been exhausted.

func (*Call) AnyTimes Uses

func (c *Call) AnyTimes() *Call

AnyTimes allows the expectation to be called 0 or more times

func (*Call) Do Uses

func (c *Call) Do(f interface{}) *Call

Do declares the action to run when the call is matched. It takes an interface{} argument to support n-arity functions.

func (*Call) MaxTimes Uses

func (c *Call) MaxTimes(n int) *Call

MaxTimes limits the number of calls to n times. If AnyTimes or MinTimes have not been called, MaxTimes also sets the minimum number of calls to 0.

func (*Call) MinTimes Uses

func (c *Call) MinTimes(n int) *Call

MinTimes requires the call to occur at least n times. If AnyTimes or MaxTimes have not been called, MinTimes also sets the maximum number of calls to infinity.

func (*Call) Return Uses

func (c *Call) Return(rets ...interface{}) *Call

Return declares the values to be returned by the mocked function call.

func (*Call) SetArg Uses

func (c *Call) SetArg(n int, value interface{}) *Call

SetArg declares an action that will set the nth argument's value, indirected through a pointer. Or, in the case of a slice, SetArg will copy value's elements into the nth argument.

func (*Call) String Uses

func (c *Call) String() string

func (*Call) Times Uses

func (c *Call) Times(n int) *Call

Times declares the exact number of times a function call is expected to be executed.

type Controller Uses

type Controller struct {
    // contains filtered or unexported fields

A Controller represents the top-level control of a mock ecosystem. It defines the scope and lifetime of mock objects, as well as their expectations. It is safe to call Controller's methods from multiple goroutines.

func NewController Uses

func NewController(t TestReporter) *Controller

func WithContext Uses

func WithContext(ctx context.Context, t TestReporter) (*Controller, context.Context)

WithContext returns a new Controller and a Context, which is cancelled on any fatal failure.

func (*Controller) Call Uses

func (ctrl *Controller) Call(receiver interface{}, method string, args ...interface{}) []interface{}

func (*Controller) Finish Uses

func (ctrl *Controller) Finish()

func (*Controller) RecordCall Uses

func (ctrl *Controller) RecordCall(receiver interface{}, method string, args ...interface{}) *Call

func (*Controller) RecordCallWithMethodType Uses

func (ctrl *Controller) RecordCallWithMethodType(receiver interface{}, method string, methodType reflect.Type, args ...interface{}) *Call

type Matcher Uses

type Matcher interface {
    // Matches returns whether x is a match.
    Matches(x interface{}) bool

    // String describes what the matcher matches.
    String() string

A Matcher is a representation of a class of values. It is used to represent the valid or expected arguments to a mocked method.

func Any Uses

func Any() Matcher


func Eq Uses

func Eq(x interface{}) Matcher

func Nil Uses

func Nil() Matcher

func Not Uses

func Not(x interface{}) Matcher

type TestReporter Uses

type TestReporter interface {
    Errorf(format string, args ...interface{})
    Fatalf(format string, args ...interface{})

A TestReporter is something that can be used to report test failures. It is satisfied by the standard library's *testing.T.


mock_matcherPackage mock_gomock is a generated GoMock package.

Package gomock imports 9 packages (graph) and is imported by 776 packages. Updated 2017-10-20. Refresh now. Tools for package owners.