Conversation
This helper is used to capture the testing.TB interface, and compare
the log output with the expected output.
This is useful for testing and refactoring purposes.
This commit improves the helper by displaying:
- the captured and expected outputs on a newline.
- the special characters in the captured output, such as newlines and tabs.
Both help with readability.
Here is an example of the output before and after the change:
Before:
assertions_test.go:3422: Logged Error: Should be in error chain
expected: *assert.customError
in chain: "EOF" (*errors.errorString)
assertions_test.go:3422: Should log Error: Should be in error chain:
expected: *assert.customError
in chain: "EOF" (*errors.errorString)
After:
assertions_test.go:3486: Actual Logged Error:
Should be in error chain\n
expected: *assert.customError\n
in chain: "EOF" (*errors.errorString)\n
assertions_test.go:3486: Expected Logged Error:
Should be in error chain:\n
expected: *assert.customError\n
in chain: "EOF" (*errors.errorString)
The new format helps to identify the differences:
- the missing colon after "Should be in error chain"
- the extra newline in the captured output
Note: I spent 10 minutes on this change, because I lost 10 minutes in
finding the differences between the captured and expected output on a
refactoring I was doing.
Collaborator
Author
|
#1741 was opened to replace this PR opened from the wrong fork |
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
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.
Summary
A simple change to provide more explicit errors message when testing the code while refactoring asserters
Changes
This helper is used to capture the testing.TB interface, and compare
the log output with the expected output.
This is useful for testing and refactoring purposes.
This commit improves the helper by displaying:
Both help with readability.
Here is an example of the output before and after the change:
Before:
After:
The new format helps to identify the differences:
Motivation
I spent 10 minutes on this change, because I lost 10 minutes in
finding the differences between the captured and expected output on a
refactoring I was doing.
Related issues
None