Use log.exception where more economical than log.error #27517
Merged
Conversation
This file contains 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
When we do log.error(..., exc_info=True), then log.exception is cleaner.
boring-cyborg
bot
added
provider:cncf-kubernetes
dstandish
commented
Nov 5, 2022
| raise ValueError("failure") | ||
|
|
||
| mock_error.assert_called_once_with("failure", exc_info=True) | ||
| assert "ValueError: failure" in caplog.text |
There was a problem hiding this comment.
using caplog is a better test because it doesn't depend precisely on the code structure, doesn't require mocking -- just looks at the log output
jedcunningham
approved these changes
Nov 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When we do log.error(..., exc_info=True), then log.exception is cleaner.