openstack/python-openstackclient
Code Issues Proposed changes

Improve no-auth path

Browse Source 
The commands that do not require authentication sometimes still need
to call ClientManager.is_network_endpoint_enabled() to see if Neutron
is available.  Optimize the paths a bit to skip auth when it is not
necessary; the upshot is Neutron will be assumed in these cases now.

This gets a LOT cleaner when it appears is a future osc-lib.

Change-Id: Ifaddc57dfa192bde04d0482e2cdcce111313a22a
This commit is contained in:
Dean Troyer 2017-04-24 18:57:05 -05:00
parent db6081fb80
commit ef99f44462
3 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
openstackclient/common/clientmanager.py
View File

@ -41,6 +41,9 @@ class ClientManager(clientmanager.ClientManager):
# A simple incrementing version for the plugin to know what is available # A simple incrementing version for the plugin to know what is available
PLUGIN_INTERFACE_VERSION = "2" PLUGIN_INTERFACE_VERSION = "2"
# Let the commands set this
_auth_required = False
def __init__( def __init__(
self, self,
cli_options=None, cli_options=None,
@ -72,7 +75,10 @@ class ClientManager(clientmanager.ClientManager):
# because openstack_config is an optional argument to # because openstack_config is an optional argument to
# CloudConfig.__init__() and we'll die if it was not # CloudConfig.__init__() and we'll die if it was not
# passed. # passed.
if self._cli_options._openstack_config is not None: if (
self._auth_required and
self._cli_options._openstack_config is not None
):
self._cli_options._openstack_config._pw_callback = \ self._cli_options._openstack_config._pw_callback = \
shell.prompt_for_password shell.prompt_for_password
try: try:
@ -85,6 +91,13 @@ class ClientManager(clientmanager.ClientManager):
return super(ClientManager, self).setup_auth() return super(ClientManager, self).setup_auth()
@property
def auth_ref(self):
if not self._auth_required:
return None
else:
return super(ClientManager, self).auth_ref
def _fallback_load_auth_plugin(self, e): def _fallback_load_auth_plugin(self, e):
# NOTES(RuiChen): Hack to avoid auth plugins choking on data they don't # NOTES(RuiChen): Hack to avoid auth plugins choking on data they don't
# expect, delete fake token and endpoint, then try to # expect, delete fake token and endpoint, then try to

6
openstackclient/shell.py
View File

@ -182,6 +182,12 @@ class OpenStackShell(shell.OpenStackShell):
# get_one_Cloud()'s validation to avoid loading plugins # get_one_Cloud()'s validation to avoid loading plugins
validate = cmd.auth_required validate = cmd.auth_required
# Force skipping auth for commands that do not need it
# NOTE(dtroyer): This is here because ClientManager does not have
# visibility into the Command object to get
# auth_required. It needs to move into osc-lib
self.client_manager._auth_required = cmd.auth_required
# Validate auth options # Validate auth options
self.cloud = self.cloud_config.get_one_cloud( self.cloud = self.cloud_config.get_one_cloud(
cloud=self.options.cloud, cloud=self.options.cloud,

4
openstackclient/tests/unit/common/test_clientmanager.py
View File

@ -66,4 +66,6 @@ class TestClientManager(osc_lib_test_utils.TestClientManager):
) )
self.assertFalse(client_manager.is_service_available('network')) self.assertFalse(client_manager.is_service_available('network'))
self.assertFalse(client_manager.is_network_endpoint_enabled()) # This is True because ClientManager.auth_ref returns None in this
# test; "no service catalog" means use Network API by default now
self.assertTrue(client_manager.is_network_endpoint_enabled())