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
|
from __future__ import print_function
import re
from functools import partial
from os.path import split
from pathlib import Path
import pytest
from testfixtures import compare, StringComparison
from sybil import Sybil, Region
from sybil.document import Document, PythonDocument
from sybil.example import Example, SybilFailure
from .helpers import sample_path, write_doctest
@pytest.fixture()
def document():
return Document('ABCDEFGH', '/the/path')
class TestRegion:
def test_repr_with_evaluator(self):
region = Region(0, 1, parsed='parsed', evaluator='evaluator')
compare(
repr(region),
expected=(
"<Region start=0 end=1 evaluator='evaluator'><Parsed>'parsed'</Parsed></Region>"
)
)
def test_repr_with_lexemes(self):
compare(
str(Region(36, 56, lexemes={
'language': 'python',
'foo': None,
'source': 'A'+'X'*1000+'Z',
'bar': {},
'baz': {f'a{i}': 'b' for i in range(11)},
})),
expected="<Region start=36 end=56>\n"
"language: 'python'\n"
"foo: None\n"
"source: 'AXXXXXXXXXXXXXXXXXXXX...XXXXXXXXXXXXXXXXXXXXZ'\n"
"bar: {}\n"
"baz: {'a0': 'b', 'a1': 'b', 'a2': 'b', 'a3': 'b', "
"'a4': 'b', 'a5': 'b', 'a6': 'b', 'a7': 'b', 'a8': 'b', 'a9': 'b', "
"'a10': 'b'}\n"
"</Region>"
)
def test_repr_with_parsed(self):
compare(
str(Region(36, 56, parsed={
'language': 'python',
'foo': None,
'source': 'X'*1000,
'bar': {},
'baz': {f'a{i}': 'b' for i in range(11)},
})),
expected="<Region start=36 end=56><Parsed>{'language': 'python'"
"...9': 'b', 'a10': 'b'}}</Parsed></Region>"
)
class TestExample:
def test_repr(self, document):
region = Region(0, 1, 'parsed', 'evaluator')
example = Example(document, 1, 2, region, {})
assert (repr(example) ==
"<Example path=/the/path line=1 column=2 using 'evaluator'>")
def test_evaluate_okay(self, document):
def evaluator(example):
example.namespace['parsed'] = example.parsed
region = Region(0, 1, 'the data', evaluator)
namespace = {}
example = Example(document, 1, 2, region, namespace)
result = example.evaluate()
assert result is None
assert namespace == {'parsed': 'the data'}
def test_evaluate_not_okay(self, document):
def evaluator(example):
return 'foo!'
region = Region(0, 1, 'the data', evaluator)
example = Example(document, 1, 2, region, {})
with pytest.raises(SybilFailure) as excinfo:
example.evaluate()
assert str(excinfo.value) == (
'Example at /the/path, line 1, column 2 did not evaluate as '
'expected:\nfoo!'
)
assert excinfo.value.example is example
assert excinfo.value.result == 'foo!'
def test_evaluate_raises_exception(self, document):
def evaluator(example):
raise ValueError('foo!')
region = Region(0, 1, 'the data', evaluator)
example = Example(document, 1, 2, region, {})
with pytest.raises(ValueError) as excinfo:
example.evaluate()
assert str(excinfo.value) == 'foo!'
class TestDocument:
def test_add(self, document):
region = Region(0, 1, None, None)
document.add(region)
assert [e.region for e in document] == [region]
def test_add_no_overlap(self, document):
region1 = Region(0, 1, None, None)
region2 = Region(6, 8, None, None)
document.add(region1)
document.add(region2)
assert [e.region for e in document] == [region1, region2]
def test_add_out_of_order(self, document):
region1 = Region(0, 1, None, None)
region2 = Region(6, 8, None, None)
document.add(region2)
document.add(region1)
assert [e.region for e in document] == [region1, region2]
def test_add_adjacent(self, document):
region1 = Region(0, 1, None, None)
region2 = Region(1, 2, None, None)
region3 = Region(2, 3, None, None)
document.add(region1)
document.add(region3)
document.add(region2)
assert [e.region for e in document] == [region1, region2, region3]
def test_add_before_start(self, document):
region = Region(-1, 0, None, None)
with pytest.raises(ValueError) as excinfo:
document.add(region)
assert str(excinfo.value) == (
'<Region start=-1 end=0> '
'from line 1, column 0 to line 1, column 1 '
'is before start of document'
)
def test_add_after_end(self, document):
region = Region(len(document.text), len(document.text)+1, None, None)
with pytest.raises(ValueError) as excinfo:
document.add(region)
assert str(excinfo.value) == (
'<Region start=8 end=9> '
'from line 1, column 9 to line 1, column 10 '
'goes beyond end of document'
)
def test_add_overlaps_with_previous(self, document):
region1 = Region(0, 2, None, None)
region2 = Region(1, 3, None, None)
document.add(region1)
with pytest.raises(ValueError) as excinfo:
document.add(region2)
assert str(excinfo.value) == (
'<Region start=0 end=2>'
' from line 1, column 1 to line 1, column 3 overlaps '
'<Region start=1 end=3>'
' from line 1, column 2 to line 1, column 4'
)
def test_add_at_same_place(self, document):
region1 = Region(0, 2, None, None)
region2 = Region(0, 3, None, None)
document.add(region1)
with pytest.raises(ValueError) as excinfo:
document.add(region2)
assert str(excinfo.value) == (
'<Region start=0 end=3>'
' from line 1, column 1 to line 1, column 4 overlaps '
'<Region start=0 end=2>'
' from line 1, column 1 to line 1, column 3'
)
def test_add_identical(self, document):
region1 = Region(0, 2, None, None)
region2 = Region(0, 2, None, None)
document.add(region1)
with pytest.raises(ValueError) as excinfo:
document.add(region2)
assert str(excinfo.value) == (
'<Region start=0 end=2>'
' from line 1, column 1 to line 1, column 3 overlaps '
'<Region start=0 end=2>'
' from line 1, column 1 to line 1, column 3'
)
def test_add_overlaps_with_next(self, document):
region1 = Region(0, 1, None, None)
region2 = Region(1, 3, None, None)
region3 = Region(2, 4, None, None)
document.add(region1)
document.add(region3)
with pytest.raises(ValueError) as excinfo:
document.add(region2)
assert str(excinfo.value) == (
'<Region start=1 end=3> '
'from line 1, column 2 to line 1, column 4 overlaps '
'<Region start=2 end=4> '
'from line 1, column 3 to line 1, column 5'
)
def test_example_path(self, document):
document.add(Region(0, 1, None, None))
assert [e.document for e in document] == [document]
def test_example_line_and_column(self):
text = 'R1XYZ\nR2XYZ\nR3XYZ\nR4XYZ\nR4XYZ\n'
i = text.index
document = Document(text, '')
document.add(Region(0, i('R2')+2, None, None))
document.add(Region(i('R3')-1, i('R3')+2, None, None))
document.add(Region(i('R4')+3, len(text), None, None))
assert ([(e.line, e.column) for e in document] ==
[(1, 1), (2, 6), (4, 4)])
def check(letter, parsed, namespace):
assert namespace is None
text, expected = parsed
assert set(text) == {letter}
actual = text.count(letter)
if actual != expected:
return '{} count was {} instead of {}'.format(
letter, actual, expected
)
# This would normally be wrong, but handy for testing here:
return '{} count was {}, as expected'.format(letter, actual)
def parse_for_x(document):
for m in re.finditer(r'(X+) (\d+) check', document.text):
yield Region(m.start(), m.end(),
(m.group(1), int(m.group(2))),
partial(check, 'X'))
def parse_for_y(document):
for m in re.finditer(r'(Y+) (\d+) check', document.text):
yield Region(m.start(), m.end(),
(m.group(1), int(m.group(2))),
partial(check, 'Y'))
def evaluate_examples(examples):
return [e.region.evaluator(e.region.parsed, namespace=None)
for e in examples]
class TestSybil:
def test_parse(self):
sybil = Sybil([parse_for_x, parse_for_y])
document = sybil.parse(Path(sample_path('sample1.txt')))
assert (evaluate_examples(document) ==
['X count was 4, as expected',
'Y count was 3, as expected'])
document = sybil.parse(Path(sample_path('sample2.txt')))
assert (evaluate_examples(document) ==
['X count was 3 instead of 4',
'Y count was 3, as expected'])
def test_explicit_encoding(self, tmp_path: Path):
path = (tmp_path / 'encoded.txt')
path.write_text(u'X 1 check\n\xa3', encoding='charmap')
sybil = Sybil([parse_for_x], encoding='charmap')
document = sybil.parse(path)
assert (evaluate_examples(document) ==
['X count was 1, as expected'])
def test_augment_document_mapping(self, tmp_path: Path):
class TextDocument(Document):
pass
sybil = Sybil([], document_types={'.txt': TextDocument})
document = sybil.parse(write_doctest(tmp_path, 'test.txt'))
assert type(document) is TextDocument
document = sybil.parse(write_doctest(tmp_path, 'test.rst'))
assert type(document) is Document
def test_override_document_mapping(self):
sybil = Sybil([parse_for_x, parse_for_y], document_types={'.py': PythonDocument})
document = sybil.parse(Path(sample_path('sample1.txt')))
assert (evaluate_examples(document) ==
['X count was 4, as expected',
'Y count was 3, as expected'])
document = sybil.parse(Path(sample_path('comments.py')))
assert (evaluate_examples(document) ==
['X count was 4, as expected',
'Y count was 3, as expected'])
def test_addition(self):
rest = Sybil([parse_for_x])
myst = Sybil([parse_for_y])
sybil = rest + myst
assert sybil == [rest, myst]
# check integrations exist:
assert sybil.pytest
assert sybil.unittest
def test_addition_to_collection(self):
rest = Sybil([parse_for_x])
myst = Sybil([parse_for_y])
bust = Sybil([parse_for_y])
sybil = rest + myst
sybil += [bust]
assert sybil == [rest, myst, bust]
# check integrations exist:
assert sybil.pytest
assert sybil.unittest
def test_default_str(self):
sybil = Sybil([parse_for_x])
compare(str(sybil), expected=StringComparison('<Sybil: \d+>'))
def test_named_str(self):
sybil = Sybil([parse_for_x], name='foo')
compare(str(sybil), expected='<Sybil: foo>')
def test_default_repr(self):
sybil = Sybil([parse_for_x])
compare(repr(sybil), expected=StringComparison('<Sybil: \d+>'))
def test_named_repr(self):
sybil = Sybil([parse_for_x], name='foo')
compare(repr(sybil), expected='<Sybil: foo>')
def check_into_namespace(example):
parsed, namespace = example.region.parsed, example.namespace
if 'parsed' not in namespace:
namespace['parsed'] = []
namespace['parsed'].append(parsed)
print(namespace['parsed'])
def parse(document):
for m in re.finditer(r'([XY]+) (\d+) check', document.text):
yield Region(m.start(), m.end(), m.start(), check_into_namespace)
def test_namespace(capsys):
sybil = Sybil([parse], path='./samples')
documents = [sybil.parse(p) for p in sorted(sybil.path.glob('sample*.txt'))]
actual = []
for document in documents:
for example in document:
print(split(example.path)[-1], example.line)
example.evaluate()
actual.append((
split(example.path)[-1],
example.line,
document.namespace['parsed'].copy(),
))
out, _ = capsys.readouterr()
assert out.split('\n') == [
'sample1.txt 1',
'[0]',
'sample1.txt 3',
'[0, 14]',
'sample2.txt 1',
'[0]',
'sample2.txt 3',
'[0, 13]',
''
]
|
