The __future__ module [1] was used in this context to ensure compatibility between python 2 and python 3. We previously dropped the support of python 2.7 [2] and now we only support python 3 so we don't need to continue to use this module and the imports listed below. Imports commonly used and their related PEPs: - `division` is related to PEP 238 [3] - `print_function` is related to PEP 3105 [4] - `unicode_literals` is related to PEP 3112 [5] - `with_statement` is related to PEP 343 [6] - `absolute_import` is related to PEP 328 [7] [1] https://docs.python.org/3/library/__future__.html [2] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html [3] https://www.python.org/dev/peps/pep-0238 [4] https://www.python.org/dev/peps/pep-3105 [5] https://www.python.org/dev/peps/pep-3112 [6] https://www.python.org/dev/peps/pep-0343 [7] https://www.python.org/dev/peps/pep-0328 Change-Id: I65fb53db889afcf1a947ea61094bfab877853324
		
			
				
	
	
		
			655 lines
		
	
	
		
			24 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			655 lines
		
	
	
		
			24 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
# Copyright 2012 OpenStack Foundation.
 | 
						|
# 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 Neutron APIs
 | 
						|
"""
 | 
						|
 | 
						|
import argparse
 | 
						|
import inspect
 | 
						|
import itertools
 | 
						|
import logging
 | 
						|
import os
 | 
						|
import sys
 | 
						|
 | 
						|
from keystoneauth1 import session
 | 
						|
import os_client_config
 | 
						|
from oslo_utils import encodeutils
 | 
						|
from oslo_utils import netutils
 | 
						|
 | 
						|
from cliff import app
 | 
						|
from cliff import command
 | 
						|
from cliff import commandmanager
 | 
						|
 | 
						|
from neutronclient._i18n import _
 | 
						|
from neutronclient.common import clientmanager
 | 
						|
from neutronclient.common import exceptions as exc
 | 
						|
from neutronclient.common import extension as client_extension
 | 
						|
from neutronclient.neutron.v2_0 import subnet
 | 
						|
from neutronclient.version import __version__
 | 
						|
 | 
						|
 | 
						|
VERSION = '2.0'
 | 
						|
NEUTRON_API_VERSION = '2.0'
 | 
						|
 | 
						|
NAMESPACE_MAP = {NEUTRON_API_VERSION: 'neutron.cli.v2'}
 | 
						|
 | 
						|
 | 
						|
def run_command(cmd, cmd_parser, sub_argv):
 | 
						|
    _argv = sub_argv
 | 
						|
    index = -1
 | 
						|
    values_specs = []
 | 
						|
    if '--' in sub_argv:
 | 
						|
        index = sub_argv.index('--')
 | 
						|
        _argv = sub_argv[:index]
 | 
						|
        values_specs = sub_argv[index:]
 | 
						|
    known_args, _values_specs = cmd_parser.parse_known_args(_argv)
 | 
						|
    if(isinstance(cmd, subnet.CreateSubnet) and not known_args.cidr):
 | 
						|
        cidr = get_first_valid_cidr(_values_specs)
 | 
						|
        if cidr:
 | 
						|
            known_args.cidr = cidr
 | 
						|
            _values_specs.remove(cidr)
 | 
						|
    cmd.values_specs = (index == -1 and _values_specs or values_specs)
 | 
						|
    return cmd.run(known_args)
 | 
						|
 | 
						|
 | 
						|
def get_first_valid_cidr(value_specs):
 | 
						|
    # Bug 1442771, argparse does not allow optional positional parameter
 | 
						|
    # to be separated from previous positional parameter.
 | 
						|
    # When cidr was separated from network, the value will not be able
 | 
						|
    # to be parsed into known_args, but saved to _values_specs instead.
 | 
						|
    for value in value_specs:
 | 
						|
        if netutils.is_valid_cidr(value):
 | 
						|
            return value
 | 
						|
 | 
						|
 | 
						|
def env(*_vars, **kwargs):
 | 
						|
    """Search for the first defined of possibly many env vars.
 | 
						|
 | 
						|
    Returns the first environment variable defined in vars, or
 | 
						|
    returns the default defined in kwargs.
 | 
						|
 | 
						|
    """
 | 
						|
    for v in _vars:
 | 
						|
        value = os.environ.get(v, None)
 | 
						|
        if value:
 | 
						|
            return value
 | 
						|
    return kwargs.get('default', '')
 | 
						|
 | 
						|
 | 
						|
def check_non_negative_int(value):
 | 
						|
    try:
 | 
						|
        value = int(value)
 | 
						|
    except ValueError:
 | 
						|
        raise argparse.ArgumentTypeError(_("invalid int value: %r") % value)
 | 
						|
    if value < 0:
 | 
						|
        raise argparse.ArgumentTypeError(_("input value %d is negative") %
 | 
						|
                                         value)
 | 
						|
    return value
 | 
						|
 | 
						|
 | 
						|
COMMANDS = {}
 | 
						|
 | 
						|
 | 
						|
# NOTE(amotoki): This is only to provide compatibility
 | 
						|
# to existing neutron CLI extensions. See bug 1706573 for detail.
 | 
						|
def _set_commands_dict_for_compat(apiversion, command_manager):
 | 
						|
    global COMMANDS
 | 
						|
    COMMANDS = {apiversion: dict((cmd, command_manager.find_command([cmd])[0])
 | 
						|
                                 for cmd in command_manager.commands)}
 | 
						|
 | 
						|
 | 
						|
class BashCompletionCommand(command.Command):
 | 
						|
    """Prints all of the commands and options for bash-completion."""
 | 
						|
 | 
						|
    def take_action(self, parsed_args):
 | 
						|
        pass
 | 
						|
 | 
						|
 | 
						|
class HelpAction(argparse.Action):
 | 
						|
    """Print help message including sub-commands
 | 
						|
 | 
						|
    Provide a custom action so the -h and --help options
 | 
						|
    to the main app will print a list of the commands.
 | 
						|
 | 
						|
    The commands are determined by checking the CommandManager
 | 
						|
    instance, passed in as the "default" value for the action.
 | 
						|
    """
 | 
						|
    def __call__(self, parser, namespace, values, option_string=None):
 | 
						|
        outputs = []
 | 
						|
        max_len = 0
 | 
						|
        app = self.default
 | 
						|
        parser.print_help(app.stdout)
 | 
						|
        app.stdout.write(_('\nCommands for API v%s:\n') % app.api_version)
 | 
						|
        command_manager = app.command_manager
 | 
						|
        for name, ep in sorted(command_manager):
 | 
						|
            factory = ep.load()
 | 
						|
            cmd = factory(self, None)
 | 
						|
            one_liner = cmd.get_description().split('\n')[0]
 | 
						|
            outputs.append((name, one_liner))
 | 
						|
            max_len = max(len(name), max_len)
 | 
						|
        for (name, one_liner) in outputs:
 | 
						|
            app.stdout.write('  %s  %s\n' % (name.ljust(max_len), one_liner))
 | 
						|
        sys.exit(0)
 | 
						|
 | 
						|
 | 
						|
class NeutronShell(app.App):
 | 
						|
 | 
						|
    # verbose logging levels
 | 
						|
    WARNING_LEVEL = 0
 | 
						|
    INFO_LEVEL = 1
 | 
						|
    DEBUG_LEVEL = 2
 | 
						|
    CONSOLE_MESSAGE_FORMAT = '%(message)s'
 | 
						|
    DEBUG_MESSAGE_FORMAT = '%(levelname)s: %(name)s %(message)s'
 | 
						|
    log = logging.getLogger(__name__)
 | 
						|
 | 
						|
    def __init__(self, apiversion):
 | 
						|
        namespace = NAMESPACE_MAP[apiversion]
 | 
						|
        description = (__doc__.strip() +
 | 
						|
                       " (neutron CLI version: %s)" % __version__)
 | 
						|
        super(NeutronShell, self).__init__(
 | 
						|
            description=description,
 | 
						|
            version=VERSION,
 | 
						|
            command_manager=commandmanager.CommandManager(namespace), )
 | 
						|
 | 
						|
        self._register_extensions(VERSION)
 | 
						|
 | 
						|
        # Pop the 'complete' to correct the outputs of 'neutron help'.
 | 
						|
        self.command_manager.commands.pop('complete')
 | 
						|
 | 
						|
        # This is instantiated in initialize_app() only when using
 | 
						|
        # password flow auth
 | 
						|
        self.auth_client = None
 | 
						|
        self.api_version = apiversion
 | 
						|
 | 
						|
        _set_commands_dict_for_compat(apiversion, self.command_manager)
 | 
						|
 | 
						|
    def build_option_parser(self, description, version):
 | 
						|
        """Return an argparse option parser for this application.
 | 
						|
 | 
						|
        Subclasses may override this method to extend
 | 
						|
        the parser with more global options.
 | 
						|
 | 
						|
        :param description: full description of the application
 | 
						|
        :paramtype description: str
 | 
						|
        :param version: version number for the application
 | 
						|
        :paramtype version: str
 | 
						|
        """
 | 
						|
        parser = argparse.ArgumentParser(
 | 
						|
            description=description,
 | 
						|
            add_help=False, )
 | 
						|
        parser.add_argument(
 | 
						|
            '--version',
 | 
						|
            action='version',
 | 
						|
            version=__version__, )
 | 
						|
        parser.add_argument(
 | 
						|
            '-v', '--verbose', '--debug',
 | 
						|
            action='count',
 | 
						|
            dest='verbose_level',
 | 
						|
            default=self.DEFAULT_VERBOSE_LEVEL,
 | 
						|
            help=_('Increase verbosity of output and show tracebacks on'
 | 
						|
                   ' errors. You can repeat this option.'))
 | 
						|
        parser.add_argument(
 | 
						|
            '-q', '--quiet',
 | 
						|
            action='store_const',
 | 
						|
            dest='verbose_level',
 | 
						|
            const=0,
 | 
						|
            help=_('Suppress output except warnings and errors.'))
 | 
						|
        parser.add_argument(
 | 
						|
            '-h', '--help',
 | 
						|
            action=HelpAction,
 | 
						|
            nargs=0,
 | 
						|
            default=self,  # tricky
 | 
						|
            help=_("Show this help message and exit."))
 | 
						|
        parser.add_argument(
 | 
						|
            '-r', '--retries',
 | 
						|
            metavar="NUM",
 | 
						|
            type=check_non_negative_int,
 | 
						|
            default=0,
 | 
						|
            help=_("How many times the request to the Neutron server should "
 | 
						|
                   "be retried if it fails. Defaults to 0."))
 | 
						|
        # FIXME(bklei): this method should come from keystoneauth1
 | 
						|
        self._append_global_identity_args(parser)
 | 
						|
 | 
						|
        return parser
 | 
						|
 | 
						|
    def _append_global_identity_args(self, parser):
 | 
						|
        # FIXME(bklei): these are global identity (Keystone) arguments which
 | 
						|
        # should be consistent and shared by all service clients. Therefore,
 | 
						|
        # they should be provided by keystoneauth1. We will need to
 | 
						|
        # refactor this code once this functionality is available in
 | 
						|
        # keystoneauth1.
 | 
						|
        #
 | 
						|
        # Note: At that time we'll need to decide if we can just abandon
 | 
						|
        #       the deprecated args (--service-type and --endpoint-type).
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-service-type', metavar='<os-service-type>',
 | 
						|
            default=env('OS_NETWORK_SERVICE_TYPE', default='network'),
 | 
						|
            help=_('Defaults to env[OS_NETWORK_SERVICE_TYPE] or "network".'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-endpoint-type', metavar='<os-endpoint-type>',
 | 
						|
            default=env('OS_ENDPOINT_TYPE', default='public'),
 | 
						|
            help=_('Defaults to env[OS_ENDPOINT_TYPE] or "public".'))
 | 
						|
 | 
						|
        # FIXME(bklei): --service-type is deprecated but kept in for
 | 
						|
        # backward compatibility.
 | 
						|
        parser.add_argument(
 | 
						|
            '--service-type', metavar='<service-type>',
 | 
						|
            default=env('OS_NETWORK_SERVICE_TYPE', default='network'),
 | 
						|
            help=_('DEPRECATED! Use --os-service-type.'))
 | 
						|
 | 
						|
        # FIXME(bklei): --endpoint-type is deprecated but kept in for
 | 
						|
        # backward compatibility.
 | 
						|
        parser.add_argument(
 | 
						|
            '--endpoint-type', metavar='<endpoint-type>',
 | 
						|
            default=env('OS_ENDPOINT_TYPE', default='public'),
 | 
						|
            help=_('DEPRECATED! Use --os-endpoint-type.'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-auth-strategy', metavar='<auth-strategy>',
 | 
						|
            default=env('OS_AUTH_STRATEGY', default='keystone'),
 | 
						|
            help=_('DEPRECATED! Only keystone is supported.'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_auth_strategy',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-cloud', metavar='<cloud>',
 | 
						|
            help=_('Defaults to env[OS_CLOUD].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-auth-url', metavar='<auth-url>',
 | 
						|
            help=_('Authentication URL, defaults to env[OS_AUTH_URL].'))
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_auth_url',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        project_name_group = parser.add_mutually_exclusive_group()
 | 
						|
        project_name_group.add_argument(
 | 
						|
            '--os-tenant-name', metavar='<auth-tenant-name>',
 | 
						|
            help=_('Authentication tenant name, defaults to '
 | 
						|
                   'env[OS_TENANT_NAME].'))
 | 
						|
        project_name_group.add_argument(
 | 
						|
            '--os-project-name',
 | 
						|
            metavar='<auth-project-name>',
 | 
						|
            help=_('Another way to specify tenant name. '
 | 
						|
                   'This option is mutually exclusive with '
 | 
						|
                   ' --os-tenant-name. '
 | 
						|
                   'Defaults to env[OS_PROJECT_NAME].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_tenant_name',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        project_id_group = parser.add_mutually_exclusive_group()
 | 
						|
        project_id_group.add_argument(
 | 
						|
            '--os-tenant-id', metavar='<auth-tenant-id>',
 | 
						|
            help=_('Authentication tenant ID, defaults to '
 | 
						|
                   'env[OS_TENANT_ID].'))
 | 
						|
        project_id_group.add_argument(
 | 
						|
            '--os-project-id',
 | 
						|
            metavar='<auth-project-id>',
 | 
						|
            help=_('Another way to specify tenant ID. '
 | 
						|
                   'This option is mutually exclusive with '
 | 
						|
                   ' --os-tenant-id. '
 | 
						|
                   'Defaults to env[OS_PROJECT_ID].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-username', metavar='<auth-username>',
 | 
						|
            help=_('Authentication username, defaults to env[OS_USERNAME].'))
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_username',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-user-id', metavar='<auth-user-id>',
 | 
						|
            help=_('Authentication user ID (Env: OS_USER_ID)'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_user_id',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-user-domain-id',
 | 
						|
            metavar='<auth-user-domain-id>',
 | 
						|
            help=_('OpenStack user domain ID. '
 | 
						|
                   'Defaults to env[OS_USER_DOMAIN_ID].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_user_domain_id',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-user-domain-name',
 | 
						|
            metavar='<auth-user-domain-name>',
 | 
						|
            help=_('OpenStack user domain name. '
 | 
						|
                   'Defaults to env[OS_USER_DOMAIN_NAME].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_user_domain_name',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_project_id',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_project_name',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-project-domain-id',
 | 
						|
            metavar='<auth-project-domain-id>',
 | 
						|
            help=_('Defaults to env[OS_PROJECT_DOMAIN_ID].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-project-domain-name',
 | 
						|
            metavar='<auth-project-domain-name>',
 | 
						|
            help=_('Defaults to env[OS_PROJECT_DOMAIN_NAME].'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-cert',
 | 
						|
            metavar='<certificate>',
 | 
						|
            help=_("Path of certificate file to use in SSL "
 | 
						|
                   "connection. This file can optionally be "
 | 
						|
                   "prepended with the private key. Defaults "
 | 
						|
                   "to env[OS_CERT]."))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-cacert',
 | 
						|
            metavar='<ca-certificate>',
 | 
						|
            help=_("Specify a CA bundle file to use in "
 | 
						|
                   "verifying a TLS (https) server certificate. "
 | 
						|
                   "Defaults to env[OS_CACERT]."))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-key',
 | 
						|
            metavar='<key>',
 | 
						|
            help=_("Path of client key to use in SSL "
 | 
						|
                   "connection. This option is not necessary "
 | 
						|
                   "if your key is prepended to your certificate "
 | 
						|
                   "file. Defaults to env[OS_KEY]."))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-password', metavar='<auth-password>',
 | 
						|
            help=_('Authentication password, defaults to env[OS_PASSWORD].'))
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_password',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-region-name', metavar='<auth-region-name>',
 | 
						|
            help=_('Authentication region name, defaults to '
 | 
						|
                   'env[OS_REGION_NAME].'))
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_region_name',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-token', metavar='<token>',
 | 
						|
            help=_('Authentication token, defaults to env[OS_TOKEN].'))
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_token',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--http-timeout', metavar='<seconds>',
 | 
						|
            default=env('OS_NETWORK_TIMEOUT', default=None), type=float,
 | 
						|
            help=_('Timeout in seconds to wait for an HTTP response. Defaults '
 | 
						|
                   'to env[OS_NETWORK_TIMEOUT] or None if not specified.'))
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--os-url', metavar='<url>',
 | 
						|
            help=_('Defaults to env[OS_URL].'))
 | 
						|
        parser.add_argument(
 | 
						|
            '--os_url',
 | 
						|
            help=argparse.SUPPRESS)
 | 
						|
 | 
						|
        parser.add_argument(
 | 
						|
            '--insecure',
 | 
						|
            action='store_true',
 | 
						|
            default=env('NEUTRONCLIENT_INSECURE', default=False),
 | 
						|
            help=_("Explicitly allow neutronclient to perform \"insecure\" "
 | 
						|
                   "SSL (https) requests. The server's certificate will "
 | 
						|
                   "not be verified against any certificate authorities. "
 | 
						|
                   "This option should be used with caution."))
 | 
						|
 | 
						|
    def _bash_completion(self):
 | 
						|
        """Prints all of the commands and options for bash-completion."""
 | 
						|
        commands = set()
 | 
						|
        options = set()
 | 
						|
        for option, _action in self.parser._option_string_actions.items():
 | 
						|
            options.add(option)
 | 
						|
        for _name, _command in self.command_manager:
 | 
						|
            commands.add(_name)
 | 
						|
            cmd_factory = _command.load()
 | 
						|
            cmd = cmd_factory(self, None)
 | 
						|
            cmd_parser = cmd.get_parser('')
 | 
						|
            for option, _action in cmd_parser._option_string_actions.items():
 | 
						|
                options.add(option)
 | 
						|
        print(' '.join(commands | options))
 | 
						|
 | 
						|
    def _register_extensions(self, version):
 | 
						|
        for name, module in itertools.chain(
 | 
						|
                client_extension._discover_via_entry_points()):
 | 
						|
            self._extend_shell_commands(name, module, version)
 | 
						|
 | 
						|
    def _extend_shell_commands(self, name, module, version):
 | 
						|
        classes = inspect.getmembers(module, inspect.isclass)
 | 
						|
        for cls_name, cls in classes:
 | 
						|
            if (issubclass(cls, client_extension.NeutronClientExtension) and
 | 
						|
                    hasattr(cls, 'shell_command')):
 | 
						|
                cmd = cls.shell_command
 | 
						|
                if hasattr(cls, 'versions'):
 | 
						|
                    if version not in cls.versions:
 | 
						|
                        continue
 | 
						|
                try:
 | 
						|
                    name_prefix = "[%s]" % name
 | 
						|
                    cls.__doc__ = ("%s %s" % (name_prefix, cls.__doc__) if
 | 
						|
                                   cls.__doc__ else name_prefix)
 | 
						|
                    self.command_manager.add_command(cmd, cls)
 | 
						|
                except TypeError:
 | 
						|
                    pass
 | 
						|
 | 
						|
    def run(self, argv):
 | 
						|
        """Equivalent to the main program for the application.
 | 
						|
 | 
						|
        :param argv: input arguments and options
 | 
						|
        :paramtype argv: list of str
 | 
						|
        """
 | 
						|
        try:
 | 
						|
            index = 0
 | 
						|
            command_pos = -1
 | 
						|
            help_pos = -1
 | 
						|
            help_command_pos = -1
 | 
						|
            for arg in argv:
 | 
						|
                if arg == 'bash-completion' and help_command_pos == -1:
 | 
						|
                    self._bash_completion()
 | 
						|
                    return 0
 | 
						|
                if arg in ('-h', '--help'):
 | 
						|
                    if help_pos == -1:
 | 
						|
                        help_pos = index
 | 
						|
                # self.command_manager.commands contains 'help',
 | 
						|
                # so we need to check this first.
 | 
						|
                elif arg == 'help':
 | 
						|
                    if help_command_pos == -1:
 | 
						|
                        help_command_pos = index
 | 
						|
                elif arg in self.command_manager.commands:
 | 
						|
                    if command_pos == -1:
 | 
						|
                        command_pos = index
 | 
						|
                index = index + 1
 | 
						|
            if command_pos > -1 and help_pos > command_pos:
 | 
						|
                argv = ['help', argv[command_pos]]
 | 
						|
            if help_command_pos > -1 and command_pos == -1:
 | 
						|
                argv[help_command_pos] = '--help'
 | 
						|
            self.options, remainder = self.parser.parse_known_args(argv)
 | 
						|
            self.configure_logging()
 | 
						|
            self.interactive_mode = not remainder
 | 
						|
            self.initialize_app(remainder)
 | 
						|
        except Exception as err:
 | 
						|
            if self.options.verbose_level >= self.DEBUG_LEVEL:
 | 
						|
                self.log.exception(err)
 | 
						|
                raise
 | 
						|
            else:
 | 
						|
                self.log.error(err)
 | 
						|
            return 1
 | 
						|
        if self.interactive_mode:
 | 
						|
            _argv = [sys.argv[0]]
 | 
						|
            sys.argv = _argv
 | 
						|
            return self.interact()
 | 
						|
        return self.run_subcommand(remainder)
 | 
						|
 | 
						|
    def run_subcommand(self, argv):
 | 
						|
        subcommand = self.command_manager.find_command(argv)
 | 
						|
        cmd_factory, cmd_name, sub_argv = subcommand
 | 
						|
        cmd = cmd_factory(self, self.options)
 | 
						|
        try:
 | 
						|
            self.prepare_to_run_command(cmd)
 | 
						|
            full_name = (cmd_name
 | 
						|
                         if self.interactive_mode
 | 
						|
                         else ' '.join([self.NAME, cmd_name])
 | 
						|
                         )
 | 
						|
            cmd_parser = cmd.get_parser(full_name)
 | 
						|
            return run_command(cmd, cmd_parser, sub_argv)
 | 
						|
        except SystemExit:
 | 
						|
            print(_("Try 'neutron help %s' for more information.") %
 | 
						|
                  cmd_name, file=sys.stderr)
 | 
						|
            raise
 | 
						|
        except Exception as e:
 | 
						|
            if self.options.verbose_level >= self.DEBUG_LEVEL:
 | 
						|
                self.log.exception("%s", e)
 | 
						|
                raise
 | 
						|
            self.log.error("%s", e)
 | 
						|
        return 1
 | 
						|
 | 
						|
    def authenticate_user(self):
 | 
						|
        """Confirm user authentication
 | 
						|
 | 
						|
        Make sure the user has provided all of the authentication
 | 
						|
        info we need.
 | 
						|
        """
 | 
						|
        cloud_config = os_client_config.OpenStackConfig().get_one_cloud(
 | 
						|
            cloud=self.options.os_cloud, argparse=self.options,
 | 
						|
            network_api_version=self.api_version,
 | 
						|
            verify=not self.options.insecure)
 | 
						|
        verify, cert = cloud_config.get_requests_verify_args()
 | 
						|
 | 
						|
        # TODO(singhj): Remove dependancy on HTTPClient
 | 
						|
        # for the case of token-endpoint authentication
 | 
						|
 | 
						|
        # When using token-endpoint authentication legacy
 | 
						|
        # HTTPClient will be used, otherwise SessionClient
 | 
						|
        # will be used.
 | 
						|
        if self.options.os_token and self.options.os_url:
 | 
						|
            auth = None
 | 
						|
            auth_session = None
 | 
						|
        else:
 | 
						|
            auth = cloud_config.get_auth()
 | 
						|
 | 
						|
            auth_session = session.Session(
 | 
						|
                auth=auth, verify=verify, cert=cert,
 | 
						|
                timeout=self.options.http_timeout)
 | 
						|
 | 
						|
        interface = self.options.os_endpoint_type or self.endpoint_type
 | 
						|
        if interface.endswith('URL'):
 | 
						|
            interface = interface[:-3]
 | 
						|
        self.client_manager = clientmanager.ClientManager(
 | 
						|
            retries=self.options.retries,
 | 
						|
            raise_errors=False,
 | 
						|
            session=auth_session,
 | 
						|
            url=self.options.os_url,
 | 
						|
            token=self.options.os_token,
 | 
						|
            region_name=cloud_config.get_region_name(),
 | 
						|
            api_version=cloud_config.get_api_version('network'),
 | 
						|
            service_type=cloud_config.get_service_type('network'),
 | 
						|
            service_name=cloud_config.get_service_name('network'),
 | 
						|
            endpoint_type=interface,
 | 
						|
            auth=auth,
 | 
						|
            insecure=not verify,
 | 
						|
            log_credentials=True)
 | 
						|
        return
 | 
						|
 | 
						|
    def initialize_app(self, argv):
 | 
						|
        """Global app init bits:
 | 
						|
 | 
						|
        * set up API versions
 | 
						|
        * validate authentication info
 | 
						|
        """
 | 
						|
 | 
						|
        super(NeutronShell, self).initialize_app(argv)
 | 
						|
 | 
						|
        # If the user is not asking for help, make sure they
 | 
						|
        # have given us auth.
 | 
						|
        cmd_name = None
 | 
						|
        if argv:
 | 
						|
            cmd_info = self.command_manager.find_command(argv)
 | 
						|
            cmd_factory, cmd_name, sub_argv = cmd_info
 | 
						|
        if self.interactive_mode or cmd_name != 'help':
 | 
						|
            self.authenticate_user()
 | 
						|
 | 
						|
    def configure_logging(self):
 | 
						|
        """Create logging handlers for any log output."""
 | 
						|
        root_logger = logging.getLogger('')
 | 
						|
 | 
						|
        # Set up logging to a file
 | 
						|
        root_logger.setLevel(logging.DEBUG)
 | 
						|
 | 
						|
        # Send higher-level messages to the console via stderr
 | 
						|
        console = logging.StreamHandler(self.stderr)
 | 
						|
        console_level = {self.WARNING_LEVEL: logging.WARNING,
 | 
						|
                         self.INFO_LEVEL: logging.INFO,
 | 
						|
                         self.DEBUG_LEVEL: logging.DEBUG,
 | 
						|
                         }.get(self.options.verbose_level, logging.DEBUG)
 | 
						|
        # The default log level is INFO, in this situation, set the
 | 
						|
        # log level of the console to WARNING, to avoid displaying
 | 
						|
        # useless messages. This equals using "--quiet"
 | 
						|
        if console_level == logging.INFO:
 | 
						|
            console.setLevel(logging.WARNING)
 | 
						|
        else:
 | 
						|
            console.setLevel(console_level)
 | 
						|
        if logging.DEBUG == console_level:
 | 
						|
            formatter = logging.Formatter(self.DEBUG_MESSAGE_FORMAT)
 | 
						|
        else:
 | 
						|
            formatter = logging.Formatter(self.CONSOLE_MESSAGE_FORMAT)
 | 
						|
        logging.getLogger('iso8601.iso8601').setLevel(logging.WARNING)
 | 
						|
        logging.getLogger('urllib3.connectionpool').setLevel(logging.WARNING)
 | 
						|
        console.setFormatter(formatter)
 | 
						|
        root_logger.addHandler(console)
 | 
						|
        return
 | 
						|
 | 
						|
 | 
						|
def main(argv=sys.argv[1:]):
 | 
						|
    try:
 | 
						|
        print(_("neutron CLI is deprecated and will be removed "
 | 
						|
                "in the future. Use openstack CLI instead."), file=sys.stderr)
 | 
						|
        return NeutronShell(NEUTRON_API_VERSION).run(
 | 
						|
            list(map(encodeutils.safe_decode, argv)))
 | 
						|
    except KeyboardInterrupt:
 | 
						|
        print(_("... terminating neutron client"), file=sys.stderr)
 | 
						|
        return 130
 | 
						|
    except exc.NeutronClientException:
 | 
						|
        return 1
 | 
						|
    except Exception as e:
 | 
						|
        print(e)
 | 
						|
        return 1
 | 
						|
 | 
						|
 | 
						|
if __name__ == "__main__":
 | 
						|
    sys.exit(main(sys.argv[1:]))
 |