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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
# Copyright (c) 2015 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.
from glanceclient.common import utils
from glanceclient import exc
from oslo_utils import encodeutils
from urllib import parse
from muranoclient.glance import ArtifactType
glare_urls = {
'create': '/v{version}/artifacts/{type_name}/v{type_version}/drafts',
'update_get_delete': '/v{version}/artifacts/{type_name}/v{type_version}'
'/{artifact_id}',
'list_drafts': '/v{version}/artifacts/{type_name}/v{type_version}/drafts?',
'list_no_drafts': '/v{version}/artifacts/{type_name}/v{type_version}?',
'publish': '/v{version}/artifacts/{type_name}/v{type_version}/'
'{artifact_id}/publish',
'blob': '/v{version}/artifacts/{type_name}/v{type_version}/{artifact_id}'
'/{blob_property}',
}
class Controller(object):
def __init__(self, http_client, type_name=None, type_version=None,
version='0.1'):
self.http_client = http_client
self.type_name = type_name
self.type_version = type_version
self.version = version
self.default_page_size = 20
self.sort_dir_values = ('asc', 'desc')
def _check_type_params(self, type_name, type_version):
"""Check that type name and type versions were specified"""
type_name = type_name or self.type_name
type_version = type_version or self.type_version
if type_name is None:
msg = "Type name must be specified"
raise exc.HTTPBadRequest(msg)
if type_version is None:
msg = "Type version must be specified"
raise exc.HTTPBadRequest(msg)
return type_name, type_version
def _validate_sort_param(self, sort):
"""Validates sorting argument for invalid keys and directions values.
:param sort: comma-separated list of sort keys with optional <:dir>
after each key
"""
for sort_param in sort.strip().split(','):
key, _sep, dir = sort_param.partition(':')
if dir and dir not in self.sort_dir_values:
msg = ('Invalid sort direction: %(sort_dir)s.'
' It must be one of the following: %(available)s.'
) % {'sort_dir': dir,
'available': ', '.join(self.sort_dir_values)}
raise exc.HTTPBadRequest(msg)
return sort
def create(self, name, version, type_name=None, type_version=None,
**kwargs):
"""Create an artifact of given type and version.
:param name: name of creating artifact.
:param version: semver string describing an artifact version
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
kwargs.update({'name': name, 'version': version})
url = glare_urls['create'].format(version=self.version,
type_name=type_name,
type_version=type_version)
resp, body = self.http_client.post(url, data=kwargs)
return ArtifactType(**body)
def update(self, artifact_id, type_name=None, type_version=None,
remove_props=None, **kwargs):
"""Update attributes of an artifact.
:param artifact_id: ID of the artifact to modify.
:param remove_props: List of property names to remove
:param **kwargs: Artifact attribute names and their new values.
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
url = glare_urls['update_get_delete'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id)
hdrs = {
'Content-Type': 'application/openstack-images-v2.1-json-patch'}
artifact_obj = self.get(artifact_id, type_name, type_version)
changes = []
if remove_props:
for prop in remove_props:
if prop in ArtifactType.generic_properties:
msg = "Generic properties cannot be removed"
raise exc.HTTPBadRequest(msg)
if prop not in kwargs:
changes.append({'op': 'remove',
'path': '/' + prop})
for prop in kwargs:
if prop in artifact_obj.generic_properties:
op = 'add' if getattr(artifact_obj,
prop) is None else 'replace'
elif prop in artifact_obj.type_specific_properties:
if artifact_obj.type_specific_properties[prop] is None:
op = 'add'
else:
op = 'replace'
else:
msg = ("Property '%s' doesn't exist in type '%s' with version"
" '%s'" % (prop, type_name, type_version))
raise exc.HTTPBadRequest(msg)
changes.append({'op': op, 'path': '/' + prop,
'value': kwargs[prop]})
resp, body = self.http_client.patch(url, headers=hdrs, data=changes)
return ArtifactType(**body)
def get(self, artifact_id, type_name=None, type_version=None,
show_level=None):
"""Get information about an artifact.
:param artifact_id: ID of the artifact to get.
:param show_level: value of datalization. Possible values:
"none", "basic", "direct", "transitive"
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
url = glare_urls['update_get_delete'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id)
if show_level:
if show_level not in ArtifactType.supported_show_levels:
msg = "Invalid show level: %s" % show_level
raise exc.HTTPBadRequest(msg)
url += '?show_level=%s' % show_level
resp, body = self.http_client.get(url)
return ArtifactType(**body)
def list(self, **kwargs):
return self._list(drafts=False, **kwargs)
def drafts(self, **kwargs):
return self._list(drafts=True, **kwargs)
def _list(self, drafts, type_name=None, type_version=None, **kwargs):
"""Retrieve a listing of Image objects.
:param page_size: Number of images to request in each
paginated request.
:returns: generator over list of artifacts.
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
limit = kwargs.get('limit')
page_size = kwargs.get('page_size') or self.default_page_size
def paginate(url, page_size, limit=None):
next_url = url
while True:
if limit and page_size > limit:
next_url = next_url.replace("limit=%s" % page_size,
"limit=%s" % limit)
resp, body = self.http_client.get(next_url)
for artifact in body['artifacts']:
yield ArtifactType(**artifact)
if limit:
limit -= 1
if limit <= 0:
raise StopIteration
try:
next_url = body['next']
except KeyError:
return
filters = kwargs.get('filters', {})
filters['limit'] = page_size
url_params = []
for param, items in filters.items():
values = [items] if not isinstance(items, list) else items
for value in values:
if isinstance(value, str):
value = encodeutils.safe_encode(value)
url_params.append({param: value})
if drafts:
url = glare_urls['list_drafts'].format(version=self.version,
type_name=type_name,
type_version=type_version)
else:
url = glare_urls['list_no_drafts'].format(
version=self.version,
type_name=type_name,
type_version=type_version
)
for param in url_params:
url = '%s&%s' % (url, parse.urlencode(param))
if 'sort' in kwargs:
url = '%s&sort=%s' % (url, self._validate_sort_param(
kwargs['sort']))
for artifact in paginate(url, page_size, limit):
yield artifact
def active(self, artifact_id, type_name=None, type_version=None):
"""Set artifact status to 'active'.
:param artifact_id: ID of the artifact to get.
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
url = glare_urls['publish'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id)
resp, body = self.http_client.post(url)
return ArtifactType(**body)
def deactivate(self, artifact_id, type_name=None, type_version=None):
raise NotImplementedError()
def delete(self, artifact_id, type_name=None, type_version=None):
"""Delete an artifact and all its data.
:param artifact_id: ID of the artifact to delete.
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
url = glare_urls['update_get_delete'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id)
self.http_client.delete(url)
def upload_blob(self, artifact_id, blob_property, data, position=None,
type_name=None, type_version=None):
"""Upload blob data.
:param artifact_id: ID of the artifact to download a blob
:param blob_property: blob property name
:param position: if blob_property is a list then the
position must be specified
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
hdrs = {'Content-Type': 'application/octet-stream'}
url = glare_urls['blob'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id,
blob_property=blob_property)
if position:
url += "/%s" % position
self.http_client.put(url, headers=hdrs, data=data)
def download_blob(self, artifact_id, blob_property, position=None,
type_name=None, type_version=None, do_checksum=True):
"""Get blob data.
:param artifact_id: ID of the artifact to download a blob
:param blob_property: blob property name
:param position: if blob_property is a list then the
position must be specified
:param do_checksum: Enable/disable checksum validation.
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
url = glare_urls['blob'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id,
blob_property=blob_property)
if position:
url += '/%s' % position
url += '/download'
resp, body = self.http_client.get(url)
checksum = resp.headers.get('content-md5', None)
content_length = int(resp.headers.get('content-length', 0))
if checksum is not None and do_checksum:
body = utils.integrity_iter(body, checksum)
return utils.IterableWithLength(body, content_length)
def delete_blob(self, artifact_id, blob_property, position=None,
type_name=None, type_version=None):
"""Delete blob and related data.
:param artifact_id: ID of the artifact to delete a blob
:param blob_property: blob property name
:param position: if blob_property is a list then the
position must be specified
"""
type_name, type_version = self._check_type_params(type_name,
type_version)
url = glare_urls['blob'].format(version=self.version,
type_name=type_name,
type_version=type_version,
artifact_id=artifact_id,
blob_property=blob_property)
if position:
url += '/%s' % position
self.http_client.delete(url)
def add_property(self, artifact_id, dependency_id, position=None,
type_name=None, type_version=None):
raise NotImplementedError()
def replace_property(self, artifact_id, dependency_id, position=None,
type_name=None, type_version=None):
raise NotImplementedError()
def remove_property(self, artifact_id, dependency_id, position=None,
type_name=None, type_version=None):
raise NotImplementedError()
def artifact_export(self, artifact_id,
type_name=None, type_version=None):
raise NotImplementedError()
def artifact_import(self, data, type_name=None, type_version=None):
raise NotImplementedError()
|