Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A Test Runner in python, for Human Readable HTML Reports

Project description

HtmlTestRunner

https://img.shields.io/pypi/v/html-testRunner.svg https://img.shields.io/travis/oldani/HtmlTestRunner.svg

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:

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:

Console output

This is what you got in the console.

Test Result:

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.

History

1 (2017-01-28)

  • First release on PyPI.

1.0.1 (2017-01-29)

  • Rename package due to conflict in PyPI.

1.0.2 (2017-01-29)

  • Fix broken docs.

1.0.3 (2017-01-29)

  • Fix bug with the template not beign include in the package.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for html-testRunner, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size html_testRunner-1.0.3-py2.py3-none-any.whl (11.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size html-testRunner-1.0.3.tar.gz (532.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page