Add API json schema to volumes api(v2.1)
Partially implements blueprint v2-on-v3-api Change-Id: I2fd9e5a083055d12d9b7182beb902a5cbec8f1a9
This commit is contained in:
Eli Qiao
parent
a7165c7f2b
commit
0ae5060281
@ -19,10 +19,11 @@ from oslo.utils import strutils
|
||||
from webob import exc
|
||||
|
||||
from nova.api.openstack import common
|
||||
from nova.api.openstack.compute.schemas.v3 import volumes as volumes_schema
|
||||
from nova.api.openstack import extensions
|
||||
from nova.api.openstack import wsgi
|
||||
from nova.api import validation
|
||||
from nova import exception
|
||||
from nova.i18n import _
|
||||
from nova import volume
|
||||
|
||||
ALIAS = "os-volumes"
|
||||
@ -127,20 +128,17 @@ class VolumeController(wsgi.Controller):
|
||||
return {'volumes': res}
|
||||
|
||||
@extensions.expected_errors(400)
|
||||
@validation.schema(volumes_schema.create)
|
||||
def create(self, req, body):
|
||||
"""Creates a new volume."""
|
||||
context = req.environ['nova.context']
|
||||
authorize(context)
|
||||
|
||||
if not self.is_valid_body(body, 'volume'):
|
||||
msg = _("volume not specified")
|
||||
raise exc.HTTPBadRequest(explanation=msg)
|
||||
|
||||
vol = body['volume']
|
||||
|
||||
vol_type = vol.get('volume_type')
|
||||
metadata = vol.get('metadata')
|
||||
snapshot_id = vol.get('snapshot_id')
|
||||
snapshot_id = vol.get('snapshot_id', None)
|
||||
|
||||
if snapshot_id is not None:
|
||||
snapshot = self.volume_api.get_snapshot(context, snapshot_id)
|
||||
@ -282,25 +280,17 @@ class SnapshotController(wsgi.Controller):
|
||||
return {'snapshots': res}
|
||||
|
||||
@extensions.expected_errors(400)
|
||||
@validation.schema(volumes_schema.snapshot_create)
|
||||
def create(self, req, body):
|
||||
"""Creates a new snapshot."""
|
||||
context = req.environ['nova.context']
|
||||
authorize(context)
|
||||
|
||||
if not self.is_valid_body(body, 'snapshot'):
|
||||
msg = _("snapshot not specified")
|
||||
raise exc.HTTPBadRequest(explanation=msg)
|
||||
|
||||
snapshot = body['snapshot']
|
||||
volume_id = snapshot['volume_id']
|
||||
|
||||
force = snapshot.get('force', False)
|
||||
try:
|
||||
force = strutils.bool_from_string(force, strict=True)
|
||||
except ValueError:
|
||||
msg = _("Invalid value '%s' for force.") % force
|
||||
raise exc.HTTPBadRequest(explanation=msg)
|
||||
|
||||
force = strutils.bool_from_string(force, strict=True)
|
||||
if force:
|
||||
create_func = self.volume_api.create_snapshot_force
|
||||
else:
|
||||
|
||||
60
nova/api/openstack/compute/schemas/v3/volumes.py
Normal file
60
nova/api/openstack/compute/schemas/v3/volumes.py
Normal file
@ -0,0 +1,60 @@
|
||||
# Copyright 2014 IBM Corporation. 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 nova.api.validation import parameter_types
|
||||
|
||||
create = {
|
||||
'type': 'object',
|
||||
'properties': {
|
||||
'volume': {
|
||||
'type': 'object',
|
||||
'properties': {
|
||||
'volume_type': {'type': 'string'},
|
||||
'metadata': {'type': 'object'},
|
||||
'snapshot_id': {'type': 'string'},
|
||||
'size': {
|
||||
'type': ['integer', 'string'],
|
||||
'pattern': '^[0-9]+$',
|
||||
'minimum': 1
|
||||
},
|
||||
'availability_zone': {'type': 'string'},
|
||||
'display_name': {'type': 'string'},
|
||||
'display_description': {'type': 'string'},
|
||||
},
|
||||
'additionalProperties': False,
|
||||
},
|
||||
},
|
||||
'required': ['volume'],
|
||||
'additionalProperties': False,
|
||||
}
|
||||
|
||||
|
||||
snapshot_create = {
|
||||
'type': 'object',
|
||||
'properties': {
|
||||
'snapshot': {
|
||||
'type': 'object',
|
||||
'properties': {
|
||||
'volume_id': {'type': 'string'},
|
||||
'force': parameter_types.boolean,
|
||||
'display_name': {'type': 'string'},
|
||||
'display_description': {'type': 'string'},
|
||||
},
|
||||
'required': ['volume_id'],
|
||||
'additionalProperties': False,
|
||||
},
|
||||
},
|
||||
'required': ['snapshot'],
|
||||
'additionalProperties': False,
|
||||
}
|
||||
@ -18,8 +18,10 @@ Common parameter types for validating request Body.
|
||||
|
||||
boolean = {
|
||||
'type': ['boolean', 'string'],
|
||||
'enum': [True, 'True', 'TRUE', 'true', '1',
|
||||
False, 'False', 'FALSE', 'false', '0'],
|
||||
'enum': [True, 'True', 'TRUE', 'true', '1', 'ON', 'On', 'on',
|
||||
'YES', 'Yes', 'yes',
|
||||
False, 'False', 'FALSE', 'false', '0', 'OFF', 'Off', 'off',
|
||||
'NO', 'No', 'no'],
|
||||
}
|
||||
|
||||
|
||||
|
||||
@ -166,7 +166,7 @@ class BootFromVolumeTest(test.TestCase):
|
||||
name='test_server', imageRef=IMAGE_UUID,
|
||||
flavorRef=2, min_count=1, max_count=1,
|
||||
block_device_mapping=[dict(
|
||||
volume_id=1,
|
||||
volume_id='1',
|
||||
device_name='/dev/vda',
|
||||
virtual='root',
|
||||
delete_on_termination=False,
|
||||
@ -184,7 +184,7 @@ class BootFromVolumeTest(test.TestCase):
|
||||
self.assertEqual(CONF.password_length, len(server['adminPass']))
|
||||
self.assertEqual(len(self._block_device_mapping_seen), 1)
|
||||
self.assertTrue(self._legacy_bdm_seen)
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['volume_id'], 1)
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['volume_id'], '1')
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['device_name'],
|
||||
'/dev/vda')
|
||||
|
||||
@ -194,7 +194,7 @@ class BootFromVolumeTest(test.TestCase):
|
||||
flavorRef=2, min_count=1, max_count=1,
|
||||
block_device_mapping_v2=[dict(
|
||||
source_type='volume',
|
||||
uuid=1,
|
||||
uuid='1',
|
||||
device_name='/dev/vda',
|
||||
boot_index=0,
|
||||
delete_on_termination=False,
|
||||
@ -212,7 +212,7 @@ class BootFromVolumeTest(test.TestCase):
|
||||
self.assertEqual(CONF.password_length, len(server['adminPass']))
|
||||
self.assertEqual(len(self._block_device_mapping_seen), 1)
|
||||
self.assertFalse(self._legacy_bdm_seen)
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['volume_id'], 1)
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['volume_id'], '1')
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['boot_index'],
|
||||
0)
|
||||
self.assertEqual(self._block_device_mapping_seen[0]['device_name'],
|
||||
@ -283,7 +283,7 @@ class VolumeApiTestV21(test.TestCase):
|
||||
|
||||
req = fakes.HTTPRequest.blank(self.url_prefix + '/os-volumes')
|
||||
self.assertRaises(webob.exc.HTTPBadRequest,
|
||||
volumes.VolumeController().create, req, body)
|
||||
volumes.VolumeController().create, req, body=body)
|
||||
|
||||
def test_volume_index(self):
|
||||
req = webob.Request.blank(self.url_prefix + '/os-volumes')
|
||||
@ -481,7 +481,7 @@ class VolumeAttachTests(test.TestCase):
|
||||
req.body = jsonutils.dumps({})
|
||||
req.headers['content-type'] = 'application/json'
|
||||
req.environ['nova.context'] = self.context
|
||||
result = self.attachments.create(req, FAKE_UUID, body)
|
||||
result = self.attachments.create(req, FAKE_UUID, body=body)
|
||||
self.assertEqual(result['volumeAttachment']['id'],
|
||||
'00000000-aaaa-aaaa-aaaa-000000000000')
|
||||
|
||||
@ -502,7 +502,7 @@ class VolumeAttachTests(test.TestCase):
|
||||
req.environ['nova.context'] = self.context
|
||||
|
||||
self.assertRaises(webob.exc.HTTPConflict, self.attachments.create,
|
||||
req, FAKE_UUID, body)
|
||||
req, FAKE_UUID, body=body)
|
||||
|
||||
def test_attach_volume_bad_id(self):
|
||||
self.stubs.Set(compute_api.API,
|
||||
@ -523,7 +523,7 @@ class VolumeAttachTests(test.TestCase):
|
||||
req.environ['nova.context'] = self.context
|
||||
|
||||
self.assertRaises(webob.exc.HTTPBadRequest, self.attachments.create,
|
||||
req, FAKE_UUID, body)
|
||||
req, FAKE_UUID, body=body)
|
||||
|
||||
def test_attach_volume_without_volumeId(self):
|
||||
self.stubs.Set(compute_api.API,
|
||||
@ -543,7 +543,7 @@ class VolumeAttachTests(test.TestCase):
|
||||
req.environ['nova.context'] = self.context
|
||||
|
||||
self.assertRaises(webob.exc.HTTPBadRequest, self.attachments.create,
|
||||
req, FAKE_UUID, body)
|
||||
req, FAKE_UUID, body=body)
|
||||
|
||||
def _test_swap(self, uuid=FAKE_UUID_A, fake_func=None, body=None):
|
||||
fake_func = fake_func or fake_swap_volume
|
||||
@ -558,7 +558,7 @@ class VolumeAttachTests(test.TestCase):
|
||||
req.body = jsonutils.dumps({})
|
||||
req.headers['content-type'] = 'application/json'
|
||||
req.environ['nova.context'] = self.context
|
||||
return self.attachments.update(req, FAKE_UUID, uuid, body)
|
||||
return self.attachments.update(req, FAKE_UUID, uuid, body=body)
|
||||
|
||||
def test_swap_volume_for_locked_server(self):
|
||||
self.ext_mgr.extensions['os-volume-attachment-update'] = True
|
||||
@ -872,6 +872,7 @@ class CommonBadRequestTestCase(object):
|
||||
entity_name = None
|
||||
controller_cls = None
|
||||
kwargs = {}
|
||||
bad_request = exc.HTTPBadRequest
|
||||
|
||||
"""
|
||||
Tests of places we throw 400 Bad Request from
|
||||
@ -887,7 +888,7 @@ class CommonBadRequestTestCase(object):
|
||||
|
||||
kwargs = self.kwargs.copy()
|
||||
kwargs['body'] = body
|
||||
self.assertRaises(webob.exc.HTTPBadRequest,
|
||||
self.assertRaises(self.bad_request,
|
||||
self.controller.create, req, **kwargs)
|
||||
|
||||
def test_create_no_body(self):
|
||||
@ -908,10 +909,12 @@ class BadRequestVolumeTestCaseV21(CommonBadRequestTestCase,
|
||||
resource = 'os-volumes'
|
||||
entity_name = 'volume'
|
||||
controller_cls = volumes_v3.VolumeController
|
||||
bad_request = exception.ValidationError
|
||||
|
||||
|
||||
class BadRequestVolumeTestCaseV2(BadRequestVolumeTestCaseV21):
|
||||
controller_cls = volumes.VolumeController
|
||||
bad_request = exc.HTTPBadRequest
|
||||
|
||||
|
||||
class BadRequestAttachmentTestCase(CommonBadRequestTestCase,
|
||||
@ -927,11 +930,13 @@ class BadRequestSnapshotTestCaseV21(CommonBadRequestTestCase,
|
||||
|
||||
resource = 'os-snapshots'
|
||||
entity_name = 'snapshot'
|
||||
controller_cls = volumes.SnapshotController
|
||||
controller_cls = volumes_v3.SnapshotController
|
||||
bad_request = exception.ValidationError
|
||||
|
||||
|
||||
class BadRequestSnapshotTestCaseV2(BadRequestSnapshotTestCaseV21):
|
||||
controller_cls = volumes_v3.SnapshotController
|
||||
controller_cls = volumes.SnapshotController
|
||||
bad_request = exc.HTTPBadRequest
|
||||
|
||||
|
||||
class ShowSnapshotTestCaseV21(test.TestCase):
|
||||
@ -957,6 +962,7 @@ class ShowSnapshotTestCaseV2(ShowSnapshotTestCaseV21):
|
||||
|
||||
class CreateSnapshotTestCaseV21(test.TestCase):
|
||||
snapshot_cls = volumes_v3.SnapshotController
|
||||
invalid_input = exception.ValidationError
|
||||
|
||||
def setUp(self):
|
||||
super(CreateSnapshotTestCaseV21, self).setUp()
|
||||
@ -967,24 +973,25 @@ class CreateSnapshotTestCaseV21(test.TestCase):
|
||||
self.stubs.Set(cinder.API, 'create_snapshot', fake_create_snapshot)
|
||||
self.req = fakes.HTTPRequest.blank('/v2/fake/os-snapshots')
|
||||
self.req.method = 'POST'
|
||||
self.body = {'snapshot': {'volume_id': 1}}
|
||||
self.body = {'snapshot': {'volume_id': '1'}}
|
||||
|
||||
def test_force_true(self):
|
||||
self.body['snapshot']['force'] = 'True'
|
||||
self.controller.create(self.req, body=self.body)
|
||||
|
||||
def test_force_false(self):
|
||||
self.body['snapshot']['force'] = 'f'
|
||||
self.body['snapshot']['force'] = 'false'
|
||||
self.controller.create(self.req, body=self.body)
|
||||
|
||||
def test_force_invalid(self):
|
||||
self.body['snapshot']['force'] = 'foo'
|
||||
self.assertRaises(exc.HTTPBadRequest,
|
||||
self.assertRaises(self.invalid_input,
|
||||
self.controller.create, self.req, body=self.body)
|
||||
|
||||
|
||||
class CreateSnapshotTestCaseV2(CreateSnapshotTestCaseV21):
|
||||
snapshot_cls = volumes.SnapshotController
|
||||
invalid_input = exc.HTTPBadRequest
|
||||
|
||||
|
||||
class DeleteSnapshotTestCaseV21(test.TestCase):
|
||||
@ -1002,7 +1009,7 @@ class DeleteSnapshotTestCaseV21(test.TestCase):
|
||||
|
||||
def test_normal_delete(self):
|
||||
self.req.method = 'POST'
|
||||
self.body = {'snapshot': {'volume_id': 1}}
|
||||
self.body = {'snapshot': {'volume_id': '1'}}
|
||||
result = self.controller.create(self.req, body=self.body)
|
||||
|
||||
self.req.method = 'DELETE'
|
||||
@ -1023,7 +1030,7 @@ class DeleteSnapshotTestCaseV21(test.TestCase):
|
||||
self.stubs.Set(cinder.API, 'delete_snapshot',
|
||||
fake_delete_snapshot_not_exist)
|
||||
self.req.method = 'POST'
|
||||
self.body = {'snapshot': {'volume_id': 1}}
|
||||
self.body = {'snapshot': {'volume_id': '1'}}
|
||||
result = self.controller.create(self.req, body=self.body)
|
||||
|
||||
self.req.method = 'DELETE'
|
||||
@ -1045,13 +1052,13 @@ class AssistedSnapshotCreateTestCase(test.TestCase):
|
||||
|
||||
def test_assisted_create(self):
|
||||
req = fakes.HTTPRequest.blank('/v2/fake/os-assisted-volume-snapshots')
|
||||
body = {'snapshot': {'volume_id': 1, 'create_info': {}}}
|
||||
body = {'snapshot': {'volume_id': '1', 'create_info': {}}}
|
||||
req.method = 'POST'
|
||||
self.controller.create(req, body=body)
|
||||
|
||||
def test_assisted_create_missing_create_info(self):
|
||||
req = fakes.HTTPRequest.blank('/v2/fake/os-assisted-volume-snapshots')
|
||||
body = {'snapshot': {'volume_id': 1}}
|
||||
body = {'snapshot': {'volume_id': '1'}}
|
||||
req.method = 'POST'
|
||||
self.assertRaises(webob.exc.HTTPBadRequest, self.controller.create,
|
||||
req, body=body)
|
||||
@ -1067,7 +1074,7 @@ class AssistedSnapshotDeleteTestCase(test.TestCase):
|
||||
|
||||
def test_assisted_delete(self):
|
||||
params = {
|
||||
'delete_info': jsonutils.dumps({'volume_id': 1}),
|
||||
'delete_info': jsonutils.dumps({'volume_id': '1'}),
|
||||
}
|
||||
req = fakes.HTTPRequest.blank(
|
||||
'/v2/fake/os-assisted-volume-snapshots?%s' %
|
||||
|
||||
@ -409,8 +409,10 @@ class BooleanTestCase(APIValidationTestCase):
|
||||
self.post(body={'foo': '0'}))
|
||||
|
||||
def test_validate_boolean_fails(self):
|
||||
enum_boolean = ("[True, 'True', 'TRUE', 'true', '1',"
|
||||
" False, 'False', 'FALSE', 'false', '0']")
|
||||
enum_boolean = ("[True, 'True', 'TRUE', 'true', '1', 'ON', 'On',"
|
||||
" 'on', 'YES', 'Yes', 'yes',"
|
||||
" False, 'False', 'FALSE', 'false', '0', 'OFF', 'Off',"
|
||||
" 'off', 'NO', 'No', 'no']")
|
||||
|
||||
detail = ("Invalid input for field/attribute foo. Value: bar."
|
||||
" 'bar' is not one of %s") % enum_boolean
|
||||
|
||||
Loading…
Reference in New Issue
Block a user