# 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 Heat API. """ from __future__ import print_function import argparse import logging import sys from keystoneauth1.identity import generic from keystoneauth1 import session as kssession from oslo_utils import encodeutils from oslo_utils import importutils import six import heatclient from heatclient._i18n import _ from heatclient import client as heat_client from heatclient.common import utils from heatclient import exc logger = logging.getLogger(__name__) osprofiler_profiler = importutils.try_import("osprofiler.profiler") class HeatShell(object): def _append_global_identity_args(self, parser): # FIXME(gyee): these are global identity (Keystone) arguments which # should be consistent and shared by all service clients. Therefore, # they should be provided by python-keystoneclient. We will need to # refactor this code once this functionality is available in # python-keystoneclient. parser.add_argument( '-k', '--insecure', default=False, action='store_true', help=_('Explicitly allow heatclient 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.')) parser.add_argument( '--os-cert', default=utils.env('OS_CERT'), help=_('Path of certificate file to use in SSL connection. ' 'This file can optionally be prepended with ' 'the private key.')) # for backward compatibility only parser.add_argument('--cert-file', dest='os_cert', help=_('DEPRECATED! Use %(arg)s.') % {'arg': '--os-cert'}) parser.add_argument('--os-key', default=utils.env('OS_KEY'), help=_('Path of client key to use in SSL ' 'connection. This option is not necessary ' 'if your key is prepended to your cert ' 'file.')) parser.add_argument('--key-file', dest='os_key', help=_('DEPRECATED! Use %(arg)s.') % {'arg': '--os-key'}) parser.add_argument('--os-cacert', metavar='', dest='os_cacert', default=utils.env('OS_CACERT'), help=_('Path of CA TLS certificate(s) used to ' 'verify the remote server\'s certificate. ' 'Without this option glance looks for the ' 'default system CA certificates.')) parser.add_argument('--ca-file', dest='os_cacert', help=_('DEPRECATED! Use %(arg)s.') % {'arg': '--os-cacert'}) parser.add_argument('--os-username', default=utils.env('OS_USERNAME'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_USERNAME]' }) parser.add_argument('--os_username', help=argparse.SUPPRESS) parser.add_argument('--os-user-id', default=utils.env('OS_USER_ID'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_USER_ID]' }) parser.add_argument('--os_user_id', help=argparse.SUPPRESS) parser.add_argument('--os-user-domain-id', default=utils.env('OS_USER_DOMAIN_ID'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_USER_DOMAIN_ID]' }) parser.add_argument('--os_user_domain_id', help=argparse.SUPPRESS) parser.add_argument('--os-user-domain-name', default=utils.env('OS_USER_DOMAIN_NAME'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_USER_DOMAIN_NAME]' }) parser.add_argument('--os_user_domain_name', help=argparse.SUPPRESS) parser.add_argument('--os-project-id', default=utils.env('OS_PROJECT_ID'), help=(_('Another way to specify tenant ID. ' 'This option is mutually exclusive with ' '%(arg)s. Defaults to %(value)s.') % { 'arg': '--os-tenant-id', 'value': 'env[OS_PROJECT_ID]'})) parser.add_argument('--os_project_id', help=argparse.SUPPRESS) parser.add_argument('--os-project-name', default=utils.env('OS_PROJECT_NAME'), help=(_('Another way to specify tenant name. ' 'This option is mutually exclusive with ' '%(arg)s. Defaults to %(value)s.') % { 'arg': '--os-tenant-name', 'value': 'env[OS_PROJECT_NAME]'})) parser.add_argument('--os_project_name', help=argparse.SUPPRESS) parser.add_argument('--os-project-domain-id', default=utils.env('OS_PROJECT_DOMAIN_ID'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_PROJECT_DOMAIN_ID]' }) parser.add_argument('--os_project_domain_id', help=argparse.SUPPRESS) parser.add_argument('--os-project-domain-name', default=utils.env('OS_PROJECT_DOMAIN_NAME'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_PROJECT_DOMAIN_NAME]' }) parser.add_argument('--os_project_domain_name', help=argparse.SUPPRESS) parser.add_argument('--os-password', default=utils.env('OS_PASSWORD'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_PASSWORD]' }) parser.add_argument('--os_password', help=argparse.SUPPRESS) parser.add_argument('--os-tenant-id', default=utils.env('OS_TENANT_ID'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_TENANT_ID]' }) parser.add_argument('--os_tenant_id', default=utils.env('OS_TENANT_ID'), help=argparse.SUPPRESS) parser.add_argument('--os-tenant-name', default=utils.env('OS_TENANT_NAME'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_TENANT_NAME]' }) parser.add_argument('--os_tenant_name', default=utils.env('OS_TENANT_NAME'), help=argparse.SUPPRESS) parser.add_argument('--os-auth-url', default=utils.env('OS_AUTH_URL'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_AUTH_URL]' }) parser.add_argument('--os_auth_url', help=argparse.SUPPRESS) parser.add_argument('--os-region-name', default=utils.env('OS_REGION_NAME'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_REGION_NAME]' }) parser.add_argument('--os_region_name', help=argparse.SUPPRESS) parser.add_argument('--os-auth-token', default=utils.env('OS_AUTH_TOKEN'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_AUTH_TOKEN]' }) parser.add_argument('--os_auth_token', help=argparse.SUPPRESS) parser.add_argument('--os-service-type', default=utils.env('OS_SERVICE_TYPE'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_SERVICE_TYPE]' }) parser.add_argument('--os_service_type', help=argparse.SUPPRESS) parser.add_argument('--os-endpoint-type', default=utils.env('OS_ENDPOINT_TYPE'), help=_('Defaults to %(value)s.') % { 'value': 'env[OS_ENDPOINT_TYPE]' }) parser.add_argument('--os_endpoint_type', help=argparse.SUPPRESS) def get_base_parser(self): parser = argparse.ArgumentParser( prog='heat', description=__doc__.strip(), epilog=_('See "%(arg)s" for help on a specific command.') % { 'arg': 'heat help COMMAND' }, add_help=False, formatter_class=HelpFormatter, ) # Global arguments parser.add_argument('-h', '--help', action='store_true', help=argparse.SUPPRESS) parser.add_argument('--version', action='version', version=heatclient.__version__, help=_("Shows the client version and exits.")) parser.add_argument('-d', '--debug', default=bool(utils.env('HEATCLIENT_DEBUG')), action='store_true', help=_('Defaults to %(value)s.') % { 'value': 'env[HEATCLIENT_DEBUG]' }) parser.add_argument('-v', '--verbose', default=False, action="store_true", help=_("Print more verbose output.")) parser.add_argument('--api-timeout', help=_('Number of seconds to wait for an ' 'API response, ' 'defaults to system socket timeout')) # os-no-client-auth tells heatclient to use token, instead of # env[OS_AUTH_URL] parser.add_argument('--os-no-client-auth', default=utils.env('OS_NO_CLIENT_AUTH'), action='store_true', help=(_("Do not contact keystone for a token. " "Defaults to %(value)s.") % {'value': 'env[OS_NO_CLIENT_AUTH]'})) parser.add_argument('--heat-url', default=utils.env('HEAT_URL'), help=_('Defaults to %(value)s.') % { 'value': 'env[HEAT_URL]' }) parser.add_argument('--heat_url', help=argparse.SUPPRESS) parser.add_argument('--heat-api-version', default=utils.env('HEAT_API_VERSION', default='1'), help=_('Defaults to %(value)s or 1.') % { 'value': 'env[HEAT_API_VERSION]' }) parser.add_argument('--heat_api_version', help=argparse.SUPPRESS) # This unused option should remain so that scripts that # use it do not break. It is suppressed so it will not # appear in the help. parser.add_argument('-t', '--token-only', default=bool(False), action='store_true', help=argparse.SUPPRESS) parser.add_argument('--include-password', default=bool(utils.env('HEAT_INCLUDE_PASSWORD')), action='store_true', help=_('Send %(arg1)s and %(arg2)s to heat.') % { 'arg1': 'os-username', 'arg2': 'os-password' }) # FIXME(gyee): this method should come from python-keystoneclient. # Will refactor this code once it is available. # https://bugs.launchpad.net/python-keystoneclient/+bug/1332337 self._append_global_identity_args(parser) if osprofiler_profiler: parser.add_argument( '--profile', metavar='HMAC_KEY', help=_('HMAC key to use for encrypting context data ' 'for performance profiling of operation. ' 'This key should be the value of HMAC key ' 'configured in osprofiler middleware in heat, ' 'it is specified in the paste configuration ' '(/etc/heat/api-paste.ini). Without the key, ' 'profiling will not be triggered ' 'even if osprofiler is enabled on server side.')) return parser def get_subcommand_parser(self, version): parser = self.get_base_parser() self.subcommands = {} subparsers = parser.add_subparsers(metavar='') submodule = utils.import_versioned_module(version, 'shell') self._find_actions(subparsers, submodule) self._find_actions(subparsers, self) 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=HelpFormatter ) 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 hyphen-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=HelpFormatter) 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_logging(self, debug): log_lvl = logging.DEBUG if debug else logging.WARNING logging.basicConfig( format="%(levelname)s (%(module)s) %(message)s", level=log_lvl) logging.getLogger('iso8601').setLevel(logging.WARNING) logging.getLogger('urllib3.connectionpool').setLevel(logging.WARNING) def _setup_verbose(self, verbose): if verbose: exc.verbose = 1 def _get_keystone_session(self, **kwargs): # first create a Keystone session cacert = kwargs.pop('cacert', None) cert = kwargs.pop('cert', None) key = kwargs.pop('key', None) insecure = kwargs.pop('insecure', False) timeout = kwargs.pop('timeout', None) verify = kwargs.pop('verify', None) if verify is None: if insecure: verify = False else: # TODO(gyee): should we do # heatclient.common.http.get_system_ca_fle()? verify = cacert or True if cert and key: # passing cert and key together is deprecated in favour of the # requests lib form of having the cert and key as a tuple cert = (cert, key) return kssession.Session(verify=verify, cert=cert, timeout=timeout) def main(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) self._setup_verbose(options.verbose) # build available subcommands based on version api_version = options.heat_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 not args and options.help or not argv: self.do_help(options) return 0 # Parse args again and call whatever callback was selected args = subcommand_parser.parse_args(argv) # 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.os_username and not args.os_auth_token: raise exc.CommandError(_("You must provide a username via either " "--os-username or env[OS_USERNAME] " "or a token via --os-auth-token or " "env[OS_AUTH_TOKEN]")) if not args.os_password and not args.os_auth_token: raise exc.CommandError(_("You must provide a password via either " "--os-password or env[OS_PASSWORD] " "or a token via --os-auth-token or " "env[OS_AUTH_TOKEN]")) if args.os_no_client_auth: if not args.heat_url: raise exc.CommandError(_("If you specify --os-no-client-auth " "you must also specify a Heat API " "URL via either --heat-url or " "env[HEAT_URL]")) else: # Tenant/project name or ID is needed to make keystoneclient # retrieve a service catalog, it's not required if # os_no_client_auth is specified, neither is the auth URL if not (args.os_tenant_id or args.os_tenant_name or args.os_project_id or args.os_project_name): raise exc.CommandError( _("You must provide a tenant id via either " "--os-tenant-id or env[OS_TENANT_ID] or a tenant name " "via either --os-tenant-name or env[OS_TENANT_NAME] " "or a project id via either --os-project-id or " "env[OS_PROJECT_ID] or a project name via " "either --os-project-name or env[OS_PROJECT_NAME]")) if not args.os_auth_url: raise exc.CommandError(_("You must provide an auth url via " "either --os-auth-url or via " "env[OS_AUTH_URL]")) kwargs = { 'insecure': args.insecure, 'cacert': args.os_cacert, 'cert': args.os_cert, 'key': args.os_key, 'timeout': args.api_timeout } service_type = args.os_service_type or 'orchestration' if args.os_no_client_auth: # Do not use session since no_client_auth means using heat to # to authenticate kwargs = { 'username': args.os_username, 'password': args.os_password, 'auth_url': args.os_auth_url, 'token': args.os_auth_token, 'include_pass': args.include_password, 'insecure': args.insecure, 'timeout': args.api_timeout, 'endpoint': args.heat_url } else: keystone_session = self._get_keystone_session(**kwargs) endpoint_type = args.os_endpoint_type or 'publicURL' if args.os_auth_token: kwargs = { 'token': args.os_auth_token, 'auth_url': args.os_auth_url } keystone_auth = generic.Token(**kwargs) else: project_id = args.os_project_id or args.os_tenant_id project_name = args.os_project_name or args.os_tenant_name kwargs = { 'username': args.os_username, 'user_id': args.os_user_id, 'user_domain_id': args.os_user_domain_id, 'user_domain_name': args.os_user_domain_name, 'password': args.os_password, 'auth_url': args.os_auth_url, 'project_id': project_id, 'project_name': project_name, 'project_domain_id': args.os_project_domain_id, 'project_domain_name': args.os_project_domain_name, } keystone_auth = generic.Password(**kwargs) kwargs = { 'auth_url': args.os_auth_url, 'session': keystone_session, 'auth': keystone_auth, 'service_type': service_type, 'endpoint_type': endpoint_type, 'region_name': args.os_region_name, 'username': args.os_username, 'password': args.os_password, 'include_pass': args.include_password } client = heat_client.Client(api_version, **kwargs) profile = osprofiler_profiler and options.profile if profile: osprofiler_profiler.init(options.profile) args.func(client, args) if profile: trace_id = osprofiler_profiler.get().get_base_id() print(_("Trace ID: %s") % trace_id) print(_("To display trace use next command:\n" "osprofiler trace show --html %s ") % trace_id) def do_bash_completion(self, args): """Prints all of the commands and options to stdout. The heat.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)) @utils.arg('command', metavar='', nargs='?', help=_('Display help for .')) 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() class HelpFormatter(argparse.HelpFormatter): def start_section(self, heading): # Title-case the headings heading = '%s%s' % (heading[0].upper(), heading[1:]) super(HelpFormatter, self).start_section(heading) def main(args=None): try: if args is None: args = sys.argv[1:] HeatShell().main(args) except KeyboardInterrupt: print(_("... terminating heat client"), file=sys.stderr) sys.exit(130) 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()