d08c7ffe52
The Python 2 urllib and urllib2 modules changed a lot in Python 3. On Python 3, the urllib functions are now grouped into submodules of urllib: urllib.parse, urllib.error, etc. The urllib2 has been removed. Replace urllib and urllib2 with six.moves.urllib to make the Cinder code compatible with Python 2 and Python 3. The new code now looks like Python 3 code (ex: "urllib.parse.urlsplit"), but it also works on Python 2. Replace also "import six.moves.urllib.parse as urlparse" with "from six.moves import urllib" to uniformize the code: "urlparse.urlsplit(href)" becomes "urllib.parse.urlsplit(href)". This patch was generated by the urllib operation of the sixer tool version 0.4: https://pypi.python.org/pypi/sixer Manual changes: * Add a try/except ImportError to get the parse_http_list function in cinder/api/urlmap.py * Import the socket module instead of using urllib2.socket in cinder/volume/drivers/huawei/rest_common.py * test_nimble.py: replace NIMBLE_URLLIB2 value with 'six.moves.urllib.request' * Remove "from six.moves.urllib import parse as urlparse", it was replaced with urllib.parse from six.moves. * Reformat to respect the 80 columns constraint Change-Id: Ibd1e7bc83bbbd93a3634207fb277d25ef1b8a086
218 lines
7.7 KiB
Python
218 lines
7.7 KiB
Python
# Copyright (c) 2011 Justin Santa Barbara
|
|
#
|
|
# 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.
|
|
|
|
from oslo_log import log as logging
|
|
from oslo_serialization import jsonutils
|
|
from oslo_utils import netutils
|
|
import requests
|
|
from six.moves import urllib
|
|
|
|
from cinder.i18n import _, _LI
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class OpenStackApiException(Exception):
|
|
def __init__(self, message=None, response=None):
|
|
self.response = response
|
|
if not message:
|
|
message = 'Unspecified error'
|
|
|
|
if response:
|
|
message = _('%(message)s\nStatus Code: %(_status)s\n'
|
|
'Body: %(_body)s') % {'_status': response.status_code,
|
|
'_body': response.text}
|
|
|
|
super(OpenStackApiException, self).__init__(message)
|
|
|
|
|
|
class OpenStackApiAuthenticationException(OpenStackApiException):
|
|
def __init__(self, response=None, message=None):
|
|
if not message:
|
|
message = _("Authentication error")
|
|
super(OpenStackApiAuthenticationException, self).__init__(message,
|
|
response)
|
|
|
|
|
|
class OpenStackApiAuthorizationException(OpenStackApiException):
|
|
def __init__(self, response=None, message=None):
|
|
if not message:
|
|
message = _("Authorization error")
|
|
super(OpenStackApiAuthorizationException, self).__init__(message,
|
|
response)
|
|
|
|
|
|
class OpenStackApiNotFoundException(OpenStackApiException):
|
|
def __init__(self, response=None, message=None):
|
|
if not message:
|
|
message = _("Item not found")
|
|
super(OpenStackApiNotFoundException, self).__init__(message, response)
|
|
|
|
|
|
class TestOpenStackClient(object):
|
|
"""Simple OpenStack API Client.
|
|
|
|
This is a really basic OpenStack API client that is under our control,
|
|
so we can make changes / insert hooks for testing
|
|
|
|
"""
|
|
|
|
def __init__(self, auth_user, auth_key, auth_uri):
|
|
super(TestOpenStackClient, self).__init__()
|
|
self.auth_result = None
|
|
self.auth_user = auth_user
|
|
self.auth_key = auth_key
|
|
self.auth_uri = auth_uri
|
|
# default project_id
|
|
self.project_id = 'openstack'
|
|
|
|
def request(self, url, method='GET', body=None, headers=None,
|
|
ssl_verify=True, stream=False):
|
|
_headers = {'Content-Type': 'application/json'}
|
|
_headers.update(headers or {})
|
|
|
|
parsed_url = urllib.parse.urlparse(url)
|
|
port = parsed_url.port
|
|
hostname = parsed_url.hostname
|
|
scheme = parsed_url.scheme
|
|
|
|
if netutils.is_valid_ipv6(hostname):
|
|
hostname = "[%s]" % hostname
|
|
|
|
relative_url = parsed_url.path
|
|
if parsed_url.query:
|
|
relative_url = relative_url + "?" + parsed_url.query
|
|
LOG.info(_LI("Doing %(method)s on %(relative_url)s"),
|
|
{'method': method, 'relative_url': relative_url})
|
|
if body:
|
|
LOG.info(_LI("Body: %s") % body)
|
|
|
|
if port:
|
|
_url = "%s://%s:%d%s" % (scheme, hostname, int(port), relative_url)
|
|
else:
|
|
_url = "%s://%s%s" % (scheme, hostname, relative_url)
|
|
|
|
response = requests.request(method, _url, data=body, headers=_headers,
|
|
verify=ssl_verify, stream=stream)
|
|
|
|
return response
|
|
|
|
def _authenticate(self):
|
|
if self.auth_result:
|
|
return self.auth_result
|
|
|
|
auth_uri = self.auth_uri
|
|
headers = {'X-Auth-User': self.auth_user,
|
|
'X-Auth-Key': self.auth_key,
|
|
'X-Auth-Project-Id': self.project_id}
|
|
response = self.request(auth_uri,
|
|
headers=headers)
|
|
|
|
http_status = response.status_code
|
|
LOG.debug("%(auth_uri)s => code %(http_status)s",
|
|
{'auth_uri': auth_uri, 'http_status': http_status})
|
|
|
|
if http_status == 401:
|
|
raise OpenStackApiAuthenticationException(response=response)
|
|
|
|
self.auth_result = response.headers
|
|
return self.auth_result
|
|
|
|
def api_request(self, relative_uri, check_response_status=None, **kwargs):
|
|
auth_result = self._authenticate()
|
|
|
|
# NOTE(justinsb): httplib 'helpfully' converts headers to lower case
|
|
base_uri = auth_result['x-server-management-url']
|
|
|
|
full_uri = '%s/%s' % (base_uri, relative_uri)
|
|
|
|
headers = kwargs.setdefault('headers', {})
|
|
headers['X-Auth-Token'] = auth_result['x-auth-token']
|
|
|
|
response = self.request(full_uri, **kwargs)
|
|
|
|
http_status = response.status_code
|
|
LOG.debug("%(relative_uri)s => code %(http_status)s",
|
|
{'relative_uri': relative_uri, 'http_status': http_status})
|
|
|
|
if check_response_status:
|
|
if http_status not in check_response_status:
|
|
if http_status == 404:
|
|
raise OpenStackApiNotFoundException(response=response)
|
|
elif http_status == 401:
|
|
raise OpenStackApiAuthorizationException(response=response)
|
|
else:
|
|
raise OpenStackApiException(
|
|
message=_("Unexpected status code"),
|
|
response=response)
|
|
|
|
return response
|
|
|
|
def _decode_json(self, response):
|
|
body = response.text
|
|
LOG.debug("Decoding JSON: %s" % (body))
|
|
if body:
|
|
return jsonutils.loads(body)
|
|
else:
|
|
return ""
|
|
|
|
def api_get(self, relative_uri, **kwargs):
|
|
kwargs.setdefault('check_response_status', [200])
|
|
response = self.api_request(relative_uri, **kwargs)
|
|
return self._decode_json(response)
|
|
|
|
def api_post(self, relative_uri, body, **kwargs):
|
|
kwargs['method'] = 'POST'
|
|
if body:
|
|
headers = kwargs.setdefault('headers', {})
|
|
headers['Content-Type'] = 'application/json'
|
|
kwargs['body'] = jsonutils.dumps(body)
|
|
|
|
kwargs.setdefault('check_response_status', [200, 202])
|
|
response = self.api_request(relative_uri, **kwargs)
|
|
return self._decode_json(response)
|
|
|
|
def api_put(self, relative_uri, body, **kwargs):
|
|
kwargs['method'] = 'PUT'
|
|
if body:
|
|
headers = kwargs.setdefault('headers', {})
|
|
headers['Content-Type'] = 'application/json'
|
|
kwargs['body'] = jsonutils.dumps(body)
|
|
|
|
kwargs.setdefault('check_response_status', [200, 202, 204])
|
|
response = self.api_request(relative_uri, **kwargs)
|
|
return self._decode_json(response)
|
|
|
|
def api_delete(self, relative_uri, **kwargs):
|
|
kwargs['method'] = 'DELETE'
|
|
kwargs.setdefault('check_response_status', [200, 202, 204])
|
|
return self.api_request(relative_uri, **kwargs)
|
|
|
|
def get_volume(self, volume_id):
|
|
return self.api_get('/volumes/%s' % volume_id)['volume']
|
|
|
|
def get_volumes(self, detail=True):
|
|
rel_url = '/volumes/detail' if detail else '/volumes'
|
|
return self.api_get(rel_url)['volumes']
|
|
|
|
def post_volume(self, volume):
|
|
return self.api_post('/volumes', volume)['volume']
|
|
|
|
def delete_volume(self, volume_id):
|
|
return self.api_delete('/volumes/%s' % volume_id)
|
|
|
|
def put_volume(self, volume_id, volume):
|
|
return self.api_put('/volumes/%s' % volume_id, volume)['volume']
|