Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

Hard to debug when a Do(fn) function no longer matches its mock signature #71

Closed
EtiennePerot opened this issue May 19, 2017 · 2 comments · Fixed by #395 or #558
Closed

Hard to debug when a Do(fn) function no longer matches its mock signature #71

EtiennePerot opened this issue May 19, 2017 · 2 comments · Fixed by #395 or #558
Assignees
@cvgw
Labels
type: feature request

Comments

@EtiennePerot
Copy link

Situation: we had code like:

type Foo interface {
  Bar(arg1, arg2 string)
  ...
}

and tests like:

do := func(arg1, arg2 string) { ... }
// ... bunch of code ...
myBarMock.EXPECT().Bar(wantArg1, wantArg2).Do(do)

Then we added an argument to Bar:

type Foo interface {
  Bar(arg1, arg2, arg3 string)
  ...
}

and updated the EXPECT():

do := func(arg1, arg2 string) { ... }
// ... bunch of code ...
myBarMock.EXPECT().Bar(wantArg1, wantArg2, wantArg3).Do(do)

... but forgot to update do. The result was "panic: reflect: Call with too many input arguments" with no strong indication that what was wrong was the do function, rather than some place where the third argument hadn't been added (e.g. missing wantArg3).
It would be nice if the message said something more obvious like "EXPECT.()Do() function doesn't match the mock signature".
@codyoss
Copy link
Member

codyoss commented Jan 15, 2020

This seems reasonable. We are open to PRs 😸

@cvgw cvgw self-assigned this Jan 17, 2020
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do signature change error msg
0d51e72 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
@cvgw cvgw mentioned this issue Feb 2, 2020
Merged
3 tasks
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do signature change error msg
8247798 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do signature change error msg
3bd0bf5 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do signature change error msg
411b967 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
3c6dd7e 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
4fc27f1 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 2, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
7d8f57b 
Update the error handling for Call.Do in the case where
the argument passed to Call.Do does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call
* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 6, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
0501097 
Update the error handling for Call.Do and Call.DoAndReturn in the case where
the argument passed does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call

Call.DoAndReturn has additional validations on the return signature

* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 6, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
5aae07b 
Update the error handling for Call.Do and Call.DoAndReturn in the case where
the argument passed does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call

Call.DoAndReturn has additional validations on the return signature

* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 28, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
67f48ca 
Update the error handling for Call.Do and Call.DoAndReturn in the case where
the argument passed does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call

Call.DoAndReturn has additional validations on the return signature

* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 28, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
dbb6401 
Update the error handling for Call.Do and Call.DoAndReturn in the case where
the argument passed does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call

Call.DoAndReturn has additional validations on the return signature

* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
cvgw added a commit that referenced this issue Feb 28, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg
e3d5d28 
Update the error handling for Call.Do and Call.DoAndReturn in the case where
the argument passed does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call

Call.DoAndReturn has additional validations on the return signature

* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
@cvgw cvgw closed this as completed in #395 Feb 28, 2020
cvgw added a commit that referenced this issue Feb 28, 2020
@cvgw
Fix #71 Do + DoAndReturn signature change error msg (#395)
f9b4ad1 
Update the error handling for Call.Do and Call.DoAndReturn in the case where
the argument passed does not match expectations.

* panic if the argument is not a function
* panic if the number of input arguments do not match those expected by Call
* panic if the types of the input arguments do not match those expected
by Call

Call.DoAndReturn has additional validations on the return signature

* panic if the number of return arguments do not match those expected by
Call
* panic if the types of return arguments do not match those expected by
Call
codyoss added a commit that referenced this issue Mar 16, 2020
@codyoss
Revert "Fix #71 Do + DoAndReturn signature change error msg (#395)" (#…
3a35fb6 
…413)

This reverts commit f9b4ad1.
@cvgw
Copy link
Collaborator

cvgw commented May 8, 2020

Reopening since the fix was reverted

@cvgw cvgw reopened this May 8, 2020
@dependabot dependabot bot mentioned this issue Mar 11, 2021
Closed
@codyoss codyoss mentioned this issue May 14, 2021
Merged
@codyoss codyoss added this to the v1.6.0 milestone May 14, 2021
codyoss added a commit that referenced this issue May 14, 2021
@codyoss
feat validate Do & DoReturn args (#558)
82ce4a7 
Previous behavior was a panic would happen if the number of args
did not match. Now the test should fail more gracefully and allow
for better debugging.

Fixes: #71
@joshblum joshblum mentioned this issue Dec 2, 2021
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@cvgw cvgw

Labels
type: feature request
Projects
None yet
Milestone
No milestone
3 participants
@EtiennePerot @codyoss @cvgw