Migrated volumes_client.py from tempest

This migrates the above files from tempest. This includes tempest commits:

 * volumes_client.py     : Ibd9b6c67c5b9790b6d6f1a76d334ee5d6c98ad5f
 * test_volumes_client.py: Ibd9b6c67c5b9790b6d6f1a76d334ee5d6c98ad5f
 * volumes.py            : Ica929c402a3d042ae751302384e68853eb28b405

to see the commit history for these files refer to the above Change-Ids
in the tempest repository.

Partially implements blueprint migrate-service-clients-to-tempest-lib

Change-Id: I10913f82dc3d0bef53edd67144cb47580d3c574d
This commit is contained in:
Ken'ichi Ohmichi 2015-10-12 23:57:19 +00:00
parent 9a68f4d125
commit 7055fb48d6
3 changed files with 312 additions and 0 deletions

View File

@ -0,0 +1,120 @@
# Copyright 2014 NEC 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.
create_get_volume = {
'status_code': [200],
'response_body': {
'type': 'object',
'properties': {
'volume': {
'type': 'object',
'properties': {
'id': {'type': 'string'},
'status': {'type': 'string'},
'displayName': {'type': ['string', 'null']},
'availabilityZone': {'type': 'string'},
'createdAt': {'type': 'string'},
'displayDescription': {'type': ['string', 'null']},
'volumeType': {'type': ['string', 'null']},
'snapshotId': {'type': ['string', 'null']},
'metadata': {'type': 'object'},
'size': {'type': 'integer'},
'attachments': {
'type': 'array',
'items': {
'type': 'object',
'properties': {
'id': {'type': 'string'},
'device': {'type': 'string'},
'volumeId': {'type': 'string'},
'serverId': {'type': 'string'}
},
'additionalProperties': False,
# NOTE- If volume is not attached to any server
# then, 'attachments' attributes comes as array
# with empty objects "[{}]" due to that elements
# of 'attachments' cannot defined as 'required'.
# If it would come as empty array "[]" then,
# those elements can be defined as 'required'.
}
}
},
'additionalProperties': False,
'required': ['id', 'status', 'displayName', 'availabilityZone',
'createdAt', 'displayDescription', 'volumeType',
'snapshotId', 'metadata', 'size', 'attachments']
}
},
'additionalProperties': False,
'required': ['volume']
}
}
list_volumes = {
'status_code': [200],
'response_body': {
'type': 'object',
'properties': {
'volumes': {
'type': 'array',
'items': {
'type': 'object',
'properties': {
'id': {'type': 'string'},
'status': {'type': 'string'},
'displayName': {'type': ['string', 'null']},
'availabilityZone': {'type': 'string'},
'createdAt': {'type': 'string'},
'displayDescription': {'type': ['string', 'null']},
'volumeType': {'type': ['string', 'null']},
'snapshotId': {'type': ['string', 'null']},
'metadata': {'type': 'object'},
'size': {'type': 'integer'},
'attachments': {
'type': 'array',
'items': {
'type': 'object',
'properties': {
'id': {'type': 'string'},
'device': {'type': 'string'},
'volumeId': {'type': 'string'},
'serverId': {'type': 'string'}
},
'additionalProperties': False,
# NOTE- If volume is not attached to any server
# then, 'attachments' attributes comes as array
# with empty object "[{}]" due to that elements
# of 'attachments' cannot defined as 'required'
# If it would come as empty array "[]" then,
# those elements can be defined as 'required'.
}
}
},
'additionalProperties': False,
'required': ['id', 'status', 'displayName',
'availabilityZone', 'createdAt',
'displayDescription', 'volumeType',
'snapshotId', 'metadata', 'size',
'attachments']
}
}
},
'additionalProperties': False,
'required': ['volumes']
}
}
delete_volume = {
'status_code': [202]
}

View File

@ -0,0 +1,78 @@
# Copyright 2012 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 oslo_serialization import jsonutils as json
from six.moves.urllib import parse as urllib
from tempest_lib.api_schema.response.compute.v2_1 import volumes as schema
from tempest_lib.common import rest_client
from tempest_lib import exceptions as lib_exc
class VolumesClient(rest_client.RestClient):
def list_volumes(self, detail=False, **params):
"""List all the volumes created."""
url = 'os-volumes'
if detail:
url += '/detail'
if params:
url += '?%s' % urllib.urlencode(params)
resp, body = self.get(url)
body = json.loads(body)
self.validate_response(schema.list_volumes, resp, body)
return rest_client.ResponseBody(resp, body)
def show_volume(self, volume_id):
"""Returns the details of a single volume."""
url = "os-volumes/%s" % volume_id
resp, body = self.get(url)
body = json.loads(body)
self.validate_response(schema.create_get_volume, resp, body)
return rest_client.ResponseBody(resp, body)
def create_volume(self, **kwargs):
"""Creates a new Volume.
size(Required): Size of volume in GB.
Following optional keyword arguments are accepted:
display_name: Optional Volume Name.
metadata: A dictionary of values to be used as metadata.
"""
post_body = json.dumps({'volume': kwargs})
resp, body = self.post('os-volumes', post_body)
body = json.loads(body)
self.validate_response(schema.create_get_volume, resp, body)
return rest_client.ResponseBody(resp, body)
def delete_volume(self, volume_id):
"""Deletes the Specified Volume."""
resp, body = self.delete("os-volumes/%s" % volume_id)
self.validate_response(schema.delete_volume, resp, body)
return rest_client.ResponseBody(resp, body)
def is_resource_deleted(self, id):
try:
self.show_volume(id)
except lib_exc.NotFound:
return True
return False
@property
def resource_type(self):
"""Returns the primary type of resource this client works with."""
return 'volume'

View File

@ -0,0 +1,114 @@
# Copyright 2015 NEC 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.
import copy
from oslotest import mockpatch
from tempest_lib import exceptions as lib_exc
from tempest_lib.services.compute import volumes_client
from tempest_lib.tests import fake_auth_provider
from tempest_lib.tests.services.compute import base
class TestVolumesClient(base.BaseComputeServiceTest):
FAKE_VOLUME = {
"id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
"displayName": u"v\u12345ol-001",
"displayDescription": u"Another \u1234volume.",
"size": 30,
"status": "Active",
"volumeType": "289da7f8-6440-407c-9fb4-7db01ec49164",
"metadata": {
"contents": "junk"
},
"availabilityZone": "us-east1",
"snapshotId": None,
"attachments": [],
"createdAt": "2012-02-14T20:53:07Z"
}
FAKE_VOLUMES = {"volumes": [FAKE_VOLUME]}
def setUp(self):
super(TestVolumesClient, self).setUp()
fake_auth = fake_auth_provider.FakeAuthProvider()
self.client = volumes_client.VolumesClient(
fake_auth, 'compute', 'regionOne')
def _test_list_volumes(self, bytes_body=False, **params):
self.check_service_client_function(
self.client.list_volumes,
'tempest_lib.common.rest_client.RestClient.get',
self.FAKE_VOLUMES, to_utf=bytes_body, **params)
def test_list_volumes_with_str_body(self):
self._test_list_volumes()
def test_list_volumes_with_byte_body(self):
self._test_list_volumes(bytes_body=True)
def test_list_volumes_with_params(self):
self._test_list_volumes(name='fake')
def _test_show_volume(self, bytes_body=False):
self.check_service_client_function(
self.client.show_volume,
'tempest_lib.common.rest_client.RestClient.get',
{"volume": self.FAKE_VOLUME},
to_utf=bytes_body, volume_id=self.FAKE_VOLUME['id'])
def test_show_volume_with_str_body(self):
self._test_show_volume()
def test_show_volume_with_bytes_body(self):
self._test_show_volume(bytes_body=True)
def _test_create_volume(self, bytes_body=False):
post_body = copy.deepcopy(self.FAKE_VOLUME)
del post_body['id']
del post_body['createdAt']
del post_body['status']
self.check_service_client_function(
self.client.create_volume,
'tempest_lib.common.rest_client.RestClient.post',
{"volume": self.FAKE_VOLUME},
to_utf=bytes_body, status=200, **post_body)
def test_create_volume_with_str_body(self):
self._test_create_volume()
def test_create_volume_with_bytes_body(self):
self._test_create_volume(bytes_body=True)
def test_delete_volume(self):
self.check_service_client_function(
self.client.delete_volume,
'tempest_lib.common.rest_client.RestClient.delete',
{}, status=202, volume_id=self.FAKE_VOLUME['id'])
def test_is_resource_deleted_true(self):
module = ('tempest_lib.services.compute.volumes_client.'
'VolumesClient.show_volume')
self.useFixture(mockpatch.Patch(
module, side_effect=lib_exc.NotFound))
self.assertTrue(self.client.is_resource_deleted('fake-id'))
def test_is_resource_deleted_false(self):
module = ('tempest_lib.services.compute.volumes_client.'
'VolumesClient.show_volume')
self.useFixture(mockpatch.Patch(
module, return_value={}))
self.assertFalse(self.client.is_resource_deleted('fake-id'))