diff --git a/releasenotes/notes/volume-transfers-client-e5ed3f5464c0cdc0.yaml b/releasenotes/notes/volume-transfers-client-e5ed3f5464c0cdc0.yaml new file mode 100644 index 0000000000..e5e479bf9a --- /dev/null +++ b/releasenotes/notes/volume-transfers-client-e5ed3f5464c0cdc0.yaml @@ -0,0 +1,18 @@ +--- +features: + - | + Define volume transfers service clients as libraries. + The following volume transfers service clients are defined as library interface. + + * transfers_client(v2) +deprecations: + - | + Deprecate volume v2 transfers resource methods from volumes_client(v2) libraries. + Same methods are available in new transfers service client: transfers_client(v2) + The following methods of volume v2 volumes_clients have been deprecated: + + * create_volume_transfer (v2.volumes_client) + * show_volume_transfer (v2.volumes_client) + * list_volume_transfers (v2.volumes_client) + * delete_volume_transfer (v2.volumes_client) + * accept_volume_transfer (v2.volumes_client) diff --git a/tempest/api/volume/admin/test_volume_quotas.py b/tempest/api/volume/admin/test_volume_quotas.py index 8bf416a26e..58ca92fdb2 100644 --- a/tempest/api/volume/admin/test_volume_quotas.py +++ b/tempest/api/volume/admin/test_volume_quotas.py @@ -32,6 +32,12 @@ class BaseVolumeQuotasAdminTestJSON(base.BaseVolumeAdminTest): cls.demo_tenant_id = cls.os.credentials.tenant_id cls.alt_client = cls.os_alt.volumes_client + @classmethod + def setup_clients(cls): + super(BaseVolumeQuotasAdminTestJSON, cls).setup_clients() + cls.transfer_client = cls.os.volume_transfers_v2_client + cls.alt_transfer_client = cls.os_alt.volume_transfers_v2_client + @decorators.idempotent_id('59eada70-403c-4cef-a2a3-a8ce2f1b07a0') def test_list_quotas(self): quotas = (self.admin_quotas_client.show_quota_set(self.demo_tenant_id) @@ -136,13 +142,13 @@ class BaseVolumeQuotasAdminTestJSON(base.BaseVolumeAdminTest): self.alt_client.tenant_id, params={'usage': True})['quota_set'] # Creates a volume transfer - transfer = self.volumes_client.create_volume_transfer( + transfer = self.transfer_client.create_volume_transfer( volume_id=volume['id'])['transfer'] transfer_id = transfer['id'] auth_key = transfer['auth_key'] # Accepts a volume transfer - self.alt_client.accept_volume_transfer( + self.alt_transfer_client.accept_volume_transfer( transfer_id, auth_key=auth_key)['transfer'] # Verify volume transferred is available diff --git a/tempest/api/volume/test_volume_transfers.py b/tempest/api/volume/test_volume_transfers.py index bfb42c66fb..afcffc228e 100644 --- a/tempest/api/volume/test_volume_transfers.py +++ b/tempest/api/volume/test_volume_transfers.py @@ -28,15 +28,18 @@ class VolumesTransfersTest(base.BaseVolumeTest): def setup_clients(cls): super(VolumesTransfersTest, cls).setup_clients() - cls.client = cls.volumes_client - cls.alt_client = cls.os_alt.volumes_client - cls.adm_client = cls.os_adm.volumes_client + cls.client = cls.os.volume_transfers_v2_client + cls.alt_client = cls.os_alt.volume_transfers_v2_client + cls.alt_volumes_client = cls.os_alt.volumes_v2_client + cls.adm_volumes_client = cls.os_adm.volumes_v2_client @decorators.idempotent_id('4d75b645-a478-48b1-97c8-503f64242f1a') def test_create_get_list_accept_volume_transfer(self): # Create a volume first volume = self.create_volume() - self.addCleanup(self.delete_volume, self.adm_client, volume['id']) + self.addCleanup(self.delete_volume, + self.adm_volumes_client, + volume['id']) # Create a volume transfer transfer = self.client.create_volume_transfer( @@ -44,7 +47,7 @@ class VolumesTransfersTest(base.BaseVolumeTest): transfer_id = transfer['id'] auth_key = transfer['auth_key'] waiters.wait_for_volume_resource_status( - self.client, volume['id'], 'awaiting-transfer') + self.volumes_client, volume['id'], 'awaiting-transfer') # Get a volume transfer body = self.client.show_volume_transfer(transfer_id)['transfer'] @@ -58,21 +61,23 @@ class VolumesTransfersTest(base.BaseVolumeTest): # Accept a volume transfer by alt_tenant body = self.alt_client.accept_volume_transfer( transfer_id, auth_key=auth_key)['transfer'] - waiters.wait_for_volume_resource_status(self.alt_client, + waiters.wait_for_volume_resource_status(self.alt_volumes_client, volume['id'], 'available') @decorators.idempotent_id('ab526943-b725-4c07-b875-8e8ef87a2c30') def test_create_list_delete_volume_transfer(self): # Create a volume first volume = self.create_volume() - self.addCleanup(self.delete_volume, self.adm_client, volume['id']) + self.addCleanup(self.delete_volume, + self.adm_volumes_client, + volume['id']) # Create a volume transfer body = self.client.create_volume_transfer( volume_id=volume['id'])['transfer'] transfer_id = body['id'] waiters.wait_for_volume_resource_status( - self.client, volume['id'], 'awaiting-transfer') + self.volumes_client, volume['id'], 'awaiting-transfer') # List all volume transfers (looking for the one we created) body = self.client.list_volume_transfers()['transfers'] @@ -85,4 +90,4 @@ class VolumesTransfersTest(base.BaseVolumeTest): # Delete a volume transfer self.client.delete_volume_transfer(transfer_id) waiters.wait_for_volume_resource_status( - self.client, volume['id'], 'available') + self.volumes_client, volume['id'], 'available') diff --git a/tempest/clients.py b/tempest/clients.py index 71c3d417d2..01abfd8162 100644 --- a/tempest/clients.py +++ b/tempest/clients.py @@ -287,6 +287,8 @@ class Manager(clients.ServiceClients): self.volume_v2.CapabilitiesClient() self.volume_scheduler_stats_v2_client = \ self.volume_v2.SchedulerStatsClient() + self.volume_transfers_v2_client = \ + self.volume_v2.TransfersClient() def _set_object_storage_clients(self): # Mandatory parameters (always defined) diff --git a/tempest/lib/services/volume/v2/__init__.py b/tempest/lib/services/volume/v2/__init__.py index b4eb771388..94348963b1 100644 --- a/tempest/lib/services/volume/v2/__init__.py +++ b/tempest/lib/services/volume/v2/__init__.py @@ -30,6 +30,7 @@ from tempest.lib.services.volume.v2.services_client import ServicesClient from tempest.lib.services.volume.v2.snapshot_manage_client import \ SnapshotManageClient from tempest.lib.services.volume.v2.snapshots_client import SnapshotsClient +from tempest.lib.services.volume.v2.transfers_client import TransfersClient from tempest.lib.services.volume.v2.types_client import TypesClient from tempest.lib.services.volume.v2.volume_manage_client import \ VolumeManageClient @@ -39,4 +40,4 @@ __all__ = ['AvailabilityZoneClient', 'BackupsClient', 'EncryptionTypesClient', 'ExtensionsClient', 'HostsClient', 'QosSpecsClient', 'QuotasClient', 'ServicesClient', 'SnapshotsClient', 'TypesClient', 'VolumesClient', 'LimitsClient', 'CapabilitiesClient', 'SchedulerStatsClient', - 'SnapshotManageClient', 'VolumeManageClient'] + 'SnapshotManageClient', 'VolumeManageClient', 'TransfersClient'] diff --git a/tempest/lib/services/volume/v2/transfers_client.py b/tempest/lib/services/volume/v2/transfers_client.py new file mode 100644 index 0000000000..6f21944623 --- /dev/null +++ b/tempest/lib/services/volume/v2/transfers_client.py @@ -0,0 +1,80 @@ +# 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.common import rest_client + + +class TransfersClient(rest_client.RestClient): + """Client class to send CRUD Volume Transfer V2 API requests""" + api_version = "v2" + + def create_volume_transfer(self, **kwargs): + """Create a volume transfer. + + For a full list of available parameters, please refer to the official + API reference: + http://developer.openstack.org/api-ref/block-storage/v2/#create-volume-transfer-v2 + """ + post_body = json.dumps({'transfer': kwargs}) + resp, body = self.post('os-volume-transfer', post_body) + body = json.loads(body) + self.expected_success(202, resp.status) + return rest_client.ResponseBody(resp, body) + + def show_volume_transfer(self, transfer_id): + """Returns the details of a volume transfer.""" + url = "os-volume-transfer/%s" % transfer_id + resp, body = self.get(url) + body = json.loads(body) + self.expected_success(200, resp.status) + return rest_client.ResponseBody(resp, body) + + def list_volume_transfers(self, **params): + """List all the volume transfers created. + + For a full list of available parameters, please refer to the official + API reference: + http://developer.openstack.org/api-ref/block-storage/v2/#list-volume-transfers-v2 + """ + url = 'os-volume-transfer' + if params: + url += '?%s' % urllib.urlencode(params) + resp, body = self.get(url) + body = json.loads(body) + self.expected_success(200, resp.status) + return rest_client.ResponseBody(resp, body) + + def delete_volume_transfer(self, transfer_id): + """Delete a volume transfer.""" + resp, body = self.delete("os-volume-transfer/%s" % transfer_id) + self.expected_success(202, resp.status) + return rest_client.ResponseBody(resp, body) + + def accept_volume_transfer(self, transfer_id, **kwargs): + """Accept a volume transfer. + + For a full list of available parameters, please refer to the official + API reference: + http://developer.openstack.org/api-ref/block-storage/v2/#accept-volume-transfer-v2 + """ + url = 'os-volume-transfer/%s/accept' % transfer_id + post_body = json.dumps({'accept': kwargs}) + resp, body = self.post(url, post_body) + body = json.loads(body) + self.expected_success(202, resp.status) + return rest_client.ResponseBody(resp, body) diff --git a/tempest/lib/services/volume/v2/volumes_client.py b/tempest/lib/services/volume/v2/volumes_client.py index 72823c02cd..44d4d65684 100644 --- a/tempest/lib/services/volume/v2/volumes_client.py +++ b/tempest/lib/services/volume/v2/volumes_client.py @@ -13,6 +13,7 @@ # License for the specific language governing permissions and limitations # under the License. +from debtcollector import moves from debtcollector import removals from oslo_serialization import jsonutils as json import six @@ -20,12 +21,43 @@ from six.moves.urllib import parse as urllib from tempest.lib.common import rest_client from tempest.lib import exceptions as lib_exc +from tempest.lib.services.volume.v2 import transfers_client class VolumesClient(rest_client.RestClient): """Client class to send CRUD Volume V2 API requests""" api_version = "v2" + create_volume_transfer = moves.moved_function( + transfers_client.TransfersClient.create_volume_transfer, + 'VolumesClient.create_volume_transfer', __name__, + message='Use create_volume_transfer from new location.', + version='Pike', removal_version='Queens') + + show_volume_transfer = moves.moved_function( + transfers_client.TransfersClient.show_volume_transfer, + 'VolumesClient.show_volume_transfer', __name__, + message='Use show_volume_transfer from new location.', + version='Pike', removal_version='Queens') + + list_volume_transfers = moves.moved_function( + transfers_client.TransfersClient.list_volume_transfers, + 'VolumesClient.list_volume_transfers', __name__, + message='Use list_volume_transfer from new location.', + version='Pike', removal_version='Queens') + + delete_volume_transfer = moves.moved_function( + transfers_client.TransfersClient.delete_volume_transfer, + 'VolumesClient.delete_volume_transfer', __name__, + message='Use delete_volume_transfer from new location.', + version='Pike', removal_version='Queens') + + accept_volume_transfer = moves.moved_function( + transfers_client.TransfersClient.accept_volume_transfer, + 'VolumesClient.accept_volume_transfer', __name__, + message='Use accept_volume_transfer from new location.', + version='Pike', removal_version='Queens') + def _prepare_params(self, params): """Prepares params for use in get or _ext_get methods. @@ -183,62 +215,6 @@ class VolumesClient(rest_client.RestClient): self.expected_success(202, resp.status) return rest_client.ResponseBody(resp, body) - def create_volume_transfer(self, **kwargs): - """Create a volume transfer. - - For a full list of available parameters, please refer to the official - API reference: - http://developer.openstack.org/api-ref/block-storage/v2/#create-volume-transfer - """ - post_body = json.dumps({'transfer': kwargs}) - resp, body = self.post('os-volume-transfer', post_body) - body = json.loads(body) - self.expected_success(202, resp.status) - return rest_client.ResponseBody(resp, body) - - def show_volume_transfer(self, transfer_id): - """Returns the details of a volume transfer.""" - url = "os-volume-transfer/%s" % transfer_id - resp, body = self.get(url) - body = json.loads(body) - self.expected_success(200, resp.status) - return rest_client.ResponseBody(resp, body) - - def list_volume_transfers(self, **params): - """List all the volume transfers created. - - For a full list of available parameters, please refer to the official - API reference: - http://developer.openstack.org/api-ref/block-storage/v2/#list-volume-transfers - """ - url = 'os-volume-transfer' - if params: - url += '?%s' % urllib.urlencode(params) - resp, body = self.get(url) - body = json.loads(body) - self.expected_success(200, resp.status) - return rest_client.ResponseBody(resp, body) - - def delete_volume_transfer(self, transfer_id): - """Delete a volume transfer.""" - resp, body = self.delete("os-volume-transfer/%s" % transfer_id) - self.expected_success(202, resp.status) - return rest_client.ResponseBody(resp, body) - - def accept_volume_transfer(self, transfer_id, **kwargs): - """Accept a volume transfer. - - For a full list of available parameters, please refer to the official - API reference: - http://developer.openstack.org/api-ref/block-storage/v2/#accept-volume-transfer - """ - url = 'os-volume-transfer/%s/accept' % transfer_id - post_body = json.dumps({'accept': kwargs}) - resp, body = self.post(url, post_body) - body = json.loads(body) - self.expected_success(202, resp.status) - return rest_client.ResponseBody(resp, body) - def update_volume_readonly(self, volume_id, **kwargs): """Update the Specified Volume readonly.""" post_body = json.dumps({'os-update_readonly_flag': kwargs})