Filter expected log messages during testing #1014
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 passed, the additional output will not be printed to the console. This is useful when the command line is tested and we do not want any output to the screen. With this change we can pass the -q flag to achieve this goal and the default behavior of the command will remain unchanged
…ng testing Many tests require the logging of messages to test the functionality but these messages are not actually required to be read in the test output and rather just clutter the output and obscure the actually important error messages. We add a filter to the console StreamHandler of the aiida logger which based on the value of the TESTING_MODE setting will suppress the log record or not. This setting is defined in aiida.settings and is False by default. In the run_tests method of the verdi devel command we import the setting and set it to True. This will cause the filter to swallow all non-important log messages. Doing this in the run_tests method guarantees that this filter is only active during the call of verdi devel tests
These temporary local solutions were put in place to suppress log messages that were fired during testing but that did not serve a purpose and were merely cluttering the output. With the newly implemented testing filter for the 'console' logging handler, these ad hoc solutions are obsolete
sphuber
changed the title
szoupanos
suggested changes
Dec 21, 2017
|
The aiida/backends/djsite/db/subtests/djangomigrations.py should be also checked. |
szoupanos
approved these changes
Dec 21, 2017
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.
Fixes #1013
Add a filter to the aiida.console StreamHandler to suppress logs during testing
Many tests require the logging of messages to test the functionality
but these messages are not actually required to be read in the
test output and rather just clutter the output and obscure the
actually important error messages.
We add a filter to the console StreamHandler of the aiida logger
which based on the value of the TESTING_MODE setting will suppress
the log record or not. This setting is defined in aiida.settings
and is False by default. In the run_tests method of the verdi devel
command we import the setting and set it to True. This will cause
the filter to swallow all non-important log messages.
Doing this in the run_tests method guarantees that this filter is
only active during the call of verdi devel tests