f0eb35495d
There are a lot of commands which have 2 places with descriptions of the parameters: * The first place is docstring of method itself. It is unified pythonic way * The second one is "help" argument of rally.cli.cliutils.args decorator which is designed to initialize argument of a method as CLI argument. It is over-complicated and misleading maintaining the 2 places, so we need to leave only one source of truth. Since the description from "help" argument is what user see, let's leave it and restrict describing CLI methods parameters via regular docstrings. Change-Id: Idbdf0f68c28ae1bd725506be81c0f8b2cf0a48bc
45 lines
1.8 KiB
Python
45 lines
1.8 KiB
Python
# 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.
|
|
|
|
import inspect
|
|
|
|
from rally.cli import main
|
|
from rally.common.plugin import info
|
|
from tests.unit import test
|
|
|
|
|
|
class DocstringsTestCase(test.TestCase):
|
|
|
|
@staticmethod
|
|
def _get_all_category_methods(category):
|
|
all_methods = inspect.getmembers(
|
|
category,
|
|
predicate=lambda x: inspect.ismethod(x) or inspect.isfunction(x))
|
|
return [m for m in all_methods if not m[0].startswith("_")]
|
|
|
|
def test_params(self):
|
|
for category in main.categories.values():
|
|
all_methods = self._get_all_category_methods(category)
|
|
for name, method in all_methods:
|
|
m_info = info.parse_docstring(method.__doc__)
|
|
if m_info["params"]:
|
|
print(m_info)
|
|
self.fail("The description of parameters for CLI methods "
|
|
"should be transmitted as a 'help' argument of "
|
|
"`rally.cli.cliutils.arg` decorator. You should "
|
|
"remove descriptions from docstring of "
|
|
"`%s.%s.%s`" % (category.__module__,
|
|
category.__class__,
|
|
name))
|