# Copyright (c) 2016 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 jsonschema
from jsonschema import exceptions as json_exceptions
from oslo_versionedobjects import fields
import semantic_version
import six
import six.moves.urllib.parse as urlparse
import six.moves.urllib.request as urlrequest
from glare.common import exception
from glare.i18n import _
[docs]class Version(fields.FieldType):
[docs] @staticmethod
def coerce(obj, field, value):
return str(semantic_version.Version.coerce(str(value)))
[docs]class VersionField(fields.AutoTypedField):
AUTO_TYPE = Version()
[docs]class BlobFieldType(fields.FieldType):
"""Blob field contains reference to blob location.
"""
BLOB_STATUS = (SAVING, ACTIVE) = ('saving', 'active')
BLOB_SCHEMA = {
'type': 'object',
'properties': {
'url': {'type': ['string', 'null'], 'format': 'uri',
'maxLength': 2048},
'size': {'type': ['number', 'null']},
'md5': {'type': ['string', 'null']},
'sha1': {'type': ['string', 'null']},
'sha256': {'type': ['string', 'null']},
'external': {'type': 'boolean'},
'id': {'type': 'string'},
'status': {'type': 'string',
'enum': list(BLOB_STATUS)},
'content_type': {'type': ['string', 'null']},
},
'required': ['url', 'size', 'md5', 'sha1', 'sha256', 'external',
'status', 'id', 'content_type']
}
[docs] @staticmethod
def coerce(obj, field, value):
"""Validate and store blob info inside oslo.vo"""
if not isinstance(value, dict):
raise ValueError(_("Blob value must be dict. Got %s type instead")
% type(value))
try:
jsonschema.validate(value, BlobFieldType.BLOB_SCHEMA)
except json_exceptions.ValidationError as e:
raise ValueError(e)
return value
[docs] @staticmethod
def to_primitive(obj, field, value):
prim = {key: val for key, val in value.items()
if key != 'id'}
if not value.get('external'):
url = '/artifacts/%(name)s/%(id)s/' % {
"name": obj.get_type_name(),
'id': obj.id
}
blob_path = field.split('[')
url = url + blob_path[0]
if len(blob_path) > 1:
url += '/%s' % blob_path[1][1:-2]
prim['url'] = url
return prim
[docs]class BlobField(fields.AutoTypedField):
AUTO_TYPE = BlobFieldType()
[docs]class LinkFieldType(fields.FieldType):
"""Link field specifies Artifact dependency on other artifact or some
external resource. From technical perspective it is just soft link to Glare
Artifact or https/http resource. So Artifact users can download the
referenced file by that link.
"""
[docs] @staticmethod
def is_external(link):
return link.startswith('http')
[docs] @staticmethod
def get_type_name(link):
url = link.split('/')
if len(url) == 4:
return url[2]
else:
raise ValueError(_("It is not possible to "
"extract type_name from link %s"), link)
[docs] @staticmethod
def coerce(obj, field, value):
# to remove the existing link user sets its value to None,
# we have to consider this case.
if value is None:
return value
# check that value is string
if not isinstance(value, six.string_types):
raise ValueError(_('A string is required in field %(field)s, '
'not a %(type)s') %
{'field': field, 'type': type(value).__name__})
# determine if link is external or internal
external = LinkFieldType.is_external(value)
# validate link itself
if external:
link = urlparse.urlparse(value)
if link.scheme not in ('http', 'https'):
raise ValueError(_('Only http and https requests '
'are allowed in url %s') % value)
try:
with urlrequest.urlopen(value) as data:
data.read(1)
except Exception:
raise ValueError(
_('Link %(link)s is not valid in field '
'%(field)s. The link must be either valid url or '
'reference to artifact. Example: '
'http://glarehost:9494/artifacts/<artifact_type>/'
'<artifact_id>'
) % {'link': value, 'field': field})
else:
result = value.split('/')
if len(result) != 4 or result[1] != 'artifacts':
raise ValueError(
_('Link %(link)s is not valid in field '
'%(field)s. The link must be either valid url or '
'reference to artifact. Example: '
'/artifacts/<artifact_type>/<artifact_id>'
) % {'link': value, 'field': field})
# try to find the referenced artifact
try:
obj.db_api.get(obj.obj_context, None, result[3])
except exception.NotFound:
raise ValueError(
_("Link %(link)s is not valid in field %(field)s, because "
"artifact with id %(art_id)s doesn't exist"
) % {'link': value, 'field': field, 'art_id': result[3]}
)
return value
[docs]class Link(fields.AutoTypedField):
AUTO_TYPE = LinkFieldType()
[docs]class List(fields.AutoTypedField):
def __init__(self, element_type, **kwargs):
self.AUTO_TYPE = fields.List(element_type())
super(List, self).__init__(**kwargs)
[docs]class Dict(fields.AutoTypedField):
def __init__(self, element_type, **kwargs):
self.AUTO_TYPE = fields.Dict(element_type())
super(Dict, self).__init__(**kwargs)