This repository was archived by the owner on Jun 27, 2023. It is now read-only.
More info when do func has wrong signature #173
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
. |
msabramo
force-pushed
the
more-info-when-Do-func-has-wrong-signature
branch
from
23c0a3c to
7251cb7
Compare
|
Rebased and fixed merge conflict. |
msabramo
force-pushed
the
more-info-when-Do-func-has-wrong-signature
branch
from
7251cb7 to
31092bf
Compare
Catch panic and show a terser call stack and the file and line number of
the function that has the wrong arguments
Before:
```
...
Test Panicked
reflect: Call using *[]*models.ImageDefinition as type int
/usr/local/Cellar/go/1.10/libexec/src/runtime/panic.go:505
Full Stack Trace
/usr/local/Cellar/go/1.10/libexec/src/runtime/panic.go:505 +0x229
reflect.Value.call(0x4889200, 0x49e60c0, 0x13, 0x49b4159, 0x4, 0xc4203c1c20, 0x3, 0x3, 0x49af000, 0x485f4c0, ...)
/usr/local/Cellar/go/1.10/libexec/src/reflect/value.go:377 +0x1202
reflect.Value.Call(0x4889200, 0x49e60c0, 0x13, 0xc4203c1c20, 0x3, 0x3, 0x94, 0x0, 0x0)
/usr/local/Cellar/go/1.10/libexec/src/reflect/value.go:308 +0xa4
git.corp.adobe.com/adobe-platform/flight-director/vendor/github.com/golang/mock/gomock.(*Call).Do.func1(0xc4202126c0, 0x3, 0x4, 0xc4201b7e40, 0x2, 0x2)
/Users/abramowi/go/src/git.corp.adobe.com/adobe-platform/flight-director/vendor/github.com/golang/mock/gomock/call.go:154 +0x23f
git.corp.adobe.com/adobe-platform/flight-director/vendor/github.com/golang/mock/gomock.(*Controller).Call(0xc420177230, 0x4913f80, 0xc42007f7a0, 0x49b5a9c, 0x6, 0xc4202126c0, 0x3, 0x4, 0x0, 0x0, ...)
/Users/abramowi/go/src/git.corp.adobe.com/adobe-platform/flight-director/vendor/github.com/golang/mock/gomock/controller.go:170 +0x167
git.corp.adobe.com/adobe-platform/flight-director/mocks/shared/db.(*MockWrapper).Select(0xc42007f7a0, 0x4829a00, 0xc420212620, 0xc4201de180, 0x34, 0xc420478520, 0x1, 0x1, 0x40133b8, 0x120, ...)
/Users/abramowi/go/src/git.corp.adobe.com/adobe-platform/flight-director/mocks/shared/db/wrapper.go:82 +0x218
git.corp.adobe.com/adobe-platform/flight-director/shared/db.(*QueryFilter).SelectIntoEntities(0xc420334988, 0x4a70c00, 0xc42007f7a0, 0x4829a00, 0xc420212620, 0x1, 0x0)
/Users/abramowi/go/src/git.corp.adobe.com/adobe-platform/flight-director/shared/db/query_filter.go:74 +0x202
...
```
After:
```
...
reflect: Call using *[]*models.ImageDefinition as type int (incorrect func args at /Users/abramowi/go/src/git.corp.adobe.com/adobe-platform/flight-director/server/routes/deploys/handlers_test.go:71?)
git.corp.adobe.com/adobe-platform/flight-director/shared/db.(*QueryFilter).SelectIntoEntities
/Users/abramowi/go/src/git.corp.adobe.com/adobe-platform/flight-director/shared/db/query_filter.go:74
...
```
msabramo
force-pushed
the
more-info-when-Do-func-has-wrong-signature
branch
from
31092bf to
2fe26fb
Compare
poy
suggested changes
Sep 27, 2019
| if r := recover(); r != nil { | ||
| errMsg, ok := r.(string) | ||
|
|
||
| // We only handle a very specific panic |
There was a problem hiding this comment.
Do you see a use case where a user might want to panic instead of failing the test?
If not, WDYTA letting fmt.Sprint do some work here (https://play.golang.org/p/SJh50xjMu_8) and allow more than just strings?
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| const skipFrames = 2 |
There was a problem hiding this comment.
Can we add some docs around this magic number?
| if r := recover(); r != nil { | ||
| errMsg, ok := r.(string) | ||
|
|
||
| // We only handle a very specific panic |
| } | ||
|
|
||
| func currentStackTrace(skipFrames int) string { | ||
| err := errors.New("fake error just to get stack") |
There was a problem hiding this comment.
Can we use the runtime package instead and avoid the extra dependency?
| } | ||
|
|
||
| func stackTraceString(stackTrace errors.StackTrace, skipFrames int) string { | ||
| buffer := bytes.NewBufferString("") |
There was a problem hiding this comment.
nit: It doesn't look like we need to use the function bytes.NewBufferString("") as we're taking in an empty string. Maybe just bytes.Buffer{}?
| !strings.Contains(errMsg, "reflect.Set: value of") { | ||
| panic(r) | ||
| } | ||
| skipFrames := 8 |
There was a problem hiding this comment.
Can we add some docs where 8 came from?
|
@msabramo are you still interested in this PR? |
codyoss
added
the
status: needs more info
|
I am going to close this for now due to lack of inactivity. Please reopen if you are still interested in working on this. Thanks. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This builds on the work in #171 but it's a bit of a different feature, so I submitted a separate PR for it.
If a
panicoccurs when calling the user-supplied function toDo, catch the panic and show a terser call stack and the file and line number of the function that has the wrong arguments.One problem with this that I just thought of is this may have a detrimental effect if the user is trying to call a function that intentionally panics. Probably not a common case. Not sure how to deal with that yet.see 0f4f173Before:
After:
Cc: @seanisom, @mayanand, @balshetzer