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
|
#!/usr/bin/env python
from __future__ import annotations
import os
import unittest
from typing import TYPE_CHECKING, Optional
if TYPE_CHECKING:
from typing_extensions import assert_type
from mkdocs.structure.nav import Navigation
else:
def assert_type(val, typ):
return None
from mkdocs import plugins
from mkdocs.commands import build
from mkdocs.config import base
from mkdocs.config import config_options as c
from mkdocs.config.base import ValidationError
from mkdocs.exceptions import Abort, BuildError, PluginError
from mkdocs.tests.base import load_config, tempdir
class _DummyPluginConfig(base.Config):
foo = c.Type(str, default='default foo')
bar = c.Type(int, default=0)
dir = c.Optional(c.Dir(exists=False))
class DummyPlugin(plugins.BasePlugin[_DummyPluginConfig]):
def on_page_content(self, html, **kwargs) -> str:
"""Modify page content by prepending `foo` config value."""
return f'{self.config.foo} {html}'
def on_nav(self, nav, **kwargs) -> None:
"""Do nothing (return None) to not modify item."""
return None
def on_page_read_source(self, **kwargs) -> str:
"""Create new source by prepending `foo` config value to 'source'."""
return f'{self.config.foo} source'
def on_pre_build(self, **kwargs) -> None:
"""Do nothing (return None)."""
return None
class TestPluginClass(unittest.TestCase):
def test_valid_plugin_options(self) -> None:
test_dir = 'test'
options = {
'foo': 'some value',
'dir': test_dir,
}
cfg_fname = os.path.join('tmp', 'test', 'fname.yml')
cfg_fname = os.path.abspath(cfg_fname)
cfg_dirname = os.path.dirname(cfg_fname)
expected = {
'foo': 'some value',
'bar': 0,
'dir': os.path.join(cfg_dirname, test_dir),
}
plugin = DummyPlugin()
errors, warnings = plugin.load_config(options, config_file_path=cfg_fname)
self.assertEqual(errors, [])
self.assertEqual(warnings, [])
assert_type(plugin.config, _DummyPluginConfig)
self.assertEqual(plugin.config, expected)
assert_type(plugin.config.bar, int)
self.assertEqual(plugin.config.bar, 0)
assert_type(plugin.config.dir, Optional[str])
def test_invalid_plugin_options(self):
plugin = DummyPlugin()
errors, warnings = plugin.load_config({'foo': 42})
self.assertEqual(
errors,
[('foo', ValidationError("Expected type: <class 'str'> but received: <class 'int'>"))],
)
self.assertEqual(warnings, [])
errors, warnings = plugin.load_config({'bar': 'a string'})
self.assertEqual(
errors,
[('bar', ValidationError("Expected type: <class 'int'> but received: <class 'str'>"))],
)
self.assertEqual(warnings, [])
errors, warnings = plugin.load_config({'invalid_key': 'value'})
self.assertEqual(errors, [])
self.assertEqual(
warnings, [('invalid_key', "Unrecognised configuration name: invalid_key")]
)
class TestPluginCollection(unittest.TestCase):
def test_correct_events_registered(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
collection['foo'] = plugin
self.assertEqual(
collection.events,
{
'startup': [],
'shutdown': [],
'serve': [],
'config': [],
'pre_build': [plugin.on_pre_build],
'files': [],
'nav': [plugin.on_nav],
'env': [],
'post_build': [],
'build_error': [],
'pre_template': [],
'template_context': [],
'post_template': [],
'pre_page': [],
'page_read_source': [plugin.on_page_read_source],
'page_markdown': [],
'page_content': [plugin.on_page_content],
'page_context': [],
'post_page': [],
},
)
def test_event_priorities(self) -> None:
class PrioPlugin(plugins.BasePlugin):
config_scheme = base.get_schema(_DummyPluginConfig)
@plugins.event_priority(100)
def on_page_content(self, html, **kwargs) -> None:
pass
@plugins.event_priority(50)
def _on_nav_1(self, nav: Navigation, **kwargs) -> None:
pass
@plugins.event_priority(-100)
def _on_nav_2(self, nav, **kwargs) -> None:
pass
on_nav = plugins.CombinedEvent(_on_nav_1, _on_nav_2)
def on_page_read_source(self, **kwargs) -> None:
pass
@plugins.event_priority(-50)
def on_post_build(self, **kwargs) -> None:
pass
collection = plugins.PluginCollection()
collection['dummy'] = dummy = DummyPlugin()
with self.assertLogs('mkdocs', level='WARNING') as cm:
collection['prio'] = prio = PrioPlugin()
self.assertEqual(
'\n'.join(cm.output),
"WARNING:mkdocs.plugins:Multiple 'on_page_read_source' handlers can't work (both plugins 'dummy' and 'prio' registered one).",
)
self.assertEqual(
collection.events['page_content'],
[prio.on_page_content, dummy.on_page_content],
)
self.assertEqual(
collection.events['nav'],
[prio._on_nav_1, dummy.on_nav, prio._on_nav_2],
)
self.assertEqual(
collection.events['page_read_source'],
[dummy.on_page_read_source, prio.on_page_read_source],
)
self.assertEqual(
collection.events['post_build'],
[prio.on_post_build],
)
def test_set_plugin_on_collection(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
collection['foo'] = plugin
self.assertEqual(list(collection.items()), [('foo', plugin)])
def test_set_multiple_plugins_on_collection(self):
collection = plugins.PluginCollection()
plugin1 = DummyPlugin()
collection['foo'] = plugin1
plugin2 = DummyPlugin()
with self.assertLogs('mkdocs', level='WARNING') as cm:
collection['bar'] = plugin2
self.assertEqual(
'\n'.join(cm.output),
"WARNING:mkdocs.plugins:Multiple 'on_page_read_source' handlers can't work (both plugins 'foo' and 'bar' registered one).",
)
self.assertEqual(list(collection.items()), [('foo', plugin1), ('bar', plugin2)])
def test_run_event_on_collection(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
plugin.load_config({'foo': 'new'})
collection['foo'] = plugin
self.assertEqual(
collection.on_page_content('page content', page=None, config={}, files=[]),
'new page content',
)
def test_run_event_twice_on_collection(self):
collection = plugins.PluginCollection()
plugin1 = DummyPlugin()
plugin1.load_config({'foo': 'new'})
collection['foo'] = plugin1
plugin2 = DummyPlugin()
plugin2.load_config({'foo': 'second'})
with self.assertLogs('mkdocs', level='WARNING') as cm:
collection['bar'] = plugin2
self.assertEqual(
'\n'.join(cm.output),
"WARNING:mkdocs.plugins:Multiple 'on_page_read_source' handlers can't work (both plugins 'foo' and 'bar' registered one).",
)
self.assertEqual(
collection.on_page_content('page content', page=None, config={}, files=[]),
'second new page content',
)
def test_event_returns_None(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
plugin.load_config({'foo': 'new'})
collection['foo'] = plugin
self.assertEqual(collection.on_nav(['nav item'], config={}, files=[]), ['nav item'])
def test_event_empty_item(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
plugin.load_config({'foo': 'new'})
collection['foo'] = plugin
self.assertEqual(collection.on_page_read_source(page=None, config={}), 'new source')
def test_event_empty_item_returns_None(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
plugin.load_config({'foo': 'new'})
collection['foo'] = plugin
self.assertEqual(collection.on_pre_build(config={}), None)
def test_run_undefined_event_on_collection(self):
collection = plugins.PluginCollection()
self.assertEqual(
collection.on_page_markdown('page markdown', page=None, config={}, files=[]),
'page markdown',
)
def test_run_unknown_event_on_collection(self):
collection = plugins.PluginCollection()
with self.assertRaises(KeyError):
collection.run_event('unknown', 'page content')
@tempdir()
def test_run_build_error_event(self, site_dir):
build_errors = []
class PluginRaisingError(plugins.BasePlugin):
def __init__(self, error_on):
self.error_on = error_on
def on_pre_page(self, page, **kwargs):
if self.error_on == 'pre_page':
raise BuildError('pre page error')
return page
def on_page_markdown(self, markdown, **kwargs):
if self.error_on == 'page_markdown':
raise BuildError('page markdown error')
return markdown
def on_page_content(self, html, **kwargs):
if self.error_on == 'page_content':
raise PluginError('page content error')
return html
def on_post_page(self, html, **kwargs):
if self.error_on == 'post_page':
raise ValueError('post page error')
def on_build_error(self, error, **kwargs):
build_errors.append(error)
cfg = load_config(site_dir=site_dir)
cfg.plugins['errorplugin'] = PluginRaisingError(error_on='pre_page')
with self.assertLogs('mkdocs', level='ERROR'):
self.assertRaises(Abort, build.build, cfg)
cfg = load_config(site_dir=site_dir)
cfg.plugins['errorplugin'] = PluginRaisingError(error_on='page_markdown')
with self.assertLogs('mkdocs', level='ERROR'):
self.assertRaises(Abort, build.build, cfg)
cfg = load_config(site_dir=site_dir)
cfg.plugins['errorplugin'] = PluginRaisingError(error_on='page_content')
with self.assertLogs('mkdocs', level='ERROR'):
self.assertRaises(Abort, build.build, cfg)
cfg = load_config(site_dir=site_dir)
cfg.plugins['errorplugin'] = PluginRaisingError(error_on='post_page')
with self.assertLogs('mkdocs', level='ERROR'):
self.assertRaises(ValueError, build.build, cfg)
cfg = load_config(site_dir=site_dir)
cfg.plugins['errorplugin'] = PluginRaisingError(error_on='')
build.build(cfg)
self.assertEqual(len(build_errors), 4)
self.assertIs(build_errors[0].__class__, BuildError)
self.assertEqual(str(build_errors[0]), 'pre page error')
self.assertIs(build_errors[1].__class__, BuildError)
self.assertEqual(str(build_errors[1]), 'page markdown error')
self.assertIs(build_errors[2].__class__, PluginError)
self.assertEqual(str(build_errors[2]), 'page content error')
self.assertIs(build_errors[3].__class__, ValueError)
self.assertEqual(str(build_errors[3]), 'post page error')
|
