Add support for attaching logs on error. #34
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
Sometimes, code being tested can produce a large amount of output which is needed to debug issues. Adding that output to successful tests can lead to blowing out size maximums for a full test suite run, even if only one test fails, because of adding the log streaming output to every test all the time. To empower users to only collect that output on failures, expose a flag on the constructor which causes addOnException to be used instead of the normal addDetail. The default stays at off so existing users should not see a behavior change.
freeekanayaka
requested changes
Jan 16, 2017
|
|
||
| def _setUp(self): | ||
| write_stream, read_stream = self._stream_factory() | ||
| self.stream = write_stream | ||
| self._read_stream = read_stream | ||
| if self._only_on_error: | ||
| self.addOnException(self._add_stream_detail) |
There was a problem hiding this comment.
This doesn't make sense to me. There's no "addOnException" method in the Fixture API.
|
|
||
|
|
||
| def _byte_stream_factory(): | ||
| result = io.BytesIO() | ||
| return (result, result) | ||
|
|
||
|
|
||
| def ByteStream(detail_name): | ||
| def ByteStream(detail_name, only_on_error=only_on_error): |
There was a problem hiding this comment.
There's no global variable called "only_on_error", so the Python interpreter tracebacks when getting to this line of code (see also the unit test failures attached to this branch by Travis).
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.
Sometimes, code being tested can produce a large amount of output which
is needed to debug issues. Adding that output to successful tests can
lead to blowing out size maximums for a full test suite run, even if
only one test fails, because of adding the log streaming output to every
test all the time.
To empower users to only collect that output on failures, expose a flag
on the constructor which causes addOnException to be used instead of the
normal addDetail. The default stays at off so existing users should not
see a behavior change.
This change is