1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
# Copyright 2013 - Mirantis, Inc.
#
# 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.
import copy
import urllib
from oslo_serialization import jsonutils
from keystoneauth1 import exceptions
urlparse = urllib.parse
class Resource(object):
resource_name = 'Something'
defaults = {}
def __init__(self, manager, data):
self.manager = manager
self._data = data
self._set_defaults()
self._set_attributes()
def _set_defaults(self):
for k, v in self.defaults.items():
if k not in self._data:
self._data[k] = v
def _set_attributes(self):
for k, v in self._data.items():
try:
setattr(self, k, v)
except AttributeError:
# In this case we already defined the attribute on the class
pass
def to_dict(self):
return copy.deepcopy(self._data)
def __str__(self):
vals = ", ".join(["%s='%s'" % (n, v)
for n, v in self._data.items()])
return "%s [%s]" % (self.resource_name, vals)
def _check_items(obj, searches):
try:
return all(getattr(obj, attr) == value for (attr, value) in searches)
except AttributeError:
return False
def extract_json(response, response_key):
if response_key is not None:
return get_json(response)[response_key]
else:
return get_json(response)
class ResourceManager(object):
resource_class = None
def __init__(self, http_client):
self.http_client = http_client
def find(self, **kwargs):
return [i for i in self.list() if _check_items(i, kwargs.items())]
def list(self):
"""This is an abstract method
This is added here so that the find method gains some clarity.
It must be implemented by the child class in order to find to work
"""
raise NotImplementedError("abstract method list must be implemented")
@staticmethod
def _build_query_params(marker=None, limit=None, sort_keys=None,
sort_dirs=None, fields=None, filters=None,
scope=None, namespace=None):
qparams = {}
if marker:
qparams['marker'] = marker
if limit and limit > 0:
qparams['limit'] = limit
if sort_keys:
qparams['sort_keys'] = sort_keys
if sort_dirs:
qparams['sort_dirs'] = sort_dirs
if fields:
qparams['fields'] = ",".join(fields)
if filters:
for name, val in filters.items():
qparams[name] = val
if scope:
qparams['scope'] = scope
if namespace:
qparams['namespace'] = namespace
return ("?%s" % urlparse.urlencode(list(qparams.items()))
if qparams else "")
def _ensure_not_empty(self, **kwargs):
for name, value in kwargs.items():
if value is None or (isinstance(value, str) and len(value) == 0):
raise APIException(
400,
'%s is missing field "%s"' %
(self.resource_class.__name__, name)
)
def _validate(self, url, data, response_key=None, dump_json=True,
headers=None, is_iter_resp=False):
return self._create(url, data, response_key, dump_json,
headers, is_iter_resp, resp_status_ok=200,
as_class=False)
def _create(self, url, data, response_key=None, dump_json=True,
headers=None, is_iter_resp=False, resp_status_ok=201,
as_class=True):
if dump_json:
data = jsonutils.dumps(data)
try:
resp = self.http_client.post(url, data, headers)
except exceptions.HttpError as ex:
self._raise_api_exception(ex.response)
if resp.status_code != resp_status_ok:
self._raise_api_exception(resp)
resource = extract_json(resp, response_key)
if is_iter_resp:
return [self.resource_class(self, resource_data)
for resource_data in resource]
return self.resource_class(self, resource) if as_class else resource
def _update(self, url, data, response_key=None, dump_json=True,
headers=None, is_iter_resp=False):
if dump_json:
data = jsonutils.dumps(data)
try:
resp = self.http_client.put(url, data, headers)
except exceptions.HttpError as ex:
self._raise_api_exception(ex.response)
if resp.status_code != 200:
self._raise_api_exception(resp)
resource = extract_json(resp, response_key)
if is_iter_resp:
return [self.resource_class(self, resource_data)
for resource_data in resource]
return self.resource_class(self, resource)
def _list(self, url, response_key=None, headers=None,
returned_res_cls=None):
try:
resp = self.http_client.get(url, headers)
except exceptions.HttpError as ex:
self._raise_api_exception(ex.response)
if resp.status_code != 200:
self._raise_api_exception(resp)
resource_class = returned_res_cls or self.resource_class
return [resource_class(self, resource_data)
for resource_data in extract_json(resp, response_key)]
def _get(self, url, response_key=None, headers=None):
try:
resp = self.http_client.get(url, headers)
except exceptions.HttpError as ex:
self._raise_api_exception(ex.response)
if resp.status_code == 200:
return self.resource_class(self, extract_json(resp, response_key))
else:
self._raise_api_exception(resp)
def _delete(self, url, headers=None):
try:
resp = self.http_client.delete(url, headers)
except exceptions.HttpError as ex:
self._raise_api_exception(ex.response)
if resp.status_code != 204:
self._raise_api_exception(resp)
@staticmethod
def _raise_api_exception(resp):
try:
error_data = (resp.headers.get("Server-Error-Message", None) or
get_json(resp).get("faultstring"))
except ValueError:
error_data = resp.content
raise APIException(error_code=resp.status_code,
error_message=error_data)
def get_json(response):
"""Gets JSON representation of response.
This method provided backward compatibility with old versions
of requests library.
"""
json_field_or_function = getattr(response, 'json', None)
if callable(json_field_or_function):
return response.json()
else:
return jsonutils.loads(response.content)
class APIException(Exception):
def __init__(self, error_code=None, error_message=None):
super(APIException, self).__init__(error_message)
self.error_code = error_code
self.error_message = error_message
|