def update(self, req, id, body):
"""Update a share."""
context = req.environ['manila.context']
if not body or 'share' not in body:
raise exc.HTTPUnprocessableEntity()
share_data = body['share']
valid_update_keys = (
'display_name',
'display_description',
'is_public',
)
update_dict = {key: share_data[key]
for key in valid_update_keys
if key in share_data}
try:
share = self.share_api.get(context, id)
except exception.NotFound:
raise exc.HTTPNotFound()
update_dict = common.validate_public_share_policy(
context, update_dict, api='update')
share = self.share_api.update(context, share, update_dict)
share.update(update_dict)
return self._view_builder.detail(req, share)
def update(self, req, id, body):
"""Update a share."""
context = req.environ['manila.context']
if not body or 'share' not in body:
raise exc.HTTPUnprocessableEntity()
share_data = body['share']
valid_update_keys = (
'display_name',
'display_description',
'is_public',
)
update_dict = {
key: share_data[key]
for key in valid_update_keys if key in share_data
}
try:
share = self.share_api.get(context, id)
except exception.NotFound:
raise exc.HTTPNotFound()
update_dict = common.validate_public_share_policy(context,
update_dict,
api='update')
share = self.share_api.update(context, share, update_dict)
share.update(update_dict)
return self._view_builder.detail(req, share)
def test_validate_public_share_policy_no_is_public(self):
api_params = {'foo': 'bar', 'clemson': 'tigers'}
self.mock_object(policy, 'check_policy')
actual_params = common.validate_public_share_policy(
'fake_context', api_params)
self.assertDictMatch(api_params, actual_params)
policy.check_policy.assert_not_called()
def test_validate_public_share_policy_no_is_public(self):
api_params = {'foo': 'bar', 'clemson': 'tigers'}
self.mock_object(policy, 'check_policy')
actual_params = common.validate_public_share_policy(
'fake_context', api_params)
self.assertDictMatch(api_params, actual_params)
policy.check_policy.assert_not_called()
def test_validate_public_share_is_public_True(self, is_public):
api_params = {'is_public': is_public, 'size': '16'}
self.mock_object(policy, 'check_policy', mock.Mock(return_value=True))
actual_params = common.validate_public_share_policy(
'fake_context', api_params, api='update')
self.assertDictMatch({'is_public': True, 'size': '16'}, actual_params)
policy.check_policy.assert_called_once_with(
'fake_context', 'share', 'set_public_share', do_raise=False)
def test_validate_public_share_is_public_True(self, is_public):
api_params = {'is_public': is_public, 'size': '16'}
self.mock_object(policy, 'check_policy', mock.Mock(return_value=True))
actual_params = common.validate_public_share_policy('fake_context',
api_params,
api='update')
self.assertDictMatch({'is_public': True, 'size': '16'}, actual_params)
policy.check_policy.assert_called_once_with('fake_context',
'share',
'set_public_share',
do_raise=False)
def _manage(self, req, body, allow_dhss_true=False):
context = req.environ['manila.context']
share_data = self._validate_manage_parameters(context, body)
share_data = common.validate_public_share_policy(context, share_data)
# NOTE(vponomaryov): compatibility actions are required between API and
# DB layers for 'name' and 'description' API params that are
# represented in DB as 'display_name' and 'display_description'
# appropriately.
name = share_data.get('display_name', share_data.get('name'))
description = share_data.get('display_description',
share_data.get('description'))
share = {
'host': share_data['service_host'],
'export_location_path': share_data['export_path'],
'share_proto': share_data['protocol'].upper(),
'share_type_id': share_data['share_type_id'],
'display_name': name,
'display_description': description,
}
if share_data.get('is_public') is not None:
share['is_public'] = share_data['is_public']
driver_options = share_data.get('driver_options', {})
if allow_dhss_true:
share['share_server_id'] = share_data.get('share_server_id')
try:
share_ref = self.share_api.manage(context, share, driver_options)
except exception.PolicyNotAuthorized as e:
raise exc.HTTPForbidden(explanation=e.msg)
except (exception.InvalidShare, exception.InvalidShareServer) as e:
raise exc.HTTPConflict(explanation=e.msg)
except exception.InvalidInput as e:
raise exc.HTTPBadRequest(explanation=e.msg)
return self._view_builder.detail(req, share_ref)
def _create(self, req, body,
check_create_share_from_snapshot_support=False,
check_availability_zones_extra_spec=False):
"""Creates a new share."""
context = req.environ['manila.context']
if not self.is_valid_body(body, 'share'):
raise exc.HTTPUnprocessableEntity()
share = body['share']
share = common.validate_public_share_policy(context, share)
# NOTE(rushiagr): Manila API allows 'name' instead of 'display_name'.
if share.get('name'):
share['display_name'] = share.get('name')
del share['name']
# NOTE(rushiagr): Manila API allows 'description' instead of
# 'display_description'.
if share.get('description'):
share['display_description'] = share.get('description')
del share['description']
size = share['size']
share_proto = share['share_proto'].upper()
msg = ("Create %(share_proto)s share of %(size)s GB" %
{'share_proto': share_proto, 'size': size})
LOG.info(msg, context=context)
availability_zone_id = None
availability_zone = share.get('availability_zone')
if availability_zone:
try:
availability_zone_id = db.availability_zone_get(
context, availability_zone).id
except exception.AvailabilityZoneNotFound as e:
raise exc.HTTPNotFound(explanation=six.text_type(e))
share_group_id = share.get('share_group_id')
if share_group_id:
try:
share_group = db.share_group_get(context, share_group_id)
except exception.ShareGroupNotFound as e:
raise exc.HTTPNotFound(explanation=six.text_type(e))
sg_az_id = share_group['availability_zone_id']
if availability_zone and availability_zone_id != sg_az_id:
msg = _("Share cannot have AZ ('%(s_az)s') different than "
"share group's one (%(sg_az)s).") % {
's_az': availability_zone_id, 'sg_az': sg_az_id}
raise exception.InvalidInput(msg)
availability_zone_id = sg_az_id
kwargs = {
'availability_zone': availability_zone_id,
'metadata': share.get('metadata'),
'is_public': share.get('is_public', False),
'share_group_id': share_group_id,
}
snapshot_id = share.get('snapshot_id')
if snapshot_id:
snapshot = self.share_api.get_snapshot(context, snapshot_id)
else:
snapshot = None
kwargs['snapshot_id'] = snapshot_id
share_network_id = share.get('share_network_id')
parent_share_type = {}
if snapshot:
# Need to check that share_network_id from snapshot's
# parents share equals to share_network_id from args.
# If share_network_id is empty then update it with
# share_network_id of parent share.
parent_share = self.share_api.get(context, snapshot['share_id'])
parent_share_net_id = parent_share.instance['share_network_id']
parent_share_type = share_types.get_share_type(
context, parent_share.instance['share_type_id'])
if share_network_id:
if share_network_id != parent_share_net_id:
msg = ("Share network ID should be the same as snapshot's"
" parent share's or empty")
raise exc.HTTPBadRequest(explanation=msg)
elif parent_share_net_id:
share_network_id = parent_share_net_id
# Verify that share can be created from a snapshot
if (check_create_share_from_snapshot_support and
not parent_share['create_share_from_snapshot_support']):
msg = (_("A new share may not be created from snapshot '%s', "
"because the snapshot's parent share does not have "
"that capability.")
% snapshot_id)
LOG.error(msg)
raise exc.HTTPBadRequest(explanation=msg)
if share_network_id:
try:
self.share_api.get_share_network(
context,
share_network_id)
except exception.ShareNetworkNotFound as e:
raise exc.HTTPNotFound(explanation=six.text_type(e))
kwargs['share_network_id'] = share_network_id
display_name = share.get('display_name')
display_description = share.get('display_description')
if 'share_type' in share and 'volume_type' in share:
msg = 'Cannot specify both share_type and volume_type'
raise exc.HTTPBadRequest(explanation=msg)
req_share_type = share.get('share_type', share.get('volume_type'))
share_type = None
if req_share_type:
try:
if not uuidutils.is_uuid_like(req_share_type):
share_type = share_types.get_share_type_by_name(
context, req_share_type)
else:
share_type = share_types.get_share_type(
context, req_share_type)
except exception.ShareTypeNotFound:
msg = _("Share type not found.")
raise exc.HTTPNotFound(explanation=msg)
elif not snapshot:
def_share_type = share_types.get_default_share_type()
if def_share_type:
share_type = def_share_type
# Only use in create share feature. Create share from snapshot
# and create share with share group features not
# need this check.
if (not share_network_id and not snapshot
and not share_group_id
and share_type and share_type.get('extra_specs')
and (strutils.bool_from_string(share_type.get('extra_specs').
get('driver_handles_share_servers')))):
msg = _('Share network must be set when the '
'driver_handles_share_servers is true.')
raise exc.HTTPBadRequest(explanation=msg)
type_chosen = share_type or parent_share_type
if type_chosen and check_availability_zones_extra_spec:
type_azs = type_chosen.get(
'extra_specs', {}).get('availability_zones', '')
type_azs = type_azs.split(',') if type_azs else []
kwargs['availability_zones'] = type_azs
if (availability_zone and type_azs and
availability_zone not in type_azs):
msg = _("Share type %(type)s is not supported within the "
"availability zone chosen %(az)s.")
type_chosen = (
req_share_type or "%s (from source snapshot)" % (
parent_share_type.get('name') or
parent_share_type.get('id'))
)
payload = {'type': type_chosen, 'az': availability_zone}
raise exc.HTTPBadRequest(explanation=msg % payload)
if share_type:
kwargs['share_type'] = share_type
new_share = self.share_api.create(context,
share_proto,
size,
display_name,
display_description,
**kwargs)
return self._view_builder.detail(req, new_share)
def _create(self,
req,
body,
check_create_share_from_snapshot_support=False,
check_availability_zones_extra_spec=False):
"""Creates a new share."""
context = req.environ['manila.context']
if not self.is_valid_body(body, 'share'):
raise exc.HTTPUnprocessableEntity()
share = body['share']
share = common.validate_public_share_policy(context, share)
# NOTE(rushiagr): Manila API allows 'name' instead of 'display_name'.
if share.get('name'):
share['display_name'] = share.get('name')
del share['name']
# NOTE(rushiagr): Manila API allows 'description' instead of
# 'display_description'.
if share.get('description'):
share['display_description'] = share.get('description')
del share['description']
size = share['size']
share_proto = share['share_proto'].upper()
msg = ("Create %(share_proto)s share of %(size)s GB" % {
'share_proto': share_proto,
'size': size
})
LOG.info(msg, context=context)
availability_zone_id = None
availability_zone = share.get('availability_zone')
if availability_zone:
try:
availability_zone_id = db.availability_zone_get(
context, availability_zone).id
except exception.AvailabilityZoneNotFound as e:
raise exc.HTTPNotFound(explanation=six.text_type(e))
share_group_id = share.get('share_group_id')
if share_group_id:
try:
share_group = db.share_group_get(context, share_group_id)
except exception.ShareGroupNotFound as e:
raise exc.HTTPNotFound(explanation=six.text_type(e))
sg_az_id = share_group['availability_zone_id']
if availability_zone and availability_zone_id != sg_az_id:
msg = _("Share cannot have AZ ('%(s_az)s') different than "
"share group's one (%(sg_az)s).") % {
's_az': availability_zone_id,
'sg_az': sg_az_id
}
raise exception.InvalidInput(msg)
availability_zone_id = sg_az_id
kwargs = {
'availability_zone': availability_zone_id,
'metadata': share.get('metadata'),
'is_public': share.get('is_public', False),
'share_group_id': share_group_id,
}
snapshot_id = share.get('snapshot_id')
if snapshot_id:
snapshot = self.share_api.get_snapshot(context, snapshot_id)
else:
snapshot = None
kwargs['snapshot_id'] = snapshot_id
share_network_id = share.get('share_network_id')
parent_share_type = {}
if snapshot:
# Need to check that share_network_id from snapshot's
# parents share equals to share_network_id from args.
# If share_network_id is empty then update it with
# share_network_id of parent share.
parent_share = self.share_api.get(context, snapshot['share_id'])
parent_share_net_id = parent_share.instance['share_network_id']
parent_share_type = share_types.get_share_type(
context, parent_share.instance['share_type_id'])
if share_network_id:
if share_network_id != parent_share_net_id:
msg = ("Share network ID should be the same as snapshot's"
" parent share's or empty")
raise exc.HTTPBadRequest(explanation=msg)
elif parent_share_net_id:
share_network_id = parent_share_net_id
# Verify that share can be created from a snapshot
if (check_create_share_from_snapshot_support and
not parent_share['create_share_from_snapshot_support']):
msg = (_("A new share may not be created from snapshot '%s', "
"because the snapshot's parent share does not have "
"that capability.") % snapshot_id)
LOG.error(msg)
raise exc.HTTPBadRequest(explanation=msg)
if share_network_id:
try:
self.share_api.get_share_network(context, share_network_id)
except exception.ShareNetworkNotFound as e:
raise exc.HTTPNotFound(explanation=six.text_type(e))
kwargs['share_network_id'] = share_network_id
display_name = share.get('display_name')
display_description = share.get('display_description')
if 'share_type' in share and 'volume_type' in share:
msg = 'Cannot specify both share_type and volume_type'
raise exc.HTTPBadRequest(explanation=msg)
req_share_type = share.get('share_type', share.get('volume_type'))
share_type = None
if req_share_type:
try:
if not uuidutils.is_uuid_like(req_share_type):
share_type = share_types.get_share_type_by_name(
context, req_share_type)
else:
share_type = share_types.get_share_type(
context, req_share_type)
except exception.ShareTypeNotFound:
msg = _("Share type not found.")
raise exc.HTTPNotFound(explanation=msg)
elif not snapshot:
def_share_type = share_types.get_default_share_type()
if def_share_type:
share_type = def_share_type
# Only use in create share feature. Create share from snapshot
# and create share with share group features not
# need this check.
if (not share_network_id and not snapshot and not share_group_id
and share_type and share_type.get('extra_specs')
and (strutils.bool_from_string(
share_type.get('extra_specs').get(
'driver_handles_share_servers')))):
msg = _('Share network must be set when the '
'driver_handles_share_servers is true.')
raise exc.HTTPBadRequest(explanation=msg)
type_chosen = share_type or parent_share_type
if type_chosen and check_availability_zones_extra_spec:
type_azs = type_chosen.get('extra_specs',
{}).get('availability_zones', '')
type_azs = type_azs.split(',') if type_azs else []
kwargs['availability_zones'] = type_azs
if (availability_zone and type_azs
and availability_zone not in type_azs):
msg = _("Share type %(type)s is not supported within the "
"availability zone chosen %(az)s.")
type_chosen = (req_share_type or "%s (from source snapshot)" %
(parent_share_type.get('name')
or parent_share_type.get('id')))
payload = {'type': type_chosen, 'az': availability_zone}
raise exc.HTTPBadRequest(explanation=msg % payload)
if share_type:
kwargs['share_type'] = share_type
new_share = self.share_api.create(context, share_proto, size,
display_name, display_description,
**kwargs)
return self._view_builder.detail(req, new_share)