Add docstring as "Details" field in Backslash test metadata #79
Conversation
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
yaelmi3
commented
Jul 19, 2018
yaelmi3
commented
- Add test_details configuration to the default config (off by default)
- Add a check in test_start: In case test_details is enabled and the test function contains dosctring, the description will be added as "test description" in the test metadata
vmalloc
requested changes
Jul 22, 2018
backslash/contrib/slash_plugin.py
Outdated
| @@ -119,9 +119,10 @@ def get_default_config(self): | |||
| // Cmdline(append="--session-label", metavar="LABEL"), | |||
| "blacklisted_warnings_category": [] // Doc( | |||
| 'Specify warnings categories which should not be reported to backslash'), | |||
| "test_details": False // Doc( | |||
There was a problem hiding this comment.
@yaelmi3 I think this should be report_test_docstrings
backslash/contrib/slash_plugin.py
Outdated
| @@ -259,6 +260,9 @@ def test_start(self): | |||
| if log_path: | |||
| kwargs.setdefault('metadata', {})['local_log_path'] = os.path.abspath(log_path) | |||
|
|
|||
| if self.current_config.test_details and slash.test.get_test_function().__doc__: | |||
There was a problem hiding this comment.
Perhaps the key we save should be just docstring?
1. Add report_test_docstrings configuration to the default config (off by default) 2. Add a check in test_start: In case test_details is enabled and the test function contains dosctring, the description will be added as "docstring" in the test metadata
|
changes updated :) |
vmalloc
approved these changes
Jul 25, 2018
|
@yaelmi3 added to changelog as well |
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.