def _verify_extra_specs(self, extra_specs, verify_all_required=True):
if verify_all_required:
try:
share_types.get_valid_required_extra_specs(extra_specs)
except exception.InvalidExtraSpec as e:
raise webob.exc.HTTPBadRequest(explanation=six.text_type(e))
def is_valid_string(v):
return isinstance(v, six.string_types) and len(v) in range(1, 256)
def is_valid_extra_spec(k, v):
valid_extra_spec_key = is_valid_string(k)
valid_type = is_valid_string(v) or isinstance(v, bool)
valid_required_extra_spec = (
share_types.is_valid_required_extra_spec(k, v) in (None, True))
return (valid_extra_spec_key
and valid_type
and valid_required_extra_spec)
for k, v in six.iteritems(extra_specs):
if is_valid_string(k) and isinstance(v, dict):
self._verify_extra_specs(v)
elif not is_valid_extra_spec(k, v):
expl = _('Invalid extra_spec: %(key)s: %(value)s') % {
'key': k, 'value': v
}
raise webob.exc.HTTPBadRequest(explanation=expl)
def _verify_extra_specs(self, extra_specs, verify_all_required=True):
if verify_all_required:
try:
share_types.get_valid_required_extra_specs(extra_specs)
except exception.InvalidExtraSpec as e:
raise webob.exc.HTTPBadRequest(explanation=six.text_type(e))
def is_valid_string(v):
return isinstance(v, six.string_types) and len(v) in range(1, 256)
def is_valid_extra_spec(k, v):
valid_extra_spec_key = is_valid_string(k)
valid_type = is_valid_string(v) or isinstance(v, bool)
valid_required_extra_spec = (
share_types.is_valid_required_extra_spec(k, v) in (None, True))
return (valid_extra_spec_key and valid_type
and valid_required_extra_spec)
for k, v in six.iteritems(extra_specs):
if is_valid_string(k) and isinstance(v, dict):
self._verify_extra_specs(v)
elif not is_valid_extra_spec(k, v):
expl = _('Invalid extra_spec: %(key)s: %(value)s') % {
'key': k,
'value': v
}
raise webob.exc.HTTPBadRequest(explanation=expl)
def test_get_valid_required_extra_specs_valid(self, specs):
actual_result = share_types.get_valid_required_extra_specs(specs)
valid_result = {
constants.ExtraSpecs.DRIVER_HANDLES_SHARE_SERVERS: 'true'
}
self.assertEqual(valid_result, actual_result)
def test_get_valid_required_extra_specs_valid(self, optional_specs):
specs = copy.copy(self.fake_required_extra_specs)
specs.update(optional_specs)
actual_result = share_types.get_valid_required_extra_specs(specs)
self.assertEqual(self.fake_required_extra_specs, actual_result)
def test_get_valid_required_extra_specs_valid(self, optional_specs):
specs = copy.copy(self.fake_required_extra_specs)
specs.update(optional_specs)
actual_result = share_types.get_valid_required_extra_specs(specs)
self.assertEqual(self.fake_required_extra_specs, actual_result)
def _create(self, req, body, set_defaults=False):
"""Creates a new share type."""
context = req.environ['manila.context']
if (not self.is_valid_body(body, 'share_type') and
not self.is_valid_body(body, 'volume_type')):
raise webob.exc.HTTPBadRequest()
elif self.is_valid_body(body, 'share_type'):
share_type = body['share_type']
else:
share_type = body['volume_type']
name = share_type.get('name')
specs = share_type.get('extra_specs', {})
is_public = share_type.get(
'os-share-type-access:is_public',
share_type.get('share_type_access:is_public', True),
)
if name is None or name == "" or len(name) > 255:
msg = _("Type name is not valid.")
raise webob.exc.HTTPBadRequest(explanation=msg)
# Note(cknight): Set the default extra spec value for snapshot_support
# for API versions before it was required.
if set_defaults:
if constants.ExtraSpecs.SNAPSHOT_SUPPORT not in specs:
specs[constants.ExtraSpecs.SNAPSHOT_SUPPORT] = True
try:
required_extra_specs = (
share_types.get_valid_required_extra_specs(specs)
)
share_types.create(context, name, specs, is_public)
share_type = share_types.get_share_type_by_name(context, name)
share_type['required_extra_specs'] = required_extra_specs
req.cache_db_share_type(share_type)
notifier_info = dict(share_types=share_type)
rpc.get_notifier('shareType').info(
context, 'share_type.create', notifier_info)
except exception.InvalidExtraSpec as e:
raise webob.exc.HTTPBadRequest(explanation=six.text_type(e))
except exception.ShareTypeExists as err:
notifier_err = dict(share_types=share_type,
error_message=six.text_type(err))
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPConflict(explanation=six.text_type(err))
except exception.NotFound as err:
notifier_err = dict(share_types=share_type,
error_message=six.text_type(err))
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPNotFound()
return self._view_builder.show(req, share_type)
def _create(self, req, body, set_defaults=False):
"""Creates a new share type."""
context = req.environ['manila.context']
if not self.is_valid_body(body, 'share_type') and \
not self.is_valid_body(body, 'volume_type'):
raise webob.exc.HTTPBadRequest()
elif self.is_valid_body(body, 'share_type'):
share_type = body['share_type']
else:
share_type = body['volume_type']
name = share_type.get('name')
specs = share_type.get('extra_specs', {})
is_public = share_type.get(
'os-share-type-access:is_public',
share_type.get('share_type_access:is_public', True),
)
if name is None or name == "" or len(name) > 255:
msg = _("Type name is not valid.")
raise webob.exc.HTTPBadRequest(explanation=msg)
# Note(cknight): Set the default extra spec value for snapshot_support
# for API versions before it was required.
if set_defaults:
if constants.ExtraSpecs.SNAPSHOT_SUPPORT not in specs:
specs[constants.ExtraSpecs.SNAPSHOT_SUPPORT] = True
try:
required_extra_specs = (
share_types.get_valid_required_extra_specs(specs)
)
share_types.create(context, name, specs, is_public)
share_type = share_types.get_share_type_by_name(context, name)
share_type['required_extra_specs'] = required_extra_specs
req.cache_db_share_type(share_type)
notifier_info = dict(share_types=share_type)
rpc.get_notifier('shareType').info(
context, 'share_type.create', notifier_info)
except exception.InvalidExtraSpec as e:
raise webob.exc.HTTPBadRequest(explanation=six.text_type(e))
except exception.ShareTypeExists as err:
notifier_err = dict(share_types=share_type,
error_message=six.text_type(err))
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPConflict(explanation=six.text_type(err))
except exception.NotFound as err:
notifier_err = dict(share_types=share_type,
error_message=six.text_type(err))
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPNotFound()
return self._view_builder.show(req, share_type)
def _create(self, req, body):
"""Creates a new share type."""
context = req.environ['manila.context']
if not self.is_valid_body(body, 'share_type') and \
not self.is_valid_body(body, 'volume_type'):
raise webob.exc.HTTPBadRequest()
elif self.is_valid_body(body, 'share_type'):
share_type = body['share_type']
else:
share_type = body['volume_type']
name = share_type.get('name', None)
specs = share_type.get('extra_specs', {})
is_public = share_type.get(
'os-share-type-access:is_public',
share_type.get('share_type_access:is_public', True),
)
if name is None or name == "" or len(name) > 255:
msg = _("Type name is not valid.")
raise webob.exc.HTTPBadRequest(explanation=msg)
try:
required_extra_specs = (
share_types.get_valid_required_extra_specs(specs)
)
except exception.InvalidExtraSpec as e:
raise webob.exc.HTTPBadRequest(explanation=six.text_type(e))
try:
share_types.create(context, name, specs, is_public)
share_type = share_types.get_share_type_by_name(context, name)
share_type['required_extra_specs'] = required_extra_specs
req.cache_db_share_type(share_type)
notifier_info = dict(share_types=share_type)
rpc.get_notifier('shareType').info(
context, 'share_type.create', notifier_info)
except exception.ShareTypeExists as err:
notifier_err = dict(share_types=share_type,
error_message=six.text_type(err))
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPConflict(explanation=six.text_type(err))
except exception.NotFound as err:
notifier_err = dict(share_types=share_type,
error_message=six.text_type(err))
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPNotFound()
return self._view_builder.show(req, share_type)
def _show_share_type_details(self, context, id):
share_type = share_types.get_share_type(context, id)
required_extra_specs = {}
try:
required_extra_specs = share_types.get_valid_required_extra_specs(
share_type['extra_specs'])
except exception.InvalidExtraSpec:
LOG.exception('Share type %(share_type_id)s has invalid required'
' extra specs.', {'share_type_id': id})
share_type['required_extra_specs'] = required_extra_specs
return share_type
def _show_share_type_details(self, context, id):
share_type = share_types.get_share_type(context, id)
required_extra_specs = {}
try:
required_extra_specs = share_types.get_valid_required_extra_specs(
share_type['extra_specs'])
except exception.InvalidExtraSpec:
LOG.exception('Share type %(share_type_id)s has invalid required'
' extra specs.', {'share_type_id': id})
share_type['required_extra_specs'] = required_extra_specs
return share_type
def _create(self, req, body, set_defaults=False):
"""Creates a new share type."""
context = req.environ['manila.context']
if (not self.is_valid_body(body, 'share_type')
and not self.is_valid_body(body, 'volume_type')):
raise webob.exc.HTTPBadRequest()
elif self.is_valid_body(body, 'share_type'):
share_type = body['share_type']
else:
share_type = body['volume_type']
name = share_type.get('name')
specs = share_type.get('extra_specs', {})
description = share_type.get('description')
if (description and req.api_version_request <
api_version.APIVersionRequest("2.41")):
msg = _("'description' key is not supported by this "
"microversion. Use 2.41 or greater microversion "
"to be able to use 'description' in share type.")
raise webob.exc.HTTPBadRequest(explanation=msg)
is_public = share_type.get(
'os-share-type-access:is_public',
share_type.get('share_type_access:is_public', True),
)
if (name is None or name == "" or len(name) > 255
or (description and len(description) > 255)):
msg = _("Type name or description is not valid.")
raise webob.exc.HTTPBadRequest(explanation=msg)
# Note(cknight): Set the default extra spec value for snapshot_support
# for API versions before it was required.
if set_defaults:
if constants.ExtraSpecs.SNAPSHOT_SUPPORT not in specs:
specs[constants.ExtraSpecs.SNAPSHOT_SUPPORT] = True
try:
required_extra_specs = (
share_types.get_valid_required_extra_specs(specs))
share_types.create(context,
name,
specs,
is_public,
description=description)
share_type = share_types.get_share_type_by_name(context, name)
share_type['required_extra_specs'] = required_extra_specs
req.cache_db_share_type(share_type)
self._notify_share_type_info(context, 'share_type.create',
share_type)
except exception.InvalidExtraSpec as e:
raise webob.exc.HTTPBadRequest(explanation=e.message)
except exception.ShareTypeExists as err:
notifier_err = dict(share_types=share_type,
error_message=err.message)
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPConflict(explanation=err.message)
except exception.NotFound as err:
notifier_err = dict(share_types=share_type,
error_message=err.message)
self._notify_share_type_error(context, 'share_type.create',
notifier_err)
raise webob.exc.HTTPNotFound()
return self._view_builder.show(req, share_type)
