openstack/nova
Code Issues Proposed changes

Convert v3 server metadata plugin to v2.1

Browse Source 
This patch converts v3 server metadata plugin to v2.1 and makes v2
unit tests share between v2 and v2.1.

The differences between v2 and v3 are described on the wiki page
https://wiki.openstack.org/wiki/NovaAPIv2tov3.

Partially implements blueprint v2-on-v3-api

Change-Id: I619a7323f515234d15000af356277dbf3d91231f
This commit is contained in:
Ghanshyam
2014-08-25 18:27:26 +09:00
committed by Ghanshyam Mann
parent acb32e773b
commit 46e5689db4
8 changed files with 105 additions and 666 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/v3/api_samples/server-metadata/server-metadata-req.json
View File

@@ -1,5 +1,5 @@
{
"metadata": {
"meta": {
"foo": "Bar Value"
}
}

4
doc/v3/api_samples/server-metadata/server-metadata-resp.json
View File

@@ -1,5 +1,5 @@
{
"metadata": {
"meta": {
"foo": "Foo Value"
}
}
}

11
nova/api/openstack/compute/plugins/v3/server_metadata.py
View File

@@ -54,7 +54,8 @@ class ServerMetadataController(wsgi.Controller):
return {'metadata': self._get_metadata(context, server_id)}
@extensions.expected_errors((400, 403, 404, 409, 413))
@wsgi.response(201)
# NOTE(gmann): Returns 200 for backwards compatibility but should be 201
# as this operation complete the creation of metadata.
def create(self, req, server_id, body):
if not self.is_valid_body(body, 'metadata'):
msg = _("Malformed request body")
@@ -71,10 +72,10 @@ class ServerMetadataController(wsgi.Controller):
@extensions.expected_errors((400, 403, 404, 409, 413))
def update(self, req, server_id, id, body):
if not self.is_valid_body(body, 'metadata'):
if not self.is_valid_body(body, 'meta'):
msg = _("Malformed request body")
raise exc.HTTPBadRequest(explanation=msg)
meta_item = body['metadata']
meta_item = body['meta']
if id not in meta_item:
expl = _('Request body and URI mismatch')
raise exc.HTTPBadRequest(explanation=expl)
@@ -89,7 +90,7 @@ class ServerMetadataController(wsgi.Controller):
meta_item,
delete=False)
return {'metadata': meta_item}
return {'meta': meta_item}
@extensions.expected_errors((400, 403, 404, 409, 413))
def update_all(self, req, server_id, body):
@@ -139,7 +140,7 @@ class ServerMetadataController(wsgi.Controller):
data = self._get_metadata(context, server_id)
try:
return {'metadata': {id: data[id]}}
return {'meta': {id: data[id]}}
except KeyError:
msg = _("Metadata item was not found")
raise exc.HTTPNotFound(explanation=msg)

601
nova/tests/api/openstack/compute/plugins/v3/test_server_metadata.py
View File

@@ -1,601 +0,0 @@
# 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.
import uuid
import mock
from oslo.config import cfg
import webob
from nova.api.openstack.compute.plugins.v3 import server_metadata
from nova.compute import rpcapi as compute_rpcapi
from nova.compute import vm_states
import nova.db
from nova import exception
from nova import objects
from nova.openstack.common import jsonutils
from nova.openstack.common import timeutils
from nova import test
from nova.tests.api.openstack import fakes
from nova.tests import fake_instance
CONF = cfg.CONF
def return_create_instance_metadata_max(context, server_id, metadata, delete):
return stub_max_server_metadata()
def return_create_instance_metadata(context, server_id, metadata, delete):
return stub_server_metadata()
def fake_instance_save(inst, **kwargs):
inst.metadata = stub_server_metadata()
inst.obj_reset_changes()
def return_server_metadata(context, server_id):
if not isinstance(server_id, str) or not len(server_id) == 36:
msg = 'id %s must be a uuid in return server metadata' % server_id
raise Exception(msg)
return stub_server_metadata()
def return_empty_server_metadata(context, server_id):
return {}
def delete_server_metadata(context, server_id, key):
pass
def stub_server_metadata():
metadata = {
"key1": "value1",
"key2": "value2",
"key3": "value3",
}
return metadata
def stub_max_server_metadata():
metadata = {"metadata": {}}
for num in range(CONF.quota_metadata_items):
metadata['metadata']['key%i' % num] = "blah"
return metadata
def return_server(context, server_id, columns_to_join=None):
return fake_instance.fake_db_instance(
**{'id': server_id,
'uuid': '0cc3346e-9fef-4445-abe6-5d2b2690ec64',
'name': 'fake',
'locked': False,
'launched_at': timeutils.utcnow(),
'vm_state': vm_states.ACTIVE})
def return_server_by_uuid(context, server_uuid,
columns_to_join=None, use_slave=False):
return fake_instance.fake_db_instance(
**{'id': 1,
'uuid': '0cc3346e-9fef-4445-abe6-5d2b2690ec64',
'name': 'fake',
'locked': False,
'launched_at': timeutils.utcnow(),
'metadata': stub_server_metadata(),
'vm_state': vm_states.ACTIVE})
def return_server_nonexistent(context, server_id,
columns_to_join=None, use_slave=False):
raise exception.InstanceNotFound(instance_id=server_id)
def fake_change_instance_metadata(self, context, instance, diff):
pass
class BaseTest(test.TestCase):
def setUp(self):
super(BaseTest, self).setUp()
fakes.stub_out_key_pair_funcs(self.stubs)
self.stubs.Set(nova.db, 'instance_get', return_server)
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_by_uuid)
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_metadata)
self.stubs.Set(compute_rpcapi.ComputeAPI, 'change_instance_metadata',
fake_change_instance_metadata)
self.controller = server_metadata.ServerMetadataController()
self.uuid = str(uuid.uuid4())
self.url = '/fake/servers/%s/metadata' % self.uuid
class ServerMetaDataTest(BaseTest):
def test_index(self):
req = fakes.HTTPRequestV3.blank(self.url)
res_dict = self.controller.index(req, self.uuid)
expected = {
'metadata': {
'key1': 'value1',
'key2': 'value2',
'key3': 'value3',
},
}
self.assertEqual(expected, res_dict)
def test_index_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_nonexistent)
req = fakes.HTTPRequestV3.blank(self.url)
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.index, req, self.url)
def test_index_no_data(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_empty_server_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
res_dict = self.controller.index(req, self.uuid)
expected = {'metadata': {}}
self.assertEqual(expected, res_dict)
def test_show(self):
req = fakes.HTTPRequestV3.blank(self.url + '/key2')
res_dict = self.controller.show(req, self.uuid, 'key2')
expected = {'metadata': {'key2': 'value2'}}
self.assertEqual(expected, res_dict)
def test_show_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_nonexistent)
req = fakes.HTTPRequestV3.blank(self.url + '/key2')
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.show, req, self.uuid, 'key2')
def test_show_meta_not_found(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_empty_server_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key6')
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.show, req, self.uuid, 'key6')
def test_delete(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_metadata)
self.stubs.Set(nova.db, 'instance_metadata_delete',
delete_server_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key2')
req.method = 'DELETE'
res = self.controller.delete(req, self.uuid, 'key2')
self.assertIsNone(res)
def test_delete_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_nonexistent)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'DELETE'
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.delete, req, self.uuid, 'key1')
def test_delete_meta_not_found(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_empty_server_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key6')
req.method = 'DELETE'
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.delete, req, self.uuid, 'key6')
def test_create(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_metadata)
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req.method = 'POST'
req.content_type = "application/json"
body = {"metadata": {"key9": "value9"}}
req.body = jsonutils.dumps(body)
res_dict = self.controller.create(req, self.uuid, body)
body['metadata'].update({
"key1": "value1",
"key2": "value2",
"key3": "value3",
})
self.assertEqual(body, res_dict)
self.assertEqual(self.controller.create.wsgi_code, 201)
def test_create_empty_body(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'POST'
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.create, req, self.uuid, None)
def test_create_item_empty_key(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {"": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.create, req, self.uuid, body)
def test_create_item_non_dict(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": None}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.create, req, self.uuid, body)
def test_create_item_key_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {("a" * 260): "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPRequestEntityTooLarge,
self.controller.create,
req, self.uuid, body)
def test_create_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_nonexistent)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'POST'
body = {"metadata": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.create, req, self.uuid, body)
def test_update_metadata(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req.method = 'POST'
req.content_type = 'application/json'
expected = {
'metadata': {
'key1': 'updatedvalue',
'key29': 'newkey',
}
}
req.body = jsonutils.dumps(expected)
response = self.controller.update_all(req, self.uuid, expected)
self.assertEqual(expected, response)
def test_update_all(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req.method = 'PUT'
req.content_type = "application/json"
expected = {
'metadata': {
'key10': 'value10',
'key99': 'value99',
},
}
req.body = jsonutils.dumps(expected)
res_dict = self.controller.update_all(req, self.uuid, expected)
self.assertEqual(expected, res_dict)
def test_update_all_empty_container(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req.method = 'PUT'
req.content_type = "application/json"
expected = {'metadata': {}}
req.body = jsonutils.dumps(expected)
res_dict = self.controller.update_all(req, self.uuid, expected)
self.assertEqual(expected, res_dict)
def test_update_all_malformed_container(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'PUT'
req.content_type = "application/json"
expected = {'meta': {}}
req.body = jsonutils.dumps(expected)
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update_all, req, self.uuid, expected)
def test_update_all_malformed_data(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'PUT'
req.content_type = "application/json"
expected = {'metadata': ['asdf']}
req.body = jsonutils.dumps(expected)
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update_all, req, self.uuid, expected)
def test_update_all_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get', return_server_nonexistent)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'PUT'
req.content_type = "application/json"
body = {'metadata': {'key10': 'value10'}}
req.body = jsonutils.dumps(body)
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.update_all, req, '100', body)
def test_update_item(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
res_dict = self.controller.update(req, self.uuid, 'key1', body)
expected = {'metadata': {'key1': 'value1'}}
self.assertEqual(expected, res_dict)
def test_update_item_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_nonexistent)
req = fakes.HTTPRequestV3.blank('/fake/servers/asdf/metadata/key1')
req.method = 'PUT'
body = {"metadata": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.update, req, self.uuid, 'key1', body)
def test_update_item_empty_body(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update, req, self.uuid, 'key1', None)
def test_update_item_empty_key(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {"": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update, req, self.uuid, '', body)
def test_update_item_key_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {("a" * 260): "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPRequestEntityTooLarge,
self.controller.update,
req, self.uuid, ("a" * 260), body)
def test_update_item_value_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {"key1": ("a" * 260)}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPRequestEntityTooLarge,
self.controller.update,
req, self.uuid, "key1", body)
def test_update_item_too_many_keys(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/key1')
req.method = 'PUT'
body = {"metadata": {"key1": "value1", "key2": "value2"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update, req, self.uuid, 'key1', body)
def test_update_item_body_uri_mismatch(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/bad')
req.method = 'PUT'
body = {"metadata": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update, req, self.uuid, 'bad', body)
def test_update_item_non_dict(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url + '/bad')
req.method = 'PUT'
body = {"metadata": None}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update, req, self.uuid, 'bad', body)
def test_too_many_metadata_items_on_create(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
data = {"metadata": {}}
for num in range(CONF.quota_metadata_items + 1):
data['metadata']['key%i' % num] = "blah"
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'POST'
req.body = jsonutils.dumps(data)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPForbidden, self.controller.create, req,
self.uuid, data)
def test_create_item_value_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'POST'
req.headers["content-type"] = "application/json"
data = {"metadata": {"key": "v" * 260}}
req.body = jsonutils.dumps(data)
self.assertRaises(webob.exc.HTTPRequestEntityTooLarge,
self.controller.create, req, self.uuid, data)
def test_too_many_metadata_items_on_update_item(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
data = {"metadata": {}}
for num in range(CONF.quota_metadata_items + 1):
data['metadata']['key%i' % num] = "blah"
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'PUT'
req.body = jsonutils.dumps(data)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPForbidden, self.controller.update_all,
req, self.uuid, data)
def test_invalid_metadata_items_on_update_item(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'PUT'
req.headers["content-type"] = "application/json"
# test for long key
data = {"metadata": {"a" * 260: "value1"}}
req.body = jsonutils.dumps(data)
self.assertRaises(webob.exc.HTTPRequestEntityTooLarge,
self.controller.update_all, req, self.uuid, data)
# test for long value
data = {"metadata": {"key": "v" * 260}}
req.body = jsonutils.dumps(data)
self.assertRaises(webob.exc.HTTPRequestEntityTooLarge,
self.controller.update_all, req, self.uuid, data)
# test for empty key.
data = {"metadata": {"": "value1"}}
req.body = jsonutils.dumps(data)
self.assertRaises(webob.exc.HTTPBadRequest,
self.controller.update_all, req, self.uuid, data)
class BadStateServerMetaDataTest(BaseTest):
def setUp(self):
super(BadStateServerMetaDataTest, self).setUp()
self.stubs.Set(nova.db, 'instance_get', self._return_server_in_build)
self.stubs.Set(nova.db, 'instance_get_by_uuid',
self._return_server_in_build_by_uuid)
self.stubs.Set(nova.db, 'instance_metadata_delete',
delete_server_metadata)
def test_invalid_state_on_delete(self):
req = fakes.HTTPRequestV3.blank(self.url + '/key2')
req.method = 'DELETE'
self.assertRaises(webob.exc.HTTPConflict, self.controller.delete,
req, self.uuid, 'key2')
def test_invalid_state_on_update_metadata(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequestV3.blank(self.url)
req.method = 'POST'
req.content_type = 'application/json'
expected = {
'metadata': {
'key1': 'updatedvalue',
'key29': 'newkey',
}
}
req.body = jsonutils.dumps(expected)
self.assertRaises(webob.exc.HTTPConflict, self.controller.update_all,
req, self.uuid, expected)
def _return_server_in_build(self, context, server_id,
columns_to_join=None):
return fake_instance.fake_db_instance(
**{'id': server_id,
'uuid': '0cc3346e-9fef-4445-abe6-5d2b2690ec64',
'name': 'fake',
'locked': False,
'vm_state': vm_states.BUILDING})
def _return_server_in_build_by_uuid(self, context, server_uuid,
columns_to_join=None, use_slave=False):
return fake_instance.fake_db_instance(
**{'id': 1,
'uuid': '0cc3346e-9fef-4445-abe6-5d2b2690ec64',
'name': 'fake',
'locked': False,
'vm_state': vm_states.BUILDING})
@mock.patch.object(nova.compute.api.API, 'update_instance_metadata',
side_effect=exception.InstanceIsLocked(instance_uuid=0))
def test_instance_lock_update_metadata(self, mock_update):
req = fakes.HTTPRequest.blank(self.url)
req.method = 'POST'
req.content_type = 'application/json'
expected = {
'metadata': {
'keydummy': 'newkey'
}
}
req.body = jsonutils.dumps(expected)
self.assertRaises(webob.exc.HTTPConflict, self.controller.update_all,
req, self.uuid, expected)

147
nova/tests/api/openstack/compute/test_server_metadata.py
View File

@@ -20,7 +20,9 @@ from oslo.config import cfg
import six
import webob
from nova.api.openstack.compute import server_metadata
from nova.api.openstack.compute.plugins.v3 import server_metadata \
as server_metadata_v21
from nova.api.openstack.compute import server_metadata as server_metadata_v2
from nova.compute import rpcapi as compute_rpcapi
from nova.compute import vm_states
import nova.db
@@ -111,9 +113,10 @@ def fake_change_instance_metadata(self, context, instance, diff):
pass
class BaseTest(test.TestCase):
class ServerMetaDataTestV21(test.TestCase):
def setUp(self):
super(BaseTest, self).setUp()
super(ServerMetaDataTestV21, self).setUp()
fakes.stub_out_key_pair_funcs(self.stubs)
self.stubs.Set(nova.db, 'instance_get', return_server)
self.stubs.Set(nova.db, 'instance_get_by_uuid',
@@ -124,16 +127,18 @@ class BaseTest(test.TestCase):
self.stubs.Set(compute_rpcapi.ComputeAPI, 'change_instance_metadata',
fake_change_instance_metadata)
self._set_up_resources()
self.controller = server_metadata.Controller()
def _set_up_resources(self):
self.controller = server_metadata_v21.ServerMetadataController()
self.uuid = str(uuid.uuid4())
self.url = '/v1.1/fake/servers/%s/metadata' % self.uuid
self.url = '/fake/servers/%s/metadata' % self.uuid
class ServerMetaDataTest(BaseTest):
def _get_request(self, param_url=''):
return fakes.HTTPRequestV3.blank(self.url + param_url)
def test_index(self):
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
res_dict = self.controller.index(req, self.uuid)
expected = {
@@ -148,35 +153,35 @@ class ServerMetaDataTest(BaseTest):
def test_index_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_nonexistent)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.index, req, self.url)
def test_index_no_data(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_empty_server_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
res_dict = self.controller.index(req, self.uuid)
expected = {'metadata': {}}
self.assertEqual(expected, res_dict)
def test_show(self):
req = fakes.HTTPRequest.blank(self.url + '/key2')
req = self._get_request('/key2')
res_dict = self.controller.show(req, self.uuid, 'key2')
expected = {'meta': {'key2': 'value2'}}
expected = {"meta": {'key2': 'value2'}}
self.assertEqual(expected, res_dict)
def test_show_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_nonexistent)
req = fakes.HTTPRequest.blank(self.url + '/key2')
req = self._get_request('/key2')
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.show, req, self.uuid, 'key2')
def test_show_meta_not_found(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_empty_server_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key6')
req = self._get_request('/key6')
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.show, req, self.uuid, 'key6')
@@ -185,7 +190,7 @@ class ServerMetaDataTest(BaseTest):
return_server_metadata)
self.stubs.Set(nova.db, 'instance_metadata_delete',
delete_server_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key2')
req = self._get_request('/key2')
req.method = 'DELETE'
res = self.controller.delete(req, self.uuid, 'key2')
@@ -194,7 +199,7 @@ class ServerMetaDataTest(BaseTest):
def test_delete_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_nonexistent)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'DELETE'
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.delete, req, self.uuid, 'key1')
@@ -202,14 +207,14 @@ class ServerMetaDataTest(BaseTest):
def test_delete_meta_not_found(self):
self.stubs.Set(nova.db, 'instance_metadata_get',
return_empty_server_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key6')
req = self._get_request('/key6')
req.method = 'DELETE'
self.assertRaises(webob.exc.HTTPNotFound,
self.controller.delete, req, self.uuid, 'key6')
def test_create(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.content_type = "application/json"
body = {"metadata": {"key9": "value9"}}
@@ -226,7 +231,7 @@ class ServerMetaDataTest(BaseTest):
def test_create_empty_body(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.headers["content-type"] = "application/json"
@@ -236,9 +241,9 @@ class ServerMetaDataTest(BaseTest):
def test_create_item_empty_key(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {"": "value1"}}
body = {"metadata": {"": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
@@ -248,7 +253,7 @@ class ServerMetaDataTest(BaseTest):
def test_create_item_non_dict(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"metadata": None}
req.body = jsonutils.dumps(body)
@@ -260,7 +265,7 @@ class ServerMetaDataTest(BaseTest):
def test_create_item_key_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {("a" * 260): "value1"}}
req.body = jsonutils.dumps(body)
@@ -273,7 +278,7 @@ class ServerMetaDataTest(BaseTest):
def test_create_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_nonexistent)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
body = {"metadata": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
@@ -284,7 +289,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_metadata(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.content_type = 'application/json'
expected = {
@@ -299,7 +304,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_all(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.content_type = "application/json"
expected = {
@@ -315,7 +320,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_all_empty_container(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.content_type = "application/json"
expected = {'metadata': {}}
@@ -327,7 +332,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_all_malformed_container(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.content_type = "application/json"
expected = {'meta': {}}
@@ -339,7 +344,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_all_malformed_data(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.content_type = "application/json"
expected = {'metadata': ['asdf']}
@@ -350,7 +355,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_all_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get', return_server_nonexistent)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.content_type = "application/json"
body = {'metadata': {'key10': 'value10'}}
@@ -362,7 +367,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_all_non_dict(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
body = {"metadata": None}
req.body = jsonutils.dumps(body)
@@ -373,19 +378,19 @@ class ServerMetaDataTest(BaseTest):
def test_update_item(self):
self.stubs.Set(objects.Instance, 'save', fake_instance_save)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
res_dict = self.controller.update(req, self.uuid, 'key1', body)
expected = {'meta': {'key1': 'value1'}}
expected = {"meta": {'key1': 'value1'}}
self.assertEqual(expected, res_dict)
def test_update_item_nonexistent_server(self):
self.stubs.Set(nova.db, 'instance_get_by_uuid',
return_server_nonexistent)
req = fakes.HTTPRequest.blank('/v1.1/fake/servers/asdf/metadata/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
@@ -397,7 +402,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_empty_body(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
req.headers["content-type"] = "application/json"
@@ -407,7 +412,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_empty_key(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {"": "value1"}}
req.body = jsonutils.dumps(body)
@@ -419,7 +424,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_key_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {("a" * 260): "value1"}}
req.body = jsonutils.dumps(body)
@@ -432,7 +437,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_value_too_long(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {"key1": ("a" * 260)}}
req.body = jsonutils.dumps(body)
@@ -445,7 +450,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_too_many_keys(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/key1')
req = self._get_request('/key1')
req.method = 'PUT'
body = {"meta": {"key1": "value1", "key2": "value2"}}
req.body = jsonutils.dumps(body)
@@ -457,7 +462,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_body_uri_mismatch(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/bad')
req = self._get_request('/bad')
req.method = 'PUT'
body = {"meta": {"key1": "value1"}}
req.body = jsonutils.dumps(body)
@@ -469,7 +474,7 @@ class ServerMetaDataTest(BaseTest):
def test_update_item_non_dict(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url + '/bad')
req = self._get_request('/bad')
req.method = 'PUT'
body = {"meta": None}
req.body = jsonutils.dumps(body)
@@ -484,18 +489,18 @@ class ServerMetaDataTest(BaseTest):
data = {"metadata": {}}
for num in range(CONF.quota_metadata_items + 1):
data['metadata']['key%i' % num] = "blah"
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.body = jsonutils.dumps(data)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPForbidden, self.controller.create,
req, self.uuid, data)
self.assertRaises(webob.exc.HTTPForbidden,
self.controller.create, req, self.uuid, data)
def test_invalid_metadata_items_on_create(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.headers["content-type"] = "application/json"
@@ -523,13 +528,13 @@ class ServerMetaDataTest(BaseTest):
data = {"metadata": {}}
for num in range(CONF.quota_metadata_items + 1):
data['metadata']['key%i' % num] = "blah"
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.body = jsonutils.dumps(data)
req.headers["content-type"] = "application/json"
self.assertRaises(webob.exc.HTTPForbidden, self.controller.update_all,
req, self.uuid, data)
self.assertRaises(webob.exc.HTTPForbidden,
self.controller.update_all, req, self.uuid, data)
def test_invalid_metadata_items_on_update_item(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
@@ -539,7 +544,7 @@ class ServerMetaDataTest(BaseTest):
data = {"metadata": {}}
for num in range(CONF.quota_metadata_items + 1):
data['metadata']['key%i' % num] = "blah"
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'PUT'
req.body = jsonutils.dumps(data)
req.headers["content-type"] = "application/json"
@@ -563,18 +568,42 @@ class ServerMetaDataTest(BaseTest):
self.controller.update_all, req, self.uuid, data)
class BadStateServerMetaDataTest(BaseTest):
class ServerMetaDataTestV2(ServerMetaDataTestV21):
def _set_up_resources(self):
self.controller = server_metadata_v2.Controller()
self.uuid = str(uuid.uuid4())
self.url = '/v1.1/fake/servers/%s/metadata' % self.uuid
def _get_request(self, param_url=''):
return fakes.HTTPRequest.blank(self.url + param_url)
class BadStateServerMetaDataTestV21(test.TestCase):
def setUp(self):
super(BadStateServerMetaDataTest, self).setUp()
super(BadStateServerMetaDataTestV21, self).setUp()
fakes.stub_out_key_pair_funcs(self.stubs)
self.stubs.Set(nova.db, 'instance_metadata_get',
return_server_metadata)
self.stubs.Set(compute_rpcapi.ComputeAPI, 'change_instance_metadata',
fake_change_instance_metadata)
self.stubs.Set(nova.db, 'instance_get', self._return_server_in_build)
self.stubs.Set(nova.db, 'instance_get_by_uuid',
self._return_server_in_build_by_uuid)
self.stubs.Set(nova.db, 'instance_metadata_delete',
delete_server_metadata)
self._set_up_resources()
def _set_up_resources(self):
self.controller = server_metadata_v21.ServerMetadataController()
self.uuid = str(uuid.uuid4())
self.url = '/fake/servers/%s/metadata' % self.uuid
def _get_request(self, param_url=''):
return fakes.HTTPRequestV3.blank(self.url + param_url)
def test_invalid_state_on_delete(self):
req = fakes.HTTPRequest.blank(self.url + '/key2')
req = self._get_request('/key2')
req.method = 'DELETE'
self.assertRaises(webob.exc.HTTPConflict, self.controller.delete,
req, self.uuid, 'key2')
@@ -582,7 +611,7 @@ class BadStateServerMetaDataTest(BaseTest):
def test_invalid_state_on_update_metadata(self):
self.stubs.Set(nova.db, 'instance_metadata_update',
return_create_instance_metadata)
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.content_type = 'application/json'
expected = {
@@ -616,7 +645,7 @@ class BadStateServerMetaDataTest(BaseTest):
@mock.patch.object(nova.compute.api.API, 'update_instance_metadata',
side_effect=exception.InstanceIsLocked(instance_uuid=0))
def test_instance_lock_update_metadata(self, mock_update):
req = fakes.HTTPRequest.blank(self.url)
req = self._get_request()
req.method = 'POST'
req.content_type = 'application/json'
expected = {
@@ -627,3 +656,13 @@ class BadStateServerMetaDataTest(BaseTest):
req.body = jsonutils.dumps(expected)
self.assertRaises(webob.exc.HTTPConflict, self.controller.update_all,
req, self.uuid, expected)
class BadStateServerMetaDataTestV2(BadStateServerMetaDataTestV21):
def _set_up_resources(self):
self.controller = server_metadata_v2.Controller()
self.uuid = str(uuid.uuid4())
self.url = '/v1.1/fake/servers/%s/metadata' % self.uuid
def _get_request(self, param_url=''):
return fakes.HTTPRequest.blank(self.url + param_url)

2
nova/tests/integrated/v3/api_samples/server-metadata/server-metadata-req.json.tpl
View File

@@ -1,5 +1,5 @@
{
"metadata": {
"meta": {
"foo": "%(value)s"
}
}

2
nova/tests/integrated/v3/api_samples/server-metadata/server-metadata-resp.json.tpl
View File

@@ -1,5 +1,5 @@
{
"metadata": {
"meta": {
"foo": "%(value)s"
}
}

2
nova/tests/integrated/v3/test_server_metadata.py
View File

@@ -45,7 +45,7 @@ class ServersMetadataJsonTest(test_servers.ServersSampleBase):
response = self._do_post('servers/%s/metadata' % uuid,
'server-metadata-all-req',
subs)
self._verify_response('server-metadata-all-resp', subs, response, 201)
self._verify_response('server-metadata-all-resp', subs, response, 200)
def test_metadata_get_all(self):
# Test getting all metadata for a server.