-
Notifications
You must be signed in to change notification settings - Fork 122
/
test_doctest.py
309 lines (261 loc) · 9.47 KB
/
test_doctest.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
"""
Tests for the doctest addons
"""
from mantiddoc.doctest import DocTestOutputParser, TestCaseReport, TestSuiteReport
import unittest
class TestCaseReportTest(unittest.TestCase):
def test_report_stores_expected_attributes_about_test(self):
name = "DummyTest"
classname = "DummySuite"
failure_txt = "Test failed"
report = TestCaseReport(classname, name, failure_txt)
self.assertEquals(name, report.name)
self.assertEquals(classname, report.classname)
self.assertEquals(failure_txt, report.failure_descr)
def test_case_passed_with_empty_failure_description(self):
name = "DummyTest"
classname = "DummySuite"
failure_txt = ""
report = TestCaseReport(classname, name, failure_txt)
self.assertTrue(report.passed)
self.assertFalse(report.failed)
def test_case_passed_with_failure_description_as_None(self):
name = "DummyTest"
classname = "DummySuite"
failure_txt = None
report = TestCaseReport(classname, name, failure_txt)
self.assertTrue(report.passed)
self.assertFalse(report.failed)
def test_case_failed_with_non_empty_failure_description(self):
name = "DummyTest"
classname = "DummySuite"
failure_txt = "Test failed"
report = TestCaseReport(classname, name, failure_txt)
self.assertTrue(report.failed)
self.assertFalse(report.passed)
#------------------------------------------------------------------------------
class TestSuiteReportTest(unittest.TestCase):
def test_report_stores_expected_attributes_about_test(self):
name = "DummySuite"
package = "tests"
testcases = [TestCaseReport("doctests", "DummyTest", "failed")]
report = TestSuiteReport(name, testcases, package)
self.assertEquals(name, report.name)
self.assertEquals(package, report.package)
self.assertEquals(testcases, report.testcases)
def test_report_gives_correct_number_test_passed_and_failed(self):
report = self.__createDummyReport()
self.assertEquals(1, report.npassed)
self.assertEquals(1, report.nfailed)
self.assertEquals(2, report.ntests)
#========================= Failure cases ==================================
def test_report_raises_error_with_empty_tests_cases_list(self):
self.assertRaises(ValueError, self.__createDummyReport, empty = True)
#========================= Helpers ========================================
def __createDummyReport(self, empty = False):
name = "DummySuite"
package = "tests"
if empty:
testcases = []
else:
testcases = [TestCaseReport("doctests", "DummyTest", "failed"),
TestCaseReport("doctests", "DummyTest2", "")]
return TestSuiteReport(name, testcases, package)
#------------------------------------------------------------------------------
ALL_PASS_EX = \
"""
Document: algorithms/AllPassed
------------------------------
2 items passed all tests:
1 tests in Ex 2
2 tests in default
3 tests in 2 items.
3 passed and 0 failed.
Test passed.
Doctest summary
===============
3 tests
0 failures in tests
0 failures in setup code
0 failures in cleanup code
"""
ALL_FAIL_EX = \
"""Document: algorithms/AllFailed
------------------------------
**********************************************************************
File "algorithms/AllFailed.rst", line 127, in Ex2
Failed example:
print "Multi-line failed"
print "test"
Expected:
No match
Got:
Multi-line failed
test
**********************************************************************
File "algorithms/AllFailed.rst", line 111, in Ex1
Failed example:
print "Single line failed test"
Expected:
No match
Got:
Single line failed test
**********************************************************************
2 items had failures:
1 of 1 in Ex1
1 of 1 in Ex2
2 tests in 2 items.
0 passed and 2 failed.
***Test Failed*** 2 failures.
Doctest summary
===============
2 tests
2 failures in tests
0 failures in setup code
0 failures in cleanup code
"""
MIX_PASSFAIL_EX = \
"""Document: algorithms/MixPassFail
--------------------------------
**********************************************************************
File "algorithms/MixPassFail.rst", line 143, in default
Failed example:
print "A failed test"
Expected:
Not a success
Got:
A failed test
**********************************************************************
File "algorithms/MixPassFail.rst", line 159, in Ex1
Failed example:
print "Second failed test"
Expected:
Not a success again
Got:
Second failed test
1 items passed all tests:
1 tests in Ex3
**********************************************************************
2 items had failures:
1 of 1 in Ex1
1 of 2 in default
4 tests in 3 items.
2 passed and 2 failed.
***Test Failed*** 2 failures.
Doctest summary
===============
4 tests
2 failures in tests
0 failures in setup code
0 failures in cleanup code
"""
class DocTestOutputParserTest(unittest.TestCase):
def test_all_passed_gives_expected_results(self):
parser = DocTestOutputParser(ALL_PASS_EX, isfile = False)
self.assertTrue(hasattr(parser, "testsuite"))
suite = parser.testsuite
self.assertEquals("doctests", suite.name)
self.assertEquals("docs", suite.package)
self.assertEquals(3, suite.ntests)
cases = suite.testcases
expected_names = ["Ex 2", "default", "default"]
for idx, case in enumerate(cases):
self.assertTrue(case.passed)
self.assertEquals(expected_names[idx], case.name)
self.assertEquals("algorithms.AllPassed", case.classname)
def test_all_failed_gives_expected_results(self):
parser = DocTestOutputParser(ALL_FAIL_EX, isfile = False)
self.assertTrue(hasattr(parser, "testsuite"))
suite = parser.testsuite
self.assertEquals("doctests", suite.name)
self.assertEquals("docs", suite.package)
self.assertEquals(2, suite.ntests)
cases = suite.testcases
expected_names = ["Ex2", "Ex1"]
expected_errors = [
"""File "algorithms/AllFailed.rst", line 127, in Ex2
Failed example:
print "Multi-line failed"
print "test"
Expected:
No match
Got:
Multi-line failed
test""", # second error
"""File "algorithms/AllFailed.rst", line 111, in Ex1
Failed example:
print "Single line failed test"
Expected:
No match
Got:
Single line failed test"""
]
# test
for idx, case in enumerate(cases):
self.assertTrue(case.failed)
self.assertEquals(expected_names[idx], case.name)
self.assertEquals(expected_errors[idx], case.failure_descr)
self.assertEquals("algorithms.AllFailed", case.classname)
def test_mix_pass_fail_gives_expected_results(self):
parser = DocTestOutputParser(MIX_PASSFAIL_EX, isfile = False)
self.assertTrue(hasattr(parser, "testsuite"))
suite = parser.testsuite
self.assertEquals("doctests", suite.name)
self.assertEquals("docs", suite.package)
self.assertEquals(4, suite.ntests)
cases = suite.testcases
expected_names = ["default", "Ex1", "Ex3", "default"]
expected_errors = [
"""File "algorithms/MixPassFail.rst", line 143, in default
Failed example:
print "A failed test"
Expected:
Not a success
Got:
A failed test""",
"""File "algorithms/MixPassFail.rst", line 159, in Ex1
Failed example:
print "Second failed test"
Expected:
Not a success again
Got:
Second failed test""",
"", "" #two passes
]
# test
for idx, case in enumerate(cases):
expected_fail = True
if expected_errors[idx] == "":
expected_fail = False
self.assertEquals(expected_fail, case.failed)
self.assertEquals(expected_names[idx], case.name)
self.assertEquals(expected_errors[idx], case.failure_descr)
self.assertEquals("algorithms.MixPassFail", case.classname)
def test_multi_document_text(self):
multi_doc = "\n".join(ALL_PASS_EX.splitlines()[:-6]) # hack off summary
multi_doc += ALL_FAIL_EX
parser = DocTestOutputParser(multi_doc, isfile = False)
self.assertTrue(hasattr(parser, "testsuite"))
suite = parser.testsuite
# The other checks should be sufficient if this passes
self.assertEquals(5, suite.ntests)
#========================= Failure cases ==================================
def test_no_document_start_gives_valueerror(self):
self.assertRaises(ValueError, DocTestOutputParser,
"----------\n 1 items passed", isfile = False)
def test_no_location_for_test_failure_gives_valueerror(self):
fail_ex_noloc = ALL_FAIL_EX.splitlines()
#remove the location line
fail_ex_noloc.pop(3)
fail_ex_noloc = "\n".join(fail_ex_noloc)
self.assertRaises(ValueError, DocTestOutputParser, fail_ex_noloc,
isfile = False)
def test_no_overall_summary_for_document_gives_valueerror(self):
fail_ex_nosum = ALL_FAIL_EX.splitlines()
fail_ex_nosum.pop(26)
fail_ex_nosum = "\n".join(fail_ex_nosum)
self.assertRaises(ValueError, DocTestOutputParser, fail_ex_nosum,
isfile = False)
#------------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()