fix golang/mock (#1310)

Gopkg.lock

@@ -231,12 +231,12 @@
   version = "v3.5.1"
 
 [[projects]]
-  digest = "1:a62049a8fa554d688c8db4845c65ddcd5986b75f3a851e4fb563c6893d292e38"
+  digest = "1:b60efdeb75d3c0ceed88783ac2495256aba3491a537d0f31401202579fd62a94"
   name = "github.com/golang/mock"
   packages = ["gomock"]
   pruneopts = "NUT"
-  revision = "13f360950a79f5864a972c786a10a50e44b69541"
+  revision = "51421b967af1f557f93a59e0057aaf15ca02e29c"
-  version = "v1.0.0"
+  version = "v1.2.0"
 
 [[projects]]
   digest = "1:ac761a089c90c1399e2fd0a0aacfe63bd7b4ecd01141c98ca9cf18059f938ea4"

Makefile

@@ -246,6 +246,7 @@ gen-install:
 
 mock-install: ##@other Install mocking tools
 	go get -u github.com/golang/mock/mockgen
+	dep ensure -update github.com/golang/mock
 
 mock: ##@other Regenerate mocks
 	mockgen -package=fcm          -destination=notifications/push/fcm/client_mock.go -source=notifications/push/fcm/client.go

account/accounts_mock.go

@@ -36,6 +36,7 @@ func (m *MockGethServiceProvider) EXPECT() *MockGethServiceProviderMockRecorder
 
 // AccountManager mocks base method
 func (m *MockGethServiceProvider) AccountManager() (*accounts.Manager, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "AccountManager")
 	ret0, _ := ret[0].(*accounts.Manager)
 	ret1, _ := ret[1].(error)
@@ -44,11 +45,13 @@ func (m *MockGethServiceProvider) AccountManager() (*accounts.Manager, error) {
 
 // AccountManager indicates an expected call of AccountManager
 func (mr *MockGethServiceProviderMockRecorder) AccountManager() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AccountManager", reflect.TypeOf((*MockGethServiceProvider)(nil).AccountManager))
 }
 
 // AccountKeyStore mocks base method
 func (m *MockGethServiceProvider) AccountKeyStore() (*keystore.KeyStore, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "AccountKeyStore")
 	ret0, _ := ret[0].(*keystore.KeyStore)
 	ret1, _ := ret[1].(error)
@@ -57,5 +60,6 @@ func (m *MockGethServiceProvider) AccountKeyStore() (*keystore.KeyStore, error)
 
 // AccountKeyStore indicates an expected call of AccountKeyStore
 func (mr *MockGethServiceProviderMockRecorder) AccountKeyStore() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AccountKeyStore", reflect.TypeOf((*MockGethServiceProvider)(nil).AccountKeyStore))
 }

notifications/push/fcm/client_mock.go

@@ -5,10 +5,9 @@
 package fcm
 
 import (
-	reflect "reflect"
+	go_fcm "github.com/NaySoftware/go-fcm"
-
-	fcm "github.com/NaySoftware/go-fcm"
 	gomock "github.com/golang/mock/gomock"
+	reflect "reflect"
 )
 
 // MockFirebaseClient is a mock of FirebaseClient interface
@@ -35,26 +34,30 @@ func (m *MockFirebaseClient) EXPECT() *MockFirebaseClientMockRecorder {
 }
 
 // NewFcmRegIdsMsg mocks base method
-func (m *MockFirebaseClient) NewFcmRegIdsMsg(tokens []string, body interface{}) *fcm.FcmClient {
+func (m *MockFirebaseClient) NewFcmRegIdsMsg(tokens []string, body interface{}) *go_fcm.FcmClient {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "NewFcmRegIdsMsg", tokens, body)
-	ret0, _ := ret[0].(*fcm.FcmClient)
+	ret0, _ := ret[0].(*go_fcm.FcmClient)
 	return ret0
 }
 
 // NewFcmRegIdsMsg indicates an expected call of NewFcmRegIdsMsg
 func (mr *MockFirebaseClientMockRecorder) NewFcmRegIdsMsg(tokens, body interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewFcmRegIdsMsg", reflect.TypeOf((*MockFirebaseClient)(nil).NewFcmRegIdsMsg), tokens, body)
 }
 
 // Send mocks base method
-func (m *MockFirebaseClient) Send() (*fcm.FcmResponseStatus, error) {
+func (m *MockFirebaseClient) Send() (*go_fcm.FcmResponseStatus, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "Send")
-	ret0, _ := ret[0].(*fcm.FcmResponseStatus)
+	ret0, _ := ret[0].(*go_fcm.FcmResponseStatus)
 	ret1, _ := ret[1].(error)
 	return ret0, ret1
 }
 
 // Send indicates an expected call of Send
 func (mr *MockFirebaseClientMockRecorder) Send() *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Send", reflect.TypeOf((*MockFirebaseClient)(nil).Send))
 }

services/peer/discoverer_mock.go

@@ -34,6 +34,7 @@ func (m *MockDiscoverer) EXPECT() *MockDiscovererMockRecorder {
 
 // Discover mocks base method
 func (m *MockDiscoverer) Discover(topic string, max, min int) error {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "Discover", topic, max, min)
 	ret0, _ := ret[0].(error)
 	return ret0
@@ -41,5 +42,6 @@ func (m *MockDiscoverer) Discover(topic string, max, min int) error {
 
 // Discover indicates an expected call of Discover
 func (mr *MockDiscovererMockRecorder) Discover(topic, max, min interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Discover", reflect.TypeOf((*MockDiscoverer)(nil).Discover), topic, max, min)
 }

services/status/account_mock.go

@@ -37,6 +37,7 @@ func (m *MockWhisperService) EXPECT() *MockWhisperServiceMockRecorder {
 
 // AddKeyPair mocks base method
 func (m *MockWhisperService) AddKeyPair(key *ecdsa.PrivateKey) (string, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "AddKeyPair", key)
 	ret0, _ := ret[0].(string)
 	ret1, _ := ret[1].(error)
@@ -45,6 +46,7 @@ func (m *MockWhisperService) AddKeyPair(key *ecdsa.PrivateKey) (string, error) {
 
 // AddKeyPair indicates an expected call of AddKeyPair
 func (mr *MockWhisperServiceMockRecorder) AddKeyPair(key interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddKeyPair", reflect.TypeOf((*MockWhisperService)(nil).AddKeyPair), key)
 }
 
@@ -73,6 +75,7 @@ func (m *MockAccountManager) EXPECT() *MockAccountManagerMockRecorder {
 
 // AddressToDecryptedAccount mocks base method
 func (m *MockAccountManager) AddressToDecryptedAccount(arg0, arg1 string) (accounts.Account, *keystore.Key, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "AddressToDecryptedAccount", arg0, arg1)
 	ret0, _ := ret[0].(accounts.Account)
 	ret1, _ := ret[1].(*keystore.Key)
@@ -82,11 +85,13 @@ func (m *MockAccountManager) AddressToDecryptedAccount(arg0, arg1 string) (accou
 
 // AddressToDecryptedAccount indicates an expected call of AddressToDecryptedAccount
 func (mr *MockAccountManagerMockRecorder) AddressToDecryptedAccount(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddressToDecryptedAccount", reflect.TypeOf((*MockAccountManager)(nil).AddressToDecryptedAccount), arg0, arg1)
 }
 
 // SelectAccount mocks base method
 func (m *MockAccountManager) SelectAccount(address, password string) error {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "SelectAccount", address, password)
 	ret0, _ := ret[0].(error)
 	return ret0
@@ -94,11 +99,13 @@ func (m *MockAccountManager) SelectAccount(address, password string) error {
 
 // SelectAccount indicates an expected call of SelectAccount
 func (mr *MockAccountManagerMockRecorder) SelectAccount(address, password interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SelectAccount", reflect.TypeOf((*MockAccountManager)(nil).SelectAccount), address, password)
 }
 
 // CreateAccount mocks base method
 func (m *MockAccountManager) CreateAccount(password string) (string, string, string, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "CreateAccount", password)
 	ret0, _ := ret[0].(string)
 	ret1, _ := ret[1].(string)
@@ -109,5 +116,6 @@ func (m *MockAccountManager) CreateAccount(password string) (string, string, str
 
 // CreateAccount indicates an expected call of CreateAccount
 func (mr *MockAccountManagerMockRecorder) CreateAccount(password interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateAccount", reflect.TypeOf((*MockAccountManager)(nil).CreateAccount), password)
 }

transactions/fake/mock.go

@@ -38,6 +38,7 @@ func (m *MockPublicTransactionPoolAPI) EXPECT() *MockPublicTransactionPoolAPIMoc
 
 // GasPrice mocks base method
 func (m *MockPublicTransactionPoolAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "GasPrice", ctx)
 	ret0, _ := ret[0].(*hexutil.Big)
 	ret1, _ := ret[1].(error)
@@ -46,11 +47,13 @@ func (m *MockPublicTransactionPoolAPI) GasPrice(ctx context.Context) (*hexutil.B
 
 // GasPrice indicates an expected call of GasPrice
 func (mr *MockPublicTransactionPoolAPIMockRecorder) GasPrice(ctx interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GasPrice", reflect.TypeOf((*MockPublicTransactionPoolAPI)(nil).GasPrice), ctx)
 }
 
 // EstimateGas mocks base method
 func (m *MockPublicTransactionPoolAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "EstimateGas", ctx, args)
 	ret0, _ := ret[0].(hexutil.Uint64)
 	ret1, _ := ret[1].(error)
@@ -59,11 +62,13 @@ func (m *MockPublicTransactionPoolAPI) EstimateGas(ctx context.Context, args Cal
 
 // EstimateGas indicates an expected call of EstimateGas
 func (mr *MockPublicTransactionPoolAPIMockRecorder) EstimateGas(ctx, args interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EstimateGas", reflect.TypeOf((*MockPublicTransactionPoolAPI)(nil).EstimateGas), ctx, args)
 }
 
 // GetTransactionCount mocks base method
 func (m *MockPublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNr rpc.BlockNumber) (*hexutil.Uint64, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "GetTransactionCount", ctx, address, blockNr)
 	ret0, _ := ret[0].(*hexutil.Uint64)
 	ret1, _ := ret[1].(error)
@@ -72,11 +77,13 @@ func (m *MockPublicTransactionPoolAPI) GetTransactionCount(ctx context.Context,
 
 // GetTransactionCount indicates an expected call of GetTransactionCount
 func (mr *MockPublicTransactionPoolAPIMockRecorder) GetTransactionCount(ctx, address, blockNr interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetTransactionCount", reflect.TypeOf((*MockPublicTransactionPoolAPI)(nil).GetTransactionCount), ctx, address, blockNr)
 }
 
 // SendRawTransaction mocks base method
 func (m *MockPublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {
+	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "SendRawTransaction", ctx, encodedTx)
 	ret0, _ := ret[0].(common.Hash)
 	ret1, _ := ret[1].(error)
@@ -85,5 +92,6 @@ func (m *MockPublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, e
 
 // SendRawTransaction indicates an expected call of SendRawTransaction
 func (mr *MockPublicTransactionPoolAPIMockRecorder) SendRawTransaction(ctx, encodedTx interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SendRawTransaction", reflect.TypeOf((*MockPublicTransactionPoolAPI)(nil).SendRawTransaction), ctx, encodedTx)
 }

vendor/github.com/golang/mock/gomock/call.go

@@ -17,18 +17,19 @@ package gomock
 import (
 	"fmt"
 	"reflect"
+	"strconv"
 	"strings"
 )
 
 // Call represents an expected call to a mock.
 type Call struct {
-	t TestReporter // for triggering test failures on invalid call setup
+	t TestHelper // for triggering test failures on invalid call setup
 
-	receiver   interface{}   // the receiver of the method call
+	receiver   interface{}  // the receiver of the method call
-	method     string        // the name of the method
+	method     string       // the name of the method
-	methodType reflect.Type  // the type of the method
+	methodType reflect.Type // the type of the method
-	args       []Matcher     // the args
+	args       []Matcher    // the args
-	rets       []interface{} // the return values (if any)
+	origin     string       // file and line number of call setup
 
 	preReqs []*Call // prerequisite calls
 
@@ -37,9 +38,42 @@ type Call struct {
 
 	numCalls int // actual number made
 
-	// Actions
+	// actions are called when this Call is called. Each action gets the args and
-	doFunc  reflect.Value
+	// can set the return values by returning a non-nil slice. Actions run in the
-	setArgs map[int]reflect.Value
+	// order they are created.
+	actions []func([]interface{}) []interface{}
+}
+
+// newCall creates a *Call. It requires the method type in order to support
+// unexported methods.
+func newCall(t TestHelper, receiver interface{}, method string, methodType reflect.Type, args ...interface{}) *Call {
+	t.Helper()
+
+	// TODO: check arity, types.
+	margs := make([]Matcher, len(args))
+	for i, arg := range args {
+		if m, ok := arg.(Matcher); ok {
+			margs[i] = m
+		} else if arg == nil {
+			// Handle nil specially so that passing a nil interface value
+			// will match the typed nils of concrete args.
+			margs[i] = Nil()
+		} else {
+			margs[i] = Eq(arg)
+		}
+	}
+
+	origin := callerInfo(3)
+	actions := []func([]interface{}) []interface{}{func([]interface{}) []interface{} {
+		// Synthesize the zero value for each of the return args' types.
+		rets := make([]interface{}, methodType.NumOut())
+		for i := 0; i < methodType.NumOut(); i++ {
+			rets[i] = reflect.Zero(methodType.Out(i)).Interface()
+		}
+		return rets
+	}}
+	return &Call{t: t, receiver: receiver, method: method, methodType: methodType,
+		args: margs, origin: origin, minCalls: 1, maxCalls: 1, actions: actions}
 }
 
 // AnyTimes allows the expectation to be called 0 or more times
@@ -68,19 +102,67 @@ func (c *Call) MaxTimes(n int) *Call {
 	return c
 }
 
-// Do declares the action to run when the call is matched.
+// DoAndReturn declares the action to run when the call is matched.
+// The return values from this function are returned by the mocked function.
 // It takes an interface{} argument to support n-arity functions.
-func (c *Call) Do(f interface{}) *Call {
+func (c *Call) DoAndReturn(f interface{}) *Call {
 	// TODO: Check arity and types here, rather than dying badly elsewhere.
-	c.doFunc = reflect.ValueOf(f)
+	v := reflect.ValueOf(f)
+
+	c.addAction(func(args []interface{}) []interface{} {
+		vargs := make([]reflect.Value, len(args))
+		ft := v.Type()
+		for i := 0; i < len(args); i++ {
+			if args[i] != nil {
+				vargs[i] = reflect.ValueOf(args[i])
+			} else {
+				// Use the zero value for the arg.
+				vargs[i] = reflect.Zero(ft.In(i))
+			}
+		}
+		vrets := v.Call(vargs)
+		rets := make([]interface{}, len(vrets))
+		for i, ret := range vrets {
+			rets[i] = ret.Interface()
+		}
+		return rets
+	})
 	return c
 }
 
+// Do declares the action to run when the call is matched. The function's
+// return values are ignored to retain backward compatibility. To use the
+// return values call DoAndReturn.
+// It takes an interface{} argument to support n-arity functions.
+func (c *Call) Do(f interface{}) *Call {
+	// TODO: Check arity and types here, rather than dying badly elsewhere.
+	v := reflect.ValueOf(f)
+
+	c.addAction(func(args []interface{}) []interface{} {
+		vargs := make([]reflect.Value, len(args))
+		ft := v.Type()
+		for i := 0; i < len(args); i++ {
+			if args[i] != nil {
+				vargs[i] = reflect.ValueOf(args[i])
+			} else {
+				// Use the zero value for the arg.
+				vargs[i] = reflect.Zero(ft.In(i))
+			}
+		}
+		v.Call(vargs)
+		return nil
+	})
+	return c
+}
+
+// Return declares the values to be returned by the mocked function call.
 func (c *Call) Return(rets ...interface{}) *Call {
+	c.t.Helper()
+
 	mt := c.methodType
 	if len(rets) != mt.NumOut() {
-		c.t.Fatalf("wrong number of arguments to Return for %T.%v: got %d, want %d",
+		c.t.Fatalf("wrong number of arguments to Return for %T.%v: got %d, want %d [%s]",
-			c.receiver, c.method, len(rets), mt.NumOut())
+			c.receiver, c.method, len(rets), mt.NumOut(), c.origin)
 	}
 	for i, ret := range rets {
 		if got, want := reflect.TypeOf(ret), mt.Out(i); got == want {
@@ -91,8 +173,8 @@ func (c *Call) Return(rets ...interface{}) *Call {
 			case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice:
 				// ok
 			default:
-				c.t.Fatalf("argument %d to Return for %T.%v is nil, but %v is not nillable",
+				c.t.Fatalf("argument %d to Return for %T.%v is nil, but %v is not nillable [%s]",
-					i, c.receiver, c.method, want)
+					i, c.receiver, c.method, want, c.origin)
 			}
 		} else if got.AssignableTo(want) {
 			// Assignable type relation. Make the assignment now so that the generated code
@@ -101,31 +183,36 @@ func (c *Call) Return(rets ...interface{}) *Call {
 			v.Set(reflect.ValueOf(ret))
 			rets[i] = v.Interface()
 		} else {
-			c.t.Fatalf("wrong type of argument %d to Return for %T.%v: %v is not assignable to %v",
+			c.t.Fatalf("wrong type of argument %d to Return for %T.%v: %v is not assignable to %v [%s]",
-				i, c.receiver, c.method, got, want)
+				i, c.receiver, c.method, got, want, c.origin)
 		}
 	}
 
-	c.rets = rets
+	c.addAction(func([]interface{}) []interface{} {
+		return rets
+	})
+
 	return c
 }
 
+// Times declares the exact number of times a function call is expected to be executed.
 func (c *Call) Times(n int) *Call {
 	c.minCalls, c.maxCalls = n, n
 	return c
 }
 
 // SetArg declares an action that will set the nth argument's value,
-// indirected through a pointer.
+// indirected through a pointer. Or, in the case of a slice, SetArg
+// will copy value's elements into the nth argument.
 func (c *Call) SetArg(n int, value interface{}) *Call {
-	if c.setArgs == nil {
+	c.t.Helper()
-		c.setArgs = make(map[int]reflect.Value)
+
-	}
 	mt := c.methodType
 	// TODO: This will break on variadic methods.
 	// We will need to check those at invocation time.
 	if n < 0 || n >= mt.NumIn() {
-		c.t.Fatalf("SetArg(%d, ...) called for a method with %d args", n, mt.NumIn())
+		c.t.Fatalf("SetArg(%d, ...) called for a method with %d args [%s]",
+			n, mt.NumIn(), c.origin)
 	}
 	// Permit setting argument through an interface.
 	// In the interface case, we don't (nay, can't) check the type here.
@@ -134,14 +221,28 @@ func (c *Call) SetArg(n int, value interface{}) *Call {
 	case reflect.Ptr:
 		dt := at.Elem()
 		if vt := reflect.TypeOf(value); !vt.AssignableTo(dt) {
-			c.t.Fatalf("SetArg(%d, ...) argument is a %v, not assignable to %v", n, vt, dt)
+			c.t.Fatalf("SetArg(%d, ...) argument is a %v, not assignable to %v [%s]",
+				n, vt, dt, c.origin)
 		}
 	case reflect.Interface:
 		// nothing to do
+	case reflect.Slice:
+		// nothing to do
 	default:
-		c.t.Fatalf("SetArg(%d, ...) referring to argument of non-pointer non-interface type %v", n, at)
+		c.t.Fatalf("SetArg(%d, ...) referring to argument of non-pointer non-interface non-slice type %v [%s]",
+			n, at, c.origin)
 	}
-	c.setArgs[n] = reflect.ValueOf(value)
+
+	c.addAction(func(args []interface{}) []interface{} {
+		v := reflect.ValueOf(value)
+		switch reflect.TypeOf(args[n]).Kind() {
+		case reflect.Slice:
+			setSlice(args[n], v)
+		default:
+			reflect.ValueOf(args[n]).Elem().Set(v)
+		}
+		return nil
+	})
 	return c
 }
 
@@ -157,8 +258,10 @@ func (c *Call) isPreReq(other *Call) bool {
 
 // After declares that the call may only match after preReq has been exhausted.
 func (c *Call) After(preReq *Call) *Call {
+	c.t.Helper()
+
 	if c == preReq {
-		c.t.Fatalf("A call isn't allowed to be it's own prerequisite")
+		c.t.Fatalf("A call isn't allowed to be its own prerequisite")
 	}
 	if preReq.isPreReq(c) {
 		c.t.Fatalf("Loop in call order: %v is a prerequisite to %v (possibly indirectly).", c, preReq)
@@ -168,7 +271,7 @@ func (c *Call) After(preReq *Call) *Call {
 	return c
 }
 
-// Returns true iff the minimum number of calls have been made.
+// Returns true if the minimum number of calls have been made.
 func (c *Call) satisfied() bool {
 	return c.numCalls >= c.minCalls
 }
@@ -184,31 +287,108 @@ func (c *Call) String() string {
 		args[i] = arg.String()
 	}
 	arguments := strings.Join(args, ", ")
-	return fmt.Sprintf("%T.%v(%s)", c.receiver, c.method, arguments)
+	return fmt.Sprintf("%T.%v(%s) %s", c.receiver, c.method, arguments, c.origin)
 }
 
 // Tests if the given call matches the expected call.
-func (c *Call) matches(args []interface{}) bool {
+// If yes, returns nil. If no, returns error with message explaining why it does not match.
-	if len(args) != len(c.args) {
+func (c *Call) matches(args []interface{}) error {
-		return false
+	if !c.methodType.IsVariadic() {
-	}
+		if len(args) != len(c.args) {
-	for i, m := range c.args {
+			return fmt.Errorf("Expected call at %s has the wrong number of arguments. Got: %d, want: %d",
-		if !m.Matches(args[i]) {
+				c.origin, len(args), len(c.args))
-			return false
+		}
+
+		for i, m := range c.args {
+			if !m.Matches(args[i]) {
+				return fmt.Errorf("Expected call at %s doesn't match the argument at index %s.\nGot: %v\nWant: %v",
+					c.origin, strconv.Itoa(i), args[i], m)
+			}
+		}
+	} else {
+		if len(c.args) < c.methodType.NumIn()-1 {
+			return fmt.Errorf("Expected call at %s has the wrong number of matchers. Got: %d, want: %d",
+				c.origin, len(c.args), c.methodType.NumIn()-1)
+		}
+		if len(c.args) != c.methodType.NumIn() && len(args) != len(c.args) {
+			return fmt.Errorf("Expected call at %s has the wrong number of arguments. Got: %d, want: %d",
+				c.origin, len(args), len(c.args))
+		}
+		if len(args) < len(c.args)-1 {
+			return fmt.Errorf("Expected call at %s has the wrong number of arguments. Got: %d, want: greater than or equal to %d",
+				c.origin, len(args), len(c.args)-1)
+		}
+
+		for i, m := range c.args {
+			if i < c.methodType.NumIn()-1 {
+				// Non-variadic args
+				if !m.Matches(args[i]) {
+					return fmt.Errorf("Expected call at %s doesn't match the argument at index %s.\nGot: %v\nWant: %v",
+						c.origin, strconv.Itoa(i), args[i], m)
+				}
+				continue
+			}
+			// The last arg has a possibility of a variadic argument, so let it branch
+
+			// sample: Foo(a int, b int, c ...int)
+			if i < len(c.args) && i < len(args) {
+				if m.Matches(args[i]) {
+					// Got Foo(a, b, c) want Foo(matcherA, matcherB, gomock.Any())
+					// Got Foo(a, b, c) want Foo(matcherA, matcherB, someSliceMatcher)
+					// Got Foo(a, b, c) want Foo(matcherA, matcherB, matcherC)
+					// Got Foo(a, b) want Foo(matcherA, matcherB)
+					// Got Foo(a, b, c, d) want Foo(matcherA, matcherB, matcherC, matcherD)
+					continue
+				}
+			}
+
+			// The number of actual args don't match the number of matchers,
+			// or the last matcher is a slice and the last arg is not.
+			// If this function still matches it is because the last matcher
+			// matches all the remaining arguments or the lack of any.
+			// Convert the remaining arguments, if any, into a slice of the
+			// expected type.
+			vargsType := c.methodType.In(c.methodType.NumIn() - 1)
+			vargs := reflect.MakeSlice(vargsType, 0, len(args)-i)
+			for _, arg := range args[i:] {
+				vargs = reflect.Append(vargs, reflect.ValueOf(arg))
+			}
+			if m.Matches(vargs.Interface()) {
+				// Got Foo(a, b, c, d, e) want Foo(matcherA, matcherB, gomock.Any())
+				// Got Foo(a, b, c, d, e) want Foo(matcherA, matcherB, someSliceMatcher)
+				// Got Foo(a, b) want Foo(matcherA, matcherB, gomock.Any())
+				// Got Foo(a, b) want Foo(matcherA, matcherB, someEmptySliceMatcher)
+				break
+			}
+			// Wrong number of matchers or not match. Fail.
+			// Got Foo(a, b) want Foo(matcherA, matcherB, matcherC, matcherD)
+			// Got Foo(a, b, c) want Foo(matcherA, matcherB, matcherC, matcherD)
+			// Got Foo(a, b, c, d) want Foo(matcherA, matcherB, matcherC, matcherD, matcherE)
+			// Got Foo(a, b, c, d, e) want Foo(matcherA, matcherB, matcherC, matcherD)
+			// Got Foo(a, b, c) want Foo(matcherA, matcherB)
+			return fmt.Errorf("Expected call at %s doesn't match the argument at index %s.\nGot: %v\nWant: %v",
+				c.origin, strconv.Itoa(i), args[i:], c.args[i])
+
 		}
 	}
 
 	// Check that all prerequisite calls have been satisfied.
 	for _, preReqCall := range c.preReqs {
 		if !preReqCall.satisfied() {
-			return false
+			return fmt.Errorf("Expected call at %s doesn't have a prerequisite call satisfied:\n%v\nshould be called before:\n%v",
+				c.origin, preReqCall, c)
 		}
 	}
 
-	return true
+	// Check that the call is not exhausted.
+	if c.exhausted() {
+		return fmt.Errorf("Expected call at %s has already been called the max number of times.", c.origin)
+	}
+
+	return nil
 }
 
-// dropPrereqs tells the expected Call to not re-check prerequite calls any
+// dropPrereqs tells the expected Call to not re-check prerequisite calls any
 // longer, and to return its current set.
 func (c *Call) dropPrereqs() (preReqs []*Call) {
 	preReqs = c.preReqs
@@ -216,38 +396,9 @@ func (c *Call) dropPrereqs() (preReqs []*Call) {
 	return
 }
 
-func (c *Call) call(args []interface{}) (rets []interface{}, action func()) {
+func (c *Call) call(args []interface{}) []func([]interface{}) []interface{} {
 	c.numCalls++
-
+	return c.actions
-	// Actions
-	if c.doFunc.IsValid() {
-		doArgs := make([]reflect.Value, len(args))
-		ft := c.doFunc.Type()
-		for i := 0; i < len(args); i++ {
-			if args[i] != nil {
-				doArgs[i] = reflect.ValueOf(args[i])
-			} else {
-				// Use the zero value for the arg.
-				doArgs[i] = reflect.Zero(ft.In(i))
-			}
-		}
-		action = func() { c.doFunc.Call(doArgs) }
-	}
-	for n, v := range c.setArgs {
-		reflect.ValueOf(args[n]).Elem().Set(v)
-	}
-
-	rets = c.rets
-	if rets == nil {
-		// Synthesize the zero value for each of the return args' types.
-		mt := c.methodType
-		rets = make([]interface{}, mt.NumOut())
-		for i := 0; i < mt.NumOut(); i++ {
-			rets[i] = reflect.Zero(mt.Out(i)).Interface()
-		}
-	}
-
-	return
 }
 
 // InOrder declares that the given calls should occur in order.
@@ -256,3 +407,14 @@ func InOrder(calls ...*Call) {
 		calls[i].After(calls[i-1])
 	}
 }
+
+func setSlice(arg interface{}, v reflect.Value) {
+	va := reflect.ValueOf(arg)
+	for i := 0; i < v.Len(); i++ {
+		va.Index(i).Set(v.Index(i))
+	}
+}
+
+func (c *Call) addAction(action func([]interface{}) []interface{}) {
+	c.actions = append(c.actions, action)
+}

vendor/github.com/golang/mock/gomock/callset.go

@@ -14,63 +14,95 @@
 
 package gomock
 
+import (
+	"bytes"
+	"fmt"
+)
+
 // callSet represents a set of expected calls, indexed by receiver and method
 // name.
-type callSet map[interface{}]map[string][]*Call
+type callSet struct {
+	// Calls that are still expected.
+	expected map[callSetKey][]*Call
+	// Calls that have been exhausted.
+	exhausted map[callSetKey][]*Call
+}
+
+// callSetKey is the key in the maps in callSet
+type callSetKey struct {
+	receiver interface{}
+	fname    string
+}
+
+func newCallSet() *callSet {
+	return &callSet{make(map[callSetKey][]*Call), make(map[callSetKey][]*Call)}
+}
 
 // Add adds a new expected call.
 func (cs callSet) Add(call *Call) {
-	methodMap, ok := cs[call.receiver]
+	key := callSetKey{call.receiver, call.method}
-	if !ok {
+	m := cs.expected
-		methodMap = make(map[string][]*Call)
+	if call.exhausted() {
-		cs[call.receiver] = methodMap
+		m = cs.exhausted
 	}
-	methodMap[call.method] = append(methodMap[call.method], call)
+	m[key] = append(m[key], call)
 }
 
 // Remove removes an expected call.
 func (cs callSet) Remove(call *Call) {
-	methodMap, ok := cs[call.receiver]
+	key := callSetKey{call.receiver, call.method}
-	if !ok {
+	calls := cs.expected[key]
-		return
+	for i, c := range calls {
-	}
-	sl := methodMap[call.method]
-	for i, c := range sl {
 		if c == call {
-			// quick removal; we don't need to maintain call order
+			// maintain order for remaining calls
-			if len(sl) > 1 {
+			cs.expected[key] = append(calls[:i], calls[i+1:]...)
-				sl[i] = sl[len(sl)-1]
+			cs.exhausted[key] = append(cs.exhausted[key], call)
-			}
-			methodMap[call.method] = sl[:len(sl)-1]
 			break
 		}
 	}
 }
 
-// FindMatch searches for a matching call. Returns nil if no call matched.
+// FindMatch searches for a matching call. Returns error with explanation message if no call matched.
-func (cs callSet) FindMatch(receiver interface{}, method string, args []interface{}) *Call {
+func (cs callSet) FindMatch(receiver interface{}, method string, args []interface{}) (*Call, error) {
-	methodMap, ok := cs[receiver]
+	key := callSetKey{receiver, method}
-	if !ok {
-		return nil
-	}
-	calls, ok := methodMap[method]
-	if !ok {
-		return nil
-	}
 
-	// Search through the unordered set of calls expected on a method on a
+	// Search through the expected calls.
-	// receiver.
+	expected := cs.expected[key]
-	for _, call := range calls {
+	var callsErrors bytes.Buffer
-		// A call should not normally still be here if exhausted,
+	for _, call := range expected {
-		// but it can happen if, for instance, .Times(0) was used.
+		err := call.matches(args)
-		// Pretend the call doesn't match.
+		if err != nil {
-		if call.exhausted() {
+			fmt.Fprintf(&callsErrors, "\n%v", err)
-			continue
+		} else {
-		}
+			return call, nil
-		if call.matches(args) {
-			return call
 		}
 	}
 
-	return nil
+	// If we haven't found a match then search through the exhausted calls so we
+	// get useful error messages.
+	exhausted := cs.exhausted[key]
+	for _, call := range exhausted {
+		if err := call.matches(args); err != nil {
+			fmt.Fprintf(&callsErrors, "\n%v", err)
+		}
+	}
+
+	if len(expected)+len(exhausted) == 0 {
+		fmt.Fprintf(&callsErrors, "there are no expected calls of the method %q for that receiver", method)
+	}
+
+	return nil, fmt.Errorf(callsErrors.String())
+}
+
+// Failures returns the calls that are not satisfied.
+func (cs callSet) Failures() []*Call {
+	failures := make([]*Call, 0, len(cs.expected))
+	for _, calls := range cs.expected {
+		for _, call := range calls {
+			if !call.satisfied() {
+				failures = append(failures, call)
+			}
+		}
+	}
+	return failures
 }

vendor/github.com/golang/mock/gomock/controller.go

@@ -56,8 +56,10 @@
 package gomock
 
 import (
+	"context"
 	"fmt"
 	"reflect"
+	"runtime"
 	"sync"
 )
 
@@ -68,97 +70,147 @@ type TestReporter interface {
 	Fatalf(format string, args ...interface{})
 }
 
+// TestHelper is a TestReporter that has the Helper method.  It is satisfied
+// by the standard library's *testing.T.
+type TestHelper interface {
+	TestReporter
+	Helper()
+}
+
 // 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.
 type Controller struct {
+	// T should only be called within a generated mock. It is not intended to
+	// be used in user code and may be changed in future versions. T is the
+	// TestReporter passed in when creating the Controller via NewController.
+	// If the TestReporter does not implment a TestHelper it will be wrapped
+	// with a nopTestHelper.
+	T             TestHelper
 	mu            sync.Mutex
-	t             TestReporter
+	expectedCalls *callSet
-	expectedCalls callSet
+	finished      bool
 }
 
 func NewController(t TestReporter) *Controller {
+	h, ok := t.(TestHelper)
+	if !ok {
+		h = nopTestHelper{t}
+	}
+
 	return &Controller{
-		t:             t,
+		T:             h,
-		expectedCalls: make(callSet),
+		expectedCalls: newCallSet(),
 	}
 }
 
+type cancelReporter struct {
+	TestHelper
+	cancel func()
+}
+
+func (r *cancelReporter) Errorf(format string, args ...interface{}) {
+	r.TestHelper.Errorf(format, args...)
+}
+func (r *cancelReporter) Fatalf(format string, args ...interface{}) {
+	defer r.cancel()
+	r.TestHelper.Fatalf(format, args...)
+}
+
+// WithContext returns a new Controller and a Context, which is cancelled on any
+// fatal failure.
+func WithContext(ctx context.Context, t TestReporter) (*Controller, context.Context) {
+	h, ok := t.(TestHelper)
+	if !ok {
+		h = nopTestHelper{t}
+	}
+
+	ctx, cancel := context.WithCancel(ctx)
+	return NewController(&cancelReporter{h, cancel}), ctx
+}
+
+type nopTestHelper struct {
+	TestReporter
+}
+
+func (h nopTestHelper) Helper() {}
+
 func (ctrl *Controller) RecordCall(receiver interface{}, method string, args ...interface{}) *Call {
+	ctrl.T.Helper()
+
 	recv := reflect.ValueOf(receiver)
 	for i := 0; i < recv.Type().NumMethod(); i++ {
 		if recv.Type().Method(i).Name == method {
 			return ctrl.RecordCallWithMethodType(receiver, method, recv.Method(i).Type(), args...)
 		}
 	}
-	ctrl.t.Fatalf("gomock: failed finding method %s on %T", method, receiver)
+	ctrl.T.Fatalf("gomock: failed finding method %s on %T", method, receiver)
-	// In case t.Fatalf does not panic.
+	panic("unreachable")
-	panic(fmt.Sprintf("gomock: failed finding method %s on %T", method, receiver))
 }
 
 func (ctrl *Controller) RecordCallWithMethodType(receiver interface{}, method string, methodType reflect.Type, args ...interface{}) *Call {
-	// TODO: check arity, types.
+	ctrl.T.Helper()
-	margs := make([]Matcher, len(args))
+
-	for i, arg := range args {
+	call := newCall(ctrl.T, receiver, method, methodType, args...)
-		if m, ok := arg.(Matcher); ok {
-			margs[i] = m
-		} else if arg == nil {
-			// Handle nil specially so that passing a nil interface value
-			// will match the typed nils of concrete args.
-			margs[i] = Nil()
-		} else {
-			margs[i] = Eq(arg)
-		}
-	}
 
 	ctrl.mu.Lock()
 	defer ctrl.mu.Unlock()
-
-	call := &Call{t: ctrl.t, receiver: receiver, method: method, methodType: methodType, args: margs, minCalls: 1, maxCalls: 1}
-
 	ctrl.expectedCalls.Add(call)
+
 	return call
 }
 
 func (ctrl *Controller) Call(receiver interface{}, method string, args ...interface{}) []interface{} {
-	ctrl.mu.Lock()
+	ctrl.T.Helper()
-	defer ctrl.mu.Unlock()
 
-	expected := ctrl.expectedCalls.FindMatch(receiver, method, args)
+	// Nest this code so we can use defer to make sure the lock is released.
-	if expected == nil {
+	actions := func() []func([]interface{}) []interface{} {
-		ctrl.t.Fatalf("no matching expected call: %T.%v(%v)", receiver, method, args)
+		ctrl.T.Helper()
-	}
+		ctrl.mu.Lock()
+		defer ctrl.mu.Unlock()
 
-	// Two things happen here:
+		expected, err := ctrl.expectedCalls.FindMatch(receiver, method, args)
-	// * the matching call no longer needs to check prerequite calls,
+		if err != nil {
-	// * and the prerequite calls are no longer expected, so remove them.
+			origin := callerInfo(2)
-	preReqCalls := expected.dropPrereqs()
+			ctrl.T.Fatalf("Unexpected call to %T.%v(%v) at %s because: %s", receiver, method, args, origin, err)
-	for _, preReqCall := range preReqCalls {
+		}
-		ctrl.expectedCalls.Remove(preReqCall)
-	}
 
-	rets, action := expected.call(args)
+		// Two things happen here:
-	if expected.exhausted() {
+		// * the matching call no longer needs to check prerequite calls,
-		ctrl.expectedCalls.Remove(expected)
+		// * and the prerequite calls are no longer expected, so remove them.
-	}
+		preReqCalls := expected.dropPrereqs()
+		for _, preReqCall := range preReqCalls {
+			ctrl.expectedCalls.Remove(preReqCall)
+		}
 
-	// Don't hold the lock while doing the call's action (if any)
+		actions := expected.call(args)
-	// so that actions may execute concurrently.
+		if expected.exhausted() {
-	// We use the deferred Unlock to capture any panics that happen above;
+			ctrl.expectedCalls.Remove(expected)
-	// here we add a deferred Lock to balance it.
+		}
-	ctrl.mu.Unlock()
+		return actions
-	defer ctrl.mu.Lock()
+	}()
-	if action != nil {
+
-		action()
+	var rets []interface{}
+	for _, action := range actions {
+		if r := action(args); r != nil {
+			rets = r
+		}
 	}
 
 	return rets
 }
 
 func (ctrl *Controller) Finish() {
+	ctrl.T.Helper()
+
 	ctrl.mu.Lock()
 	defer ctrl.mu.Unlock()
 
+	if ctrl.finished {
+		ctrl.T.Fatalf("Controller.Finish was called more than once. It has to be called exactly once.")
+	}
+	ctrl.finished = true
+
 	// If we're currently panicking, probably because this is a deferred call,
 	// pass through the panic.
 	if err := recover(); err != nil {
@@ -166,18 +218,18 @@ func (ctrl *Controller) Finish() {
 	}
 
 	// Check that all remaining expected calls are satisfied.
-	failures := false
+	failures := ctrl.expectedCalls.Failures()
-	for _, methodMap := range ctrl.expectedCalls {
+	for _, call := range failures {
-		for _, calls := range methodMap {
+		ctrl.T.Errorf("missing call(s) to %v", call)
-			for _, call := range calls {
-				if !call.satisfied() {
-					ctrl.t.Errorf("missing call(s) to %v", call)
-					failures = true
-				}
-			}
-		}
 	}
-	if failures {
+	if len(failures) != 0 {
-		ctrl.t.Fatalf("aborting test due to missing call(s)")
+		ctrl.T.Fatalf("aborting test due to missing call(s)")
 	}
 }
+
+func callerInfo(skip int) string {
+	if _, file, line, ok := runtime.Caller(skip + 1); ok {
+		return fmt.Sprintf("%s:%d", file, line)
+	}
+	return "unknown file"
+}

vendor/github.com/golang/mock/gomock/matchers.go

@@ -1,5 +1,3 @@
-//go:generate mockgen -destination mock_matcher/mock_matcher.go github.com/golang/mock/gomock Matcher
-
 // Copyright 2010 Google Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -87,6 +85,18 @@ func (n notMatcher) String() string {
 	return "not(" + n.m.String() + ")"
 }
 
+type assignableToTypeOfMatcher struct {
+	targetType reflect.Type
+}
+
+func (m assignableToTypeOfMatcher) Matches(x interface{}) bool {
+	return reflect.TypeOf(x).AssignableTo(m.targetType)
+}
+
+func (m assignableToTypeOfMatcher) String() string {
+	return "is assignable to " + m.targetType.Name()
+}
+
 // Constructors
 func Any() Matcher             { return anyMatcher{} }
 func Eq(x interface{}) Matcher { return eqMatcher{x} }
@@ -97,3 +107,16 @@ func Not(x interface{}) Matcher {
 	}
 	return notMatcher{Eq(x)}
 }
+
+// AssignableToTypeOf is a Matcher that matches if the parameter to the mock
+// function is assignable to the type of the parameter to this function.
+//
+// Example usage:
+//
+// 		dbMock.EXPECT().
+// 			Insert(gomock.AssignableToTypeOf(&EmployeeRecord{})).
+// 			Return(errors.New("DB error"))
+//
+func AssignableToTypeOf(x interface{}) Matcher {
+	return assignableToTypeOfMatcher{reflect.TypeOf(x)}
+}