A Test Runner in python, for Human Readable HTML Reports
Project description
===============================
HtmlTestRunner
===============================
.. image:: https://img.shields.io/pypi/v/HtmlTestRunner.svg
:target: https://pypi.python.org/pypi/html-testRunner
.. image:: https://img.shields.io/travis/oldani/HtmlTestRunner.svg
:target: https://travis-ci.org/oldani/HtmlTestRunner
HtmlTest runner is a unittest test runner that save test results
in Html files, for human readable presentation of results.
This Package was inspired in ``unittest-xml-reporting`` and
``HtmlTestRunner by tungwaiyip``.
This project was created due to needs of getting human readables reports
for test runned, i found one but was lack and with a lot of bad practice,
but i liked how ``xml-reporting`` works. So i create this one that
incorporated code from both projects but up to date.
--------------
Usage:
--------------
.. code-block:: python
import HtmlTestRunner
import unittest
class TestStringMethods(unittest.TestCase):
""" Example test for HtmlRunner. """
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
def test_split(self):
s = 'hello world'
self.assertEqual(s.split(), ['hello', 'world'])
# check that s.split fails when the separator is not a string
with self.assertRaises(TypeError):
s.split(2)
def test_error(self):
""" This test should be marked as error one. """
raise ValueError
def test_fail(self):
""" This test should fail. """
self.assertEqual(1, 2)
@unittest.skip("This is a skipped test.")
def test_skip(self):
""" This test should be skipped. """
pass
if __name__ == '__main__':
unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='example_dir'))
As simple as import the class an initialize it, it only have one request parameter that is output, this one is use to place the report in a sub direcotry in ``reports`` directory.
-----------------
Console output:
-----------------
.. figure:: docs/console_output.png
:alt: Console output
This is what you got in the console.
------------------
Test Result:
------------------
.. figure:: docs/test_results.gif
:alt: Test Results
This is a sample of the template that came by default with the runner. If you want
to customize it or use a new one just replace the template in the template folder,
the runner use jinja to render the template, so take in account the vars that are
being pass to the template.
TODO
--------
* Add test and docs
Credits
---------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
1 (2017-01-28)
------------------
* First release on PyPI.
HtmlTestRunner
===============================
.. image:: https://img.shields.io/pypi/v/HtmlTestRunner.svg
:target: https://pypi.python.org/pypi/html-testRunner
.. image:: https://img.shields.io/travis/oldani/HtmlTestRunner.svg
:target: https://travis-ci.org/oldani/HtmlTestRunner
HtmlTest runner is a unittest test runner that save test results
in Html files, for human readable presentation of results.
This Package was inspired in ``unittest-xml-reporting`` and
``HtmlTestRunner by tungwaiyip``.
This project was created due to needs of getting human readables reports
for test runned, i found one but was lack and with a lot of bad practice,
but i liked how ``xml-reporting`` works. So i create this one that
incorporated code from both projects but up to date.
--------------
Usage:
--------------
.. code-block:: python
import HtmlTestRunner
import unittest
class TestStringMethods(unittest.TestCase):
""" Example test for HtmlRunner. """
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
def test_split(self):
s = 'hello world'
self.assertEqual(s.split(), ['hello', 'world'])
# check that s.split fails when the separator is not a string
with self.assertRaises(TypeError):
s.split(2)
def test_error(self):
""" This test should be marked as error one. """
raise ValueError
def test_fail(self):
""" This test should fail. """
self.assertEqual(1, 2)
@unittest.skip("This is a skipped test.")
def test_skip(self):
""" This test should be skipped. """
pass
if __name__ == '__main__':
unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='example_dir'))
As simple as import the class an initialize it, it only have one request parameter that is output, this one is use to place the report in a sub direcotry in ``reports`` directory.
-----------------
Console output:
-----------------
.. figure:: docs/console_output.png
:alt: Console output
This is what you got in the console.
------------------
Test Result:
------------------
.. figure:: docs/test_results.gif
:alt: Test Results
This is a sample of the template that came by default with the runner. If you want
to customize it or use a new one just replace the template in the template folder,
the runner use jinja to render the template, so take in account the vars that are
being pass to the template.
TODO
--------
* Add test and docs
Credits
---------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
1 (2017-01-28)
------------------
* First release on PyPI.
