diff options
Diffstat (limited to 'openstackclient')
| -rw-r--r-- | openstackclient/common/commandmanager.py | 42 | ||||
| -rw-r--r-- | openstackclient/identity/v2_0/user.py | 4 | ||||
| -rw-r--r-- | openstackclient/identity/v3/user.py | 247 | ||||
| -rw-r--r-- | openstackclient/shell.py | 72 |
4 files changed, 354 insertions, 11 deletions
diff --git a/openstackclient/common/commandmanager.py b/openstackclient/common/commandmanager.py new file mode 100644 index 00000000..e366034a --- /dev/null +++ b/openstackclient/common/commandmanager.py @@ -0,0 +1,42 @@ +# Copyright 2012-2013 OpenStack, LLC. +# +# 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. +# + +"""Modify Cliff's CommandManager""" + +import logging +import pkg_resources + +import cliff.commandmanager + + +LOG = logging.getLogger(__name__) + + +class CommandManager(cliff.commandmanager.CommandManager): + """Alters Cliff's default CommandManager behaviour to load additiona + command groups after initialization. + """ + def _load_commands(self, group=None): + if not group: + group = self.namespace + for ep in pkg_resources.iter_entry_points(group): + LOG.debug('found command %r' % ep.name) + self.commands[ep.name.replace('_', ' ')] = ep + return + + def add_command_group(self, group=None): + """Adds another group of command entrypoints""" + if group: + self._load_commands(group) diff --git a/openstackclient/identity/v2_0/user.py b/openstackclient/identity/v2_0/user.py index 2017e5e3..840cc500 100644 --- a/openstackclient/identity/v2_0/user.py +++ b/openstackclient/identity/v2_0/user.py @@ -13,7 +13,7 @@ # under the License. # -"""User action implementations""" +"""Identity v2.0 User action implementations""" import logging @@ -126,7 +126,7 @@ class ListUser(lister.Lister): def take_action(self, parsed_args): self.log.debug('take_action(%s)' % parsed_args) if parsed_args.long: - columns = ('ID', 'Name', 'TenantId', 'Email', 'Enabled') + columns = ('ID', 'Name', 'Tenant Id', 'Email', 'Enabled') else: columns = ('ID', 'Name') data = self.app.client_manager.identity.users.list() diff --git a/openstackclient/identity/v3/user.py b/openstackclient/identity/v3/user.py new file mode 100644 index 00000000..bf592d81 --- /dev/null +++ b/openstackclient/identity/v3/user.py @@ -0,0 +1,247 @@ +# Copyright 2012-2013 OpenStack, LLC. +# +# 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. +# + +"""Identity v3 User action implementations""" + +import logging + +from cliff import command +from cliff import lister +from cliff import show + +from openstackclient.common import utils + + +class CreateUser(show.ShowOne): + """Create user command""" + + api = 'identity' + log = logging.getLogger(__name__ + '.CreateUser') + + def get_parser(self, prog_name): + parser = super(CreateUser, self).get_parser(prog_name) + parser.add_argument( + 'name', + metavar='<user-name>', + help='New user name', + ) + parser.add_argument( + '--password', + metavar='<user-password>', + help='New user password', + ) + parser.add_argument( + '--email', + metavar='<user-email>', + help='New user email address', + ) + parser.add_argument( + '--project', + metavar='<project>', + help='New default project name or ID', + ) + enable_group = parser.add_mutually_exclusive_group() + enable_group.add_argument( + '--enable', + dest='enabled', + action='store_true', + default=True, + help='Enable user', + ) + enable_group.add_argument( + '--disable', + dest='enabled', + action='store_false', + help='Disable user', + ) + return parser + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)' % parsed_args) + identity_client = self.app.client_manager.identity + if parsed_args.project: + project_id = utils.find_resource( + identity_client.projects, parsed_args.project).id + else: + project_id = None + user = identity_client.users.create( + parsed_args.name, + parsed_args.password, + parsed_args.email, + project_id=project_id, + enabled=parsed_args.enabled, + ) + + info = {} + info.update(user._info) + return zip(*sorted(info.iteritems())) + + +class DeleteUser(command.Command): + """Delete user command""" + + api = 'identity' + log = logging.getLogger(__name__ + '.DeleteUser') + + def get_parser(self, prog_name): + parser = super(DeleteUser, self).get_parser(prog_name) + parser.add_argument( + 'user', + metavar='<user>', + help='Name or ID of user to delete', + ) + return parser + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)' % parsed_args) + identity_client = self.app.client_manager.identity + user = utils.find_resource( + identity_client.users, parsed_args.user) + identity_client.users.delete(user.id) + return + + +class ListUser(lister.Lister): + """List user command""" + + api = 'identity' + log = logging.getLogger(__name__ + '.ListUser') + + def get_parser(self, prog_name): + parser = super(ListUser, self).get_parser(prog_name) + parser.add_argument( + '--project', + metavar='<project>', + help='Name or ID of project to filter users', + ) + parser.add_argument( + '--long', + action='store_true', + default=False, + help='Additional fields are listed in output', + ) + return parser + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)' % parsed_args) + if parsed_args.long: + columns = ('ID', 'Name', 'Project Id', 'Email', 'Enabled') + else: + columns = ('ID', 'Name') + data = self.app.client_manager.identity.users.list() + return (columns, + (utils.get_item_properties( + s, columns, + formatters={}, + ) for s in data)) + + +class SetUser(command.Command): + """Set user command""" + + api = 'identity' + log = logging.getLogger(__name__ + '.SetUser') + + def get_parser(self, prog_name): + parser = super(SetUser, self).get_parser(prog_name) + parser.add_argument( + 'user', + metavar='<user>', + help='Name or ID of user to change', + ) + parser.add_argument( + '--name', + metavar='<new-user-name>', + help='New user name', + ) + parser.add_argument( + '--password', + metavar='<user-password>', + help='New user password', + ) + parser.add_argument( + '--email', + metavar='<user-email>', + help='New user email address', + ) + parser.add_argument( + '--project', + metavar='<project>', + help='New default project name or ID', + ) + enable_group = parser.add_mutually_exclusive_group() + enable_group.add_argument( + '--enable', + dest='enabled', + action='store_true', + default=True, + help='Enable user (default)', + ) + enable_group.add_argument( + '--disable', + dest='enabled', + action='store_false', + help='Disable user', + ) + return parser + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)' % parsed_args) + identity_client = self.app.client_manager.identity + user = utils.find_resource( + identity_client.users, parsed_args.user) + kwargs = {} + if parsed_args.name: + kwargs['name'] = parsed_args.name + if parsed_args.email: + kwargs['email'] = parsed_args.email + if parsed_args.project: + project_id = utils.find_resource( + identity_client.projects, parsed_args.project).id + kwargs['projectId'] = project_id + if 'enabled' in parsed_args: + kwargs['enabled'] = parsed_args.enabled + + if not len(kwargs): + stdout.write("User not updated, no arguments present") + return + identity_client.users.update(user.id, **kwargs) + return + + +class ShowUser(show.ShowOne): + """Show user command""" + + api = 'identity' + log = logging.getLogger(__name__ + '.ShowUser') + + def get_parser(self, prog_name): + parser = super(ShowUser, self).get_parser(prog_name) + parser.add_argument( + 'user', + metavar='<user>', + help='Name or ID of user to display', + ) + return parser + + def take_action(self, parsed_args): + self.log.debug('take_action(%s)' % parsed_args) + identity_client = self.app.client_manager.identity + user = utils.find_resource( + identity_client.users, parsed_args.user) + + info = {} + info.update(user._info) + return zip(*sorted(info.iteritems())) diff --git a/openstackclient/shell.py b/openstackclient/shell.py index 5dc04572..2654d658 100644 --- a/openstackclient/shell.py +++ b/openstackclient/shell.py @@ -21,17 +21,22 @@ import os import sys from cliff.app import App -from cliff.commandmanager import CommandManager +from cliff.help import HelpAction from openstackclient.common import clientmanager from openstackclient.common import exceptions as exc from openstackclient.common import openstackkeyring from openstackclient.common import utils +from openstackclient.common.commandmanager import CommandManager VERSION = '0.1' KEYRING_SERVICE = 'openstack' +DEFAULT_COMPUTE_API_VERSION = '2' +DEFAULT_IDENTITY_API_VERSION = '2.0' +DEFAULT_IMAGE_API_VERSION = '1.0' + def env(*vars, **kwargs): """Search for the first defined of possibly many env vars @@ -63,6 +68,35 @@ class OpenStackShell(App): # password flow auth self.auth_client = None + # NOTE(dtroyer): This hack changes the help action that Cliff + # automatically adds to the parser so we can defer + # its execution until after the api-versioned commands + # have been loaded. There doesn't seem to be a + # way to edit/remove anything from an existing parser. + + # Replace the cliff-added HelpAction to defer its execution + self.DeferredHelpAction = None + for a in self.parser._actions: + if type(a) == HelpAction: + # Found it, save and replace it + self.DeferredHelpAction = a + + # These steps are argparse-implementation-dependent + self.parser._actions.remove(a) + if self.parser._option_string_actions['-h']: + del self.parser._option_string_actions['-h'] + if self.parser._option_string_actions['--help']: + del self.parser._option_string_actions['--help'] + + # Make a new help option to just set a flag + self.parser.add_argument( + '-h', '--help', + action='store_true', + dest='deferred_help', + default=False, + help="show this help message and exit", + ) + def build_option_parser(self, description, version): parser = super(OpenStackShell, self).build_option_parser( description, @@ -102,20 +136,30 @@ class OpenStackShell(App): parser.add_argument( '--os-identity-api-version', metavar='<identity-api-version>', - default=env('OS_IDENTITY_API_VERSION', default='2.0'), - help='Identity API version, default=2.0 ' - '(Env: OS_IDENTITY_API_VERSION)') + default=env( + 'OS_IDENTITY_API_VERSION', + default=DEFAULT_IDENTITY_API_VERSION), + help='Identity API version, default=' + + DEFAULT_IDENTITY_API_VERSION + + ' (Env: OS_IDENTITY_API_VERSION)') parser.add_argument( '--os-compute-api-version', metavar='<compute-api-version>', - default=env('OS_COMPUTE_API_VERSION', default='2'), - help='Compute API version, default=2 ' - '(Env: OS_COMPUTE_API_VERSION)') + default=env( + 'OS_COMPUTE_API_VERSION', + default=DEFAULT_COMPUTE_API_VERSION), + help='Compute API version, default=' + + DEFAULT_COMPUTE_API_VERSION + + ' (Env: OS_COMPUTE_API_VERSION)') parser.add_argument( '--os-image-api-version', metavar='<image-api-version>', - default=env('OS_IMAGE_API_VERSION', default='1.0'), - help='Image API version, default=1.0 (Env: OS_IMAGE_API_VERSION)') + default=env( + 'OS_IMAGE_API_VERSION', + default=DEFAULT_IMAGE_API_VERSION), + help='Image API version, default=' + + DEFAULT_IMAGE_API_VERSION + + ' (Env: OS_IMAGE_API_VERSION)') parser.add_argument( '--os-token', metavar='<token>', @@ -251,6 +295,16 @@ class OpenStackShell(App): 'image': self.options.os_image_api_version, } + # Add the API version-specific commands + for api in self.api_version.keys(): + version = '.v' + self.api_version[api].replace('.', '_') + self.command_manager.add_command_group( + 'openstack.' + api + version) + + # Handle deferred help and exit + if self.options.deferred_help: + self.DeferredHelpAction(self.parser, self.parser, None, None) + # If the user is not asking for help, make sure they # have given us auth. cmd_name = None |