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

Jump to bottom
Merged
merged 4 commits into from
Sep 10, 2025
Merged

assert.PanicsWithError: report error message #1400

merged 4 commits into from
Sep 10, 2025

Conversation

olivergondza
Copy link
Contributor

Summary

Always report error message on PanicsWithError error message mismatch.

Changes

Add Error message field to the failure message, that reports panicErr.Error() IFF it panicked with an error its message is different from expected.

Motivation

Better defect localization in case of nested errors causing panic.

Before:

Error: func (assert.PanicTestFunc)(0x627a80) should panic with error message:	"at the disco"
	Panic value:	&errors.joinError{errs:[]error{(*errors.errorString)(0xc0000a1540), (*errors.errorString)(0xc0000a1550)}}
	Panic stack:	goroutine 19 [running]:
	...

After:

Error: func (assert.PanicTestFunc)(0x627b20) should panic with error message:	"at the disco"
	Panic value:	&errors.joinError{errs:[]error{(*errors.errorString)(0xc000065550), (*errors.errorString)(0xc000065560)}}
	Error message:	"wrapped err msg\nother err msg"
	Panic stack:	goroutine 6 [running]:
	...

Related issues

Closes #1399

@olivergondza olivergondza mentioned this pull request Jun 8, 2023
Open
@dolmen dolmen added pkg-assert Change related to package testify/assert enhancement labels Jul 6, 2023
@dolmen dolmen added the enhancement: output format Enhancement related to formatting of messages label Jun 2, 2025
dolmen
dolmen requested changes Jun 2, 2025
View reviewed changes
Copy link
Collaborator

@dolmen dolmen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests must be fixed to not use assert.CollectT.

@dolmen dolmen changed the title Fix #1399: Always report error message on PanicsWithError mismatch assert.PanicsWithError: report error message Jun 2, 2025
@olivergondza
Copy link
Contributor Author

@dolmen, I have performed the needed refactor and rebased. PTAL.

The captureTestingT could not have been used in the most straightforward way possible, as some of the checks are negative, and test other "labels" than error...

dolmen
dolmen previously requested changes Jun 2, 2025
View reviewed changes
@ccoVeille ccoVeille mentioned this pull request Jun 3, 2025
Closed
brackendawson
brackendawson previously approved these changes Aug 26, 2025
View reviewed changes
Copy link
Collaborator

@brackendawson brackendawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested this myself and it works, the change is a worthwhile improvement.

@dolmen are you happy that your comments are addressed?

ccoVeille
ccoVeille reviewed Sep 1, 2025
View reviewed changes
brackendawson
brackendawson approved these changes Sep 10, 2025
View reviewed changes
Copy link
Collaborator

@brackendawson brackendawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still LGTM

@brackendawson brackendawson dismissed dolmen’s stale review September 10, 2025 06:52

dolmen's last change requested, to change the variable name mckT to mockT, was completed.

@brackendawson brackendawson merged commit b5a0821 into stretchr:master Sep 10, 2025
9 checks passed
@olivergondza olivergondza deleted the issue-1399 branch September 10, 2025 07:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ccoVeille ccoVeille ccoVeille left review comments

@brackendawson brackendawson brackendawson approved these changes

@dolmen dolmen dolmen left review comments

Assignees

No one assigned

Labels

enhancement: output format Enhancement related to formatting of messages enhancement help wanted must-rebase pkg-assert Change related to package testify/assert

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

PanicsWithError does not report error message for complex errors

4 participants

@olivergondza @dolmen @brackendawson @ccoVeille