implement flavors

[weiwei]

This is to address #101, as well as other frequent xml schema support requirements.

I've thought about JunitXml(flavor='pytest'), but typings will be tricky when it comes to dealing with elements like TestSuite and TestCase, which will also be different with those in the "standard" implementation, For example, autocompletion won't know this TestCase now has a rerun_errors() method.

With implementation in this PR, a flavor and its elements are imported and used separately, and autocompletion works on each case.

from junitparser.flavors.pytest_xml import JUnitXml, TestSuite, TestCase, RerunFailure

# Create cases
case1 = TestCase('case1') # A pytest case
case1.group = 'Group1' # pytest specific
case1.add_rerun_result(RerunFailure('Server Error', '500') # pytest specific

# Create suite and add cases
suite = TestSuite('suite1') # A pytest suite
suite.add_property('build', '55')
suite.add_testcase(case1)
suite.remove_testcase(case2)

# Add suite to JunitXml
xml = JUnitXml() # A pytest JUnitXml class
xml.add_testsuite(suite)
xml.write('junit.xml')

Also address #97 by adding rudimentary types

[weiwei]

Maybe name it to JUnitXml as well. Could result in less cognitive load. Flavors are separated by file names already.

[EnricoMi]

Yes, this should be

Suggested change

	class PytestXml(JUnitXml):
	class JUnitXml(junitparser.JUnitXml):

Then user code looks identical, no matter which import they use:

from junitparser.junitparser import JUnitXml
from junitparser.flavors.pytest_xml import JUnitXml

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.27 🎉

Comparison is base (314d69c) 97.96% compared to head (284189c) 98.24%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #108      +/-   ##
==========================================
+ Coverage   97.96%   98.24%   +0.27%     
==========================================
  Files           6        8       +2     
  Lines        1231     1424     +193     
==========================================
+ Hits         1206     1399     +193     
  Misses         25       25              

Impacted Files	Coverage Δ
junitparser/cli.py	50.00% <ø> (ø)
tests/test_cli.py	100.00% <ø> (ø)
tests/test_fromfile.py	98.75% <ø> (-0.03%)	⬇️
tests/test_general.py	99.11% <ø> (-0.01%)	⬇️
junitparser/__init__.py	100.00% <100.00%> (ø)
junitparser/junitparser.py	99.12% <100.00%> (ø)
junitparser/xunit2.py	100.00% <100.00%> (ø)
tests/test_xunit2.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[EnricoMi]

I like the idea of using packages to select the flavour, re-exporting unchanged classes and deriving changed classes.

I think the xml is redundant in the pytest_xml flavour name.

[EnricoMi]

Yes, this should be

Suggested change

	class PytestXml(JUnitXml):
	class JUnitXml(junitparser.JUnitXml):

Then user code looks identical, no matter which import they use:

from junitparser.junitparser import JUnitXml
from junitparser.flavors.pytest_xml import JUnitXml

[EnricoMi]

I'd prefer

from junitparser.pytest_xml import ...

[weiwei]

Less nesting is good. Keeping the root clean may be also worth it. Let me think this over.

[weiwei]

No code change. Just that orders need to be adjusted for the type hints to work.

[weiwei]

Format change curtesy of black.

[EnricoMi]

Looks great!