31e43bc112
*) Introduce meta class that allows to bind meta data to class Like we have for context order and hidden, for scenarios validation types and so on. In near future all plugin will use meta stuff for storing infomration required for: validation, types, rally-info stuff *) Make base Plugin class subclass of MetaMixin *) Rename plugin -> configure decorator *) Make configure() and deprecated() work for all objects (not only subclasses of Plugin) *) Add from_func decorator that makes functional look like plugin *) Add support of plugins namespace Change-Id: I160a0021bc0e2da9aa43e26286c4e0491340fa51
151 lines
4.3 KiB
Python
151 lines
4.3 KiB
Python
# Copyright 2015: Mirantis Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
from rally.common.plugin import plugin
|
|
from rally import exceptions
|
|
from tests.unit import test
|
|
|
|
|
|
class PluginModuleTestCase(test.TestCase):
|
|
|
|
def test_deprecated_func(self):
|
|
|
|
@plugin.deprecated("some", "0.0.1")
|
|
@plugin.configure(name="deprecated_func_plugin_test")
|
|
@plugin.from_func()
|
|
def func():
|
|
return 42
|
|
|
|
self.assertEqual("deprecated_func_plugin_test", func.get_name())
|
|
self.assertEqual({"reason": "some", "rally_version": "0.0.1"},
|
|
func.is_deprecated())
|
|
self.assertEqual(42, func())
|
|
|
|
def test_configure(self):
|
|
|
|
@plugin.configure(name="configure_func_plugin_test")
|
|
@plugin.from_func()
|
|
def func(a):
|
|
return a
|
|
|
|
self.assertEqual("configure_func_plugin_test", func.get_name())
|
|
self.assertEqual(42, func(42))
|
|
|
|
def test_deprecated_cls(self):
|
|
|
|
@plugin.deprecated("God why?", "0.0.2")
|
|
@plugin.configure(name="deprecated_class_plugin_check")
|
|
class MyPlugin(plugin.Plugin):
|
|
pass
|
|
|
|
self.assertEqual({"reason": "God why?", "rally_version": "0.0.2"},
|
|
MyPlugin.is_deprecated())
|
|
|
|
def test_configure_cls(self):
|
|
|
|
@plugin.configure(name="get_name_class_plugin")
|
|
class MyPlugin(plugin.Plugin):
|
|
pass
|
|
|
|
self.assertEqual("get_name_class_plugin", MyPlugin.get_name())
|
|
|
|
def test_from_func(self):
|
|
|
|
@plugin.from_func()
|
|
def func():
|
|
return 42
|
|
|
|
missing = [field for field in set(dir(plugin.Plugin)) - set(dir(func))
|
|
if not field.startswith("__")]
|
|
self.assertEqual([], missing)
|
|
self.assertTrue(issubclass(func._plugin, plugin.Plugin))
|
|
self.assertEqual(42, func())
|
|
|
|
def test_from_func_with_basecls(self):
|
|
|
|
class FakeFuncBasePlugin(plugin.Plugin):
|
|
pass
|
|
|
|
@plugin.from_func(FakeFuncBasePlugin)
|
|
def func():
|
|
return 43
|
|
|
|
self.assertTrue(issubclass(func._plugin, FakeFuncBasePlugin))
|
|
self.assertEqual(43, func())
|
|
|
|
def test_from_func_with_bad_basecls(self):
|
|
|
|
class FakeFuncBasePlugin(object):
|
|
pass
|
|
|
|
self.assertRaises(TypeError,
|
|
plugin.from_func, FakeFuncBasePlugin)
|
|
|
|
|
|
@plugin.configure(name="test_base_plugin")
|
|
class BasePlugin(plugin.Plugin):
|
|
pass
|
|
|
|
|
|
@plugin.configure(name="test_some_plugin")
|
|
class SomePlugin(BasePlugin):
|
|
pass
|
|
|
|
|
|
@plugin.deprecated("some_reason", "0.1.1")
|
|
@plugin.configure(name="test_deprecated_plugin")
|
|
class DeprecatedPlugin(BasePlugin):
|
|
pass
|
|
|
|
|
|
class NotInitedPlugin(BasePlugin):
|
|
pass
|
|
|
|
|
|
class PluginTestCase(test.TestCase):
|
|
|
|
def test_get(self):
|
|
self.assertEqual(SomePlugin,
|
|
BasePlugin.get("test_some_plugin"))
|
|
|
|
def test_get_not_found(self):
|
|
self.assertRaises(exceptions.PluginNotFound,
|
|
BasePlugin.get, "non_existing")
|
|
|
|
def test_get_multple_found(self):
|
|
|
|
@plugin.configure("test_2_plugins_with_same_name")
|
|
class A(plugin.Plugin):
|
|
pass
|
|
|
|
class B(plugin.Plugin):
|
|
pass
|
|
|
|
self.assertRaises(exceptions.PluginWithSuchNameExists,
|
|
plugin.configure("test_2_plugins_with_same_name"), B)
|
|
|
|
def test_get_name(self):
|
|
self.assertEqual("test_some_plugin", SomePlugin.get_name())
|
|
|
|
def test_get_all(self):
|
|
self.assertEqual(set([SomePlugin, DeprecatedPlugin]),
|
|
set(BasePlugin.get_all()))
|
|
self.assertEqual([], SomePlugin.get_all())
|
|
|
|
def test_is_deprecated(self):
|
|
self.assertFalse(SomePlugin.is_deprecated())
|
|
self.assertEqual(DeprecatedPlugin.is_deprecated(),
|
|
{"reason": "some_reason", "rally_version": "0.1.1"})
|