junitparser 0.3

Manipulates JUnit/xUnit Result XML files

What does it do?

junitparser is a JUnit/xUnit Result XML Parser. Use it to parse and manipulate existing Result XML files, or create new JUnit/xUnit result XMLs from scratch.

There are already a lot of modules that converts JUnit/xUnit XML from a specific format, but you may run into some proprietory or less-known formats and you want to convert them and feed the result to another tool, or, you may want to manipulate the results in your own way. This is where junitparser come into handy.

Why junitparser?

• Functionality. There are various JUnit/xUnit XML libraries, some does parsing, some does XML generation, some does manipulation. This module tries to do most functions in a single package.

• Extensibility. JUnit/xUnit is hardly a standardized format. The base format is somewhat universally agreed with, but beyond that, there could be “custom” elements and attributes. junitparser aims to support them all, by monkeypatching and subclassing some base classes.

• Pythonic. You can manipulate test cases and suites in a pythonic way.

• Simplicity. One single code file. No external dependencies. Though it will use lxml if available.

Installation

pip install junitparser

Usage

Create Junit XML format reports from scratch

You have some test result data, and you want to convert them into junit.xml format.

from junitparser import TestCase, TestSuite, JunitXml, Skipped, Error

# Create cases
case1 = TestCase('case1')
case1.result = Skipped()
case2 = TestCase('case2')
case2.result = Error('Example error message', 'the_error_type')

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

# Add suite to JunitXml
xml = JunitXml()
xml.add_testsuite(suite)
xml.write('junit.xml')

Read and manipulate exiting JUnit/xUnit XML files

You have some existing junit.xml files, and you want to modify the content.

from junitparser import JUnitXml

xml = JUnitXml('/path/to/junit.xml')
for suite in result:
    # handle suites
    for case in suite:
        # handle cases
xml.write() # Writes back to file

Merge XML files

You have two or more XML files, and you want to merge them into one.

from junitparser import JUnitXml

xml1 = JUnitXml('/path/to/junit1.xml')
xml2 = JUnitXml('/path/to/junit2.xml')

newxml = xml1 + xml2
# Alternatively, merge inplace
xml1 += xml2

Create XML with custom attributes

You want to use an attribute that is not supported by default.

from junitparser import TestCase, Attr

# Add the custom attribute
TestCase.id = Attr('id')
case = TestCase()
case.id = '123'

print(case.tostring())

And you get the following output:

b'<testcase id="123"/>\n'

Create XML with custom element

There may be once in 1000 years you want to it this way, but anyways. Suppose you want to add element CustomElement to TestCase.

from junitparser import Element, Attr, TestSuite

# Create the new element by subclassing Element,
# and add custom attributes to it.
class CustomElement(Element):
    _tag = 'custom'
    foo = Attr()
    bar = Attr()

testcase = TestCase()
custom = CustomElement()
testcase.append(custom)
# To find a single sub-element:
testcase.child(CustomElement)
# To iterate over custom elements:
for custom in testcase.iterchildren(CustomElement):
    ... # Do things with custom element

Test

You can run the cases directly:

python test.py

Or use pytest:

pytest test.py

TODO

• XML 1.0 and 1.1 compatibilities.

• More tests, especially test for errors.

Notes

Python 2 is not supported. Currently there is no plan to support Python 2.

There are some other packages providing similar functionalities. They are out there for a longer time, but might not be as fun as junitparser:

• xunitparser: Read JUnit/XUnit XML files and map them to Python objects

• xunitgen: Generate xUnit.xml files

• xunitmerge: Utility for merging multiple XUnit xml reports into a single xml report.

• junit-xml: Creates JUnit XML test result documents that can be read by tools such as Jenkins