openstack/python-cinderclient
Code Issues Proposed changes

Replace bypass_url with os_endpoint

Browse Source 
The --bypass-url argument was removed with
I3b951cc4eb3adff23f3d2cbe674971816261ef56 so this name does not make
sense now.  Replace with os_endpoint.

Change-Id: Ifa889cc2e885e9c621c8494995b2020195b696ca
This commit is contained in:
Ian Wienand 2020-03-24 15:52:04 +11:00
parent 9c5a850f5a
commit d41d7155c0
6 changed files with 21 additions and 20 deletions

23
cinderclient/client.py

@ -277,7 +277,7 @@ class HTTPClient(object):
proxy_tenant_id=None, proxy_token=None, region_name=None,
endpoint_type='publicURL', service_type=None,
service_name=None, volume_service_name=None,
bypass_url=None, retries=None,
os_endpoint=None, retries=None,
http_log_debug=False, cacert=None,
auth_system='keystone', auth_plugin=None, api_version=None,
logger=None, user_domain_name='Default',
@ -304,11 +304,12 @@ class HTTPClient(object):
self.service_type = service_type
self.service_name = service_name
self.volume_service_name = volume_service_name
self.bypass_url = bypass_url.rstrip('/') if bypass_url else bypass_url
self.os_endpoint = os_endpoint.rstrip('/') \
if os_endpoint else os_endpoint
self.retries = int(retries or 0)
self.http_log_debug = http_log_debug
self.management_url = self.bypass_url or None
self.management_url = self.os_endpoint or None
self.auth_token = None
self.proxy_token = proxy_token
self.proxy_tenant_id = proxy_tenant_id
@ -484,7 +485,7 @@ class HTTPClient(object):
try:
version = get_volume_api_from_url(self.management_url)
except exceptions.UnsupportedVersion as e:
if self.management_url == self.bypass_url:
if self.management_url == self.os_endpoint:
msg = (_("Invalid url was specified in --os-endpoint %s")
% six.text_type(e))
else:
@ -588,8 +589,8 @@ class HTTPClient(object):
# existing token? If so, our actual endpoints may
# be different than that of the admin token.
if self.proxy_token:
if self.bypass_url:
self.set_management_url(self.bypass_url)
if self.os_endpoint:
self.set_management_url(self.os_endpoint)
else:
self._fetch_endpoints_from_auth(admin_url)
# Since keystone no longer returns the user token
@ -608,8 +609,8 @@ class HTTPClient(object):
auth_url = auth_url + '/v2.0'
self._v2_or_v3_auth(auth_url)
if self.bypass_url:
self.set_management_url(self.bypass_url)
if self.os_endpoint:
self.set_management_url(self.os_endpoint)
elif not self.management_url:
raise exceptions.Unauthorized('Cinder Client')
@ -689,7 +690,7 @@ def _construct_http_client(username=None, password=None, project_id=None,
region_name=None, endpoint_type='publicURL',
service_type='volume',
service_name=None, volume_service_name=None,
bypass_url=None, retries=None,
os_endpoint=None, retries=None,
http_log_debug=False,
auth_system='keystone', auth_plugin=None,
cacert=None, tenant_id=None,
@ -700,7 +701,7 @@ def _construct_http_client(username=None, password=None, project_id=None,
if session:
kwargs.setdefault('user_agent', 'python-cinderclient')
kwargs.setdefault('interface', endpoint_type)
kwargs.setdefault('endpoint_override', bypass_url)
kwargs.setdefault('endpoint_override', os_endpoint)
return SessionClient(session=session,
auth=auth,
@ -728,7 +729,7 @@ def _construct_http_client(username=None, password=None, project_id=None,
service_type=service_type,
service_name=service_name,
volume_service_name=volume_service_name,
bypass_url=bypass_url,
os_endpoint=os_endpoint,
retries=retries,
http_log_debug=http_log_debug,
cacert=cacert,

2
cinderclient/shell.py

@ -718,7 +718,7 @@ class OpenStackCinderShell(object):
service_type=service_type,
service_name=service_name,
volume_service_name=volume_service_name,
bypass_url=os_endpoint,
os_endpoint=os_endpoint,
retries=options.retries,
http_log_debug=args.debug,
insecure=insecure,

4
cinderclient/tests/unit/test_client.py

@ -49,10 +49,10 @@ class ClientTest(utils.TestCase):
os_endpoint = 'http://example.com/'
httpclient_mock.return_value = None
cinderclient.client._construct_http_client(
bypass_url=os_endpoint)
os_endpoint=os_endpoint)
self.assertTrue(httpclient_mock.called)
self.assertEqual(os_endpoint,
httpclient_mock.call_args[1].get('bypass_url'))
httpclient_mock.call_args[1].get('os_endpoint'))
session_mock.assert_not_called()
def test_log_req(self):

4
cinderclient/tests/unit/test_http.py

@ -110,7 +110,7 @@ def get_authed_client(retries=0, **kwargs):
def get_authed_endpoint_url(retries=0):
cl = client.HTTPClient("username", "password",
"project_id", "auth_test",
bypass_url="volume/v100/", retries=retries)
os_endpoint="volume/v100/", retries=retries)
cl.auth_token = "token"
return cl
@ -333,7 +333,7 @@ class ClientTest(utils.TestCase):
def test_os_endpoint_url(self):
cl = get_authed_endpoint_url()
self.assertEqual("volume/v100", cl.bypass_url)
self.assertEqual("volume/v100", cl.os_endpoint)
self.assertEqual("volume/v100", cl.management_url)
def test_auth_failure(self):

4
cinderclient/v2/client.py

@ -55,7 +55,7 @@ class Client(object):
proxy_tenant_id=None, proxy_token=None, region_name=None,
endpoint_type='publicURL', extensions=None,
service_type='volumev2', service_name=None,
volume_service_name=None, bypass_url=None, retries=0,
volume_service_name=None, os_endpoint=None, retries=0,
http_log_debug=False, cacert=None, auth_system='keystone',
auth_plugin=None, session=None, api_version=None,
logger=None, **kwargs):
@ -114,7 +114,7 @@ class Client(object):
service_type=service_type,
service_name=service_name,
volume_service_name=volume_service_name,
bypass_url=bypass_url,
os_endpoint=os_endpoint,
retries=retries,
http_log_debug=http_log_debug,
cacert=cacert,

4
cinderclient/v3/client.py

@ -61,7 +61,7 @@ class Client(object):
proxy_tenant_id=None, proxy_token=None, region_name=None,
endpoint_type='publicURL', extensions=None,
service_type='volumev3', service_name=None,
volume_service_name=None, bypass_url=None, retries=0,
volume_service_name=None, os_endpoint=None, retries=0,
http_log_debug=False, cacert=None, auth_system='keystone',
auth_plugin=None, session=None, api_version=None,
logger=None, **kwargs):
@ -125,7 +125,7 @@ class Client(object):
service_type=service_type,
service_name=service_name,
volume_service_name=volume_service_name,
bypass_url=bypass_url,
os_endpoint=os_endpoint,
retries=retries,
http_log_debug=http_log_debug,
cacert=cacert,