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
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Tests for pw_cli.plugins."""
from pathlib import Path
import sys
import tempfile
import types
from typing import Dict, Iterator
import unittest
from pw_cli import plugins
def _no_docstring() -> int:
return 123
def _with_docstring() -> int:
"""This docstring is brought to you courtesy of Pigweed."""
return 456
def _create_files(directory: str, files: Dict[str, str]) -> Iterator[Path]:
for relative_path, contents in files.items():
path = Path(directory) / relative_path
path.parent.mkdir(exist_ok=True, parents=True)
path.write_text(contents)
yield path
class TestPlugin(unittest.TestCase):
"""Tests for plugins.Plugins."""
def test_target_name_attribute(self) -> None:
self.assertEqual(
plugins.Plugin('abc', _no_docstring).target_name,
f'{__name__}._no_docstring',
)
def test_target_name_no_name_attribute(self) -> None:
has_no_name = 'no __name__'
self.assertFalse(hasattr(has_no_name, '__name__'))
self.assertEqual(
plugins.Plugin('abc', has_no_name).target_name,
'<unknown>.no __name__',
)
_TEST_PLUGINS = {
'TEST_PLUGINS': (
f'test_plugin {__name__} _with_docstring\n'
f'other_plugin {__name__} _no_docstring\n'
),
'nested/in/dirs/TEST_PLUGINS': f'test_plugin {__name__} _no_docstring\n',
}
class TestPluginRegistry(unittest.TestCase):
"""Tests for plugins.Registry."""
def setUp(self) -> None:
self._registry = plugins.Registry(
validator=plugins.callable_with_no_args
)
def test_register(self) -> None:
self.assertIsNotNone(self._registry.register('a_plugin', _no_docstring))
self.assertIs(self._registry['a_plugin'].target, _no_docstring)
def test_register_by_name(self) -> None:
self.assertIsNotNone(
self._registry.register_by_name(
'plugin_one', __name__, '_no_docstring'
)
)
self.assertIsNotNone(
self._registry.register('plugin_two', _no_docstring)
)
self.assertIs(self._registry['plugin_one'].target, _no_docstring)
self.assertIs(self._registry['plugin_two'].target, _no_docstring)
def test_register_by_name_undefined_module(self) -> None:
with self.assertRaisesRegex(plugins.Error, 'No module named'):
self._registry.register_by_name(
'plugin_two', 'not a module', 'something'
)
def test_register_by_name_undefined_function(self) -> None:
with self.assertRaisesRegex(plugins.Error, 'does not exist'):
self._registry.register_by_name('plugin_two', __name__, 'nothing')
def test_register_fails_validation(self) -> None:
with self.assertRaisesRegex(plugins.Error, 'must be callable'):
self._registry.register('plugin_two', 'not function')
def test_run_with_argv_sets_sys_argv(self) -> None:
def stash_argv() -> int:
self.assertEqual(['pw go', '1', '2'], sys.argv)
return 1
self.assertIsNotNone(self._registry.register('go', stash_argv))
original_argv = sys.argv
self.assertEqual(self._registry.run_with_argv('go', ['1', '2']), 1)
self.assertIs(sys.argv, original_argv)
def test_run_with_argv_registered_plugin(self) -> None:
with self.assertRaises(KeyError):
self._registry.run_with_argv('plugin_one', [])
def test_register_cannot_overwrite(self) -> None:
self.assertIsNotNone(self._registry.register('foo', lambda: None))
self.assertIsNotNone(
self._registry.register_by_name('bar', __name__, '_no_docstring')
)
with self.assertRaises(plugins.Error):
self._registry.register('foo', lambda: None)
with self.assertRaises(plugins.Error):
self._registry.register('bar', lambda: None)
def test_register_same_file_multiple_times_no_error(self) -> None:
with tempfile.TemporaryDirectory() as tempdir:
paths = list(_create_files(tempdir, _TEST_PLUGINS))
self._registry.register_file(paths[0])
self._registry.register_file(paths[0])
self._registry.register_file(paths[0])
self.assertIs(self._registry['test_plugin'].target, _with_docstring)
def test_help_uses_function_or_module_docstring(self) -> None:
self.assertIsNotNone(self._registry.register('a', _no_docstring))
self.assertIsNotNone(self._registry.register('b', _with_docstring))
self.assertIn(__doc__, '\n'.join(self._registry.detailed_help(['a'])))
self.assertNotIn(
__doc__, '\n'.join(self._registry.detailed_help(['b']))
)
self.assertIn(
_with_docstring.__doc__,
'\n'.join(self._registry.detailed_help(['b'])),
)
def test_empty_string_if_no_help(self) -> None:
fake_module_name = f'{__name__}.fake_module_for_test{id(self)}'
fake_module = types.ModuleType(fake_module_name)
self.assertIsNone(fake_module.__doc__)
sys.modules[fake_module_name] = fake_module
try:
function = lambda: None
function.__module__ = fake_module_name
self.assertIsNotNone(self._registry.register('a', function))
self.assertEqual(self._registry['a'].help(full=False), '')
self.assertEqual(self._registry['a'].help(full=True), '')
finally:
del sys.modules[fake_module_name]
def test_decorator_not_called(self) -> None:
@self._registry.plugin
def nifty() -> None:
pass
self.assertEqual(self._registry['nifty'].target, nifty)
def test_decorator_called_no_args(self) -> None:
@self._registry.plugin()
def nifty() -> None:
pass
self.assertEqual(self._registry['nifty'].target, nifty)
def test_decorator_called_with_args(self) -> None:
@self._registry.plugin(name='nifty')
def my_nifty_keen_plugin() -> None:
pass
self.assertEqual(self._registry['nifty'].target, my_nifty_keen_plugin)
if __name__ == '__main__':
unittest.main()
|
