File: index.rst

package info (click to toggle)
python-xmlrunner 4.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 336 kB
  • sloc: python: 2,035; makefile: 215
file content (43 lines) | stat: -rw-r--r-- 1,114 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
unittest-xml-reporting
======================

``unittest-xml-reporting`` is a ``unittest`` test runner that can save
test results to XML files (jUnit) and be consumed by a wide range of
tools such as continuous integration systems.


Getting started
===============

Similar to the ``unittest`` module, you can run::

    python -m xmlrunner test_module
    python -m xmlrunner module.TestClass
    python -m xmlrunner module.Class.test_method

as well as::

    python -m xmlrunner discover [options]

You can also add a top level file to allow running the tests with
the command ``python tests.py``, and configure the test runner
to output the XML reports in the ``test-reports`` directory. ::

    # tests.py

    if __name__ == '__main__':
        unittest.main(
            testRunner=xmlrunner.XMLTestRunner(output='test-reports'),
            # these make sure that some options that are not applicable
            # remain hidden from the help menu.
            failfast=False, buffer=False, catchbreak=False)



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`