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
|
import inspect
import sys
import tempfile
import unittest
from contextlib import contextmanager
from io import StringIO
from unittest import mock
from tap.parser import Parser
try:
import yaml
from more_itertools import peekable # noqa
have_yaml = True
except ImportError:
have_yaml = False
@contextmanager
def captured_output():
new_out, new_err = StringIO(), StringIO()
old_out, old_err = sys.stdout, sys.stderr
try:
sys.stdout, sys.stderr = new_out, new_err
yield sys.stdout, sys.stderr
finally:
sys.stdout, sys.stderr = old_out, old_err
class TestParser(unittest.TestCase):
"""Tests for tap.parser.Parser"""
def test_finds_ok(self):
"""The parser extracts an ok line."""
parser = Parser()
line = parser.parse_line("ok - This is a passing test line.")
self.assertEqual("test", line.category)
self.assertTrue(line.ok)
self.assertTrue(line.number is None)
def test_finds_number(self):
"""The parser extracts a test number."""
parser = Parser()
line = parser.parse_line("ok 42 is the magic number.")
self.assertEqual("test", line.category)
self.assertEqual(42, line.number)
def test_finds_description(self):
parser = Parser()
line = parser.parse_line("ok 42 A passing test.")
self.assertEqual("test", line.category)
self.assertEqual("A passing test.", line.description)
def test_after_hash_is_not_description(self):
parser = Parser()
line = parser.parse_line("ok A description # Not part of description.")
self.assertEqual("test", line.category)
self.assertEqual("A description", line.description)
def test_finds_todo(self):
parser = Parser()
line = parser.parse_line("ok A description # TODO Not done")
self.assertEqual("test", line.category)
self.assertTrue(line.todo)
def test_finds_skip(self):
parser = Parser()
line = parser.parse_line("ok A description # SKIP for now")
self.assertEqual("test", line.category)
self.assertTrue(line.skip)
def test_finds_not_ok(self):
"""The parser extracts a not ok line."""
parser = Parser()
line = parser.parse_line("not ok - This is a failing test line.")
self.assertEqual("test", line.category)
self.assertFalse(line.ok)
self.assertTrue(line.number is None)
self.assertEqual("", line.directive.text)
def test_finds_directive(self):
"""The parser extracts a directive"""
parser = Parser()
test_line = "not ok - This line fails # TODO not implemented"
line = parser.parse_line(test_line)
directive = line.directive
self.assertEqual("test", line.category)
self.assertEqual("TODO not implemented", directive.text)
self.assertFalse(directive.skip)
self.assertTrue(directive.todo)
self.assertEqual("not implemented", directive.reason)
def test_unrecognizable_line(self):
"""The parser returns an unrecognizable line."""
parser = Parser()
line = parser.parse_line("This is not a valid TAP line. # srsly")
self.assertEqual("unknown", line.category)
def test_diagnostic_line(self):
"""The parser extracts a diagnostic line."""
text = "# An example diagnostic line"
parser = Parser()
line = parser.parse_line(text)
self.assertEqual("diagnostic", line.category)
self.assertEqual(text, line.text)
def test_bail_out_line(self):
"""The parser extracts a bail out line."""
parser = Parser()
line = parser.parse_line("Bail out! This is the reason to bail.")
self.assertEqual("bail", line.category)
self.assertEqual("This is the reason to bail.", line.reason)
def test_finds_version(self):
"""The parser extracts a version line."""
parser = Parser()
line = parser.parse_line("TAP version 13")
self.assertEqual("version", line.category)
self.assertEqual(13, line.version)
def test_errors_on_old_version(self):
"""The TAP spec dictates that anything less than 13 is an error."""
parser = Parser()
with self.assertRaises(ValueError):
parser.parse_line("TAP version 12")
def test_finds_plan(self):
"""The parser extracts a plan line."""
parser = Parser()
line = parser.parse_line("1..42")
self.assertEqual("plan", line.category)
self.assertEqual(42, line.expected_tests)
def test_finds_plan_with_skip(self):
"""The parser extracts a plan line containing a SKIP."""
parser = Parser()
line = parser.parse_line("1..42 # Skipping this test file.")
self.assertEqual("plan", line.category)
self.assertTrue(line.skip)
def test_ignores_plan_with_any_non_skip_directive(self):
"""The parser only recognizes SKIP directives in plans."""
parser = Parser()
line = parser.parse_line("1..42 # TODO will not work.")
self.assertEqual("unknown", line.category)
def test_parses_text(self):
sample = inspect.cleandoc(
"""1..2
ok 1 A passing test
not ok 2 A failing test"""
)
parser = Parser()
lines = []
for line in parser.parse_text(sample):
lines.append(line)
self.assertEqual(3, len(lines))
self.assertEqual("plan", lines[0].category)
self.assertEqual("test", lines[1].category)
self.assertTrue(lines[1].ok)
self.assertEqual("test", lines[2].category)
self.assertFalse(lines[2].ok)
def test_parses_file(self):
sample = inspect.cleandoc(
"""1..2
ok 1 A passing test
not ok 2 A failing test"""
)
temp = tempfile.NamedTemporaryFile(delete=False) # noqa: SIM115
temp.write(sample.encode("utf-8"))
temp.close()
parser = Parser()
lines = []
for line in parser.parse_file(temp.name):
lines.append(line)
self.assertEqual(3, len(lines))
self.assertEqual("plan", lines[0].category)
self.assertEqual("test", lines[1].category)
self.assertTrue(lines[1].ok)
self.assertIsNone(lines[1].yaml_block)
self.assertEqual("test", lines[2].category)
self.assertFalse(lines[2].ok)
def test_parses_yaml(self):
sample = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing test
---
test: sample yaml
...
not ok 2 A failing test"""
)
parser = Parser()
lines = []
for line in parser.parse_text(sample):
lines.append(line)
if have_yaml:
converted_yaml = yaml.safe_load("""test: sample yaml""")
self.assertEqual(4, len(lines))
self.assertEqual(13, lines[0].version)
self.assertEqual(converted_yaml, lines[2].yaml_block)
self.assertEqual("test", lines[3].category)
self.assertIsNone(lines[3].yaml_block)
else:
self.assertEqual(7, len(lines))
self.assertEqual(13, lines[0].version)
for line_index in list(range(3, 6)):
self.assertEqual("unknown", lines[line_index].category)
self.assertEqual("test", lines[6].category)
def test_parses_mixed(self):
# Test that we can parse both a version 13 and earlier version files
# using the same parser. Make sure that parsing works regardless of
# the order of the incoming documents.
sample_version_13 = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing version 13 test
---
test: sample yaml
...
not ok 2 A failing version 13 test"""
)
sample_pre_13 = inspect.cleandoc(
"""1..2
ok 1 A passing pre-13 test
not ok 2 A failing pre-13 test"""
)
parser = Parser()
lines = []
lines.extend(parser.parse_text(sample_version_13))
lines.extend(parser.parse_text(sample_pre_13))
if have_yaml:
self.assertEqual(13, lines[0].version)
self.assertEqual("A passing version 13 test", lines[2].description)
self.assertEqual("A failing version 13 test", lines[3].description)
self.assertEqual("A passing pre-13 test", lines[5].description)
self.assertEqual("A failing pre-13 test", lines[6].description)
else:
self.assertEqual(13, lines[0].version)
self.assertEqual("A passing version 13 test", lines[2].description)
self.assertEqual("A failing version 13 test", lines[6].description)
self.assertEqual("A passing pre-13 test", lines[8].description)
self.assertEqual("A failing pre-13 test", lines[9].description)
# Test parsing documents in reverse order
parser = Parser()
lines = []
lines.extend(parser.parse_text(sample_pre_13))
lines.extend(parser.parse_text(sample_version_13))
if have_yaml:
self.assertEqual("A passing pre-13 test", lines[1].description)
self.assertEqual("A failing pre-13 test", lines[2].description)
self.assertEqual(13, lines[3].version)
self.assertEqual("A passing version 13 test", lines[5].description)
self.assertEqual("A failing version 13 test", lines[6].description)
else:
self.assertEqual("A passing pre-13 test", lines[1].description)
self.assertEqual("A failing pre-13 test", lines[2].description)
self.assertEqual(13, lines[3].version)
self.assertEqual("A passing version 13 test", lines[5].description)
self.assertEqual("A failing version 13 test", lines[9].description)
def test_parses_yaml_no_end(self):
sample = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing test
---
test: sample yaml
not ok 2 A failing test"""
)
parser = Parser()
lines = []
for line in parser.parse_text(sample):
lines.append(line)
if have_yaml:
converted_yaml = yaml.safe_load("""test: sample yaml""")
self.assertEqual(4, len(lines))
self.assertEqual(13, lines[0].version)
self.assertEqual(converted_yaml, lines[2].yaml_block)
self.assertEqual("test", lines[3].category)
self.assertIsNone(lines[3].yaml_block)
else:
self.assertEqual(6, len(lines))
self.assertEqual(13, lines[0].version)
for line_index in list(range(3, 5)):
self.assertEqual("unknown", lines[line_index].category)
self.assertEqual("test", lines[5].category)
def test_parses_yaml_more_complex(self):
sample = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing test
---
message: test
severity: fail
data:
got:
- foo
expect:
- bar
output: |-
a multiline string
must be handled properly
even with | pipes
| here > and: there
last_nl: |+
there's a newline here ->
"""
)
parser = Parser()
lines = []
for line in parser.parse_text(sample):
lines.append(line)
if have_yaml:
converted_yaml = yaml.safe_load(
r'''
message: test
severity: fail
data:
got:
- foo
expect:
- bar
output: "a multiline string\nmust be handled properly\neven with | pipes\n| here > and: there"
last_nl: "there's a newline here ->\n"''' # noqa
)
self.assertEqual(3, len(lines))
self.assertEqual(13, lines[0].version)
self.assertEqual(converted_yaml, lines[2].yaml_block)
else:
self.assertEqual(19, len(lines))
self.assertEqual(13, lines[0].version)
for line_index in list(range(3, 11)):
self.assertEqual("unknown", lines[line_index].category)
def test_parses_yaml_no_association(self):
sample = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing test
# Diagnostic line
---
test: sample yaml
...
not ok 2 A failing test"""
)
parser = Parser()
lines = []
for line in parser.parse_text(sample):
lines.append(line)
self.assertEqual(8, len(lines))
self.assertEqual(13, lines[0].version)
self.assertIsNone(lines[2].yaml_block)
self.assertEqual("diagnostic", lines[3].category)
for line_index in list(range(4, 7)):
self.assertEqual("unknown", lines[line_index].category)
self.assertEqual("test", lines[7].category)
def test_parses_yaml_no_start(self):
sample = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing test
test: sample yaml
...
not ok 2 A failing test"""
)
parser = Parser()
lines = []
for line in parser.parse_text(sample):
lines.append(line)
self.assertEqual(6, len(lines))
self.assertEqual(13, lines[0].version)
self.assertIsNone(lines[2].yaml_block)
for line_index in list(range(3, 5)):
self.assertEqual("unknown", lines[line_index].category)
self.assertEqual("test", lines[5].category)
def test_malformed_yaml(self):
self.maxDiff = None
sample = inspect.cleandoc(
"""TAP version 13
1..2
ok 1 A passing test
---
test: sample yaml
\tfail: tabs are not allowed!
...
not ok 2 A failing test"""
)
yaml_err = inspect.cleandoc(
"""
WARNING: Optional imports not found, TAP 13 output will be
ignored. To parse yaml, see requirements in docs:
https://tappy.readthedocs.io/en/latest/consumers.html#tap-version-13"""
)
parser = Parser()
lines = []
with captured_output() as (parse_out, _):
for line in parser.parse_text(sample):
lines.append(line)
if have_yaml:
self.assertEqual(4, len(lines))
self.assertEqual(13, lines[0].version)
with captured_output() as (out, _):
self.assertIsNone(lines[2].yaml_block)
self.assertEqual(
"Error parsing yaml block. Check formatting.", out.getvalue().strip()
)
self.assertEqual("test", lines[3].category)
self.assertIsNone(lines[3].yaml_block)
else:
self.assertEqual(8, len(lines))
self.assertEqual(13, lines[0].version)
for line_index in list(range(3, 7)):
self.assertEqual("unknown", lines[line_index].category)
self.assertEqual("test", lines[7].category)
self.assertEqual(yaml_err, parse_out.getvalue().strip())
def test_parse_empty_file(self):
temp = tempfile.NamedTemporaryFile(delete=False) # noqa: SIM115
temp.close()
parser = Parser()
lines = []
for line in parser.parse_file(temp.name):
lines.append(line)
self.assertEqual(0, len(lines))
@mock.patch(
"tap.parser.sys.stdin",
StringIO(
"""1..2
ok 1 A passing test
not ok 2 A failing test"""
),
)
def test_parses_stdin(self):
parser = Parser()
lines = []
for line in parser.parse_stdin():
lines.append(line)
self.assertEqual(3, len(lines))
self.assertEqual("plan", lines[0].category)
self.assertEqual("test", lines[1].category)
self.assertTrue(lines[1].ok)
self.assertEqual("test", lines[2].category)
self.assertFalse(lines[2].ok)
|
