html-reporter

What is html-reporter?

html_reporter.HTMLTestRunner is a Python test runner for use with its unittest framework. After running the test cases, it generates a report in an HTML file to show the results in a nice, human-readable way. This package was inspired by HTMLTestRunner.py written by Wai Yip Tung and began with transforming the old code to use Jinja2 template and adopting Bootstrap 5 CSS.

html_reporter could be useful in programming classes, where teachers/lectures want to show the test results of students' code, or for anyone who wants to see a nicer test report than the boring terminal output.

Following is an example of the output HTML file:

Getting started

Prerequisites

html-reporter requires Python 3.7 or later.

Install

Install the package via pip:

$ pip install html-reporter

Usage

HTMLTestRunner is a counterpart to unittest.TextTestRunner. Instantiate an HTMLTestRunner object and use it to run your test suite.

Example using unittest.main:

import unittest
from html_reporter import HTMLTestRunner

# define your test cases

# output to a file
if __name__ == "__main__":
    runner = HTMLTestRunner(
        report_filepath="my_report.html",
        title="My unit test",
        description="This demonstrates the report output by HTMLTestRunner.",
        open_in_browser=True
    )

    # run the test
    unittest.main(testRunner=runner)

Example using unittest.TestSuite:

import unittest
from html_reporter import HTMLTestRunner

# define your test cases

# output to a file
if __name__ == "__main__":
    my_test_suite = unittest.TestSuite()  # define your test suite
    # add your test cases:
    # my_test_suite.addTest(...)

    runner = HTMLTestRunner(
        report_filepath="my_report.html",
        title="My unit test",
        description="This demonstrates the report output by HTMLTestRunner.",
        open_in_browser=True
    )

    # run the test
    runner.run(my_test_suite)

TODO

• [x] Switch to Jinja2 template
• [x] Refactor
• [x] Add support for skipped tests
• [x] Release pypi package
• [ ] Option for combine/separate report files
• [ ] Add tests
• [ ] Improve documentations

Credits

• This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
• This package was inspired by HTMLTestRunner.py written by Wai Yip Tung.