Initial split from python-novaclient.0.0

1 files changed, 435 insertions, 0 deletions

diff --git a/cinderclient/shell.py b/cinderclient/shell.py
new file mode 100644
index 0000000..25d5536
--- /dev/null
+++ b/cinderclient/shell.py
@@ -0,0 +1,435 @@
+
+# Copyright 2011 OpenStack LLC.
+# 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.
+
+"""
+Command-line interface to the OpenStack Volume API.
+"""
+
+import argparse
+import glob
+import httplib2
+import imp
+import itertools
+import os
+import pkgutil
+import sys
+import logging
+
+from cinderclient import client
+from cinderclient import exceptions as exc
+import cinderclient.extension
+from cinderclient import utils
+from cinderclient.v1 import shell as shell_v1
+
+DEFAULT_OS_VOLUME_API_VERSION = "1"
+DEFAULT_CINDER_ENDPOINT_TYPE = 'publicURL'
+DEFAULT_CINDER_SERVICE_TYPE = 'compute'
+
+logger = logging.getLogger(__name__)
+
+
+class CinderClientArgumentParser(argparse.ArgumentParser):
+
+    def __init__(self, *args, **kwargs):
+        super(CinderClientArgumentParser, self).__init__(*args, **kwargs)
+
+    def error(self, message):
+        """error(message: string)
+
+        Prints a usage message incorporating the message to stderr and
+        exits.
+        """
+        self.print_usage(sys.stderr)
+        #FIXME(lzyeval): if changes occur in argparse.ArgParser._check_value
+        choose_from = ' (choose from'
+        progparts = self.prog.partition(' ')
+        self.exit(2, "error: %(errmsg)s\nTry '%(mainp)s help %(subp)s'"
+                     " for more information.\n" %
+                     {'errmsg': message.split(choose_from)[0],
+                      'mainp': progparts[0],
+                      'subp': progparts[2]})
+
+
+class OpenStackCinderShell(object):
+
+    def get_base_parser(self):
+        parser = CinderClientArgumentParser(
+            prog='cinder',
+            description=__doc__.strip(),
+            epilog='See "cinder help COMMAND" '\
+                   'for help on a specific command.',
+            add_help=False,
+            formatter_class=OpenStackHelpFormatter,
+        )
+
+        # Global arguments
+        parser.add_argument('-h', '--help',
+            action='store_true',
+            help=argparse.SUPPRESS,
+        )
+
+        parser.add_argument('--debug',
+            default=False,
+            action='store_true',
+            help="Print debugging output")
+
+        parser.add_argument('--os_username',
+            default=utils.env('OS_USERNAME', 'CINDER_USERNAME'),
+            help='Defaults to env[OS_USERNAME].')
+
+        parser.add_argument('--os_password',
+            default=utils.env('OS_PASSWORD', 'CINDER_PASSWORD'),
+            help='Defaults to env[OS_PASSWORD].')
+
+        parser.add_argument('--os_tenant_name',
+            default=utils.env('OS_TENANT_NAME', 'CINDER_PROJECT_ID'),
+            help='Defaults to env[OS_TENANT_NAME].')
+
+        parser.add_argument('--os_auth_url',
+            default=utils.env('OS_AUTH_URL', 'CINDER_URL'),
+            help='Defaults to env[OS_AUTH_URL].')
+
+        parser.add_argument('--os_region_name',
+            default=utils.env('OS_REGION_NAME', 'CINDER_REGION_NAME'),
+            help='Defaults to env[OS_REGION_NAME].')
+
+        parser.add_argument('--service_type',
+            help='Defaults to compute for most actions')
+
+        parser.add_argument('--service_name',
+            default=utils.env('CINDER_SERVICE_NAME'),
+            help='Defaults to env[CINDER_SERVICE_NAME]')
+
+        parser.add_argument('--volume_service_name',
+            default=utils.env('CINDER_VOLUME_SERVICE_NAME'),
+            help='Defaults to env[CINDER_VOLUME_SERVICE_NAME]')
+
+        parser.add_argument('--endpoint_type',
+            default=utils.env('CINDER_ENDPOINT_TYPE',
+                        default=DEFAULT_CINDER_ENDPOINT_TYPE),
+            help='Defaults to env[CINDER_ENDPOINT_TYPE] or '
+                    + DEFAULT_CINDER_ENDPOINT_TYPE + '.')
+
+        parser.add_argument('--os_volume_api_version',
+            default=utils.env('OS_VOLUME_API_VERSION',
+            default=DEFAULT_OS_VOLUME_API_VERSION),
+            help='Accepts 1, defaults to env[OS_VOLUME_API_VERSION].')
+
+        parser.add_argument('--insecure',
+            default=utils.env('CINDERCLIENT_INSECURE', default=False),
+            action='store_true',
+            help=argparse.SUPPRESS)
+
+        # FIXME(dtroyer): The args below are here for diablo compatibility,
+        #                 remove them in folsum cycle
+
+        # alias for --os_username, left in for backwards compatibility
+        parser.add_argument('--username',
+            help='Deprecated')
+
+        # alias for --os_region_name, left in for backwards compatibility
+        parser.add_argument('--region_name',
+            help='Deprecated')
+
+        # alias for --os_password, left in for backwards compatibility
+        parser.add_argument('--apikey', '--password', dest='apikey',
+            default=utils.env('CINDER_API_KEY'),
+            help='Deprecated')
+
+        # alias for --os_tenant_name, left in for backward compatibility
+        parser.add_argument('--projectid', '--tenant_name', dest='projectid',
+            default=utils.env('CINDER_PROJECT_ID'),
+            help='Deprecated')
+
+        # alias for --os_auth_url, left in for backward compatibility
+        parser.add_argument('--url', '--auth_url', dest='url',
+            default=utils.env('CINDER_URL'),
+            help='Deprecated')
+
+        return parser
+
+    def get_subcommand_parser(self, version):
+        parser = self.get_base_parser()
+
+        self.subcommands = {}
+        subparsers = parser.add_subparsers(metavar='<subcommand>')
+
+        try:
+            actions_module = {
+                '1.1': shell_v1,
+                '2': shell_v1,
+            }[version]
+        except KeyError:
+            actions_module = shell_v1
+
+        self._find_actions(subparsers, actions_module)
+        self._find_actions(subparsers, self)
+
+        for extension in self.extensions:
+            self._find_actions(subparsers, extension.module)
+
+        self._add_bash_completion_subparser(subparsers)
+
+        return parser
+
+    def _discover_extensions(self, version):
+        extensions = []
+        for name, module in itertools.chain(
+                self._discover_via_python_path(version),
+                self._discover_via_contrib_path(version)):
+
+            extension = cinderclient.extension.Extension(name, module)
+            extensions.append(extension)
+
+        return extensions
+
+    def _discover_via_python_path(self, version):
+        for (module_loader, name, ispkg) in pkgutil.iter_modules():
+            if name.endswith('python_cinderclient_ext'):
+                if not hasattr(module_loader, 'load_module'):
+                    # Python 2.6 compat: actually get an ImpImporter obj
+                    module_loader = module_loader.find_module(name)
+
+                module = module_loader.load_module(name)
+                yield name, module
+
+    def _discover_via_contrib_path(self, version):
+        module_path = os.path.dirname(os.path.abspath(__file__))
+        version_str = "v%s" % version.replace('.', '_')
+        ext_path = os.path.join(module_path, version_str, 'contrib')
+        ext_glob = os.path.join(ext_path, "*.py")
+
+        for ext_path in glob.iglob(ext_glob):
+            name = os.path.basename(ext_path)[:-3]
+
+            if name == "__init__":
+                continue
+
+            module = imp.load_source(name, ext_path)
+            yield name, module
+
+    def _add_bash_completion_subparser(self, subparsers):
+        subparser = subparsers.add_parser('bash_completion',
+            add_help=False,
+            formatter_class=OpenStackHelpFormatter
+        )
+        self.subcommands['bash_completion'] = subparser
+        subparser.set_defaults(func=self.do_bash_completion)
+
+    def _find_actions(self, subparsers, actions_module):
+        for attr in (a for a in dir(actions_module) if a.startswith('do_')):
+            # I prefer to be hypen-separated instead of underscores.
+            command = attr[3:].replace('_', '-')
+            callback = getattr(actions_module, attr)
+            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=OpenStackHelpFormatter
+            )
+            subparser.add_argument('-h', '--help',
+                action='help',
+                help=argparse.SUPPRESS,
+            )
+            self.subcommands[command] = subparser
+            for (args, kwargs) in arguments:
+                subparser.add_argument(*args, **kwargs)
+            subparser.set_defaults(func=callback)
+
+    def setup_debugging(self, debug):
+        if not debug:
+            return
+
+        streamhandler = logging.StreamHandler()
+        streamformat = "%(levelname)s (%(module)s:%(lineno)d) %(message)s"
+        streamhandler.setFormatter(logging.Formatter(streamformat))
+        logger.setLevel(logging.DEBUG)
+        logger.addHandler(streamhandler)
+
+        httplib2.debuglevel = 1
+
+    def main(self, argv):
+        # Parse args once to find version
+        parser = self.get_base_parser()
+        (options, args) = parser.parse_known_args(argv)
+        self.setup_debugging(options.debug)
+
+        # build available subcommands based on version
+        self.extensions = self._discover_extensions(
+                options.os_volume_api_version)
+        self._run_extension_hooks('__pre_parse_args__')
+
+        subcommand_parser = self.get_subcommand_parser(
+                options.os_volume_api_version)
+        self.parser = subcommand_parser
+
+        if options.help and len(args) == 0:
+            subcommand_parser.print_help()
+            return 0
+
+        args = subcommand_parser.parse_args(argv)
+        self._run_extension_hooks('__post_parse_args__', args)
+
+        # Short-circuit and deal with help 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
+
+        (os_username, os_password, os_tenant_name, os_auth_url,
+                os_region_name, endpoint_type, insecure,
+                service_type, service_name, volume_service_name,
+                username, apikey, projectid, url, region_name) = (
+                        args.os_username, args.os_password,
+                        args.os_tenant_name, args.os_auth_url,
+                        args.os_region_name, args.endpoint_type,
+                        args.insecure, args.service_type, args.service_name,
+                        args.volume_service_name, args.username,
+                        args.apikey, args.projectid,
+                        args.url, args.region_name)
+
+        if not endpoint_type:
+            endpoint_type = DEFAULT_CINDER_ENDPOINT_TYPE
+
+        if not service_type:
+            service_type = DEFAULT_CINDER_SERVICE_TYPE
+            service_type = utils.get_service_type(args.func) or service_type
+
+        #FIXME(usrleon): Here should be restrict for project id same as
+        # for os_username or os_password but for compatibility it is not.
+
+        if not utils.isunauthenticated(args.func):
+            if not os_username:
+                if not username:
+                    raise exc.CommandError("You must provide a username "
+                            "via either --os_username or env[OS_USERNAME]")
+                else:
+                    os_username = username
+
+            if not os_password:
+                if not apikey:
+                    raise exc.CommandError("You must provide a password "
+                            "via either --os_password or via "
+                            "env[OS_PASSWORD]")
+                else:
+                    os_password = apikey
+
+            if not os_tenant_name:
+                if not projectid:
+                    raise exc.CommandError("You must provide a tenant name "
+                            "via either --os_tenant_name or "
+                            "env[OS_TENANT_NAME]")
+                else:
+                    os_tenant_name = projectid
+
+            if not os_auth_url:
+                if not url:
+                    raise exc.CommandError("You must provide an auth url "
+                            "via either --os_auth_url or env[OS_AUTH_URL]")
+                else:
+                    os_auth_url = url
+
+            if not os_region_name and region_name:
+                os_region_name = region_name
+
+        if not os_tenant_name:
+            raise exc.CommandError("You must provide a tenant name "
+                    "via either --os_tenant_name or env[OS_TENANT_NAME]")
+
+        if not os_auth_url:
+            raise exc.CommandError("You must provide an auth url "
+                    "via either --os_auth_url or env[OS_AUTH_URL]")
+
+        self.cs = client.Client(options.os_volume_api_version, os_username,
+                os_password, os_tenant_name, os_auth_url, insecure,
+                region_name=os_region_name, endpoint_type=endpoint_type,
+                extensions=self.extensions, service_type=service_type,
+                service_name=service_name,
+                volume_service_name=volume_service_name)
+
+        try:
+            if not utils.isunauthenticated(args.func):
+                self.cs.authenticate()
+        except exc.Unauthorized:
+            raise exc.CommandError("Invalid OpenStack Nova credentials.")
+        except exc.AuthorizationFailure:
+            raise exc.CommandError("Unable to authorize user")
+
+        args.func(self.cs, args)
+
+    def _run_extension_hooks(self, hook_type, *args, **kwargs):
+        """Run hooks for all registered extensions."""
+        for extension in self.extensions:
+            extension.run_hooks(hook_type, *args, **kwargs)
+
+    def do_bash_completion(self, args):
+        """
+        Prints all of the commands and options to stdout so that the
+        cinder.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 sc._optionals._option_string_actions.keys():
+                options.add(option)
+
+        commands.remove('bash-completion')
+        commands.remove('bash_completion')
+        print ' '.join(commands | options)
+
+    @utils.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 args.command:
+            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()
+
+
+# I'm picky about my shell help.
+class OpenStackHelpFormatter(argparse.HelpFormatter):
+    def start_section(self, heading):
+        # Title-case the headings
+        heading = '%s%s' % (heading[0].upper(), heading[1:])
+        super(OpenStackHelpFormatter, self).start_section(heading)
+
+
+def main():
+    try:
+        OpenStackCinderShell().main(sys.argv[1:])
+
+    except Exception, e:
+        logger.debug(e, exc_info=1)
+        print >> sys.stderr, "ERROR: %s" % str(e)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()