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
|
"""Tests for mkdocs-include-markdown-plugin `exclude` setting."""
import functools
import os
import re
import pytest
from mkdocs.exceptions import PluginError
from mkdocs_include_markdown_plugin.event import on_page_markdown
from testing_helpers import parametrize_directives, unix_only
@unix_only
@parametrize_directives
@pytest.mark.parametrize(
('filenames', 'exclude', 'exclude_prefix', 'expected_result'),
(
pytest.param(
('foo', 'bar', 'baz'),
f'content{os.sep}foo*',
True,
'bar\nbaz\n',
id='ignore-by-glob',
),
pytest.param(
('foo', 'bar', 'baz'),
f'content{os.sep}ba*',
True,
'foo\n',
id='ignore-multiple-by-glob',
),
pytest.param(
('foo', 'bar', 'baz'),
'',
True,
'bar\nbaz\nfoo\n',
id='not-ignore',
),
pytest.param(
('foo', 'bar', 'baz'),
'*',
True,
None,
id='ignore-all',
),
pytest.param(
('foo', 'bar', 'baz'),
f'..{os.sep}content{os.sep}*',
False,
None,
id='ignore-all-relative',
),
pytest.param(
('foo', 'bar', 'baz'),
f'..{os.sep}content{os.sep}b*',
False,
'foo\n',
id='ignore-relative',
),
),
)
def test_exclude(
page,
tmp_path,
plugin,
caplog,
directive,
filenames,
exclude,
exclude_prefix,
expected_result,
):
includer_folder = tmp_path / 'includer'
content_folder = tmp_path / 'content'
includer_folder.mkdir()
content_folder.mkdir()
includer_file = includer_folder / 'main.txt'
files = {
filename: content_folder / filename for filename in filenames
}
exclude_prefix = f'{tmp_path}{os.sep}' if exclude_prefix else ''
includer_file_content = f'''{{%
{directive} "{tmp_path}{os.sep}content/*"
exclude='{exclude_prefix}{exclude}'
%}}'''
for basename, file in files.items():
file.write_text(f'{basename}\n')
includer_file.write_text(includer_file_content)
func = functools.partial(
on_page_markdown,
includer_file_content,
page(includer_file),
includer_folder,
plugin,
)
if expected_result is None:
with pytest.raises(PluginError) as exc:
func()
assert re.match(r'No files found including ', str(exc.value))
else:
assert func() == expected_result
assert len(caplog.records) == 0
|
