**** CubicPower OpenStack Study ****
# Copyright 2011 OpenStack Foundation
# All Rights Reserved.
#
# 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 webob import exc
from nova.api.openstack import common
from nova.api.openstack import extensions
from nova.api.openstack import wsgi
from nova import compute
from nova import exception
from nova.openstack.common.gettextutils import _
**** CubicPower OpenStack Study ****
class ServerMetadataController(wsgi.Controller):
"""The server metadata API controller for the OpenStack API."""
**** CubicPower OpenStack Study ****
def __init__(self):
self.compute_api = compute.API()
super(ServerMetadataController, self).__init__()
**** CubicPower OpenStack Study ****
def _get_metadata(self, context, server_id):
server = common.get_instance(self.compute_api, context, server_id)
try:
# NOTE(mikal): get_instanc_metadata sometimes returns
# InstanceNotFound in unit tests, even though the instance is
# fetched on the line above. I blame mocking.
meta = self.compute_api.get_instance_metadata(context, server)
except exception.InstanceNotFound:
msg = _('Server does not exist')
raise exc.HTTPNotFound(explanation=msg)
meta_dict = {}
for key, value in meta.iteritems():
meta_dict[key] = value
return meta_dict
@extensions.expected_errors(404)
**** CubicPower OpenStack Study ****
def index(self, req, server_id):
"""Returns the list of metadata for a given instance."""
context = req.environ['nova.context']
return {'metadata': self._get_metadata(context, server_id)}
@extensions.expected_errors((400, 404, 409, 413))
@wsgi.response(201)
**** CubicPower OpenStack Study ****
def create(self, req, server_id, body):
if not self.is_valid_body(body, 'metadata'):
msg = _("Malformed request body")
raise exc.HTTPBadRequest(explanation=msg)
metadata = body['metadata']
context = req.environ['nova.context']
new_metadata = self._update_instance_metadata(context,
server_id,
metadata,
delete=False)
return {'metadata': new_metadata}
@extensions.expected_errors((400, 404, 409, 413))
**** CubicPower OpenStack Study ****
def update(self, req, server_id, id, body):
if not self.is_valid_body(body, 'metadata'):
msg = _("Malformed request body")
raise exc.HTTPBadRequest(explanation=msg)
meta_item = body['metadata']
if id not in meta_item:
expl = _('Request body and URI mismatch')
raise exc.HTTPBadRequest(explanation=expl)
if len(meta_item) > 1:
expl = _('Request body contains too many items')
raise exc.HTTPBadRequest(explanation=expl)
context = req.environ['nova.context']
self._update_instance_metadata(context,
server_id,
meta_item,
delete=False)
return {'metadata': meta_item}
@extensions.expected_errors((400, 404, 409, 413))
**** CubicPower OpenStack Study ****
def update_all(self, req, server_id, body):
if not self.is_valid_body(body, 'metadata'):
msg = _("Malformed request body")
raise exc.HTTPBadRequest(explanation=msg)
metadata = body['metadata']
context = req.environ['nova.context']
new_metadata = self._update_instance_metadata(context,
server_id,
metadata,
delete=True)
return {'metadata': new_metadata}
**** CubicPower OpenStack Study ****
def _update_instance_metadata(self, context, server_id, metadata,
delete=False):
try:
server = common.get_instance(self.compute_api, context, server_id,
want_objects=True)
return self.compute_api.update_instance_metadata(context,
server,
metadata,
delete)
except exception.InvalidMetadata as error:
raise exc.HTTPBadRequest(explanation=error.format_message())
except exception.InvalidMetadataSize as error:
raise exc.HTTPRequestEntityTooLarge(
explanation=error.format_message())
except exception.QuotaError as error:
raise exc.HTTPRequestEntityTooLarge(
explanation=error.format_message(),
headers={'Retry-After': 0})
except exception.InstanceInvalidState as state_error:
common.raise_http_conflict_for_instance_invalid_state(state_error,
'update metadata')
@extensions.expected_errors(404)
**** CubicPower OpenStack Study ****
def show(self, req, server_id, id):
"""Return a single metadata item."""
context = req.environ['nova.context']
data = self._get_metadata(context, server_id)
try:
return {'metadata': {id: data[id]}}
except KeyError:
msg = _("Metadata item was not found")
raise exc.HTTPNotFound(explanation=msg)
@extensions.expected_errors((404, 409))
@wsgi.response(204)
**** CubicPower OpenStack Study ****
def delete(self, req, server_id, id):
"""Deletes an existing metadata."""
context = req.environ['nova.context']
metadata = self._get_metadata(context, server_id)
if id not in metadata:
msg = _("Metadata item was not found")
raise exc.HTTPNotFound(explanation=msg)
server = common.get_instance(self.compute_api, context, server_id,
want_objects=True)
try:
self.compute_api.delete_instance_metadata(context, server, id)
except exception.InstanceInvalidState as state_error:
common.raise_http_conflict_for_instance_invalid_state(state_error,
'delete metadata')
**** CubicPower OpenStack Study ****
class ServerMetadata(extensions.V3APIExtensionBase):
"""Server Metadata API."""
name = "Server Metadata"
alias = "server-metadata"
version = 1
**** CubicPower OpenStack Study ****
def get_resources(self):
parent = {'member_name': 'server',
'collection_name': 'servers'}
resources = [extensions.ResourceExtension('metadata',
ServerMetadataController(),
member_name='server_meta',
parent=parent,
custom_routes_fn=
self.server_metadata_map
)]
return resources
**** CubicPower OpenStack Study ****
def get_controller_extensions(self):
return []
**** CubicPower OpenStack Study ****
def server_metadata_map(self, mapper, wsgi_resource):
mapper.connect("metadata", "/servers/{server_id}/metadata",
controller=wsgi_resource,
action='update_all', conditions={"method": ['PUT']})