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
|
# 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.compute.schemas import server_metadata
from nova.api.openstack import wsgi
from nova.api import validation
from nova.compute import api as compute
from nova import exception
from nova.i18n import _
from nova.policies import server_metadata as sm_policies
class ServerMetadataController(wsgi.Controller):
"""The server metadata API controller for the OpenStack API."""
def __init__(self):
super(ServerMetadataController, self).__init__()
self.compute_api = compute.API()
def _get_metadata(self, context, server):
try:
# NOTE(mikal): get_instance_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.items():
meta_dict[key] = value
return meta_dict
@wsgi.expected_errors(404)
def index(self, req, server_id):
"""Returns the list of metadata for a given instance."""
context = req.environ['nova.context']
server = common.get_instance(self.compute_api, context, server_id)
context.can(sm_policies.POLICY_ROOT % 'index',
target={'project_id': server.project_id})
return {'metadata': self._get_metadata(context, server)}
@wsgi.expected_errors((403, 404, 409))
# NOTE(gmann): Returns 200 for backwards compatibility but should be 201
# as this operation complete the creation of metadata.
@validation.schema(server_metadata.create)
def create(self, req, server_id, body):
metadata = body['metadata']
context = req.environ['nova.context']
server = common.get_instance(self.compute_api, context, server_id)
context.can(sm_policies.POLICY_ROOT % 'create',
target={'project_id': server.project_id})
new_metadata = self._update_instance_metadata(context,
server,
metadata,
delete=False)
return {'metadata': new_metadata}
@wsgi.expected_errors((400, 403, 404, 409))
@validation.schema(server_metadata.update)
def update(self, req, server_id, id, body):
context = req.environ['nova.context']
server = common.get_instance(self.compute_api, context, server_id)
context.can(sm_policies.POLICY_ROOT % 'update',
target={'project_id': server.project_id})
meta_item = body['meta']
if id not in meta_item:
expl = _('Request body and URI mismatch')
raise exc.HTTPBadRequest(explanation=expl)
self._update_instance_metadata(context,
server,
meta_item,
delete=False)
return {'meta': meta_item}
@wsgi.expected_errors((403, 404, 409))
@validation.schema(server_metadata.update_all)
def update_all(self, req, server_id, body):
context = req.environ['nova.context']
server = common.get_instance(self.compute_api, context, server_id)
context.can(sm_policies.POLICY_ROOT % 'update_all',
target={'project_id': server.project_id})
metadata = body['metadata']
new_metadata = self._update_instance_metadata(context,
server,
metadata,
delete=True)
return {'metadata': new_metadata}
def _update_instance_metadata(self, context, server, metadata,
delete=False):
try:
return self.compute_api.update_instance_metadata(context,
server,
metadata,
delete)
except exception.QuotaError as error:
raise exc.HTTPForbidden(explanation=error.format_message())
except exception.InstanceIsLocked as e:
raise exc.HTTPConflict(explanation=e.format_message())
except exception.InstanceInvalidState as state_error:
common.raise_http_conflict_for_instance_invalid_state(state_error,
'update metadata', server.uuid)
@wsgi.expected_errors(404)
def show(self, req, server_id, id):
"""Return a single metadata item."""
context = req.environ['nova.context']
server = common.get_instance(self.compute_api, context, server_id)
context.can(sm_policies.POLICY_ROOT % 'show',
target={'project_id': server.project_id})
data = self._get_metadata(context, server)
try:
return {'meta': {id: data[id]}}
except KeyError:
msg = _("Metadata item was not found")
raise exc.HTTPNotFound(explanation=msg)
@wsgi.expected_errors((404, 409))
@wsgi.response(204)
def delete(self, req, server_id, id):
"""Deletes an existing metadata."""
context = req.environ['nova.context']
server = common.get_instance(self.compute_api, context, server_id)
context.can(sm_policies.POLICY_ROOT % 'delete',
target={'project_id': server.project_id})
metadata = self._get_metadata(context, server)
if id not in metadata:
msg = _("Metadata item was not found")
raise exc.HTTPNotFound(explanation=msg)
try:
self.compute_api.delete_instance_metadata(context, server, id)
except exception.InstanceIsLocked as e:
raise exc.HTTPConflict(explanation=e.format_message())
except exception.InstanceInvalidState as state_error:
common.raise_http_conflict_for_instance_invalid_state(state_error,
'delete metadata', server_id)
|
