def test_find(self):
ext_reg = ExtensionRegistry()
obj1 = A()
obj2 = A()
obj3 = A()
obj4 = B()
obj5 = B()
obj6 = B()
# noinspection PyUnusedLocal
def load_obj3(ext: Extension):
return obj3
# noinspection PyUnusedLocal
def load_obj4(ext: Extension):
return obj4
ext_reg.add_extension(component=obj1, point='A', name='a1', description='knorg')
ext_reg.add_extension(component=obj2, point='A', name='a2', description='gnatz')
ext_reg.add_extension(loader=load_obj3, point='A', name='a3', description='gnatz')
ext_reg.add_extension(loader=load_obj4, point='B', name='b1', description='knorg')
ext_reg.add_extension(component=obj5, point='B', name='b2', description='gnatz')
ext_reg.add_extension(component=obj6, point='B', name='b3', description='knorg')
def is_knorg(ext: Extension):
return ext.metadata.get('description') == 'knorg'
def is_gnatz(ext: Extension):
return ext.metadata.get('description') == 'gnatz'
result = ext_reg.find_extensions('A', predicate=is_knorg)
self.assertEqual(1, len(result))
result = ext_reg.find_components('A', predicate=is_knorg)
self.assertEqual(1, len(result))
result = ext_reg.find_extensions('B', predicate=is_knorg)
self.assertEqual(2, len(result))
result = ext_reg.find_extensions('C', predicate=is_knorg)
self.assertEqual(0, len(result))
result = ext_reg.find_components('C', predicate=is_knorg)
self.assertEqual(0, len(result))
result = ext_reg.find_extensions('A', predicate=is_gnatz)
self.assertEqual(2, len(result))
result = ext_reg.find_components('A', predicate=is_gnatz)
self.assertEqual(2, len(result))
result = ext_reg.find_extensions('B', predicate=is_gnatz)
self.assertEqual(1, len(result))
result = ext_reg.find_components('B', predicate=is_gnatz)
self.assertEqual(1, len(result))
result = ext_reg.find_extensions('C', predicate=is_gnatz)
self.assertEqual(0, len(result))
result = ext_reg.find_components('C', predicate=is_gnatz)
self.assertEqual(0, len(result))
def test_protocol(self):
ext_reg = ExtensionRegistry()
a_obj = A()
def b_loader(ext):
return B(name=ext.name)
a_ext = ext_reg.add_extension(component=a_obj, point='A', name='test')
b_ext = ext_reg.add_extension(loader=b_loader, point='B', name='test')
self.assertEqual(True, ext_reg.has_extension('A', 'test'))
self.assertIsInstance(a_ext, Extension)
self.assertEqual('test', a_ext.name)
self.assertEqual('A', a_ext.point)
self.assertEqual(False, a_ext.is_lazy)
self.assertIs(a_obj, a_ext.component)
self.assertIs(a_obj, a_ext.component)
self.assertIs(a_obj, ext_reg.get_component('A', 'test'))
self.assertIs(a_ext, ext_reg.get_extension('A', 'test'))
self.assertEqual(True, ext_reg.has_extension('B', 'test'))
self.assertIsInstance(b_ext, Extension)
self.assertEqual('test', b_ext.name)
self.assertEqual('B', b_ext.point)
self.assertEqual(True, b_ext.is_lazy)
b_obj = b_ext.component
self.assertIs(b_obj, b_ext.component)
self.assertIs(b_obj, ext_reg.get_component('B', 'test'))
self.assertIs(b_ext, ext_reg.get_extension('B', 'test'))
self.assertEqual({'name': 'test'}, b_obj.kwargs)
self.assertEqual([a_ext], ext_reg.find_extensions('A'))
self.assertEqual([b_ext], ext_reg.find_extensions('B'))
self.assertEqual([], ext_reg.find_extensions('C'))
self.assertEqual([a_obj], ext_reg.find_components('A'))
self.assertEqual([b_obj], ext_reg.find_components('B'))
self.assertEqual([], ext_reg.find_components('C'))
ext_reg.remove_extension('A', 'test')
self.assertEqual(False, ext_reg.has_extension('A', 'test'))
ext_reg.remove_extension('B', 'test')
self.assertEqual(False, ext_reg.has_extension('B', 'test'))
class PluginTest(unittest.TestCase):
def setUp(self):
self.ext_registry = ExtensionRegistry()
def test_get_xcube_default_plugins(self):
plugins = get_plugins()
self.assertIsNotNone(plugins)
self.assertIn('xcube', plugins)
def test_load_plugins_by_entry_points(self):
plugins = load_plugins([EntryPoint('test', init_plugin)], ext_registry=self.ext_registry)
self.assertEqual(dict(test=dict(name='test', doc='A test plugin that registers test extensions')), plugins)
self.assertTrue(self.ext_registry.has_extension('test.util.test_plugin', 'ext1'))
self.assertTrue(self.ext_registry.has_extension('test.util.test_plugin', 'ext2'))
self.assertTrue(self.ext_registry.has_extension('test.util.test_plugin', 'ext3'))
def test_load_plugins_by_module_discovery(self):
entry_points = discover_plugin_modules(module_prefixes=['test'])
plugins = load_plugins(entry_points, ext_registry=self.ext_registry)
self.assertEqual(dict(test=dict(name='test', doc='A test plugin that registers test extensions')), plugins)
self.assertTrue(self.ext_registry.has_extension('test.util.test_plugin', 'ext1'))
self.assertTrue(self.ext_registry.has_extension('test.util.test_plugin', 'ext2'))
self.assertTrue(self.ext_registry.has_extension('test.util.test_plugin', 'ext3'))
def test_load_plugins_by_bad_entry_point(self):
plugins = load_plugins([EntryPointBad('test', init_plugin)], ext_registry=self.ext_registry)
self.assertEqual({}, plugins)
self.assertEqual([], self.ext_registry.find_components('test.util.test_plugin'))
def test_load_plugins_by_bad_init_plugin(self):
plugins = load_plugins([EntryPoint('test', init_plugin_bad)], ext_registry=self.ext_registry)
self.assertEqual({}, plugins)
self.assertEqual([], self.ext_registry.find_components('test.util.test_plugin'))
def test_load_plugins_init_plugin_not_callable(self):
plugins = load_plugins([EntryPoint('test', "init_plugin_not_callable")], ext_registry=self.ext_registry)
self.assertEqual({}, plugins)
self.assertEqual([], self.ext_registry.find_components('test'))
def test_load_plugins_by_failing_module_discovery(self):
entry_points = discover_plugin_modules(module_prefixes=['random'])
plugins = load_plugins(entry_points, ext_registry=self.ext_registry)
self.assertEqual({}, plugins)
self.assertEqual([], self.ext_registry.find_components('test.util.test_plugin'))