Rework clientmanager

* Add compatibility for plugin v2 interface removed from osc-lib
* ClientManager.is_network_endpoint_enabled() is wrapper for
  new is_service_available()

Change-Id: I6f26ce9e4d0702f50c7949bacfbeeb0f98cddb5d

Author: Dean Troyer

openstackclient/common/clientmanager.py

@@ -15,20 +15,13 @@
 
 """Manage access to the clients, including authenticating when needed."""
 
-import copy
 import logging
 import pkg_resources
 import sys
 
 from keystoneauth1.loading import base
 from osc_lib.api import auth
-from osc_lib import exceptions
-from oslo_utils import strutils
-import requests
-import six
-
-from openstackclient.common import session as osc_session
-from openstackclient.identity import client as identity_client
+from osc_lib import clientmanager
 
 
 LOG = logging.getLogger(__name__)
@@ -109,267 +102,44 @@ def build_auth_params(auth_plugin_name, cmd_options):
     return (auth_plugin_loader, auth_params)
 
 
-class ClientCache(object):
-    """Descriptor class for caching created client handles."""
-
-    def __init__(self, factory):
-        self.factory = factory
-        self._handle = None
-
-    def __get__(self, instance, owner):
-        # Tell the ClientManager to login to keystone
-        if self._handle is None:
-            try:
-                self._handle = self.factory(instance)
-            except AttributeError as err:
-                # Make sure the failure propagates. Otherwise, the plugin just
-                # quietly isn't there.
-                new_err = exceptions.PluginAttributeError(err)
-                six.reraise(new_err.__class__, new_err, sys.exc_info()[2])
-        return self._handle
+class ClientManager(clientmanager.ClientManager):
+    """Manages access to API clients, including authentication
 
-
-class ClientManager(object):
-    """Manages access to API clients, including authentication."""
+    Wrap osc_lib's ClientManager to maintain compatibility for the existing
+    plugin V2 interface.  Some currently private attributes become public
+    in osc-lib so we need to maintain a transition period.
+    """
 
     # A simple incrementing version for the plugin to know what is available
     PLUGIN_INTERFACE_VERSION = "2"
 
-    identity = ClientCache(identity_client.make_client)
-
-    def __getattr__(self, name):
-        # this is for the auth-related parameters.
-        if name in ['_' + o.replace('-', '_')
-                    for o in auth.OPTIONS_LIST]:
-            return self._auth_params[name[1:]]
-
-        raise AttributeError(name)
-
     def __init__(
         self,
         cli_options=None,
         api_version=None,
-        verify=True,
         pw_func=None,
     ):
-        """Set up a ClientManager
-
-        :param cli_options:
-            Options collected from the command-line, environment, or wherever
-        :param api_version:
-            Dict of API versions: key is API name, value is the version
-        :param verify:
-            TLS certificate verification; may be a boolean to enable or disable
-            server certificate verification, or a filename of a CA certificate
-            bundle to be used in verification (implies True)
-        :param pw_func:
-            Callback function for asking the user for a password.  The function
-            takes an optional string for the prompt ('Password: ' on None) and
-            returns a string containing the password
-        """
-
-        self._cli_options = cli_options
-        self._api_version = api_version
-        self._pw_callback = pw_func
-        self._url = self._cli_options.auth.get('url')
-        self._region_name = self._cli_options.region_name
-        self._interface = self._cli_options.interface
-
-        self.timing = self._cli_options.timing
-
-        self._auth_ref = None
-        self.session = None
-
-        # verify is the Requests-compatible form
-        self._verify = verify
-        # also store in the form used by the legacy client libs
-        self._cacert = None
-        if isinstance(verify, bool):
-            self._insecure = not verify
-        else:
-            self._cacert = verify
-            self._insecure = False
-
-        # Set up client certificate and key
-        # NOTE(cbrandily): This converts client certificate/key to requests
-        #                  cert argument: None (no client certificate), a path
-        #                  to client certificate or a tuple with client
-        #                  certificate/key paths.
-        self._cert = self._cli_options.cert
-        if self._cert and self._cli_options.key:
-            self._cert = self._cert, self._cli_options.key
-
-        # Get logging from root logger
-        root_logger = logging.getLogger('')
-        LOG.setLevel(root_logger.getEffectiveLevel())
-
-        # NOTE(gyee): use this flag to indicate whether auth setup has already
-        # been completed. If so, do not perform auth setup again. The reason
-        # we need this flag is that we want to be able to perform auth setup
-        # outside of auth_ref as auth_ref itself is a property. We can not
-        # retrofit auth_ref to optionally skip scope check. Some operations
-        # do not require a scoped token. In those cases, we call setup_auth
-        # prior to dereferrencing auth_ref.
-        self._auth_setup_completed = False
-
-    def _set_default_scope_options(self):
-        # TODO(mordred): This is a usability improvement that's broadly useful
-        # We should port it back up into os-client-config.
-        default_domain = self._cli_options.default_domain
-
-        # NOTE(hieulq): If USER_DOMAIN_NAME, USER_DOMAIN_ID, PROJECT_DOMAIN_ID
-        # or PROJECT_DOMAIN_NAME is present and API_VERSION is 2.0, then
-        # ignore all domain related configs.
-        if (self._api_version.get('identity') == '2.0' and
-                self.auth_plugin_name.endswith('password')):
-            domain_props = ['project_domain_name', 'project_domain_id',
-                            'user_domain_name', 'user_domain_id']
-            for prop in domain_props:
-                if self._auth_params.pop(prop, None) is not None:
-                    LOG.warning("Ignoring domain related configs " +
-                                prop + " because identity API version is 2.0")
-            return
-
-        # NOTE(aloga): The scope parameters below only apply to v3 and v3
-        # related auth plugins, so we stop the parameter checking if v2 is
-        # being used.
-        if (self._api_version.get('identity') != '3' or
-                self.auth_plugin_name.startswith('v2')):
-            return
-
-        # NOTE(stevemar): If PROJECT_DOMAIN_ID or PROJECT_DOMAIN_NAME is
-        # present, then do not change the behaviour. Otherwise, set the
-        # PROJECT_DOMAIN_ID to 'OS_DEFAULT_DOMAIN' for better usability.
-        if ('project_domain_id' in self._auth_params and
-                not self._auth_params.get('project_domain_id') and
-                not self._auth_params.get('project_domain_name')):
-            self._auth_params['project_domain_id'] = default_domain
-
-        # NOTE(stevemar): If USER_DOMAIN_ID or USER_DOMAIN_NAME is present,
-        # then do not change the behaviour. Otherwise, set the
-        # USER_DOMAIN_ID to 'OS_DEFAULT_DOMAIN' for better usability.
-        if ('user_domain_id' in self._auth_params and
-                not self._auth_params.get('user_domain_id') and
-                not self._auth_params.get('user_domain_name')):
-            self._auth_params['user_domain_id'] = default_domain
-
-    def setup_auth(self):
-        """Set up authentication
-
-        This is deferred until authentication is actually attempted because
-        it gets in the way of things that do not require auth.
-        """
-
-        if self._auth_setup_completed:
-            return
-
-        # If no auth type is named by the user, select one based on
-        # the supplied options
-        self.auth_plugin_name = select_auth_plugin(self._cli_options)
-
-        # Basic option checking to avoid unhelpful error messages
-        auth.check_valid_authentication_options(self._cli_options,
-                                                self.auth_plugin_name)
-
-        # Horrible hack alert...must handle prompt for null password if
-        # password auth is requested.
-        if (self.auth_plugin_name.endswith('password') and
-                not self._cli_options.auth.get('password')):
-            self._cli_options.auth['password'] = self._pw_callback()
-
-        (auth_plugin, self._auth_params) = build_auth_params(
-            self.auth_plugin_name,
-            self._cli_options,
+        super(ClientManager, self).__init__(
+            cli_options=cli_options,
+            api_version=api_version,
+            pw_func=pw_func,
         )
 
-        self._set_default_scope_options()
-
-        # For compatibility until all clients can be updated
-        if 'project_name' in self._auth_params:
-            self._project_name = self._auth_params['project_name']
-        elif 'tenant_name' in self._auth_params:
-            self._project_name = self._auth_params['tenant_name']
-
-        LOG.info('Using auth plugin: %s', self.auth_plugin_name)
-        LOG.debug('Using parameters %s',
-                  strutils.mask_password(self._auth_params))
-        self.auth = auth_plugin.load_from_options(**self._auth_params)
-        # needed by SAML authentication
-        request_session = requests.session()
-        self.session = osc_session.TimingSession(
-            auth=self.auth,
-            session=request_session,
-            verify=self._verify,
-            cert=self._cert,
-            user_agent=USER_AGENT,
-        )
-
-        self._auth_setup_completed = True
-
-    def validate_scope(self):
-        if self._auth_ref.project_id is not None:
-            # We already have a project scope.
-            return
-        if self._auth_ref.domain_id is not None:
-            # We already have a domain scope.
-            return
-
-        # We do not have a scoped token (and the user's default project scope
-        # was not implied), so the client needs to be explicitly configured
-        # with a scope.
-        auth.check_valid_authorization_options(self._cli_options,
-                                               self.auth_plugin_name)
-
-    @property
-    def auth_ref(self):
-        """Dereference will trigger an auth if it hasn't already"""
-        if not self._auth_ref:
-            self.setup_auth()
-            LOG.debug("Get auth_ref")
-            self._auth_ref = self.auth.get_auth_ref(self.session)
-        return self._auth_ref
+        # TODO(dtroyer): For compatibility; mark this for removal when plugin
+        #                interface v2 is removed
+        self._region_name = self.region_name
+        self._interface = self.interface
+        self._cacert = self.cacert
+        self._insecure = not self.verify
 
     def is_network_endpoint_enabled(self):
         """Check if the network endpoint is enabled"""
-        # Trigger authentication necessary to determine if the network
-        # endpoint is enabled.
-        if self.auth_ref:
-            service_catalog = self.auth_ref.service_catalog
-        else:
-            service_catalog = None
-        # Assume that the network endpoint is enabled.
-        network_endpoint_enabled = True
-        if service_catalog:
-            if 'network' in service_catalog.get_endpoints():
-                LOG.debug("Network endpoint in service catalog")
-            else:
-                LOG.debug("No network endpoint in service catalog")
-                network_endpoint_enabled = False
-        else:
-            LOG.debug("No service catalog, assuming network endpoint enabled")
-        return network_endpoint_enabled
-
-    def get_endpoint_for_service_type(self, service_type, region_name=None,
-                                      interface='public'):
-        """Return the endpoint URL for the service type."""
-        if not interface:
-            interface = 'public'
-        # See if we are using password flow auth, i.e. we have a
-        # service catalog to select endpoints from
-        if self.auth_ref:
-            endpoint = self.auth_ref.service_catalog.url_for(
-                service_type=service_type,
-                region_name=region_name,
-                interface=interface,
-            )
-        else:
-            # Get the passed endpoint directly from the auth plugin
-            endpoint = self.auth.get_endpoint(self.session,
-                                              interface=interface)
-        return endpoint
 
-    def get_configuration(self):
-        return copy.deepcopy(self._cli_options.config)
+        # NOTE(dtroyer): is_service_available() can also return None if
+        #                there is no Service Catalog, callers here are
+        #                not expecting that so fold None into True to
+        #                use Network API by default
+        return self.is_service_available('network') is not False
 
 
 # Plugin Support
@@ -391,7 +161,7 @@ def get_plugin_modules(group):
         setattr(
             ClientManager,
             module.API_NAME,
-            ClientCache(
+            clientmanager.ClientCache(
                 getattr(sys.modules[ep.module_name], 'make_client', None)
             ),
         )

openstackclient/shell.py

@@ -26,6 +26,7 @@
 from cliff import command
 from cliff import complete
 from cliff import help
+from osc_lib.cli import client_config as cloud_config
 from osc_lib.command import timing
 from osc_lib import exceptions as exc
 from osc_lib import logs
@@ -38,8 +39,6 @@
 from openstackclient.common import commandmanager
 from openstackclient.i18n import _
 
-from os_client_config import config as cloud_config
-
 osprofiler_profiler = importutils.try_import("osprofiler.profiler")
 
 
@@ -309,6 +308,9 @@ def initialize_app(self, argv):
         tenant_id = getattr(self.options, 'tenant_id', None)
         tenant_name = getattr(self.options, 'tenant_name', None)
 
+        # Save default domain
+        self.default_domain = self.options.default_domain
+
         # handle some v2/v3 authentication inconsistencies by just acting like
         # both the project and tenant information are both present. This can
         # go away if we stop registering all the argparse options together.
@@ -325,7 +327,7 @@ def initialize_app(self, argv):
         # Ignore the default value of interface. Only if it is set later
         # will it be used.
         try:
-            cc = cloud_config.OpenStackConfig(
+            cc = cloud_config.OSC_Config(
                 override_defaults={
                     'interface': None,
                     'auth_type': auth_type,
@@ -368,9 +370,6 @@ def initialize_app(self, argv):
         if self.verify and self.cloud.cacert:
             self.verify = self.cloud.cacert
 
-        # Save default domain
-        self.default_domain = self.options.default_domain
-
         # Loop through extensions to get API versions
         for mod in clientmanager.PLUGIN_MODULES:
             default_version = getattr(mod, 'DEFAULT_API_VERSION', None)
@@ -429,7 +428,6 @@ def initialize_app(self, argv):
 
         self.client_manager = clientmanager.ClientManager(
             cli_options=self.cloud,
-            verify=self.verify,
             api_version=self.api_version,
             pw_func=prompt_for_password,
         )