Skip to main content

Unittest runner producing Test Anything Protocol (TAP) output

Project description

simpletap is a test runner that integrates with the unittest framework to produce TAP (Test Anything Protocol) compatible output.

simpletap has been extensively tested under Python 2.7 and is considered production ready.
Python 3.4-3.5 is also supported but has not seen as much testing.


In your test scripts, instead of:

if __name__ == "__main__":


if __name__ == "__main__":
    from simpletap import TAPTestRunner

A small test case like:

import unittest

class IntegerArithmeticTestCase(unittest.TestCase):
    def testAdd(self):  # test method names begin 'test*'
        "test adding values"
        self.assertEqual((1 + 2), 3)
        self.assertEqual(0 + 1, 1)

    def testMultiply(self):
        "test multiplying values"
        self.assertEqual((0 * 10), 0)
        self.assertEqual((5 * 8), 40)

    def testFail(self):
        "a failing test"
        self.assertEqual(0, 1)

    def testExpectFail(self):
        "we saw this coming"
        self.assertEqual(0, 1)

    @unittest.skipIf(True, "Skipping this one")
    def testSkip(self):
        "pending a fix"
        self.assertEqual(0, 1)

    def testError(self):
        "oops something went wrong"
        no_such_variable + 1  # Oops!

if __name__ == "__main__":
    from simpletap import TAPTestRunner

When saved in a file called and executed would produce:

ok 1 - test adding values
not ok 2 - oops something went wrong
# ERROR: NameError on file line 30 in testError: 'no_such_variable + 1  # Oops!':
#        global name 'no_such_variable' is not defined
skip 3 - we saw this coming
# EXPECTED_FAILURE: AssertionError on file line 21 in testExpectFail: 'self.assertEqual(0, 1)':
#                   0 != 1
not ok 4 - a failing test
# FAIL: AssertionError on file line 16 in testFail: 'self.assertEqual(0, 1)':
#       0 != 1
ok 5 - test multiplying values
skip 6 - pending a fix
#       Skipping this one

You can also launch simpletap directly from the command line in much the same way you do with unittest:

python -m simpletap test.IntegerArithmeticTestCase

Deviations from standard

The specification of Test Anything Protocol treats skipped tests as ok.

During the use of this module it was found to be more useful to treat these, as well as expected failures as extensions to the specification under the keyword skip.


The test suite is configured to run via tox.


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 simpletap, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size simpletap-1.0.1-py2-none-any.whl (14.0 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size simpletap-1.0.1-py3-none-any.whl (14.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size simpletap-1.0.1.tar.gz (15.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page