Skip to content

assert.PanicsWithError: report error message #1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 10, 2025
Merged

assert.PanicsWithError: report error message #1400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f554a8
Fix #1399: Always report error message on PanicsWithError mismatch
olivergondza Jun 8, 2023
38d9e83
Fix tests to work with go 1.19
olivergondza Jun 8, 2023
94ddd7e
refact(test): Make use of captureTestingT over CollectT
olivergondza Jun 2, 2025
a87733a
Refactor PanicsWithError for increased readability
olivergondza Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions assert/assertions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1343,9 +1343,15 @@ func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs .
if !funcDidPanic {
return Fail(t, fmt.Sprintf("func %#v should panic\n\tPanic value:\t%#v", f, panicValue), msgAndArgs...)
}
panicErr, ok := panicValue.(error)
if !ok || panicErr.Error() != errString {
return Fail(t, fmt.Sprintf("func %#v should panic with error message:\t%#v\n\tPanic value:\t%#v\n\tPanic stack:\t%s", f, errString, panicValue, panickedStack), msgAndArgs...)
panicErr, isError := panicValue.(error)
if !isError || panicErr.Error() != errString {
msg := fmt.Sprintf("func %#v should panic with error message:\t%#v\n", f, errString)
if isError {
msg += fmt.Sprintf("\tError message:\t%#v\n", panicErr.Error())
}
msg += fmt.Sprintf("\tPanic value:\t%#v\n", panicValue)
msg += fmt.Sprintf("\tPanic stack:\t%s\n", panickedStack)
return Fail(t, msg, msgAndArgs...)
}

return true
Expand Down
53 changes: 33 additions & 20 deletions assert/assertions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1587,30 +1587,43 @@ func TestPanicsWithValue(t *testing.T) {
func TestPanicsWithError(t *testing.T) {
t.Parallel()

mockT := new(testing.T)

if !PanicsWithError(mockT, "panic", func() {
mockT := new(captureTestingT)
succeeded := PanicsWithError(mockT, "panic", func() {
panic(errors.New("panic"))
}) {
t.Error("PanicsWithError should return true")
}
})
mockT.checkResultAndErrMsg(t, true, succeeded, "")

if PanicsWithError(mockT, "Panic!", func() {
}) {
t.Error("PanicsWithError should return false")
}
succeeded = PanicsWithError(mockT, "Panic!", func() {})
Equal(t, false, succeeded, "PanicsWithError should return false")
Contains(t, mockT.msg, "Panic value:\t<nil>")

if PanicsWithError(mockT, "at the disco", func() {
panic(errors.New("panic"))
}) {
t.Error("PanicsWithError should return false")
}
succeeded = PanicsWithError(mockT, "expected panic err msg", func() {
panic(errors.New("actual panic err msg"))
})
Equal(t, false, succeeded, "PanicsWithError should return false")
Contains(t, mockT.msg, `Error message: "actual panic err msg"`)

if PanicsWithError(mockT, "Panic!", func() {
panic("panic")
}) {
t.Error("PanicsWithError should return false")
}
succeeded = PanicsWithError(mockT, "expected panic err msg", func() {
panic(&PanicsWithErrorWrapper{"wrapped", errors.New("actual panic err msg")})
})
Equal(t, false, succeeded, "PanicsWithError should return false")
Contains(t, mockT.msg, `Error message: "wrapped: actual panic err msg"`)

succeeded = PanicsWithError(mockT, "expected panic msg", func() {
panic("actual panic msg")
})
Equal(t, false, succeeded, "PanicsWithError should return false")
Contains(t, mockT.msg, `Panic value: "actual panic msg"`)
NotContains(t, mockT.msg, "Error message:", "PanicsWithError should not report error message if not due an error")
}

type PanicsWithErrorWrapper struct {
Prefix string
Err error
}

func (e PanicsWithErrorWrapper) Error() string {
return e.Prefix + ": " + e.Err.Error()
}

func TestNotPanics(t *testing.T) {
Expand Down