Capture plug exceptions into the test record #614
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
jettisonjoe
reviewed
Jul 25, 2017
| """When the framework throws an exception, turn it into a failure code.""" | ||
| if self.test_state and not self.test_state.is_finalized: | ||
| self.test_state.test_record.add_outcome_details(exc_type.__name__, exc_val.message) | ||
| return True |
There was a problem hiding this comment.
This is going to be a departure from the previous logic, which suppressed only in the case of ThreadTerminationError. Is that intentional?
There was a problem hiding this comment.
Agree we should look into this more.
- Looking at
util/threads.pyit seems like this is mainly a matter of logging (if the exception is suppressed, it is not printed or logged, otherwise, it is sent to both logging.exception and stderr) or am I missing another side effect that can occur as a result of the thread raising an exception? - It seems like returning True here risks silencing some errors completely (except for the outcome detail added to the test record). Errors in plug initialization are logged in PlugManager.initialize_plugs but other errors might be silenced.
- I noticed PhaseExecutorThread has sort of the opposite behavior—it never suppresses exceptions. It also makes its own call to logger.exception, so in the console you get “Phase <...> raised an exception” followed by “Thread raised an exception” followed by “Exception in thread” (three printouts of the same exception). We should see if the logging behavior can be more consistent (and not unnecessarily repetitive?).
Kenadia
approved these changes
Jul 25, 2017
| @@ -224,3 +249,4 @@ def test_execute_run_if_false(self): | |||
| def test_execute_phase_return_skip(self): | |||
| result = self.phase_executor.execute_phase(phase_return_skip) | |||
| self.assertEqual(PhaseResult.SKIP, result.phase_result) | |||
|
|
|||
| def _thread_exception(self, exc_type, exc_val, exc_tb): | ||
| """When the framework throws an exception, turn it into a failure code.""" | ||
| if self.test_state and not self.test_state.is_finalized: | ||
| self.test_state.test_record.add_outcome_details(exc_type.__name__, exc_val.message) |
| @@ -146,6 +146,12 @@ def _thread_proc(self): | |||
|
|
|||
| # Everything is set, set status and begin test execution. | |||
| self._execute_test_phases(phase_exec) | |||
|
|
|||
| def _thread_exception(self, exc_type, exc_val, exc_tb): | |||
| """When the framework throws an exception, turn it into a failure code.""" | |||
There was a problem hiding this comment.
I think we should clarify When the framework throws an exception a little more. Looks like this is called when an exception is raised inside a test but outside of all phases?
| """When the framework throws an exception, turn it into a failure code.""" | ||
| if self.test_state and not self.test_state.is_finalized: | ||
| self.test_state.test_record.add_outcome_details(exc_type.__name__, exc_val.message) | ||
| return True |
There was a problem hiding this comment.
Agree we should look into this more.
- Looking at
util/threads.pyit seems like this is mainly a matter of logging (if the exception is suppressed, it is not printed or logged, otherwise, it is sent to both logging.exception and stderr) or am I missing another side effect that can occur as a result of the thread raising an exception? - It seems like returning True here risks silencing some errors completely (except for the outcome detail added to the test record). Errors in plug initialization are logged in PlugManager.initialize_plugs but other errors might be silenced.
- I noticed PhaseExecutorThread has sort of the opposite behavior—it never suppresses exceptions. It also makes its own call to logger.exception, so in the console you get “Phase <...> raised an exception” followed by “Thread raised an exception” followed by “Exception in thread” (three printouts of the same exception). We should see if the logging behavior can be more consistent (and not unnecessarily repetitive?).
|
I'm also not seeing the logger in the plug show up in the test record, example self.logger.info('blah'). Does this PR address that also? Thanks |
|
I don't think so. That should be in the test record already... |
|
Ah I see it in test record when run within a phase, I don't see it when called in tearDown |
|
@Kenadia is this PR still needed? Looks like it's getting stale sitting here. |
|
Having plug exceptions into the test record would still be useful |
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.
This change is