Add RallyShell
One of the major task of rallyclient is a command line interface.
This patch implements base for it.
- rallyclient.exc - the main module for exceptions, which include custom
exceptions(not implemented yet) and exceptions from common code;
- rallyclient.shell - base shell, which is independent from version of API
- rallyclient.utils - custom rallyclient's utils
- rallyclient._i18n - setup for oslo.i18n
- rallyclient.v1.* - versioned module for Rally API V1
- rallyclient.v1.shell - base shell for Rally API V1
bp api-rally-python-client
Change-Id: I910b311908013207aac04ae3b2f24405b58f69c9
This commit is contained in:
Andrey Kurilin
parent
c4ef481a88
commit
cc44f2536a
|
|
@ -0,0 +1,32 @@
|
|||
# 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.
|
||||
|
||||
"""
|
||||
oslo.i18n integration module.
|
||||
See http://docs.openstack.org/developer/oslo.i18n/usage.html .
|
||||
"""
|
||||
|
||||
from oslo import i18n
|
||||
_translators = i18n.TranslatorFactory(domain='rallyclient')
|
||||
|
||||
# The primary translation function using the well-known name "_"
|
||||
_ = _translators.primary
|
||||
|
||||
# Translators for log levels.
|
||||
#
|
||||
# The abbreviated names are meant to reflect the usual use of a short
|
||||
# name like '_'. The "L" is for "log" and the other letter comes from
|
||||
# the level.
|
||||
_LI = _translators.log_info
|
||||
_LW = _translators.log_warning
|
||||
_LE = _translators.log_error
|
||||
_LC = _translators.log_critical
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# 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.
|
||||
|
||||
"""
|
||||
Custom exceptions for `rallyclient`.
|
||||
"""
|
||||
|
||||
from rallyclient.openstack.common.apiclient.exceptions import * # noqa
|
||||
|
|
@ -0,0 +1,222 @@
|
|||
# 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.
|
||||
|
||||
"""
|
||||
Command-line interface to the Rally API.
|
||||
"""
|
||||
|
||||
from __future__ import print_function
|
||||
|
||||
import argparse
|
||||
import logging
|
||||
import sys
|
||||
|
||||
import oslo.i18n
|
||||
from oslo.utils import encodeutils
|
||||
import six
|
||||
|
||||
import rallyclient
|
||||
from rallyclient import exc
|
||||
from rallyclient.openstack.common import cliutils
|
||||
# NOTE(akurilin): despite the fact rallyclient uses `oslo.utils`,
|
||||
# `importutils` from `oslo.utils` is not equal to `importutils` from common
|
||||
# code and oslo-team proposes to use `stevedore`, but noone uses `stevedore`
|
||||
# instead of `importutils` yet, so I dislike this variant and think that we
|
||||
# should use `importutils` from `oslo-incubator`, until oslo-team does not
|
||||
# describe the process of replacing `importutils` with `stevedore`.
|
||||
from rallyclient.openstack.common import importutils
|
||||
from rallyclient import utils
|
||||
|
||||
|
||||
oslo.i18n.install('rallyclient')
|
||||
|
||||
|
||||
class RallyShell(object):
|
||||
|
||||
def get_base_parser(self):
|
||||
parser = argparse.ArgumentParser(
|
||||
prog='rallyclient',
|
||||
description=__doc__.strip(),
|
||||
epilog='See "rallyclient help COMMAND" '
|
||||
'for help on a specific command.',
|
||||
add_help=False,
|
||||
formatter_class=utils.HelpFormatter,
|
||||
)
|
||||
|
||||
# Global arguments
|
||||
parser.add_argument(
|
||||
'-h', '--help',
|
||||
action='store_true', help=argparse.SUPPRESS)
|
||||
|
||||
parser.add_argument(
|
||||
'--version',
|
||||
action='version', version=rallyclient.__version__)
|
||||
|
||||
parser.add_argument(
|
||||
'-d', '--debug',
|
||||
default=bool(cliutils.env('RALLYCLIENT_DEBUG')),
|
||||
action='store_true', help='Defaults to env[RALLYCLIENT_DEBUG].')
|
||||
|
||||
parser.add_argument(
|
||||
'-v', '--verbose',
|
||||
default=False, action="store_true",
|
||||
help="Print more verbose output.")
|
||||
|
||||
parser.add_argument(
|
||||
'--timeout',
|
||||
default=600, help='Number of seconds to wait for a response.')
|
||||
|
||||
parser.add_argument(
|
||||
'--rally-url',
|
||||
default=cliutils.env('RALLY_URL'),
|
||||
help='Defaults to env[RALLY_URL].')
|
||||
|
||||
parser.add_argument(
|
||||
'--rally_url', help=argparse.SUPPRESS)
|
||||
|
||||
parser.add_argument(
|
||||
'--rally-api-version',
|
||||
default=cliutils.env('RALLY_API_VERSION', default='1'),
|
||||
help='Defaults to env[RALLY_API_VERSION] or 1.')
|
||||
|
||||
parser.add_argument(
|
||||
'--rally_api_version', help=argparse.SUPPRESS)
|
||||
|
||||
parser.add_argument(
|
||||
'--rally_stand_alone_mode',
|
||||
default=bool(cliutils.env('RALLYCLIENT_STANDALONE_MODE')),
|
||||
action='store_true',
|
||||
help='Defaults to env[RALLYCLIENT_STANDALONE_MODE].')
|
||||
|
||||
return parser
|
||||
|
||||
def get_subcommand_parser(self, version):
|
||||
parser = self.get_base_parser()
|
||||
|
||||
self.subcommands = {}
|
||||
subparsers = parser.add_subparsers(metavar='<subcommand>')
|
||||
|
||||
submodule = importutils.import_versioned_module(version, 'shell')
|
||||
submodule.enhance_parser(parser, subparsers, self.subcommands)
|
||||
|
||||
utils.define_commands_from_module(subparsers, self, self.subcommands)
|
||||
self._add_bash_completion_subparser(subparsers)
|
||||
|
||||
return parser
|
||||
|
||||
def _add_bash_completion_subparser(self, subparsers):
|
||||
subparser = subparsers.add_parser(
|
||||
'bash_completion',
|
||||
add_help=False,
|
||||
formatter_class=utils.HelpFormatter
|
||||
)
|
||||
self.subcommands['bash_completion'] = subparser
|
||||
subparser.set_defaults(func=self.do_bash_completion)
|
||||
|
||||
def _setup_logging(self, debug):
|
||||
format = '%(levelname)s (%(module)s) %(message)s'
|
||||
if debug:
|
||||
logging.basicConfig(format=format, level=logging.DEBUG)
|
||||
else:
|
||||
logging.basicConfig(format=format, level=logging.WARN)
|
||||
logging.getLogger('iso8601').setLevel(logging.WARNING)
|
||||
logging.getLogger('urllib3.connectionpool').setLevel(logging.WARNING)
|
||||
|
||||
def parse_args(self, argv):
|
||||
# Parse args once to find version
|
||||
parser = self.get_base_parser()
|
||||
(options, args) = parser.parse_known_args(argv)
|
||||
self._setup_logging(options.debug)
|
||||
|
||||
# build available subcommands based on version
|
||||
api_version = options.rally_api_version
|
||||
subcommand_parser = self.get_subcommand_parser(api_version)
|
||||
self.parser = subcommand_parser
|
||||
|
||||
# Handle top-level --help/-h before attempting to parse
|
||||
# a command off the command line
|
||||
if options.help or not argv:
|
||||
self.do_help(options)
|
||||
return 0
|
||||
|
||||
# Return parsed args
|
||||
return api_version, subcommand_parser.parse_args(argv)
|
||||
|
||||
def main(self, argv):
|
||||
parsed = self.parse_args(argv)
|
||||
if parsed == 0:
|
||||
return 0
|
||||
api_version, args = parsed
|
||||
|
||||
# Short-circuit and deal with help command right away.
|
||||
if args.func == self.do_help:
|
||||
self.do_help(args)
|
||||
return 0
|
||||
elif args.func == self.do_bash_completion:
|
||||
self.do_bash_completion(args)
|
||||
return 0
|
||||
if not args.rally_stand_alone_mode:
|
||||
# TODO(akurilin): implement authentication via keystone
|
||||
raise NotImplementedError(
|
||||
_("Sorry, only stand-alone mode is available now."))
|
||||
|
||||
# TODO(akurilin): uncomment when clientV1 will be ready
|
||||
# client = rally.get_client(api_version, **vars(args))
|
||||
# call whatever callback was selected
|
||||
# args.func(client, args)
|
||||
|
||||
def do_bash_completion(self, args):
|
||||
"""Prints all of the commands and options to stdout.
|
||||
|
||||
The rallyclient.bash_completion script doesn't have to hard code them.
|
||||
"""
|
||||
commands = set()
|
||||
options = set()
|
||||
for sc_str, sc in self.subcommands.items():
|
||||
commands.add(sc_str)
|
||||
for option in list(sc._optionals._option_string_actions):
|
||||
options.add(option)
|
||||
|
||||
commands.remove('bash-completion')
|
||||
commands.remove('bash_completion')
|
||||
print(' '.join(commands | options))
|
||||
|
||||
@cliutils.arg('command', metavar='<subcommand>', nargs='?',
|
||||
help='Display help for <subcommand>')
|
||||
def do_help(self, args):
|
||||
"""Display help about this program or one of its subcommands."""
|
||||
if getattr(args, 'command', None):
|
||||
if args.command in self.subcommands:
|
||||
self.subcommands[args.command].print_help()
|
||||
else:
|
||||
raise exc.CommandError("'%s' is not a valid subcommand" %
|
||||
args.command)
|
||||
else:
|
||||
self.parser.print_help()
|
||||
|
||||
|
||||
def main(args=None):
|
||||
try:
|
||||
if args is None:
|
||||
args = sys.argv[1:]
|
||||
|
||||
RallyShell().main(args)
|
||||
|
||||
except Exception as e:
|
||||
if '--debug' in args or '-d' in args:
|
||||
raise
|
||||
else:
|
||||
print(encodeutils.safe_encode(six.text_type(e)), file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
# 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 argparse
|
||||
|
||||
|
||||
class HelpFormatter(argparse.HelpFormatter):
|
||||
INDENT_BEFORE_ARGUMENTS = 6
|
||||
MAX_WIDTH_ARGUMENTS = 32
|
||||
|
||||
def add_arguments(self, actions):
|
||||
for action in filter(lambda x: not x.option_strings, actions):
|
||||
for choice in action.choices:
|
||||
length = len(choice) + self.INDENT_BEFORE_ARGUMENTS
|
||||
if (self.MAX_WIDTH_ARGUMENTS >= length and
|
||||
length > self._max_help_position):
|
||||
self._max_help_position = length
|
||||
super(HelpFormatter, self).add_arguments(actions)
|
||||
|
||||
def start_section(self, heading):
|
||||
# Title-case the headings
|
||||
heading = '%s%s' % (heading[0].upper(), heading[1:])
|
||||
super(HelpFormatter, self).start_section(heading)
|
||||
|
||||
|
||||
def define_command(subparsers, command, callback, cmd_mapper):
|
||||
'''Define a command in the subparsers collection.
|
||||
|
||||
:param subparsers: subparsers collection where the command will go
|
||||
:param command: command name
|
||||
:param callback: function that will be used to process the command
|
||||
'''
|
||||
desc = callback.__doc__ or ''
|
||||
help = desc.strip().split('\n')[0]
|
||||
arguments = getattr(callback, 'arguments', [])
|
||||
|
||||
subparser = subparsers.add_parser(command, help=help,
|
||||
description=desc,
|
||||
add_help=False,
|
||||
formatter_class=HelpFormatter)
|
||||
subparser.add_argument('-h', '--help', action='help',
|
||||
help=argparse.SUPPRESS)
|
||||
cmd_mapper[command] = subparser
|
||||
for (args, kwargs) in arguments:
|
||||
subparser.add_argument(*args, **kwargs)
|
||||
subparser.set_defaults(func=callback)
|
||||
|
||||
|
||||
def define_commands_from_module(subparsers, command_module, cmd_mapper):
|
||||
'''Find all methods beginning with 'do_' in a module, and add them
|
||||
as commands into a subparsers collection.
|
||||
'''
|
||||
for method_name in (a for a in dir(command_module) if a.startswith('do_')):
|
||||
# Commands should be hypen-separated instead of underscores.
|
||||
command = method_name[3:].replace('_', '-')
|
||||
callback = getattr(command_module, method_name)
|
||||
define_command(subparsers, command, callback, cmd_mapper)
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# 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 rallyclient import utils
|
||||
|
||||
|
||||
COMMAND_MODULES = []
|
||||
|
||||
|
||||
def enhance_parser(parser, subparsers, cmd_mapper):
|
||||
'''Take a basic (nonversioned) parser and enhance it with
|
||||
commands and options specific for this version of API.
|
||||
|
||||
:param parser: top level parser :param subparsers: top level
|
||||
parser's subparsers collection where subcommands will go
|
||||
'''
|
||||
for command_module in COMMAND_MODULES:
|
||||
utils.define_commands_from_module(subparsers, command_module,
|
||||
cmd_mapper)
|
||||
|
|
@ -21,6 +21,10 @@ classifier =
|
|||
[files]
|
||||
packages = rallyclient
|
||||
|
||||
[entry_points]
|
||||
console_scripts =
|
||||
rallyclient = rallyclient.shell:main
|
||||
|
||||
[pbr]
|
||||
autodoc_index_modules = True
|
||||
|
||||
|
|
|
|||
5
tox.ini
5
tox.ini
|
|
@ -27,7 +27,10 @@ commands = python setup.py testr --coverage --testr-args='{posargs}'
|
|||
commands = {posargs}
|
||||
|
||||
[flake8]
|
||||
ignore = E12
|
||||
# H405 multi line docstring summary not separated with an empty line
|
||||
# H904 Wrap long lines in parentheses instead of a backslash
|
||||
# E127 Continuation line over-indented for visual indent
|
||||
ignore = H405,H904,E12
|
||||
builtins = _
|
||||
exclude = .venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,tools
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue