def test_combined_results_in_one_file_tap_version_13(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(outdir=outdir, combined=True)
tracker.add_ok("FakeTestCase", "YESSS!")
tracker.add_ok("DifferentFakeTestCase", "GOAAL!")
tracker.generate_tap_reports()
self.assertFalse(
os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
self.assertFalse(
os.path.exists(os.path.join(outdir, "DifferentFakeTestCase.tap")))
with open(os.path.join(outdir, "testresults.tap"), "r") as f:
report = f.read()
expected = inspect.cleandoc("""
TAP version 13
{header_1}
ok 1 YESSS!
{header_2}
ok 2 GOAAL!
1..2
""".format(
header_1=self._make_header("FakeTestCase"),
header_2=self._make_header("DifferentFakeTestCase"),
))
self.assertEqual(report.strip(), expected)
def test_combined_results_in_one_file_tap_version_12(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(outdir=outdir, combined=True)
tracker.add_ok("FakeTestCase", "YESSS!")
tracker.add_ok("DifferentFakeTestCase", "GOAAL!")
tracker.generate_tap_reports()
self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
self.assertFalse(
os.path.exists(os.path.join(outdir, "DifferentFakeTestCase.tap"))
)
with open(os.path.join(outdir, "testresults.tap"), "r") as f:
report = f.read()
expected = inspect.cleandoc(
"""{header_1}
ok 1 YESSS!
{header_2}
ok 2 GOAAL!
1..2
""".format(
header_1=self._make_header("FakeTestCase"),
header_2=self._make_header("DifferentFakeTestCase"),
)
)
self.assertEqual(report.strip(), expected)
def test_write_plan_first_combined(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(streaming=False, outdir=outdir, combined=True)
tracker.set_plan(123)
tracker.generate_tap_reports()
with open(os.path.join(outdir, "testresults.tap"), "r") as f:
lines = f.readlines()
self.assertEqual(lines[0], "1..123\n")
def test_streaming_writes_plan(self):
stream = StringIO()
tracker = Tracker(streaming=True, stream=stream)
tracker.combined_line_number = 42
tracker.generate_tap_reports()
self.assertEqual(stream.getvalue(), '1..42\n')
def test_write_plan_first_combined(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(streaming=False, outdir=outdir, combined=True)
tracker.set_plan(123)
tracker.generate_tap_reports()
with open(os.path.join(outdir, "testresults.tap"), "r") as f:
lines = f.readlines()
self.assertEqual(lines[0], "1..123\n")
def test_streaming_writes_plan(self):
stream = StringIO()
tracker = Tracker(streaming=True, stream=stream)
tracker.combined_line_number = 42
tracker.generate_tap_reports()
self.assertEqual(stream.getvalue(), '1..42\n')
def test_generates_tap_reports_in_existing_outdir(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(outdir=outdir)
tracker.add_ok('FakeTestCase', 'I should be in the specified dir.')
tracker.generate_tap_reports()
tap_file = os.path.join(outdir, 'FakeTestCase.tap')
self.assertTrue(os.path.exists(tap_file))
def test_streaming_does_not_write_files(self):
outdir = tempfile.mkdtemp()
stream = StringIO()
tracker = Tracker(outdir=outdir, streaming=True, stream=stream)
tracker.add_ok("FakeTestCase", "YESSS!")
tracker.generate_tap_reports()
self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
def test_generates_tap_reports_in_existing_outdir(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(outdir=outdir)
tracker.add_ok('FakeTestCase', 'I should be in the specified dir.')
tracker.generate_tap_reports()
tap_file = os.path.join(outdir, 'FakeTestCase.tap')
self.assertTrue(os.path.exists(tap_file))
def test_streaming_does_not_write_files(self):
outdir = tempfile.mkdtemp()
stream = StringIO()
tracker = Tracker(outdir=outdir, streaming=True, stream=stream)
tracker.add_ok("FakeTestCase", "YESSS!")
tracker.generate_tap_reports()
self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
def test_generates_tap_reports_in_new_outdir(self):
tempdir = tempfile.mkdtemp()
outdir = os.path.join(tempdir, "non", "existent", "path")
tracker = Tracker(outdir=outdir)
tracker.add_ok("FakeTestCase", "I should be in the specified dir.")
tracker.generate_tap_reports()
tap_file = os.path.join(outdir, "FakeTestCase.tap")
self.assertTrue(os.path.exists(tap_file))
def test_generates_tap_reports_in_new_outdir(self):
tempdir = tempfile.mkdtemp()
outdir = os.path.join(tempdir, "non", "existent", "path")
tracker = Tracker(outdir=outdir)
tracker.add_ok("FakeTestCase", "I should be in the specified dir.")
tracker.generate_tap_reports()
tap_file = os.path.join(outdir, "FakeTestCase.tap")
self.assertTrue(os.path.exists(tap_file))
def test_write_plan_first_streaming(self):
outdir = tempfile.mkdtemp()
stream = StringIO()
tracker = Tracker(outdir=outdir, streaming=True, stream=stream)
tracker.set_plan(123)
tracker.add_ok("FakeTestCase", "YESSS!")
tracker.generate_tap_reports()
self.assertEqual(
stream.getvalue(), "1..123\n# TAP results for FakeTestCase\nok 1 YESSS!\n"
)
self.assertFalse(os.path.exists(os.path.join(outdir, "FakeTestCase.tap")))
class TAPTestResult(TextTestResult):
# This attribute will store the user's desired output directory.
OUTDIR = None
def __init__(self, stream, descriptions, verbosity):
super(TAPTestResult, self).__init__(stream, descriptions, verbosity)
self.tracker = Tracker(outdir=self.OUTDIR)
def stopTestRun(self):
"""Once the test run is complete, generate each of the TAP files."""
super(TAPTestResult, self).stopTestRun()
self.tracker.generate_tap_reports()
def addError(self, test, err):
super(TAPTestResult, self).addError(test, err)
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addFailure(self, test, err):
super(TAPTestResult, self).addFailure(test, err)
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addSuccess(self, test):
super(TAPTestResult, self).addSuccess(test)
self.tracker.add_ok(self._cls_name(test), self._description(test))
def addSkip(self, test, reason):
super(TAPTestResult, self).addSkip(test, reason)
self.tracker.add_skip(self._cls_name(test), self._description(test),
reason)
def addExpectedFailure(self, test, err):
super(TAPTestResult, self).addExpectedFailure(test, err)
self.tracker.add_not_ok(self._cls_name(test), self._description(test),
'(expected failure)')
def addUnexpectedSuccess(self, test):
super(TAPTestResult, self).addUnexpectedSuccess(test)
self.tracker.add_ok(self._cls_name(test), self._description(test),
'(unexpected success)')
def _cls_name(self, test):
return test.__class__.__name__
def _description(self, test):
return test.shortDescription() or str(test)
class TAPTestResult(TextTestResult):
# This attribute will store the user's desired output directory.
OUTDIR = None
def __init__(self, stream, descriptions, verbosity):
super(TAPTestResult, self).__init__(stream, descriptions, verbosity)
self.tracker = Tracker(outdir=self.OUTDIR)
def stopTestRun(self):
"""Once the test run is complete, generate each of the TAP files."""
super(TAPTestResult, self).stopTestRun()
self.tracker.generate_tap_reports()
def addError(self, test, err):
super(TAPTestResult, self).addError(test, err)
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addFailure(self, test, err):
super(TAPTestResult, self).addFailure(test, err)
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addSuccess(self, test):
super(TAPTestResult, self).addSuccess(test)
self.tracker.add_ok(self._cls_name(test), self._description(test))
def addSkip(self, test, reason):
super(TAPTestResult, self).addSkip(test, reason)
self.tracker.add_skip(
self._cls_name(test), self._description(test), reason)
def addExpectedFailure(self, test, err):
super(TAPTestResult, self).addExpectedFailure(test, err)
self.tracker.add_not_ok(self._cls_name(test), self._description(test),
'(expected failure)')
def addUnexpectedSuccess(self, test):
super(TAPTestResult, self).addUnexpectedSuccess(test)
self.tracker.add_ok(self._cls_name(test), self._description(test),
'(unexpected success)')
def _cls_name(self, test):
return test.__class__.__name__
def _description(self, test):
return test.shortDescription() or str(test)
class TAP(Plugin):
"""This plugin provides test results in the Test Anything Protocol format.
"""
name = 'tap'
def options(self, parser, env=os.environ):
super(TAP, self).options(parser, env=env)
parser.add_option(
'--tap-outdir',
help='An optional output directory to write TAP files to. If the'
' directory does not exist, it will be created.')
def configure(self, options, conf):
super(TAP, self).configure(options, conf)
if self.enabled:
self.tracker = Tracker(outdir=options.tap_outdir)
def finalize(self, results):
self.tracker.generate_tap_reports()
def addError(self, test, err):
err_cls, reason, _ = err
if err_cls != SkipTest:
self.tracker.add_not_ok(self._cls_name(test),
self._description(test))
else:
self.tracker.add_skip(self._cls_name(test),
self._description(test), reason)
def addFailure(self, test, err):
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addSuccess(self, test):
self.tracker.add_ok(self._cls_name(test), self._description(test))
def _cls_name(self, test):
# nose masks the true test case name so the real class name is found
# under the test attribute.
return test.test.__class__.__name__
def _description(self, test):
return test.shortDescription() or str(test)
class TAP(Plugin):
"""This plugin provides test results in the Test Anything Protocol format.
"""
name = 'tap'
def options(self, parser, env=os.environ):
super(TAP, self).options(parser, env=env)
parser.add_option(
'--tap-outdir',
help='An optional output directory to write TAP files to. If the'
' directory does not exist, it will be created.')
def configure(self, options, conf):
super(TAP, self).configure(options, conf)
if self.enabled:
self.tracker = Tracker(outdir=options.tap_outdir)
def finalize(self, results):
self.tracker.generate_tap_reports()
def addError(self, test, err):
err_cls, reason, _ = err
if err_cls != SkipTest:
self.tracker.add_not_ok(
self._cls_name(test), self._description(test))
else:
self.tracker.add_skip(
self._cls_name(test), self._description(test), reason)
def addFailure(self, test, err):
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addSuccess(self, test):
self.tracker.add_ok(self._cls_name(test), self._description(test))
def _cls_name(self, test):
# nose masks the true test case name so the real class name is found
# under the test attribute.
return test.test.__class__.__name__
def _description(self, test):
return test.shortDescription() or str(test)
def test_combined_results_in_one_file(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(outdir=outdir, combined=True)
tracker.add_ok('FakeTestCase', 'YESSS!')
tracker.add_ok('DifferentFakeTestCase', 'GOAAL!')
tracker.generate_tap_reports()
self.assertFalse(
os.path.exists(os.path.join(outdir, 'FakeTestCase.tap')))
self.assertFalse(
os.path.exists(os.path.join(outdir, 'DifferentFakeTestCase.tap')))
with open(os.path.join(outdir, 'testresults.tap'), 'r') as f:
report = f.read()
expected = inspect.cleandoc("""{header_1}
ok 1 - YESSS!
{header_2}
ok 2 - GOAAL!
1..2
""".format(header_1=self._make_header('FakeTestCase'),
header_2=self._make_header('DifferentFakeTestCase')))
self.assertEqual(report.strip(), expected)
def test_combined_results_in_one_file(self):
outdir = tempfile.mkdtemp()
tracker = Tracker(outdir=outdir, combined=True)
tracker.add_ok('FakeTestCase', 'YESSS!')
tracker.add_ok('DifferentFakeTestCase', 'GOAAL!')
tracker.generate_tap_reports()
self.assertFalse(
os.path.exists(os.path.join(outdir, 'FakeTestCase.tap')))
self.assertFalse(
os.path.exists(os.path.join(outdir, 'DifferentFakeTestCase.tap')))
with open(os.path.join(outdir, 'testresults.tap'), 'r') as f:
report = f.read()
expected = inspect.cleandoc(
"""# TAP results for FakeTestCase
ok 1 - YESSS!
# TAP results for DifferentFakeTestCase
ok 2 - GOAAL!
1..2
""")
self.assertEqual(report.strip(), expected)
def test_write_plan_first_streaming(self):
stream = StringIO()
tracker = Tracker(streaming=True, stream=stream)
tracker.set_plan(123)
tracker.generate_tap_reports()
self.assertEqual(stream.getvalue(), "1..123\n")
class TAP(Plugin):
"""This plugin provides test results in the Test Anything Protocol format.
"""
name = 'tap'
def options(self, parser, env=os.environ):
super(TAP, self).options(parser, env=env)
parser.add_option(
'--tap-stream', default=False, action='store_true',
help=_('Stream TAP output instead of the default test runner'
' output.'))
parser.add_option(
'--tap-outdir', metavar='PATH', help=_(
'An optional output directory to write TAP files to. '
'If the directory does not exist, it will be created.'))
parser.add_option(
'--tap-combined', default=False, action='store_true',
help=_('Store all TAP test results into a combined output file.'))
parser.add_option(
'--tap-format', default='', metavar='FORMAT',
help=_(
'An optional format string for the TAP output.'
' The format options are:'
' {short_description} for the short description, and'
' {method_name} for the test method name.'))
def configure(self, options, conf):
super(TAP, self).configure(options, conf)
if self.enabled:
self.tracker = Tracker(
outdir=options.tap_outdir, combined=options.tap_combined,
streaming=options.tap_stream)
self._format = options.tap_format
def finalize(self, results):
self.tracker.generate_tap_reports()
def setOutputStream(self, stream):
# When streaming is on, hijack the stream and return a dummy to send
# standard nose output to oblivion.
if self.tracker.streaming:
self.tracker.stream = stream
return DummyStream()
return stream
def addError(self, test, err):
err_cls, reason, _ = err
if err_cls != SkipTest:
diagnostics = formatter.format_exception(err)
self.tracker.add_not_ok(
self._cls_name(test), self._description(test),
diagnostics=diagnostics)
else:
self.tracker.add_skip(
self._cls_name(test), self._description(test), reason)
def addFailure(self, test, err):
diagnostics = formatter.format_exception(err)
self.tracker.add_not_ok(
self._cls_name(test), self._description(test),
diagnostics=diagnostics)
def addSuccess(self, test):
self.tracker.add_ok(self._cls_name(test), self._description(test))
def _cls_name(self, test):
if isinstance(test, ContextSuite):
# In the class setup and teardown, test is a ContextSuite
# instead of a test case. Grab the name from the context.
return test.context.__name__
else:
# nose masks the true test case name so the real class name
# is found under the test attribute.
return test.test.__class__.__name__
def _description(self, test):
if self._format:
try:
return self._format.format(
method_name=str(test),
short_description=test.shortDescription() or '')
except KeyError:
sys.exit(_(
'Bad format string: {format}\n'
'Replacement options are: {{short_description}} and '
'{{method_name}}').format(format=self._format))
return test.shortDescription() or str(test)
class TAP(Plugin):
"""This plugin provides test results in the Test Anything Protocol format.
"""
name = 'tap'
def options(self, parser, env=os.environ):
super(TAP, self).options(parser, env=env)
parser.add_option(
'--tap-stream', default=False, action='store_true',
help=_('Stream TAP output instead of the default test runner'
' output.'))
parser.add_option(
'--tap-outdir', metavar='PATH', help=_(
'An optional output directory to write TAP files to. '
'If the directory does not exist, it will be created.'))
parser.add_option(
'--tap-combined', default=False, action='store_true',
help=_('Store all TAP test results into a combined output file.'))
parser.add_option(
'--tap-format', default='', metavar='FORMAT',
help=_(
'An optional format string for the TAP output.'
' The format options are:'
' {short_description} for the short description, and'
' {method_name} for the test method name.'))
def configure(self, options, conf):
super(TAP, self).configure(options, conf)
if self.enabled:
self.tracker = Tracker(
outdir=options.tap_outdir, combined=options.tap_combined,
streaming=options.tap_stream)
self._format = options.tap_format
def finalize(self, results):
self.tracker.generate_tap_reports()
def setOutputStream(self, stream):
# When streaming is on, hijack the stream and return a dummy to send
# standard nose output to oblivion.
if self.tracker.streaming:
self.tracker.stream = stream
return DummyStream()
return stream
def addError(self, test, err):
err_cls, reason, _ = err
if err_cls != SkipTest:
self.tracker.add_not_ok(
self._cls_name(test), self._description(test))
else:
self.tracker.add_skip(
self._cls_name(test), self._description(test), reason)
def addFailure(self, test, err):
self.tracker.add_not_ok(self._cls_name(test), self._description(test))
def addSuccess(self, test):
self.tracker.add_ok(self._cls_name(test), self._description(test))
def _cls_name(self, test):
if isinstance(test, ContextSuite):
# In the class setup and teardown, test is a ContextSuite
# instead of a test case. Grab the name from the context.
return test.context.__name__
else:
# nose masks the true test case name so the real class name
# is found under the test attribute.
return test.test.__class__.__name__
def _description(self, test):
if self._format:
try:
return self._format.format(
method_name=str(test),
short_description=test.shortDescription() or '')
except KeyError:
sys.exit(_(
'Bad format string: {format}\n'
'Replacement options are: {{short_description}} and '
'{{method_name}}').format(format=self._format))
return test.shortDescription() or str(test)
def test_write_plan_first_streaming(self):
stream = StringIO()
tracker = Tracker(streaming=True, stream=stream)
tracker.set_plan(123)
tracker.generate_tap_reports()
self.assertEqual(stream.getvalue(), "1..123\n")