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.
Usage
In your test scripts, instead of:
if __name__ == "__main__":
unittest.main()
use:
if __name__ == "__main__":
from simpletap import TAPTestRunner
unittest.main(testRunner=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)
@unittest.expectedFailure
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
unittest.main(testRunner=TAPTestRunner())
When saved in a file called test.py and executed would produce:
1..6
ok 1 - test.py: test adding values
not ok 2 - test.py: oops something went wrong
# ERROR: NameError on file test.py line 30 in testError: 'no_such_variable + 1 # Oops!':
# global name 'no_such_variable' is not defined
skip 3 - test.py: we saw this coming
# EXPECTED_FAILURE: AssertionError on file test.py line 21 in testExpectFail: 'self.assertEqual(0, 1)':
# 0 != 1
not ok 4 - test.py: a failing test
# FAIL: AssertionError on file test.py line 16 in testFail: 'self.assertEqual(0, 1)':
# 0 != 1
ok 5 - test.py: test multiplying values
skip 6 - test.py: pending a fix
# SKIP:
# 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.
Testing
The test suite is configured to run via tox.
Status:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for simpletap-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2eb8e32c0d5e178963f531977f116ef0df51bfa45795a64b4be39ac8d247ec55 |
|
MD5 | 74dae38acdf234172353f8cf056635c1 |
|
BLAKE2b-256 | 9647897c92791698536b52cd43af7264ceb3ebb9093657623445842757cdef51 |
Hashes for simpletap-1.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc029d10372d270eb26410698495cefa32460090c47b7f984342c84941fed1e7 |
|
MD5 | ab913a7ed26a0879235656912f3129bc |
|
BLAKE2b-256 | 247c24fa38ab4ffadd86bee3aa3f00574337d95d2d6ecc6ca6bdf45e1aef87e3 |