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
|
#!/usr/bin/env python
import unittest
from unittest import mock
import os
from mkdocs import plugins
from mkdocs import config
class DummyPlugin(plugins.BasePlugin):
config_scheme = (
('foo', config.config_options.Type(str, default='default foo')),
('bar', config.config_options.Type(int, default=0)),
('dir', config.config_options.Dir(exists=False)),
)
def on_pre_page(self, content, **kwargs):
""" modify page content by prepending `foo` config value. """
return '{} {}'.format(self.config['foo'], content)
def on_nav(self, item, **kwargs):
""" do nothing (return None) to not modify item. """
return None
def on_page_read_source(self, **kwargs):
""" create new source by prepending `foo` config value to 'source'. """
return '{} {}'.format(self.config['foo'], 'source')
def on_pre_build(self, **kwargs):
""" do nothing (return None). """
return None
class TestPluginClass(unittest.TestCase):
def test_valid_plugin_options(self):
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 = os.path.join(cfg_dirname, test_dir)
expected = {
'foo': 'some value',
'bar': 0,
'dir': expected,
}
plugin = DummyPlugin()
errors, warnings = plugin.load_config(options, config_file_path=cfg_fname)
self.assertEqual(plugin.config, expected)
self.assertEqual(errors, [])
self.assertEqual(warnings, [])
def test_invalid_plugin_options(self):
plugin = DummyPlugin()
errors, warnings = plugin.load_config({'foo': 42})
self.assertEqual(len(errors), 1)
self.assertIn('foo', errors[0])
self.assertEqual(warnings, [])
errors, warnings = plugin.load_config({'bar': 'a string'})
self.assertEqual(len(errors), 1)
self.assertIn('bar', errors[0])
self.assertEqual(warnings, [])
errors, warnings = plugin.load_config({'invalid_key': 'value'})
self.assertEqual(errors, [])
self.assertEqual(len(warnings), 1)
self.assertIn('invalid_key', warnings[0])
class TestPluginCollection(unittest.TestCase):
def test_set_plugin_on_collection(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
collection['foo'] = plugin
self.assertEqual([(k, v) for k, v in collection.items()], [('foo', plugin)])
def test_set_multiple_plugins_on_collection(self):
collection = plugins.PluginCollection()
plugin1 = DummyPlugin()
collection['foo'] = plugin1
plugin2 = DummyPlugin()
collection['bar'] = plugin2
self.assertEqual([(k, v) for k, v in 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.run_event('pre_page', 'page content'), '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'})
collection['bar'] = plugin2
self.assertEqual(collection.run_event('pre_page', 'page content'),
'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.run_event('nav', 'nav item'), 'nav item')
def test_event_empty_item(self):
collection = plugins.PluginCollection()
plugin = DummyPlugin()
plugin.load_config({'foo': 'new'})
collection['foo'] = plugin
self.assertEqual(collection.run_event('page_read_source'), '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.run_event('pre_build'), None)
def test_run_undefined_event_on_collection(self):
collection = plugins.PluginCollection()
self.assertEqual(collection.run_event('pre_page', 'page content'), 'page content')
def test_run_unknown_event_on_collection(self):
collection = plugins.PluginCollection()
self.assertRaises(KeyError, collection.run_event, 'unknown', 'page content')
MockEntryPoint = mock.Mock()
MockEntryPoint.configure_mock(**{'name': 'sample', 'load.return_value': DummyPlugin})
@mock.patch('pkg_resources.iter_entry_points', return_value=[MockEntryPoint])
class TestPluginConfig(unittest.TestCase):
def test_plugin_config_without_options(self, mock_class):
cfg = {'plugins': ['sample']}
option = config.config_options.Plugins()
cfg['plugins'] = option.validate(cfg['plugins'])
self.assertIsInstance(cfg['plugins'], plugins.PluginCollection)
self.assertIn('sample', cfg['plugins'])
self.assertIsInstance(cfg['plugins']['sample'], plugins.BasePlugin)
expected = {
'foo': 'default foo',
'bar': 0,
'dir': None,
}
self.assertEqual(cfg['plugins']['sample'].config, expected)
def test_plugin_config_with_options(self, mock_class):
cfg = {
'plugins': [{
'sample': {
'foo': 'foo value',
'bar': 42
}
}]
}
option = config.config_options.Plugins()
cfg['plugins'] = option.validate(cfg['plugins'])
self.assertIsInstance(cfg['plugins'], plugins.PluginCollection)
self.assertIn('sample', cfg['plugins'])
self.assertIsInstance(cfg['plugins']['sample'], plugins.BasePlugin)
expected = {
'foo': 'foo value',
'bar': 42,
'dir': None,
}
self.assertEqual(cfg['plugins']['sample'].config, expected)
def test_plugin_config_empty_list_with_empty_default(self, mock_class):
cfg = {'plugins': []}
option = config.config_options.Plugins(default=[])
cfg['plugins'] = option.validate(cfg['plugins'])
self.assertIsInstance(cfg['plugins'], plugins.PluginCollection)
self.assertEqual(len(cfg['plugins']), 0)
def test_plugin_config_empty_list_with_default(self, mock_class):
# Default is ignored
cfg = {'plugins': []}
option = config.config_options.Plugins(default=['sample'])
cfg['plugins'] = option.validate(cfg['plugins'])
self.assertIsInstance(cfg['plugins'], plugins.PluginCollection)
self.assertEqual(len(cfg['plugins']), 0)
def test_plugin_config_none_with_empty_default(self, mock_class):
cfg = {'plugins': None}
option = config.config_options.Plugins(default=[])
cfg['plugins'] = option.validate(cfg['plugins'])
self.assertIsInstance(cfg['plugins'], plugins.PluginCollection)
self.assertEqual(len(cfg['plugins']), 0)
def test_plugin_config_none_with_default(self, mock_class):
# Default is used.
cfg = {'plugins': None}
option = config.config_options.Plugins(default=['sample'])
cfg['plugins'] = option.validate(cfg['plugins'])
self.assertIsInstance(cfg['plugins'], plugins.PluginCollection)
self.assertIn('sample', cfg['plugins'])
self.assertIsInstance(cfg['plugins']['sample'], plugins.BasePlugin)
expected = {
'foo': 'default foo',
'bar': 0,
'dir': None,
}
self.assertEqual(cfg['plugins']['sample'].config, expected)
def test_plugin_config_uninstalled(self, mock_class):
cfg = {'plugins': ['uninstalled']}
option = config.config_options.Plugins()
self.assertRaises(config.base.ValidationError, option.validate, cfg['plugins'])
def test_plugin_config_not_list(self, mock_class):
cfg = {'plugins': 'sample'} # should be a list
option = config.config_options.Plugins()
self.assertRaises(config.base.ValidationError, option.validate, cfg['plugins'])
def test_plugin_config_multivalue_dict(self, mock_class):
cfg = {
'plugins': [{
'sample': {
'foo': 'foo value',
'bar': 42
},
'extra_key': 'baz'
}]
}
option = config.config_options.Plugins()
self.assertRaises(config.base.ValidationError, option.validate, cfg['plugins'])
def test_plugin_config_not_string_or_dict(self, mock_class):
cfg = {
'plugins': [('not a string or dict',)]
}
option = config.config_options.Plugins()
self.assertRaises(config.base.ValidationError, option.validate, cfg['plugins'])
def test_plugin_config_options_not_dict(self, mock_class):
cfg = {
'plugins': [{
'sample': 'not a dict'
}]
}
option = config.config_options.Plugins()
self.assertRaises(config.base.ValidationError, option.validate, cfg['plugins'])
|
