eb66136085
Since current scenario implementation transforms method to class at runtime, it is reasonable to have class-based scenario implementation which will be much simpler to use behind the scenes. This class should be based on Scenario and do not break compatibility. The only required method is run() which is actually a body of scenario. This patch contains changes in following groups (scenarios and tests): /senlin/ /swift/ /tempest/ /vm/ /watcher/ /zaqar/ and modules: rally/plugins/openstack/context/vm/custom_image.py tests/unit/test_docstrings.py Change-Id: Ia7f33d7c279991232286b34abe199d125b92f023
94 lines
4.4 KiB
Python
94 lines
4.4 KiB
Python
# Copyright 2014: 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 discover
|
|
from rally.common.plugin import info
|
|
from rally.deployment import engine
|
|
from rally.deployment.serverprovider import provider
|
|
from rally.task import scenario
|
|
from rally.task import sla
|
|
from tests.unit import test
|
|
|
|
|
|
class DocstringsTestCase(test.TestCase):
|
|
|
|
def _assert_class_has_docstrings(self, obj, long_description=True):
|
|
if not obj.__module__.startswith("rally."):
|
|
return
|
|
|
|
self.assertIsNotNone(obj.__doc__,
|
|
"%s doesn't have a class-level docstring." %
|
|
obj)
|
|
doc = info.parse_docstring(obj.__doc__)
|
|
self.assertIsNotNone(
|
|
doc["short_description"],
|
|
"Docstring for %s should have a one-line description." % obj)
|
|
if long_description:
|
|
self.assertIsNotNone(
|
|
doc["long_description"],
|
|
"Docstring for %s should have a multi-line description." % obj)
|
|
|
|
def test_all_scenarios_have_docstrings(self):
|
|
ignored_params = ["self", "scenario_obj"]
|
|
for scenario_inst in scenario.Scenario.get_all():
|
|
try:
|
|
self.assertIsNotNone(scenario_inst.__doc__,
|
|
"%s doensn't have a docstring." %
|
|
scenario_inst.get_name())
|
|
except Exception:
|
|
msg = ("'{}.run' doesn't have a docstring. "
|
|
"At least class '{}' or method '{}.run' "
|
|
"should contain a docstring")
|
|
inst_name = scenario_inst.__name__
|
|
if scenario_inst.is_classbased:
|
|
self.assertIsNotNone(scenario_inst.run.__doc__,
|
|
msg.format(inst_name,
|
|
inst_name,
|
|
inst_name))
|
|
doc = info.parse_docstring(scenario_inst.__doc__)
|
|
short_description = doc["short_description"]
|
|
self.assertIsNotNone(short_description,
|
|
"Docstring for %s should have "
|
|
"at least a one-line description." %
|
|
scenario_inst.get_name())
|
|
self.assertFalse(short_description.startswith("Test"),
|
|
"One-line description for %s "
|
|
"should be declarative and not start "
|
|
"with 'Test(s) ...'" % scenario_inst.get_name())
|
|
if not scenario_inst.is_classbased:
|
|
params_count = scenario_inst.__code__.co_argcount
|
|
params = scenario_inst.__code__.co_varnames[:params_count]
|
|
documented_params = [p["name"] for p in doc["params"]]
|
|
for param in params:
|
|
if param not in ignored_params:
|
|
self.assertIn(param, documented_params,
|
|
"Docstring for %(scenario)s should "
|
|
"describe the '%(param)s' parameter "
|
|
"in the :param <name>: clause." %
|
|
{"scenario": scenario_inst.get_name(),
|
|
"param": param})
|
|
|
|
def test_all_deploy_engines_have_docstrings(self):
|
|
for deploy_engine in engine.Engine.get_all():
|
|
self._assert_class_has_docstrings(deploy_engine)
|
|
|
|
def test_all_server_providers_have_docstrings(self):
|
|
for _provider in provider.ProviderFactory.get_all():
|
|
self._assert_class_has_docstrings(_provider)
|
|
|
|
def test_all_SLA_have_docstrings(self):
|
|
for s in discover.itersubclasses(sla.SLA):
|
|
self._assert_class_has_docstrings(s, long_description=False)
|