File: test_nested_includes.py

package info (click to toggle)
mkdocs-include-markdown-plugin 7.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 1,316 kB
  • sloc: python: 5,360; makefile: 6
file content (365 lines) | stat: -rw-r--r-- 7,882 bytes parent folder | download | duplicates (2)
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
"""Nested inclusion tests."""

import pytest

from mkdocs_include_markdown_plugin.event import on_page_markdown


@pytest.mark.parametrize(
    (
        'first_includer_content',
        'second_includer_content',
        'included_content',
        'expected_result',
        'expected_warnings_schemas',
    ),
    (
        # Includer -> Markdown -> Markdown
        pytest.param(
            '''# Header

{%
  include-markdown "{filepath}"
%}''',
            '''Some text from second includer.

{%
  include-markdown "{filepath}"
%}
''',
            '''Some test from final included.''',
            '''# Header

Some text from second includer.

Some test from final included.
''',
            [],
            id='includer -> markdown -> markdown',
        ),

        # Includer -> Markdown -> file
        pytest.param(
            '''# Header

{%
  include-markdown "{filepath}"
%}''',
            '''Some text from second includer.

{%
  include "{filepath}"
%}
''',
            '''Some test from final included.''',
            '''# Header

Some text from second includer.

Some test from final included.
''',
            [],
            id='includer -> markdown -> file',
        ),

        # Includer -> file -> file
        pytest.param(
            '''# Header

{%
  include "{filepath}"
%}''',
            '''Some text from second includer.

{%
  include "{filepath}"
%}
''',
            '''Some test from final included.''',
            '''# Header

Some text from second includer.

Some test from final included.
''',
            [],
            id='includer -> file -> file',
        ),

        # Includer -> file -> Markdown
        pytest.param(
            '''# Header

{%
  include "{filepath}"
%}''',
            '''Some text from second includer.

{%
  include-markdown "{filepath}"
  start="<!-- start -->"
  end="<!-- end -->"
%}
''',
            '''This must be ignored
<!-- start -->Some test from final included.<!-- end -->

This must be ignored also
''',
            '''# Header

Some text from second includer.

Some test from final included.
''',
            [],
            id='includer -> file -> markdown',
        ),

        # cumulative_heading_offset
        pytest.param(
            '''# Header

{%
  include-markdown "{filepath}"
  heading-offset=1
%}''',
            '''# Header 2

{%
  include-markdown "{filepath}"
  heading-offset=1
%}
''',
            '''# Header 3
''',
            '''# Header

## Header 2

### Header 3

''',
            [],
            id='cumulative_heading_offset',
        ),

        # start and end defined in first inclusion but not found
        pytest.param(
            '''# Header

{%
  include-markdown '{filepath}'
  start="<!--start-->"
  end="<!--end-->"
%}''',
            '''# Header 2

''',
            '''# Header 3
''',
            '''# Header

# Header 2

''',
            [
                (
                    "Delimiter start '<!--start-->' of 'include-markdown'"
                    ' directive at {first_includer_file}:3 not detected'
                    ' in the file {second_includer_file}'
                ),
                (
                    "Delimiter end '<!--end-->' of 'include-markdown'"
                    ' directive at {first_includer_file}:3 not detected'
                    ' in the file {second_includer_file}'
                ),
            ],
            id='start-end-not-found (first-level)',
        ),
        # start and end defined in second inclusion but not found
        pytest.param(
            '''# Header

{%
  include-markdown "{filepath}"
%}''',
            '''# Header 2

{%
  include-markdown "{filepath}"
  start="<!--start-->"
  end="<!--end-->"
%}''',
            '''# Header 3

Included content
''',
            '''# Header

# Header 2

# Header 3

Included content
''',
            [
                (
                    "Delimiter start '<!--start-->' of 'include-markdown'"
                    ' directive at {second_includer_file}:3 not detected'
                    ' in the file {included_file}'
                ),
                (
                    "Delimiter end '<!--end-->' of 'include-markdown'"
                    ' directive at {second_includer_file}:3 not detected'
                    ' in the file {included_file}'
                ),
            ],
            id='start-end-not-found (second-level)',
        ),
        # recursive inclusion disabled with `include` directive
        pytest.param(
            '''# Header

{%
  include "{filepath}"
  recursive=false
%}''',
            '''# Header 2

{% include "{filepath}" %}
''',
            '''# Header 3

This content must not be included.
''',
            '''# Header

# Header 2

{% include "{filepath}" %}
''',
            [],
            id='include-recursive=false',
        ),
        # recursive inclusion disabled with `include-markdown` directive
        pytest.param(
            '''# Header

{%
  include-markdown "{filepath}"
  recursive=false
%}''',
            '''# Header 2

{% include-markdown "{filepath}" %}
''',
            '''# Header 3

This content must not be included.
''',
            '''# Header

# Header 2

{% include-markdown "{filepath}" %}
''',
            [],
            id='include-markdown-recursive=false',
        ),
    ),
)
def test_nested_include(
    first_includer_content,
    second_includer_content,
    included_content,
    expected_result,
    expected_warnings_schemas,
    page,
    plugin,
    caplog,
    tmp_path,
):
    first_includer_file = tmp_path / 'first-includer.txt'
    second_includer_file = tmp_path / 'second-includer.txt'
    included_file = tmp_path / 'included.txt'

    first_includer_content = first_includer_content.replace(
        '{filepath}', second_includer_file.as_posix(),
    )
    second_includer_content = second_includer_content.replace(
        '{filepath}', included_file.as_posix(),
    )
    expected_result = expected_result.replace(
        '{filepath}', included_file.as_posix(),
    )

    first_includer_file.write_text(first_includer_content)
    second_includer_file.write_text(second_includer_content)
    included_file.write_text(included_content)

    # assert content
    assert on_page_markdown(
        first_includer_content, page(first_includer_file), tmp_path, plugin,
    ) == expected_result

    # assert warnings
    expected_warnings_schemas = expected_warnings_schemas or []
    expected_warnings = [
        msg_schema.replace(
            '{first_includer_file}',
            str(first_includer_file.relative_to(tmp_path)),
        ).replace(
            '{second_includer_file}',
            str(second_includer_file.relative_to(tmp_path)),
        ).replace(
            '{included_file}',
            str(included_file.relative_to(tmp_path)),
        ) for msg_schema in expected_warnings_schemas
    ]

    for record in caplog.records:
        assert record.msg in expected_warnings
    assert len(expected_warnings_schemas) == len(caplog.records)


def test_nested_include_relpath(page, tmp_path, plugin):
    docs_dir = tmp_path / 'docs'
    docs_dir.mkdir()

    first_includer_file = tmp_path / 'first-includer.txt'
    second_includer_file = docs_dir / 'second-includer.txt'
    included_file = tmp_path / 'included.txt'

    first_includer_content = '''# Header

{%
  include-markdown "./docs/second-includer.txt"
%}
'''
    first_includer_file.write_text(first_includer_content)

    second_includer_content = '''Text from second includer.

{%
  include-markdown "../included.txt"
%}
'''
    second_includer_file.write_text(second_includer_content)

    included_file.write_text('Included content.')

    expected_result = '''# Header

Text from second includer.

Included content.

'''

    assert on_page_markdown(
        first_includer_content,
        page(first_includer_file),
        docs_dir,
        plugin,
    ) == expected_result