/
test_arguments.py
393 lines (338 loc) · 11.6 KB
/
test_arguments.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
import functools
import os
import re
import sys
import pytest
from mkdocs_include_markdown_plugin.event import on_page_markdown
from testing_helpers import parametrize_directives
double_quotes_windows_path_skip = pytest.mark.skipif(
sys.platform.startswith('win'),
reason=(
'Double quotes are reserved characters not allowed for'
' paths under Windows'
),
)
@pytest.mark.parametrize(
('directive', 'arguments'),
(
pytest.param(
'include',
[
'preserve-includer-indent',
'dedent',
'trailing-newlines',
],
id='include',
),
pytest.param(
'include-markdown',
[
'preserve-includer-indent',
'dedent',
'rewrite-relative-urls',
'comments',
'trailing-newlines',
],
id='include-markdown',
),
),
)
def test_invalid_bool_arguments(directive, arguments, page, tmp_path, caplog):
for argument_name in arguments:
page_to_include_filepath = tmp_path / 'included.md'
page_to_include_filepath.write_text('Included\n')
filename = 'includer.md'
result = on_page_markdown(
f'''{{%
{directive} "{page_to_include_filepath}"
{argument_name}=invalidoption
%}}''',
page(tmp_path / filename),
tmp_path,
)
assert result == ''
assert len(caplog.records) == 1
assert caplog.records[0].msg == (
f"Invalid value for '{argument_name}' argument of '{directive}'"
f' directive at {filename}:1. Possible values are true or false.'
)
caplog.clear()
@parametrize_directives
def test_start_end_mixed_quotes(directive, page, caplog, tmp_path):
page_to_include_filepath = tmp_path / 'included.md'
page_to_include_filepath.write_text('''Content that should be ignored
<!-- "s'tar't" -->
Content to include
<!-- 'en"d' -->
More content that should be ignored
''')
result = on_page_markdown(
f'''{{%
{directive} "{page_to_include_filepath}"
comments=false
start='<!-- "s\\'tar\\'t" -->'
end="<!-- 'en\\"d' -->"
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == '\nContent to include\n'
assert len(caplog.records) == 0
@parametrize_directives
def test_invalid_start_end_arguments(directive, page, caplog, tmp_path):
page_to_include_filepath = tmp_path / 'included.md'
included_content = '''Content that should be ignored
<!-- start -->
Content to include
<!-- end -->
More content that should be ignored
'''
page_to_include_filepath.write_text(included_content)
result = on_page_markdown(
f'''
{{%
{directive} "{page_to_include_filepath}"
comments=false
start=''
end=""
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == f'\n{included_content}'
records_messages = [record.msg for record in caplog.records]
expected_args = ['start', 'end']
for arg_name in expected_args:
assert (
f"Invalid empty '{arg_name}' argument in '{directive}'"
' directive at includer.md:2'
) in records_messages
assert len(records_messages) == len(expected_args)
@double_quotes_windows_path_skip
@parametrize_directives
def test_exclude_double_quote_escapes(directive, page, tmp_path):
drectory_to_include = tmp_path / 'exclude_double_quote_escapes'
drectory_to_include.mkdir()
page_to_include_filepath = drectory_to_include / 'included.md'
page_to_include_filepath.write_text('Content that should be included\n')
page_to_exclude_filepath = drectory_to_include / 'igno"re"d.md'
page_to_exclude_filepath.write_text('Content that should be excluded\n')
page_to_exclude_escaped_filepath = str(
page_to_exclude_filepath,
).replace('"', '\\"')
includer_glob = os.path.join(str(drectory_to_include), '*.md')
result = on_page_markdown(
f'''{{%
{directive} "{includer_glob}"
comments=false
exclude="{page_to_exclude_escaped_filepath}"
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == 'Content that should be included\n'
@double_quotes_windows_path_skip
@parametrize_directives
def test_invalid_exclude_argument(directive, page, tmp_path, caplog):
drectory_to_include = tmp_path / 'exclude_double_quote_escapes'
drectory_to_include.mkdir()
page_to_include_filepath = drectory_to_include / 'included.md'
page_to_include_filepath.write_text('Content that should be included\n')
page_to_exclude_filepath = drectory_to_include / 'igno"re"d.md'
page_to_exclude_filepath.write_text('Content that should be excluded\n')
includer_glob = os.path.join(str(drectory_to_include), '*.md')
result = on_page_markdown(
f'''{{%
{directive} "{includer_glob}"
comments=false
exclude=
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == (
'Content that should be excluded\n'
'Content that should be included\n'
)
assert len(caplog.records) == 1
assert caplog.records[0].msg == (
f"Invalid empty 'exclude' argument in '{directive}' directive"
' at includer.md:1'
)
class TestFilename:
double_quoted_filenames = [
'inc"luded.md', 'inc"lude"d.md', 'included.md"', '"included.md',
]
single_quoted_filenames = [
fname.replace('"', "'") for fname in double_quoted_filenames
]
@double_quotes_windows_path_skip
@parametrize_directives
@pytest.mark.parametrize('filename', double_quoted_filenames)
def test_not_escaped_double_quotes(
self, directive, filename, page, tmp_path, caplog,
):
page_to_include_filepath = tmp_path / filename
page_to_include_filepath.write_text('Foo\n')
result = on_page_markdown(
f'{{% {directive} "{page_to_include_filepath}" %}}',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert not result
assert len(caplog.records) == 1
assert re.match(
r'^No files found including ',
caplog.records[0].msg,
)
@double_quotes_windows_path_skip
@parametrize_directives
@pytest.mark.parametrize('filename', double_quoted_filenames)
def test_escaped_double_quotes(
self, directive, filename, page, tmp_path,
):
included_content = 'Foo\n'
page_to_include_filepath = tmp_path / filename
page_to_include_filepath.write_text(included_content)
# escape filename passed as argument
escaped_page_to_include_filepath = str(
page_to_include_filepath,
).replace('"', '\\"')
result = on_page_markdown(
f'''{{%
{directive} "{escaped_page_to_include_filepath}"
{'comments=false' if directive == 'include-markdown' else ''}
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == included_content
@parametrize_directives
@pytest.mark.parametrize('filename', single_quoted_filenames)
def test_escaped_single_quotes(
self, filename, directive, page, tmp_path,
):
included_content = 'Foo\n'
page_to_include_filepath = tmp_path / filename
page_to_include_filepath.write_text(included_content)
# escape filename passed as argument
escaped_page_to_include_filepath = str(
page_to_include_filepath,
).replace("'", "\\'")
result = on_page_markdown(
f'''{{%
{directive} '{escaped_page_to_include_filepath}'
{'comments=false' if directive == 'include-markdown' else ''}
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == included_content
@double_quotes_windows_path_skip
@parametrize_directives
@pytest.mark.parametrize('filename', double_quoted_filenames)
def test_unescaped_double_quotes(
self, filename, directive, page, tmp_path,
):
included_content = 'Foo\n'
page_to_include_filepath = tmp_path / filename
page_to_include_filepath.write_text(included_content)
result = on_page_markdown(
f'''{{%
{directive} '{page_to_include_filepath}'
{'comments=false' if directive == 'include-markdown' else ''}
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == included_content
@parametrize_directives
@pytest.mark.parametrize('filename', single_quoted_filenames)
def test_unescaped_single_quotes(
self, filename, directive, page, tmp_path,
):
included_content = 'Foo\n'
page_to_include_filepath = tmp_path / filename
page_to_include_filepath.write_text(included_content)
result = on_page_markdown(
f'''{{%
{directive} "{page_to_include_filepath}"
{'comments=false' if directive == 'include-markdown' else ''}
%}}''',
page(tmp_path / 'includer.md'),
tmp_path,
)
assert result == included_content
@double_quotes_windows_path_skip
@parametrize_directives
@pytest.mark.parametrize(
'filename', ["inc'luded\".md", "''i\"nc\"lude'd.md"],
)
@pytest.mark.parametrize(
'quote', ('"', "'"), ids=('quote="', "quote='"),
)
@pytest.mark.parametrize(
'escape', (True, False), ids=('escape=True', 'escape=False'),
)
def test_mixed_quotes(
self, filename, quote, escape, directive, page, tmp_path, caplog,
):
included_content = 'Foo\n'
page_to_include_filepath = tmp_path / filename
page_to_include_filepath.write_text(included_content)
if escape:
escaped_page_to_include_filepath = str(
page_to_include_filepath,
).replace(quote, f'\\{quote}')
else:
escaped_page_to_include_filepath = page_to_include_filepath
markdown = f'''{{%
{directive} {quote}{escaped_page_to_include_filepath}{quote}
{'comments=false' if directive == 'include-markdown' else ''}
%}}'''
func = functools.partial(
on_page_markdown,
markdown,
page(tmp_path / 'includer.md'),
tmp_path,
)
if escape:
assert func() == included_content
assert len(caplog.records) == 0
else:
assert func() == ''
assert len(caplog.records) == 1
assert re.match(
r'No files found including ',
caplog.records[0].msg,
)
@parametrize_directives
def test_no_filename(self, directive, page, tmp_path, caplog):
filename = 'includer.md'
# shouldn't raise errors
on_page_markdown(
f'\n\n{{% {directive} %}}',
page(tmp_path / filename),
tmp_path,
)
assert caplog.records[0].msg == (
f"Found no path passed including with '{directive}' directive"
f' at {filename}:3'
)
assert len(caplog.records) == 1
@parametrize_directives
def test_non_existent_filename(self, directive, page, tmp_path, caplog):
page_content = f'''{{%
{directive} "/path/to/file/that/does/not/exists"
start="<!--start-here-->"
end="<!--end-here-->"
%}}'''
page_filepath = tmp_path / 'example.md'
page_filepath.write_text(page_content)
assert on_page_markdown(
page_content,
page(page_filepath),
tmp_path,
) == ''
assert len(caplog.records) == 1
assert re.match(r'No files found including ', caplog.records[0].msg)