Merge "Fixed bugs in registry and add test case"

This commit is contained in:
Jenkins 2015-05-29 09:53:28 +00:00 committed by Gerrit Code Review
commit 61f02bd9b9
2 changed files with 208 additions and 18 deletions

View File

@ -50,7 +50,7 @@ class PluginInfo(object):
def __lt__(self, other):
if self.user_provided != other.user_provided:
# user provided ones must be sorted above system ones.
return self.user_provided > other.user_provided_
return self.user_provided > other.user_provided
if len(self.name) != len(other.name):
# more specific (longer) name must be sorted above system ones.
return len(self.name) > len(other.name)
@ -76,8 +76,7 @@ class Registry(object):
def _register_info(self, name, info):
'''place the new info in the correct location in the registry.
:param path: a list of keys ['profiles', 'my_stack', 'os.heat.stack'],
or ['policies', 'my_policy', 'ScalingPolicy']
:param path: a string of plugin name.
:param info: reference to a PluginInfo data structure, deregister a
PluginInfo if specified as None.
'''
@ -108,19 +107,12 @@ class Registry(object):
pi = PluginInfo(self, name, plugin)
self._register_info(name, pi)
def _load_registry(self, path, registry):
for k, v in iter(registry.items()):
path = path + [k]
if v is None:
self._register_info(path, None)
elif isinstance(v, dict):
self._load_registry(path, v)
else:
info = PluginInfo(self, path, v)
self._register_info(path, info)
def load(self, json_snippet):
self._load_registry([], json_snippet)
for k, v in iter(json_snippet.items()):
if v is None:
self._register_info(k, None)
else:
self.register_plugin(k, v)
def iterable_by(self, name):
plugin = self._registry.get(name)
@ -143,12 +135,12 @@ class Registry(object):
for k, v in iter(level.items()):
if isinstance(v, dict):
tmp[k] = _as_dict(v)
elif v.user_provided:
tmp[k] = v.value
else:
tmp[k] = v.plugin
return tmp
return _as_dict(self._registry)
def get_types(self):
'''Return a list of valid profile types.'''
'''Return a list of valid plugin types.'''
return [{'name': name} for name in six.iterkeys(self._registry)]

View File

@ -0,0 +1,198 @@
# 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
#
# http://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.
import mock
from senlin.engine import registry
from senlin.tests.common import base
class PluginInfoTest(base.SenlinTestCase):
def setUp(self):
super(PluginInfoTest, self).setUp()
self.reg = registry.Registry('SENLIN', None)
def test_create(self):
plugin = mock.Mock()
pi = registry.PluginInfo(self.reg, 'FOO', plugin)
self.assertIsInstance(pi, registry.PluginInfo)
self.assertEqual(self.reg, pi.registry)
self.assertEqual('FOO', pi.name)
self.assertEqual(plugin, pi.plugin)
self.assertTrue(pi.user_provided)
def test_eq_ne(self):
plugin1 = mock.Mock()
plugin2 = mock.Mock()
pi1 = registry.PluginInfo(self.reg, 'FOO', plugin1)
pi2 = registry.PluginInfo(self.reg, 'FOO', plugin1)
pi3 = registry.PluginInfo(self.reg, 'BAR', plugin1)
pi4 = registry.PluginInfo(self.reg, 'FOO', plugin2)
self.assertIsNotNone(pi1)
self.assertTrue(pi1 == pi2)
self.assertFalse(pi1 == pi3)
self.assertFalse(pi1 == pi4)
self.assertFalse(pi2 == pi4)
self.assertFalse(pi3 == pi4)
self.assertFalse(pi1 != pi2)
self.assertTrue(pi1 != pi3)
self.assertTrue(pi1 != pi4)
self.assertTrue(pi2 != pi4)
self.assertTrue(pi3 != pi4)
def test_ordering(self):
plugin1 = mock.Mock()
plugin2 = mock.Mock()
pi1 = registry.PluginInfo(self.reg, 'FOO', plugin1)
pi2 = registry.PluginInfo(self.reg, 'FOO', plugin1)
pi2.user_provided = False
self.assertTrue(pi1 < pi2)
pi3 = registry.PluginInfo(self.reg, 'FOO_LONG', plugin1)
self.assertTrue(pi3 < pi1)
pi4 = registry.PluginInfo(self.reg, 'BAR', plugin2)
self.assertTrue(pi4 < pi1)
def test_str(self):
plugin = mock.Mock()
pi = registry.PluginInfo(self.reg, 'FOO', plugin)
expected = '[Plugin](User:True) FOO -> %s' % str(plugin)
self.assertEqual(expected, str(pi))
class RegistryTest(base.SenlinTestCase):
def setUp(self):
super(RegistryTest, self).setUp()
def test_create(self):
reg = registry.Registry('SENLIN', None)
self.assertEqual('SENLIN', reg.registry_name)
self.assertEqual({}, reg._registry)
self.assertTrue(reg.is_global)
self.assertIsNone(reg.global_registry)
reg_sub = registry.Registry('SUB', reg)
self.assertEqual('SUB', reg_sub.registry_name)
self.assertEqual({}, reg_sub._registry)
self.assertFalse(reg_sub.is_global)
self.assertEqual(reg, reg_sub.global_registry)
def test_register_info(self):
reg = registry.Registry('SENLIN', None)
plugin = mock.Mock()
pi = registry.PluginInfo(reg, 'FOO', plugin)
reg._register_info('FOO', pi)
result = reg._registry.get('FOO')
self.assertEqual(pi, result)
# register the same name and same PluginInfo, no new entry added
reg._register_info('FOO', pi)
self.assertEqual(1, len(reg._registry))
# register the same name with different PluginInfo -> replacement
new_pi = registry.PluginInfo(reg, 'FOO', plugin)
reg._register_info('FOO', new_pi)
self.assertEqual(1, len(reg._registry))
# additional check: this is a global registry
self.assertFalse(new_pi.user_provided)
def test_register_plugin(self):
reg = registry.Registry('SENLIN', None)
plugin = mock.Mock()
reg.register_plugin('FOO', plugin)
pi = reg._registry.get('FOO')
self.assertIsInstance(pi, registry.PluginInfo)
self.assertEqual(plugin, pi.plugin)
self.assertEqual('FOO', pi.name)
def test_load(self):
snippet = {
'K2': 'Class2',
'K4': 'Class4',
'K5': 'Class5',
}
reg = registry.Registry('SENLIN', None)
reg.load(snippet)
pi2 = reg._registry.get('K2')
self.assertIsInstance(pi2, registry.PluginInfo)
self.assertEqual('K2', pi2.name)
self.assertEqual('Class2', pi2.plugin)
pi4 = reg._registry.get('K4')
self.assertIsInstance(pi4, registry.PluginInfo)
self.assertEqual('K4', pi4.name)
self.assertEqual('Class4', pi4.plugin)
pi5 = reg._registry.get('K5')
self.assertIsInstance(pi5, registry.PluginInfo)
self.assertEqual('K5', pi5.name)
self.assertEqual('Class5', pi5.plugin)
def test_iterable_by(self):
reg = registry.Registry('GLOBAL', None)
plugin = mock.Mock()
reg.register_plugin('FOO', plugin)
res = [r for r in reg.iterable_by('FOO')]
self.assertEqual(1, len(res))
self.assertEqual('FOO', res[0].name)
def test_get_plugin(self):
# Global registry
reg = registry.Registry('GLOBAL', None)
self.assertTrue(reg.is_global)
# Register plugin in global
plugin = mock.Mock()
reg.register_plugin('FOO', plugin)
self.assertEqual(plugin, reg.get_plugin('FOO'))
# Sub registry
sub = registry.Registry('SUB', reg)
self.assertFalse(sub.is_global)
# Retrieve plugin from global registry
self.assertEqual(plugin, sub.get_plugin('FOO'))
# Plugin in local registry overrides that in the global registry
plugin_new = mock.Mock()
sub.register_plugin('FOO', plugin_new)
self.assertEqual(plugin_new, sub.get_plugin('FOO'))
def test_as_dict(self):
reg = registry.Registry('GLOBAL', None)
plugin1 = mock.Mock()
reg.register_plugin('FOO', plugin1)
plugin2 = mock.Mock()
reg.register_plugin('BAR', plugin2)
res = reg.as_dict()
self.assertIsInstance(res, dict)
self.assertEqual(plugin1, res.get('FOO'))
self.assertEqual(plugin2, res.get('BAR'))
def test_get_types(self):
reg = registry.Registry('GLOBAL', None)
plugin1 = mock.Mock()
reg.register_plugin('FOO', plugin1)
plugin2 = mock.Mock()
reg.register_plugin('BAR', plugin2)
self.assertIn({'name': 'FOO'}, reg.get_types())
self.assertIn({'name': 'BAR'}, reg.get_types())