def test_blacklist_argument(self):
"""blacklist argument gets verified and processed in init"""
# No blacklist
ploader = loader.PluginLoader()
self.assertIsNone(ploader.blacklist)
# List of tuples and BlacklistEntry objects
blentry = BlacklistEntry('parser', 'yaml', '2.0', '>=')
blacklist = [blentry, ('parser', 'json'), ('parser', 'xml', '<', '1.0')]
ploader = loader.PluginLoader(blacklist=blacklist)
self.assertEqual(len(ploader.blacklist), 3)
for entry in ploader.blacklist:
self.assertIsInstance(entry, BlacklistEntry)
self.assertIs(ploader.blacklist[0], blentry)
self.assertEqual(ploader.blacklist[1].type, 'parser')
self.assertEqual(ploader.blacklist[1].name, 'json')
self.assertEqual(ploader.blacklist[1].version, None)
self.assertEqual(ploader.blacklist[1].operator, '==')
self.assertEqual(ploader.blacklist[2].type, 'parser')
self.assertEqual(ploader.blacklist[2].name, 'xml')
self.assertEqual(ploader.blacklist[2].version, '1.0')
self.assertEqual(ploader.blacklist[2].operator, '<')
# Entry isn't iterable
with self.assertRaisesRegex(AttributeError, 'Invalid blacklist entry'):
ploader = loader.PluginLoader(blacklist=[1, 2, 3])
# Bad arguments for BlacklistEntry
with self.assertRaisesRegex(AttributeError, 'Invalid blacklist entry'):
ploader = loader.PluginLoader(blacklist=[(1, 2, 3)])
def test_get_plugin_missing(self):
"""Attempt to retrieve non-existent plugin, return None"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib')
self.assertIsNone(ploader.get_plugin('penguin', 'json'))
self.assertIsNone(ploader.get_plugin('parser', 'penguin'))
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib')
self.assertIsNone(ploader.get_plugin('parser', 'json', '300.1.1'))
def test_repr(self):
"""Only non-default settings show up in repr"""
ploader = loader.PluginLoader(modules=['avengers.iwar', 'avengers.stark'], group='Avengers')
output = "PluginLoader(group='Avengers', modules=['avengers.iwar', 'avengers.stark'])"
self.assertEqual(repr(ploader), output)
blacklist = [('parser', 'json'), ('parser', 'xml', '<', '1.0')]
output = "PluginLoader(blacklist=(%r, %r))" % (BlacklistEntry('parser', 'json'),
BlacklistEntry('parser', 'xml', '<', '1.0'))
ploader = loader.PluginLoader(blacklist=blacklist)
self.assertEqual(repr(ploader), output)
def test_load_entry_points_pkg(self):
"""Load modules from entry points"""
# Entry point is package
epoint1 = EntryPoint.parse('hooks = tests.testdata.lib.hooks', dist=DIST)
# Entry point is module
epoint2 = EntryPoint.parse('parsers = tests.testdata.lib.parsers.xml', dist=DIST)
DIST._ep_map = {'pluginlib.test.plugins': {'hooks': epoint1, 'parsers': epoint2}}
ploader = loader.PluginLoader(group='testdata', entry_point='pluginlib.test.plugins')
plugins = ploader.plugins
self.assertEqual(len(plugins), 3)
self.assertTrue('parser' in plugins)
self.assertTrue('engine' in plugins)
self.assertTrue('hook' in plugins)
self.assertEqual(len(plugins.engine), 0)
self.assertEqual(len(plugins.hook), 2)
self.assertTrue('right' in plugins.hook)
self.assertTrue('left' in plugins.hook)
self.assertEqual(len(plugins.parser), 1)
self.assertTrue('xml' in plugins.parser)
def test_blacklist(self):
"""Blacklist prevents listing plugin"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib',
blacklist=[('parser', 'json', '2.0'), ('engine',)])
plugins = ploader.plugins
self.assertEqual(len(plugins.engine), 0)
self.assertEqual(plugins.parser.json.version, '1.0')
def test_load_paths_duplicate(self):
"""Ignore duplicate paths"""
path = os.path.join(DATAPATH, 'lib', 'engines')
ploader = loader.PluginLoader(group='testdata', paths=[path, path])
plugins = ploader.plugins
self.assertEqual(len(plugins.engine), 1)
self.assertTrue('steam' in plugins.engine)
def test_type_filter(self):
"""Filter plugin types"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib',
type_filter=('engine', 'parser'))
plugins = ploader.plugins
self.assertTrue('parser' in plugins)
self.assertTrue('engine' in plugins)
self.assertFalse('hook' in plugins)
def test_get_plugin_filtered(self):
"""Retrieve specific plugin if not filtered"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib',
type_filter=('engine', 'hook'))
self.assertIsNone(ploader.get_plugin('parser', 'json'))
steamplugin = ploader.get_plugin('engine', 'steam')
self.assertEqual(steamplugin.name, 'steam')
def test_bad_import2(self):
"""Exception raised by imported module"""
ploader = loader.PluginLoader(group='testdata', modules=['tests.testdata.bad2'])
error = 'Error while importing candidate plugin module tests.testdata.bad2'
with self.assertRaisesRegex(PluginImportError, error) as e:
ploader.plugins # pylint: disable=pointless-statement
self.assertRegex(e.exception.friendly, 'RuntimeError: This parrot is no more')
self.assertRegex(e.exception.friendly, 'tests.testdata.bad2')
self.assertRegex(e.exception.friendly, 'line 24')
def test_bad_arguments(self):
"""Error is raised when argument type is wrong"""
# Expect iterables
for arg in ('modules', 'paths', 'blacklist', 'type_filter'):
with self.assertRaises(TypeError):
loader.PluginLoader(**{arg: 'string'})
with self.assertRaises(TypeError):
loader.PluginLoader(**{arg: 8675309})
# Expect strings
for arg in ('library', 'entry_point', 'prefix_package'):
with self.assertRaises(TypeError):
loader.PluginLoader(**{arg: [1, 2, 3]})
with self.assertRaises(TypeError):
loader.PluginLoader(**{arg: 8675309})
def test_bad_import(self):
"""Syntax error in imported module"""
ploader = loader.PluginLoader(group='testdata', modules=['tests.testdata.bad'])
error = 'Error while importing candidate plugin module tests.testdata.bad'
with self.assertRaisesRegex(PluginImportError, error) as e:
ploader.plugins # pylint: disable=pointless-statement
self.assertRegex(e.exception.friendly, 'SyntaxError: invalid syntax')
self.assertRegex(e.exception.friendly, 'tests.testdata.bad')
self.assertRegex(e.exception.friendly, 'line 12')
def test_load_paths_missing(self):
"""Log on invalid path"""
path1 = os.path.join(DATAPATH, 'lib', 'engines')
path2 = os.path.join(DATAPATH, 'NotARealPath')
ploader = loader.PluginLoader(group='testdata', paths=[path1, path2])
plugins = ploader.plugins
self.assertEqual(len(plugins.engine), 1)
self.assertTrue('steam' in plugins.engine)
self.assertRegex(OUTPUT.getvalue().splitlines()[-1], 'not a valid directory')
def test_get_plugin_blacklist(self):
"""Retrieve specific plugin if not blacklisted"""
blacklist = [('parser', 'json', '2.0'), ('parser', 'xml'), ('engine',)]
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib',
blacklist=blacklist)
self.assertIsNone(ploader.get_plugin('parser', 'json', '2.0'))
self.assertIsNone(ploader.get_plugin('parser', 'xml'))
self.assertIsNone(ploader.get_plugin('engine', 'steam'))
jsonplugin = ploader.get_plugin('parser', 'json')
self.assertEqual(jsonplugin.name, 'json')
self.assertEqual(jsonplugin.version, '1.0')
def test_get_plugin(self):
"""Retrieve specific plugin"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib')
with mock.patch.object(ploader, 'load_modules',
wraps=ploader.load_modules) as mock_load_modules:
jsonplugin = ploader.get_plugin('parser', 'json')
self.assertEqual(jsonplugin.name, 'json')
self.assertEqual(jsonplugin.version, '2.0')
self.assertEqual(mock_load_modules.call_count, 1)
jsonplugin = ploader.get_plugin('parser', 'json', '1.0')
self.assertEqual(jsonplugin.name, 'json')
self.assertEqual(jsonplugin.version, '1.0')
self.assertEqual(mock_load_modules.call_count, 1)
def test_load_modules(self):
"""Load modules from modules"""
ploader = loader.PluginLoader(group='testdata', modules=['tests.testdata.lib.parsers'])
plugins = ploader.plugins
self.assertEqual(len(plugins), 3)
self.assertTrue('parser' in plugins)
self.assertTrue('engine' in plugins)
self.assertTrue('hook' in plugins)
self.assertEqual(len(plugins.engine), 0)
self.assertEqual(len(plugins.hook), 0)
self.assertEqual(len(plugins.parser), 2)
self.assertTrue('xml' in plugins.parser)
self.assertTrue('json' in plugins.parser)
self.assertEqual(plugins.parser.json.version, '2.0')
def test_plugins(self):
"""plugins only loads modules on the first call"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib')
with mock.patch.object(ploader, 'load_modules',
wraps=ploader.load_modules) as mock_load_modules:
plugins1 = ploader.plugins
self.assertEqual(mock_load_modules.call_count, 1)
self.assertEqual(len(plugins1.parser), 2)
self.assertTrue('xml' in plugins1.parser)
self.assertTrue('json' in plugins1.parser)
self.assertEqual(plugins1.parser.json.version, '2.0')
plugins2 = ploader.plugins
self.assertEqual(mock_load_modules.call_count, 1)
self.assertEqual(plugins1, plugins2)
def test_load_paths(self):
"""Load modules from paths"""
path = os.path.join(DATAPATH, 'lib', 'engines')
ploader = loader.PluginLoader(group='testdata', paths=[path])
plugins = ploader.plugins
self.assertEqual(len(plugins), 3)
self.assertTrue('parser' in plugins)
self.assertTrue('engine' in plugins)
self.assertTrue('hook' in plugins)
self.assertEqual(len(plugins.parser), 0)
self.assertEqual(len(plugins.hook), 0)
self.assertEqual(len(plugins.engine), 1)
self.assertTrue('steam' in plugins.engine)
self.assertEqual(plugins.engine.steam.__module__, 'pluginlib.importer.steam')
def test_load_entry_points_not_mod(self):
"""Raise warning and continue when entry point fails"""
epoint = EntryPoint.parse('parsers = tests.testdata.lib.parsers.xml:XML', dist=DIST)
DIST._ep_map = {'pluginlib.test.plugins': {'parsers': epoint}}
ploader = loader.PluginLoader(group='testdata', entry_point='pluginlib.test.plugins')
with warnings.catch_warnings(record=True) as e:
warnings.simplefilter("always")
plugins = ploader.plugins
self.assertEqual(len(e), 1)
self.assertTrue(issubclass(e[-1].category, EntryPointWarning))
self.assertRegex(str(e[-1].message), "Entry point 'parsers' is not a module or package")
self.assertEqual(len(plugins.parser), 1)
self.assertTrue('xml' in plugins.parser)
self.assertEqual(len(plugins.engine), 0)
self.assertEqual(len(plugins.hook), 0)
def test_plugins_all(self):
"""plugins only loads modules on the first call"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib')
with mock.patch.object(ploader, 'load_modules',
wraps=ploader.load_modules) as mock_load_modules:
plugins1 = ploader.plugins_all
self.assertEqual(mock_load_modules.call_count, 1)
self.assertEqual(len(plugins1.parser), 2)
self.assertTrue('xml' in plugins1.parser)
self.assertIsInstance(plugins1.parser.xml, dict)
self.assertTrue('json' in plugins1.parser)
self.assertIsInstance(plugins1.parser.json, dict)
self.assertEqual(sorted(plugins1.parser.json.keys()), ['1.0', '2.0'])
plugins2 = ploader.plugins_all
self.assertEqual(mock_load_modules.call_count, 1)
self.assertEqual(plugins1, plugins2)
def test_load_paths_prefix_pkg(self):
"""Load modules from paths with alternate prefix package"""
path = os.path.join(DATAPATH, 'lib', 'engines')
ploader = loader.PluginLoader(group='testdata', paths=[path],
prefix_package='tests.testdata.importer')
plugins = ploader.plugins
self.assertEqual(len(plugins), 3)
self.assertTrue('parser' in plugins)
self.assertTrue('engine' in plugins)
self.assertTrue('hook' in plugins)
self.assertEqual(len(plugins.parser), 0)
self.assertEqual(len(plugins.hook), 0)
self.assertEqual(len(plugins.engine), 1)
self.assertTrue('steam' in plugins.engine)
self.assertEqual(plugins.engine.steam.__module__, 'tests.testdata.importer.steam')
def test_load_lib(self):
"""Load modules from standard library"""
ploader = loader.PluginLoader(group='testdata', library='tests.testdata.lib')
plugins = ploader.plugins
self.assertEqual(len(plugins), 3)
self.assertTrue('parser' in plugins)
self.assertTrue('engine' in plugins)
self.assertTrue('hook' in plugins)
self.assertEqual(len(plugins.parser), 2)
self.assertTrue('xml' in plugins.parser)
self.assertTrue('json' in plugins.parser)
self.assertEqual(plugins.parser.json.version, '2.0')
self.assertEqual(len(plugins.engine), 1)
self.assertTrue('steam' in plugins.engine)
self.assertEqual(len(plugins.hook), 2)
self.assertTrue('right' in plugins.hook)
self.assertTrue('left' in plugins.hook)
def test_load_entry_points_bad2(self):
"""Raise warning and continue when entry point fails - bad module"""
epoint1 = EntryPoint.parse('bad = tests.testdata.lib.parsers.bad', dist=DIST)
epoint2 = EntryPoint.parse('parsers = tests.testdata.lib.parsers.xml', dist=DIST)
DIST._ep_map = {'pluginlib.test.plugins': {'bad': epoint1, 'parsers': epoint2}}
ploader = loader.PluginLoader(group='testdata', entry_point='pluginlib.test.plugins')
with warnings.catch_warnings(record=True) as e:
warnings.simplefilter("always")
plugins = ploader.plugins
self.assertEqual(len(e), 1)
self.assertTrue(issubclass(e[-1].category, EntryPointWarning))
self.assertRegex(str(e[-1].message), 'can not be loaded for entry point bad')
self.assertEqual(len(plugins.parser), 1)
self.assertTrue('xml' in plugins.parser)
self.assertEqual(len(plugins.engine), 0)
self.assertEqual(len(plugins.hook), 0)