https://github.com/kyrus/python-junit-xml

A Python module for creating JUnit XML test result documents that can be read by tools such as Jenkins. If you are ever working with test tool or test suite written in Python and want to take advantage of Jenkins' pretty graphs and test reporting capabilities, this module will let you generate the XML test reports.
https://github.com/kyrus/python-junit-xml

Last synced: 30 days ago
JSON representation

A Python module for creating JUnit XML test result documents that can be read by tools such as Jenkins. If you are ever working with test tool or test suite written in Python and want to take advantage of Jenkins' pretty graphs and test reporting capabilities, this module will let you generate the XML test reports.

• Host: GitHub
• URL: https://github.com/kyrus/python-junit-xml
• Owner: kyrus
• License: mit
• Created: 2013-01-14T19:59:00.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-12-20T16:55:27.000Z (12 months ago)
• Last Synced: 2024-09-08T02:12:00.837Z (3 months ago)
• Language: Python
• Homepage:
• Size: 87.9 KB
• Stars: 113
• Watchers: 16
• Forks: 66
• Open Issues: 32
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
python-junit-xml

================

.. image:: https://travis-ci.org/kyrus/python-junit-xml.png?branch=master

About

-----

A Python module for creating JUnit XML test result documents that can be

read by tools such as Jenkins or Bamboo. If you are ever working with test tool or

test suite written in Python and want to take advantage of Jenkins' or Bamboo's

pretty graphs and test reporting capabilities, this module will let you

generate the XML test reports.

*As there is no definitive Jenkins JUnit XSD that I could find, the XML

documents created by this module support a schema based on Google

searches and the Jenkins JUnit XML reader source code. File a bug if

something doesn't work like you expect it to.

For Bamboo situation is the same.*

Installation

------------

Install using pip or easy_install:

::

	pip install junit-xml

	or

	easy_install junit-xml

You can also clone the Git repository from Github and install it manually:

::

    git clone https://github.com/kyrus/python-junit-xml.git

    python setup.py install

Using

-----

Create a test suite, add a test case, and print it to the screen:

.. code-block:: python

    from junit_xml import TestSuite, TestCase

    test_cases = [TestCase('Test1', 'some.class.name', 123.345, 'I am stdout!', 'I am stderr!')]

    ts = TestSuite("my test suite", test_cases)

    # pretty printing is on by default but can be disabled using prettyprint=False

    print(TestSuite.to_xml_string([ts]))

Produces the following output

.. code-block:: xml

    

    

        

            

                

                    I am stdout!

                

                

                    I am stderr!

                

            

        

    

Writing XML to a file:

.. code-block:: python

    # you can also write the XML to a file and not pretty print it

    with open('output.xml', 'w') as f:

        TestSuite.to_file(f, [ts], prettyprint=False)

See the docs and unit tests for more examples.

NOTE: Unicode characters identified as "illegal or discouraged" are automatically

stripped from the XML string or file.

Running the tests

-----------------

::

    # activate your virtualenv

    pip install tox

    tox

Releasing a new version

-----------------------

1. Bump version in `setup.py`

2. Build distribution with `python setup.py sdist bdist_wheel`

3. Upload to Pypi with `twine upload dist/*`

4. Verify the new version was uploaded at https://pypi.org/project/junit-xml/#history