Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

xmlrunner: Expose python test class docstrings as comments in the XML result file #270

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

xmlrunner: Expose python test class docstrings as comments in the XML result file #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tests/django_example/app/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

# Create your tests here.
class DummyTestCase(TestCase):
"""Collection of dummy test cases"""

def test_pass(self):
"""Test Pass"""
pass
Expand Down
26 changes: 21 additions & 5 deletions xmlrunner/result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,10 @@ def __init__(self, test_result, test_method, outcome=SUCCESS, err=None, subTest=
self.lineno = lineno
self.doc = doc

# 'test_method' actually represents the test class that will lead to a
# 'testsuite' XML node
self.suite_doc = test_method.__doc__

def id(self):
return self.test_id

Expand Down Expand Up @@ -465,8 +469,11 @@ def _get_info_by_testcase(self):
test_info = test_info[0]
testcase_name = test_info.test_name
if testcase_name not in tests_by_testcase:
tests_by_testcase[testcase_name] = []
tests_by_testcase[testcase_name].append(test_info)
tests_by_testcase[testcase_name] = {
'suite_doc': test_info.suite_doc,
'tests': []
}
tests_by_testcase[testcase_name]['tests'].append(test_info)

return tests_by_testcase

Expand All @@ -482,7 +489,7 @@ def _report_testsuite_properties(xml_testsuite, xml_document, properties):

_report_testsuite_properties = staticmethod(_report_testsuite_properties)

def _report_testsuite(suite_name, tests, xml_document, parentElement,
def _report_testsuite(suite_name, suite_doc, tests, xml_document, parentElement,
properties):
"""
Appends the testsuite section to the XML document.
Expand Down Expand Up @@ -512,6 +519,12 @@ def _report_testsuite(suite_name, tests, xml_document, parentElement,
skips = filter(lambda e: e.outcome == _TestInfo.SKIP, tests)
testsuite.setAttribute('skipped', str(len(list(skips))))

if suite_doc:
comment = str(suite_doc)
# The use of '--' is forbidden in XML comments
comment = comment.replace('--', '--')
testsuite.appendChild(xml_document.createComment(safe_unicode(comment)))

_XMLTestResult._report_testsuite_properties(
testsuite, xml_document, properties)

Expand Down Expand Up @@ -633,7 +646,10 @@ def generate_reports(self, test_runner):
doc.appendChild(testsuite)
parentElement = testsuite

for suite, tests in all_results.items():
for suite, suite_info in all_results.items():
suite_doc = suite_info['suite_doc']
tests = suite_info['tests']

if outputHandledAsString:
doc = Document()
parentElement = doc
Expand All @@ -645,7 +661,7 @@ def generate_reports(self, test_runner):

# Build the XML file
testsuite = _XMLTestResult._report_testsuite(
suite_name, tests, doc, parentElement, self.properties
suite_name, suite_doc, tests, doc, parentElement, self.properties
)

if outputHandledAsString:
Expand Down