-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
test_reporter.py
1668 lines (1409 loc) · 56.4 KB
/
test_reporter.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
#
# Maintainer: Jonathan Lange
"""
Tests for L{twisted.trial.reporter}.
"""
import errno
import os
import re
import sys
from inspect import getmro
from io import BytesIO, StringIO
from typing import Type
from unittest import (
TestCase as StdlibTestCase,
TestSuite as PyUnitTestSuite,
expectedFailure,
)
from hamcrest import assert_that, equal_to, has_item, has_length
from twisted.python import log
from twisted.python.failure import Failure
from twisted.trial import itrial, reporter, runner, unittest, util
from twisted.trial.reporter import UncleanWarningsReporterWrapper, _ExitWrapper
from twisted.trial.test import erroneous, sample
from twisted.trial.unittest import SkipTest, Todo, makeTodo
from .._dist.test.matchers import isFailure, matches_result, similarFrame
from .matchers import after
class BrokenStream:
"""
Stream-ish object that raises a signal interrupt error. We use this to make
sure that Trial still manages to write what it needs to write.
"""
written = False
flushed = False
def __init__(self, fObj):
self.fObj = fObj
def write(self, s):
if self.written:
return self.fObj.write(s)
self.written = True
raise OSError(errno.EINTR, "Interrupted write")
def flush(self):
if self.flushed:
return self.fObj.flush()
self.flushed = True
raise OSError(errno.EINTR, "Interrupted flush")
class StringTest(unittest.SynchronousTestCase):
def stringComparison(self, expect, output):
output = list(filter(None, output))
self.assertTrue(
len(expect) <= len(output),
"Must have more observed than expected"
"lines %d < %d" % (len(output), len(expect)),
)
REGEX_PATTERN_TYPE = type(re.compile(""))
for line_number, (exp, out) in enumerate(zip(expect, output)):
if exp is None:
continue
elif isinstance(exp, str):
self.assertSubstring(
exp, out, "Line %d: %r not in %r" % (line_number, exp, out)
)
elif isinstance(exp, REGEX_PATTERN_TYPE):
self.assertTrue(
exp.match(out),
"Line %d: %r did not match string %r"
% (line_number, exp.pattern, out),
)
else:
raise TypeError(f"don't know what to do with object {exp!r}")
class TestResultTests(unittest.SynchronousTestCase):
def setUp(self):
self.result = reporter.TestResult()
def test_pyunitAddError(self):
# pyunit passes an exc_info tuple directly to addError
try:
raise RuntimeError("foo")
except RuntimeError as e:
excValue = e
self.result.addError(self, sys.exc_info())
failure = self.result.errors[0][1]
self.assertEqual(excValue, failure.value)
self.assertEqual(RuntimeError, failure.type)
def test_pyunitAddFailure(self):
# pyunit passes an exc_info tuple directly to addFailure
try:
raise self.failureException("foo")
except self.failureException as e:
excValue = e
self.result.addFailure(self, sys.exc_info())
failure = self.result.failures[0][1]
self.assertEqual(excValue, failure.value)
self.assertEqual(self.failureException, failure.type)
def test_somethingElse(self):
"""
L{reporter.TestResult.addError} raises L{TypeError} if it is called with
an error that is neither a L{sys.exc_info}-like three-tuple nor a
L{Failure}.
"""
with self.assertRaises(TypeError):
self.result.addError(self, "an error")
with self.assertRaises(TypeError):
self.result.addError(self, Exception("an error"))
with self.assertRaises(TypeError):
self.result.addError(
self, (Exception, Exception("an error"), None, "extra")
)
with self.assertRaises(TypeError):
self.result.addError(self, (Exception, Exception("an error")))
class ReporterRealtimeTests(TestResultTests):
def setUp(self):
output = StringIO()
self.result = reporter.Reporter(output, realtime=True)
class ErrorReportingTests(StringTest):
doubleSeparator = re.compile(r"^=+$")
def setUp(self):
self.loader = runner.TestLoader()
self.output = StringIO()
self.result: reporter.Reporter = reporter.Reporter(self.output)
def getOutput(self, suite):
result = self.getResult(suite)
result.done()
return self.output.getvalue()
def getResult(self, suite: PyUnitTestSuite) -> reporter.Reporter:
suite.run(self.result)
return self.result
def test_formatErroredMethod(self):
"""
A test method which runs and has an error recorded against it is
reported in the output stream with the I{ERROR} tag along with a
summary of what error was reported and the ID of the test.
"""
cls = erroneous.SynchronousTestFailureInSetUp
suite = self.loader.loadClass(cls)
output = self.getOutput(suite).splitlines()
match = [
self.doubleSeparator,
"[ERROR]",
"Traceback (most recent call last):",
re.compile(r"^\s+File .*erroneous\.py., line \d+, in setUp$"),
re.compile(r"^\s+raise FoolishError." r".I am a broken setUp method..$"),
(
"twisted.trial.test.erroneous.FoolishError: "
"I am a broken setUp method"
),
f"{cls.__module__}.{cls.__name__}.test_noop",
]
self.stringComparison(match, output)
def test_formatFailedMethod(self):
"""
A test method which runs and has a failure recorded against it is
reported in the output stream with the I{FAIL} tag along with a summary
of what failure was reported and the ID of the test.
"""
suite = self.loader.loadByName(
"twisted.trial.test.erroneous.TestRegularFail.test_fail"
)
output = self.getOutput(suite).splitlines()
match = [
self.doubleSeparator,
"[FAIL]",
"Traceback (most recent call last):",
re.compile(r"^\s+File .*erroneous\.py., line \d+, in test_fail$"),
re.compile(r'^\s+self\.fail\("I fail"\)$'),
"twisted.trial.unittest.FailTest: I fail",
"twisted.trial.test.erroneous.TestRegularFail.test_fail",
]
self.stringComparison(match, output)
def test_doctestError(self):
"""
A problem encountered while running a doctest is reported in the output
stream with a I{FAIL} or I{ERROR} tag along with a summary of what
problem was encountered and the ID of the test.
"""
from twisted.trial.test import erroneous
suite = unittest.decorate(self.loader.loadDoctests(erroneous), itrial.ITestCase)
output = self.getOutput(suite)
path = "twisted.trial.test.erroneous.unexpectedException"
for substring in ["1/0", "ZeroDivisionError", "Exception raised:", path]:
self.assertSubstring(substring, output)
self.assertTrue(
re.search("Fail(ed|ure in) example:", output),
"Couldn't match 'Failure in example: ' " "or 'Failed example: '",
)
expect = [self.doubleSeparator, re.compile(r"\[(ERROR|FAIL)\]")]
self.stringComparison(expect, output.splitlines())
def test_hiddenException(self) -> None:
"""
When a function scheduled using L{IReactorTime.callLater} in a
test method raises an exception that exception is added to the test
result as an error.
This happens even if the test also fails and the test failure is also
added to the test result as a failure.
Only really necessary for testing the deprecated style of tests that
use iterate() directly. See
L{erroneous.DelayedCall.testHiddenException} for more details.
"""
test = erroneous.DelayedCall("testHiddenException")
result = self.getResult(PyUnitTestSuite([test]))
assert_that(
result, matches_result(errors=has_length(1), failures=has_length(1))
)
[(actualCase, error)] = result.errors
assert_that(test, equal_to(actualCase))
assert_that(
error,
isFailure(
type=equal_to(RuntimeError),
value=after(str, equal_to("something blew up")),
frames=has_item(similarFrame("go", "erroneous.py")), # type: ignore[arg-type]
),
)
[(actualCase, failure)] = result.failures
assert_that(test, equal_to(actualCase))
assert_that(
failure,
isFailure(
type=equal_to(test.failureException),
value=after(
str, equal_to("Deliberate failure to mask the hidden exception")
),
frames=has_item(similarFrame("testHiddenException", "erroneous.py")), # type: ignore[arg-type]
),
)
class UncleanWarningWrapperErrorReportingTests(ErrorReportingTests):
"""
Tests that the L{UncleanWarningsReporterWrapper} can sufficiently proxy
IReporter failure and error reporting methods to a L{reporter.Reporter}.
"""
def setUp(self):
self.loader = runner.TestLoader()
self.output = StringIO()
self.reporter: reporter.Reporter = reporter.Reporter(self.output)
self.result = UncleanWarningsReporterWrapper(self.reporter)
def getResult(self, suite: PyUnitTestSuite) -> reporter.Reporter:
suite.run(self.result)
return self.reporter
class TracebackHandlingTests(unittest.SynchronousTestCase):
def getErrorFrames(self, test):
"""
Run the given C{test}, make sure it fails and return the trimmed
frames.
@param test: The test case to run.
@return: The C{list} of frames trimmed.
"""
stream = StringIO()
result = reporter.Reporter(stream)
test.run(result)
bads = result.failures + result.errors
self.assertEqual(len(bads), 1)
self.assertEqual(bads[0][0], test)
return result._trimFrames(bads[0][1].frames)
def checkFrames(self, observedFrames, expectedFrames):
for observed, expected in zip(observedFrames, expectedFrames):
self.assertEqual(observed[0], expected[0])
observedSegs = os.path.splitext(observed[1])[0].split(os.sep)
expectedSegs = expected[1].split("/")
self.assertEqual(observedSegs[-len(expectedSegs) :], expectedSegs)
self.assertEqual(len(observedFrames), len(expectedFrames))
def test_basic(self):
test = erroneous.TestRegularFail("test_fail")
frames = self.getErrorFrames(test)
self.checkFrames(frames, [("test_fail", "twisted/trial/test/erroneous")])
def test_subroutine(self):
test = erroneous.TestRegularFail("test_subfail")
frames = self.getErrorFrames(test)
self.checkFrames(
frames,
[
("test_subfail", "twisted/trial/test/erroneous"),
("subroutine", "twisted/trial/test/erroneous"),
],
)
def test_deferred(self):
"""
C{_trimFrames} removes traces of C{_runCallbacks} when getting an error
in a callback returned by a C{TestCase} based test.
"""
test = erroneous.TestAsynchronousFail("test_fail")
frames = self.getErrorFrames(test)
self.checkFrames(
frames,
[
# This depends on the implementation of test_fail. Currently
# it uses deferLater so we get a frame from the task module.
("cb", "twisted/internet/task"),
],
)
def test_noFrames(self):
result = reporter.Reporter(None)
self.assertEqual([], result._trimFrames([]))
def test_oneFrame(self):
result = reporter.Reporter(None)
self.assertEqual(["fake frame"], result._trimFrames(["fake frame"]))
def test_exception(self):
"""
C{_trimFrames} removes traces of C{runWithWarningsSuppressed} from
C{utils} when a synchronous exception happens in a C{TestCase}
based test.
"""
test = erroneous.TestAsynchronousFail("test_exception")
frames = self.getErrorFrames(test)
self.checkFrames(frames, [("test_exception", "twisted/trial/test/erroneous")])
class FormatFailuresTests(StringTest):
def setUp(self):
try:
raise RuntimeError("foo")
except RuntimeError:
self.f = Failure()
self.f.frames = [
["foo", "foo/bar.py", 5, [("x", 5)], [("y", "orange")]],
["qux", "foo/bar.py", 10, [("a", "two")], [("b", "MCMXCIX")]],
]
self.stream = StringIO()
self.result = reporter.Reporter(self.stream)
def test_formatDefault(self):
tb = self.result._formatFailureTraceback(self.f)
self.stringComparison(
[
"Traceback (most recent call last):",
' File "foo/bar.py", line 5, in foo',
re.compile(r"^\s*$"),
' File "foo/bar.py", line 10, in qux',
re.compile(r"^\s*$"),
"RuntimeError: foo",
],
tb.splitlines(),
)
def test_formatString(self):
tb = """
File "twisted/trial/unittest.py", line 256, in failUnlessSubstring
return self.failUnlessIn(substring, astring, msg)
exceptions.TypeError: iterable argument required
"""
expected = """
File "twisted/trial/unittest.py", line 256, in failUnlessSubstring
return self.failUnlessIn(substring, astring, msg)
exceptions.TypeError: iterable argument required
"""
formatted = self.result._formatFailureTraceback(tb)
self.assertEqual(expected, formatted)
def test_mutation(self):
frames = self.f.frames[:]
# The call shouldn't mutate the frames.
self.result._formatFailureTraceback(self.f)
self.assertEqual(self.f.frames, frames)
class PyunitNamesTests(unittest.SynchronousTestCase):
def setUp(self):
self.stream = StringIO()
self.test = sample.PyunitTest("test_foo")
def test_verboseReporter(self):
result = reporter.VerboseTextReporter(self.stream)
result.startTest(self.test)
output = self.stream.getvalue()
self.assertEqual(output, "twisted.trial.test.sample.PyunitTest.test_foo ... ")
def test_treeReporter(self):
result = reporter.TreeReporter(self.stream)
result.startTest(self.test)
output = self.stream.getvalue()
output = output.splitlines()[-1].strip()
self.assertEqual(output, result.getDescription(self.test) + " ...")
def test_getDescription(self):
result = reporter.TreeReporter(self.stream)
output = result.getDescription(self.test)
self.assertEqual(output, "test_foo")
def test_minimalReporter(self):
"""
The summary of L{reporter.MinimalReporter} is a simple list of numbers,
indicating how many tests ran, how many failed etc.
The numbers represents:
* the run time of the tests
* the number of tests run, printed 2 times for legacy reasons
* the number of errors
* the number of failures
* the number of skips
"""
result = reporter.MinimalReporter(self.stream)
self.test.run(result)
result._printSummary()
output = self.stream.getvalue().strip().split(" ")
self.assertEqual(output[1:], ["1", "1", "0", "0", "0"])
def test_minimalReporterTime(self):
"""
L{reporter.MinimalReporter} reports the time to run the tests as first
data in its output.
"""
times = [1.0, 1.2, 1.5, 1.9]
result = reporter.MinimalReporter(self.stream)
result._getTime = lambda: times.pop(0)
self.test.run(result)
result._printSummary()
output = self.stream.getvalue().strip().split(" ")
timer = output[0]
self.assertEqual(timer, "0.7")
def test_emptyMinimalReporter(self):
"""
The summary of L{reporter.MinimalReporter} is a list of zeroes when no
test is actually run.
"""
result = reporter.MinimalReporter(self.stream)
result._printSummary()
output = self.stream.getvalue().strip().split(" ")
self.assertEqual(output, ["0", "0", "0", "0", "0", "0"])
class DirtyReactorTests(unittest.SynchronousTestCase):
"""
The trial script has an option to treat L{DirtyReactorAggregateError}s as
warnings, as a migration tool for test authors. It causes a wrapper to be
placed around reporters that replaces L{DirtyReactorAggregatErrors} with
warnings.
"""
def setUp(self):
self.dirtyError = Failure(util.DirtyReactorAggregateError(["foo"], ["bar"]))
self.output = StringIO()
self.test = DirtyReactorTests("test_errorByDefault")
def test_errorByDefault(self):
"""
L{DirtyReactorAggregateError}s are reported as errors with the default
Reporter.
"""
result = reporter.Reporter(stream=self.output)
result.addError(self.test, self.dirtyError)
self.assertEqual(len(result.errors), 1)
self.assertEqual(result.errors[0][1], self.dirtyError)
def test_warningsEnabled(self):
"""
L{DirtyReactorAggregateError}s are reported as warnings when using
the L{UncleanWarningsReporterWrapper}.
"""
result = UncleanWarningsReporterWrapper(reporter.Reporter(stream=self.output))
self.assertWarns(
UserWarning,
self.dirtyError.getErrorMessage(),
reporter.__file__,
result.addError,
self.test,
self.dirtyError,
)
def test_warningsMaskErrors(self):
"""
L{DirtyReactorAggregateError}s are I{not} reported as errors if the
L{UncleanWarningsReporterWrapper} is used.
"""
result = UncleanWarningsReporterWrapper(reporter.Reporter(stream=self.output))
self.assertWarns(
UserWarning,
self.dirtyError.getErrorMessage(),
reporter.__file__,
result.addError,
self.test,
self.dirtyError,
)
self.assertEqual(result._originalReporter.errors, [])
def test_dealsWithThreeTuples(self):
"""
Some annoying stuff can pass three-tuples to addError instead of
Failures (like PyUnit). The wrapper, of course, handles this case,
since it is a part of L{twisted.trial.itrial.IReporter}! But it does
not convert L{DirtyReactorAggregateError} to warnings in this case,
because nobody should be passing those in the form of three-tuples.
"""
result = UncleanWarningsReporterWrapper(reporter.Reporter(stream=self.output))
result.addError(self.test, (self.dirtyError.type, self.dirtyError.value, None))
self.assertEqual(len(result._originalReporter.errors), 1)
self.assertEqual(
result._originalReporter.errors[0][1].type, self.dirtyError.type
)
self.assertEqual(
result._originalReporter.errors[0][1].value, self.dirtyError.value
)
class TrialNamesTests(unittest.SynchronousTestCase):
def setUp(self):
self.stream = StringIO()
self.test = sample.FooTest("test_foo")
def test_verboseReporter(self):
result = reporter.VerboseTextReporter(self.stream)
result.startTest(self.test)
output = self.stream.getvalue()
self.assertEqual(output, self.test.id() + " ... ")
def test_treeReporter(self):
result = reporter.TreeReporter(self.stream)
result.startTest(self.test)
output = self.stream.getvalue()
output = output.splitlines()[-1].strip()
self.assertEqual(output, result.getDescription(self.test) + " ...")
def test_treeReporterWithDocstrings(self):
"""A docstring"""
result = reporter.TreeReporter(self.stream)
self.assertEqual(result.getDescription(self), "test_treeReporterWithDocstrings")
def test_getDescription(self):
result = reporter.TreeReporter(self.stream)
output = result.getDescription(self.test)
self.assertEqual(output, "test_foo")
class SkipTests(unittest.SynchronousTestCase):
"""
Tests for L{reporter.Reporter}'s handling of skips.
"""
def setUp(self):
self.stream = StringIO()
self.result = reporter.Reporter(self.stream)
self.test = sample.FooTest("test_foo")
def _getSkips(self, result):
"""
Get the number of skips that happened to a reporter.
"""
return len(result.skips)
def test_accumulation(self):
self.result.addSkip(self.test, "some reason")
self.assertEqual(self._getSkips(self.result), 1)
def test_success(self):
self.result.addSkip(self.test, "some reason")
self.assertEqual(True, self.result.wasSuccessful())
def test_summary(self):
"""
The summary of a successful run with skips indicates that the test
suite passed and includes the number of skips.
"""
self.result.addSkip(self.test, "some reason")
self.result.done()
output = self.stream.getvalue().splitlines()[-1]
prefix = "PASSED "
self.assertTrue(output.startswith(prefix))
self.assertEqual(output[len(prefix) :].strip(), "(skips=1)")
def test_basicErrors(self):
"""
The output at the end of a test run with skips includes the reasons
for skipping those tests.
"""
self.result.addSkip(self.test, "some reason")
self.result.done()
output = self.stream.getvalue().splitlines()[3]
self.assertEqual(output.strip(), "some reason")
def test_booleanSkip(self):
"""
Tests can be skipped without specifying a reason by setting the 'skip'
attribute to True. When this happens, the test output includes 'True'
as the reason.
"""
self.result.addSkip(self.test, True)
self.result.done()
output = self.stream.getvalue().splitlines()[3]
self.assertEqual(output, "True")
def test_exceptionSkip(self):
"""
Skips can be raised as errors. When this happens, the error is
included in the summary at the end of the test suite.
"""
try:
1 / 0
except Exception as e:
error = e
self.result.addSkip(self.test, error)
self.result.done()
output = "\n".join(self.stream.getvalue().splitlines()[3:5]).strip()
self.assertEqual(output, str(error))
class UncleanWarningSkipTests(SkipTests):
"""
Tests for skips on a L{reporter.Reporter} wrapped by an
L{UncleanWarningsReporterWrapper}.
"""
def setUp(self):
SkipTests.setUp(self)
self.result = UncleanWarningsReporterWrapper(self.result)
def _getSkips(self, result):
"""
Get the number of skips that happened to a reporter inside of an
unclean warnings reporter wrapper.
"""
return len(result._originalReporter.skips)
class TodoTests(unittest.SynchronousTestCase):
"""
Tests for L{reporter.Reporter}'s handling of todos.
"""
def setUp(self):
self.stream = StringIO()
self.result = reporter.Reporter(self.stream)
self.test = sample.FooTest("test_foo")
def _getTodos(self, result):
"""
Get the expected failures that happened to a reporter.
"""
return result.expectedFailures
def _getUnexpectedSuccesses(self, result):
"""
Get the unexpected successes that happened to a reporter.
"""
return result.unexpectedSuccesses
def test_accumulation(self):
"""
L{reporter.Reporter} accumulates the expected failures that it
is notified of.
"""
self.result.addExpectedFailure(
self.test, Failure(Exception()), makeTodo("todo!")
)
self.assertEqual(len(self._getTodos(self.result)), 1)
def test_noTodoProvided(self):
"""
If no C{Todo} is provided to C{addExpectedFailure}, then
L{reporter.Reporter} makes up a sensible default.
This allows standard Python unittests to use Twisted reporters.
"""
failure = Failure(Exception())
self.result.addExpectedFailure(self.test, failure)
[(test, error, todo)] = self._getTodos(self.result)
self.assertEqual(test, self.test)
self.assertEqual(error, failure)
self.assertEqual(repr(todo), repr(makeTodo("Test expected to fail")))
def test_success(self):
"""
A test run is still successful even if there are expected failures.
"""
self.result.addExpectedFailure(
self.test, Failure(Exception()), makeTodo("todo!")
)
self.assertEqual(True, self.result.wasSuccessful())
def test_unexpectedSuccess(self):
"""
A test which is marked as todo but succeeds will have an unexpected
success reported to its result. A test run is still successful even
when this happens.
"""
self.result.addUnexpectedSuccess(self.test, makeTodo("Heya!"))
self.assertEqual(True, self.result.wasSuccessful())
self.assertEqual(len(self._getUnexpectedSuccesses(self.result)), 1)
def test_unexpectedSuccessNoTodo(self):
"""
A test which is marked as todo but succeeds will have an unexpected
success reported to its result. A test run is still successful even
when this happens.
If no C{Todo} is provided, then we make up a sensible default. This
allows standard Python unittests to use Twisted reporters.
"""
self.result.addUnexpectedSuccess(self.test)
[(test, todo)] = self._getUnexpectedSuccesses(self.result)
self.assertEqual(test, self.test)
self.assertEqual(repr(todo), repr(makeTodo("Test expected to fail")))
def test_summary(self):
"""
The reporter's C{printSummary} method should print the number of
expected failures that occurred.
"""
self.result.addExpectedFailure(
self.test, Failure(Exception()), makeTodo("some reason")
)
self.result.done()
output = self.stream.getvalue().splitlines()[-1]
prefix = "PASSED "
self.assertTrue(output.startswith(prefix))
self.assertEqual(output[len(prefix) :].strip(), "(expectedFailures=1)")
def test_basicErrors(self):
"""
The reporter's L{printErrors} method should include the value of the
Todo.
"""
self.result.addExpectedFailure(
self.test, Failure(Exception()), makeTodo("some reason")
)
self.result.done()
output = self.stream.getvalue().splitlines()[3].strip()
self.assertEqual(output, "Reason: 'some reason'")
def test_booleanTodo(self):
"""
Booleans CAN'T be used as the value of a todo. Maybe this sucks. This
is a test for current behavior, not a requirement.
"""
self.result.addExpectedFailure(self.test, Failure(Exception()), True)
self.assertRaises(Exception, self.result.done)
def test_exceptionTodo(self):
"""
The exception for expected failures should be shown in the
C{printErrors} output.
"""
try:
1 / 0
except Exception as e:
error = e
self.result.addExpectedFailure(self.test, Failure(error), makeTodo("todo!"))
self.result.done()
output = "\n".join(self.stream.getvalue().splitlines()[3:]).strip()
self.assertTrue(str(error) in output)
def test_standardLibraryCompatibilityFailure(self):
"""
Tests that use the standard library C{expectedFailure} feature worth
with Trial reporters.
"""
class Test(StdlibTestCase):
@expectedFailure
def test_fail(self):
self.fail("failure")
test = Test("test_fail")
test.run(self.result)
self.assertEqual(len(self._getTodos(self.result)), 1)
def test_standardLibraryCompatibilitySuccess(self):
"""
Tests that use the standard library C{expectedFailure} feature worth
with Trial reporters.
"""
class Test(StdlibTestCase):
@expectedFailure
def test_success(self):
pass
test = Test("test_success")
test.run(self.result)
self.assertEqual(len(self._getUnexpectedSuccesses(self.result)), 1)
class UncleanWarningTodoTests(TodoTests):
"""
Tests for L{UncleanWarningsReporterWrapper}'s handling of todos.
"""
def setUp(self):
TodoTests.setUp(self)
self.result = UncleanWarningsReporterWrapper(self.result)
def _getTodos(self, result):
"""
Get the todos that happened to a reporter inside of an unclean
warnings reporter wrapper.
"""
return result._originalReporter.expectedFailures
def _getUnexpectedSuccesses(self, result):
"""
Get the number of unexpected successes that happened to a reporter
inside of an unclean warnings reporter wrapper.
"""
return result._originalReporter.unexpectedSuccesses
class MockColorizer:
"""
Used by TreeReporterTests to make sure that output is colored correctly.
"""
def __init__(self, stream):
self.log = []
def write(self, text, color):
self.log.append((color, text))
class TreeReporterTests(unittest.SynchronousTestCase):
def setUp(self):
self.test = sample.FooTest("test_foo")
self.stream = StringIO()
self.result = reporter.TreeReporter(self.stream)
self.result._colorizer = MockColorizer(self.stream)
self.log = self.result._colorizer.log
def makeError(self):
try:
1 / 0
except ZeroDivisionError:
f = Failure()
return f
def test_summaryColoredSuccess(self):
"""
The summary in case of success should have a good count of successes
and be colored properly.
"""
self.result.addSuccess(self.test)
self.result.done()
self.assertEqual(self.log[1], (self.result.SUCCESS, "PASSED"))
self.assertEqual(
self.stream.getvalue().splitlines()[-1].strip(), "(successes=1)"
)
def test_summaryColoredFailure(self):
"""
The summary in case of failure should have a good count of errors
and be colored properly.
"""
try:
raise RuntimeError("foo")
except RuntimeError:
self.result.addError(self, sys.exc_info())
self.result.done()
self.assertEqual(self.log[1], (self.result.FAILURE, "FAILED"))
self.assertEqual(self.stream.getvalue().splitlines()[-1].strip(), "(errors=1)")
def test_getPrelude(self):
"""
The tree needs to get the segments of the test ID that correspond
to the module and class that it belongs to.
"""
self.assertEqual(
["foo.bar", "baz"], self.result._getPreludeSegments("foo.bar.baz.qux")
)
self.assertEqual(["foo", "bar"], self.result._getPreludeSegments("foo.bar.baz"))
self.assertEqual(["foo"], self.result._getPreludeSegments("foo.bar"))
self.assertEqual([], self.result._getPreludeSegments("foo"))
def test_groupResults(self):
"""
If two different tests have the same error, L{Reporter._groupResults}
includes them together in one of the tuples in the list it returns.
"""
try:
raise RuntimeError("foo")
except RuntimeError:
self.result.addError(self, sys.exc_info())
self.result.addError(self.test, sys.exc_info())
try:
raise RuntimeError("bar")
except RuntimeError:
extra = sample.FooTest("test_bar")
self.result.addError(extra, sys.exc_info())
self.result.done()
grouped = self.result._groupResults(
self.result.errors, self.result._formatFailureTraceback
)
self.assertEqual(grouped[0][1], [self, self.test])
self.assertEqual(grouped[1][1], [extra])
def test_printResults(self):
"""
L{Reporter._printResults} uses the results list and formatter callable
passed to it to produce groups of results to write to its output
stream.
"""
def formatter(n):
return str(n) + "\n"
first = sample.FooTest("test_foo")
second = sample.FooTest("test_bar")
third = sample.PyunitTest("test_foo")
self.result._printResults(
"FOO", [(first, 1), (second, 1), (third, 2)], formatter
)
self.assertEqual(
self.stream.getvalue(),
"%(double separator)s\n"
"FOO\n"
"1\n"
"\n"
"%(first)s\n"
"%(second)s\n"
"%(double separator)s\n"
"FOO\n"
"2\n"
"\n"
"%(third)s\n"
% {
"double separator": self.result._doubleSeparator,
"first": first.id(),
"second": second.id(),
"third": third.id(),
},
)
class ReporterInterfaceTests(unittest.SynchronousTestCase):
"""
Tests for the bare interface of a trial reporter.
Subclass this test case and provide a different 'resultFactory' to test
that a particular reporter implementation will work with the rest of
Trial.
@cvar resultFactory: A callable that returns a reporter to be tested. The
callable must take the same parameters as L{reporter.Reporter}.
"""
resultFactory: Type[itrial.IReporter] = reporter.Reporter
def setUp(self):
self.test = sample.FooTest("test_foo")
self.stream = StringIO()
self.publisher = log.LogPublisher()
self.result = self.resultFactory(self.stream, publisher=self.publisher)
def test_shouldStopInitiallyFalse(self):
"""
shouldStop is False to begin with.
"""
self.assertEqual(False, self.result.shouldStop)
def test_shouldStopTrueAfterStop(self):
"""
shouldStop becomes True soon as someone calls stop().
"""
self.result.stop()
self.assertEqual(True, self.result.shouldStop)