def test_autoload(self): pm = PluginManager() pm.items('test.c1') assert 'test.c1' in pm._item assert 'tstpkg1.plugin:C1Plugin1' in pm._item['test.c1'] pm = PluginManager(autoload=[]) pm.items('test.c1') assert 'test.c1' in pm._item assert 'tstpkg1.plugin:C1Plugin1' not in pm._item['test.c1']
def test_autoload(self): pm = PluginManager() pm.items("test.c1") assert "test.c1" in pm._item assert "tstpkg1.plugin:C1Plugin1" in pm._item["test.c1"] pm = PluginManager(autoload=[]) pm.items("test.c1") assert "test.c1" in pm._item assert "tstpkg1.plugin:C1Plugin1" not in pm._item["test.c1"]
def list_plugins(lst, verbose=False): from openalea.core.plugin.manager import PluginManager pm = PluginManager() import pkg_resources from openalea.core.plugin import iter_groups if lst in ['summary', 'all']: prefixes = ['openalea', 'oalab', 'vpltk'] else: prefixes = [lst] for group in sorted(iter_groups()): match = False for prefix in prefixes: if group.startswith(prefix): match = True break if match: eps = [ep for ep in pkg_resources.iter_entry_points(group)] if lst == 'summary': print '\n\033[91m%s\033[0m (%d plugins)' % (group, len(eps)) for ep in eps: parts = [str(s) for s in (ep.module_name, ep.name)] identifier = ':'.join(parts) print ' - %s \033[90m%s (%s)\033[0m' % (ep.name, identifier, ep.dist.egg_name()) else: print '\033[44m%s\033[0m' % group UNDEF = 'Not defined' plugin_groups = {UNDEF: []} for plugin in pm.items(group): interface = getattr(plugin, 'implement', None) if interface: plugin_groups.setdefault(interface, []).append(plugin) else: plugin_groups[UNDEF].append(plugin) for group, plugins in plugin_groups.items(): if not plugins: continue print ' implements: \033[91m%s\033[0m' % group plugin_names = {} for plugin in plugins: plugin_names[plugin.name] = plugin for pl_name in sorted(plugin_names): plugin = plugin_names[pl_name] p_class = plugin.__class__ print ' - \033[93m%s \033[90m%s:%s\033[0m' % (plugin_name(plugin), p_class.__module__, p_class.__name__) if verbose: print ' tags: %s' % ', '.join(plugin.tags) print ' plugin: %s, egg: %s\n path: %s' % ( ep.name, ep.dist.egg_name(), ep.dist.location) print ' criteria:' for crit_name in sorted(dir(plugin)): if crit_name in ('implementation', '__call__'): continue crit = getattr(plugin, crit_name) if can_display_criterion(crit_name, crit): print format_criterion(crit_name, crit, 10) print print
class TestPluginManager(unittest.TestCase): @classmethod def setupClass(cls): cls.tmppath, cls.pythonpath = install_package() import pkg_resources dist = list(pkg_resources.find_distributions(cls.pythonpath))[0] pkg_resources.working_set.add(dist) def setUp(self): self.pm = PluginManager() self.pm.debug = False self.pim = PluginInstanceManager(self.pm) def test_autoload(self): pm = PluginManager() pm.items('test.c1') assert 'test.c1' in pm._item assert 'tstpkg1.plugin:C1Plugin1' in pm._item['test.c1'] pm = PluginManager(autoload=[]) pm.items('test.c1') assert 'test.c1' in pm._item assert 'tstpkg1.plugin:C1Plugin1' not in pm._item['test.c1'] def test_module_plugin_def(self): assert self.pm.items('test.c1') # check if right plugins have been found assert self.pm.item('MyPlugin1', 'test.c1') is not None assert self.pm.item('MyPlugin2', 'test.c1') is not None def test_manual_plugin_def(self): assert self.pm.items('test.c2') # check if right plugins have been found assert self.pm.item('C2Plugin1', 'test.c2') is not None assert self.pm.item('C2Plugin2', 'test.c2') is not None def test_interface_filter(self): plugins = self.pm.items('test.c1') assert len(plugins) == 2 plugins = self.pm.items('test.c1', criteria=dict(implement='IClass1')) assert len(plugins) == 1 assert plugins[0].name == 'MyPlugin1' def test_dynamic_plugin(self): pl = self.pm.add(AlgoPlugin1, 'test.dynamic3') self.pm.add(AlgoPlugin2, 'test.dynamic3') assert len(self.pm.items('test.dynamic3')) == 2 objc3c1 = self.pim.instance('test.dynamic3', 'algo_1') assert objc3c1 assert isinstance(objc3c1, Algo) objc3c2 = self.pim.instance('test.dynamic3', 'algo_2') assert objc3c2 assert isinstance(objc3c1, Algo) def atest_proxy_plugin(self): from openalea.core.plugin.manager import SimpleClassPluginProxy self.pm.add('test.dynamic4', Algo, plugin_proxy=SimpleClassPluginProxy) objc4c1 = self.pim.instance('test.dynamic4', 'Algo') objc4c1_2 = self.pim.instance('test.dynamic4', 'Algo') objc4c1_3 = self.pim.new('test.dynamic4', 'Algo') assert objc4c1 self.assertIsInstance(objc4c1, Algo) assert objc4c1 is objc4c1_2 assert objc4c1 is not objc4c1_3 def test_plugin_name(self): import tstpkg1.plugin import tstpkg1.impl # Check manager use plugin name attribute if defined (instead of class name) c1plugin1 = self.pm.item('MyPlugin1', 'test.c1') self.assertIsInstance(c1plugin1, tstpkg1.plugin.C1Plugin1) # Check there is no conflict if two plugins with same alias (in setup.py) but in different categories # Check plugin name use class name if no attribute "name" c2plugin1 = self.pm.item('C2Plugin1', 'test.c2') self.assertIsInstance(c2plugin1, tstpkg1.plugin.C2Plugin1) def test_new_instance(self): import tstpkg1.impl objc1c1 = self.pim.instance('test.c1', 'MyPlugin1') assert objc1c1 assert isinstance(objc1c1, tstpkg1.impl.C1Class1) objc1c2 = self.pim.instance('test.c1', 'MyPlugin2') assert objc1c2 assert isinstance(objc1c2, tstpkg1.impl.C1Class2) objc2c1 = self.pim.instance('test.c2', 'C2Plugin1') assert objc2c1 assert isinstance(objc2c1, tstpkg1.impl.C2Class1) objc2c2 = self.pim.instance('test.c2', 'C2Plugin2') assert objc2c1 assert isinstance(objc2c2, tstpkg1.impl.C2Class2) # Check instance return existing instance objc1c1_2 = self.pim.instance('test.c1', 'MyPlugin1') assert objc1c1 is objc1c1_2 assert self.pim.instances('test.c1', 'MyPlugin1')[0] is objc1c1_2 def test_multiple_instance(self): # Assert weakref work correctly and plugin instances have been lost assert not self.pim.instances('test.c1', 'MyPlugin1') objc1c1_0 = self.pim.instance('test.c1', 'MyPlugin1') objc1c1_1 = self.pim.new('test.c1', 'MyPlugin1') objc1c1_2 = self.pim.new('test.c1', 'MyPlugin1') # Assert all object have been created correctly assert objc1c1_0 assert objc1c1_1 assert objc1c1_2 # Assert all instances are different as we use new instead of instance assert objc1c1_0 is not objc1c1_1 assert objc1c1_1 is not objc1c1_2 objc1c2 = self.pim.new('test.c1', 'MyPlugin2') assert len(self.pim.instances('test.c1', 'MyPlugin1')) == 3 assert len(self.pim.instances('test.c1')) == 4 del objc1c1_2 assert len(self.pim.instances('test.c1', 'MyPlugin1')) == 2 assert len(self.pim.instances('test.c1')) == 3 del objc1c2 assert len(self.pim.instances('test.c1', 'MyPlugin1')) == 2 assert len(self.pim.instances('test.c1', 'MyPlugin2')) == 0 assert len(self.pim.instances('test.c1')) == 2 def test_debug_ep_load(self): self.pm.debug = True with self.assertRaises(ImportError): self.pm.items('test.err1') self.pm.clear() self.pm.debug = False self.pm.items('test.err1') @classmethod def tearDownClass(cls): cls.tmppath.rmtree()
class TestPluginManager(unittest.TestCase): @classmethod def setupClass(cls): cls.tmppath, cls.pythonpath = install_package() import pkg_resources dist = list(pkg_resources.find_distributions(cls.pythonpath))[0] pkg_resources.working_set.add(dist) def setUp(self): self.pm = PluginManager() self.pm.debug = False self.pim = PluginInstanceManager(self.pm) def test_autoload(self): pm = PluginManager() pm.items("test.c1") assert "test.c1" in pm._item assert "tstpkg1.plugin:C1Plugin1" in pm._item["test.c1"] pm = PluginManager(autoload=[]) pm.items("test.c1") assert "test.c1" in pm._item assert "tstpkg1.plugin:C1Plugin1" not in pm._item["test.c1"] def test_module_plugin_def(self): assert self.pm.items("test.c1") # check if right plugins have been found assert self.pm.item("MyPlugin1", "test.c1") is not None assert self.pm.item("MyPlugin2", "test.c1") is not None def test_manual_plugin_def(self): assert self.pm.items("test.c2") # check if right plugins have been found assert self.pm.item("C2Plugin1", "test.c2") is not None assert self.pm.item("C2Plugin2", "test.c2") is not None def test_interface_filter(self): plugins = self.pm.items("test.c1") assert len(plugins) == 2 plugins = self.pm.items("test.c1", criteria=dict(implement="IClass1")) assert len(plugins) == 1 assert plugins[0].name == "MyPlugin1" def test_dynamic_plugin(self): pl = self.pm.add(AlgoPlugin1, "test.dynamic3") self.pm.add(AlgoPlugin2, "test.dynamic3") assert len(self.pm.items("test.dynamic3")) == 2 objc3c1 = self.pim.instance("test.dynamic3", "algo_1") assert objc3c1 assert isinstance(objc3c1, Algo) objc3c2 = self.pim.instance("test.dynamic3", "algo_2") assert objc3c2 assert isinstance(objc3c1, Algo) def atest_proxy_plugin(self): from openalea.core.plugin.manager import SimpleClassPluginProxy self.pm.add("test.dynamic4", Algo, plugin_proxy=SimpleClassPluginProxy) objc4c1 = self.pim.instance("test.dynamic4", "Algo") objc4c1_2 = self.pim.instance("test.dynamic4", "Algo") objc4c1_3 = self.pim.new("test.dynamic4", "Algo") assert objc4c1 self.assertIsInstance(objc4c1, Algo) assert objc4c1 is objc4c1_2 assert objc4c1 is not objc4c1_3 def test_plugin_name(self): import tstpkg1.plugin import tstpkg1.impl # Check manager use plugin name attribute if defined (instead of class name) c1plugin1 = self.pm.item("MyPlugin1", "test.c1") self.assertIsInstance(c1plugin1, tstpkg1.plugin.C1Plugin1) # Check there is no conflict if two plugins with same alias (in setup.py) but in different categories # Check plugin name use class name if no attribute "name" c2plugin1 = self.pm.item("C2Plugin1", "test.c2") self.assertIsInstance(c2plugin1, tstpkg1.plugin.C2Plugin1) def test_new_instance(self): import tstpkg1.impl objc1c1 = self.pim.instance("test.c1", "MyPlugin1") assert objc1c1 assert isinstance(objc1c1, tstpkg1.impl.C1Class1) objc1c2 = self.pim.instance("test.c1", "MyPlugin2") assert objc1c2 assert isinstance(objc1c2, tstpkg1.impl.C1Class2) objc2c1 = self.pim.instance("test.c2", "C2Plugin1") assert objc2c1 assert isinstance(objc2c1, tstpkg1.impl.C2Class1) objc2c2 = self.pim.instance("test.c2", "C2Plugin2") assert objc2c1 assert isinstance(objc2c2, tstpkg1.impl.C2Class2) # Check instance return existing instance objc1c1_2 = self.pim.instance("test.c1", "MyPlugin1") assert objc1c1 is objc1c1_2 assert self.pim.instances("test.c1", "MyPlugin1")[0] is objc1c1_2 def test_multiple_instance(self): # Assert weakref work correctly and plugin instances have been lost assert not self.pim.instances("test.c1", "MyPlugin1") objc1c1_0 = self.pim.instance("test.c1", "MyPlugin1") objc1c1_1 = self.pim.new("test.c1", "MyPlugin1") objc1c1_2 = self.pim.new("test.c1", "MyPlugin1") # Assert all object have been created correctly assert objc1c1_0 assert objc1c1_1 assert objc1c1_2 # Assert all instances are different as we use new instead of instance assert objc1c1_0 is not objc1c1_1 assert objc1c1_1 is not objc1c1_2 objc1c2 = self.pim.new("test.c1", "MyPlugin2") assert len(self.pim.instances("test.c1", "MyPlugin1")) == 3 assert len(self.pim.instances("test.c1")) == 4 del objc1c1_2 assert len(self.pim.instances("test.c1", "MyPlugin1")) == 2 assert len(self.pim.instances("test.c1")) == 3 del objc1c2 assert len(self.pim.instances("test.c1", "MyPlugin1")) == 2 assert len(self.pim.instances("test.c1", "MyPlugin2")) == 0 assert len(self.pim.instances("test.c1")) == 2 def test_debug_ep_load(self): self.pm.debug = True with self.assertRaises(ImportError): self.pm.items("test.err1") self.pm.clear() self.pm.debug = False self.pm.items("test.err1") @classmethod def tearDownClass(cls): cls.tmppath.rmtree()