| # 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 debtcollector import moves |
| from debtcollector import removals |
| from oslo_serialization import jsonutils as json |
| import six |
| 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 import base_client |
| from tempest.lib.services.volume.v2 import transfers_client |
| |
| |
| class VolumesClient(base_client.BaseClient): |
| """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. |
| |
| If params is a string it will be left as it is, but if it's not it will |
| be urlencoded. |
| """ |
| if isinstance(params, six.string_types): |
| return params |
| return urllib.urlencode(params) |
| |
| def list_volumes(self, detail=False, params=None): |
| """List all the volumes created. |
| |
| Params can be a string (must be urlencoded) or a dictionary. |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#list-volumes-with-details |
| http://developer.openstack.org/api-ref/block-storage/v2/#list-volumes |
| """ |
| url = 'volumes' |
| if detail: |
| url += '/detail' |
| if params: |
| url += '?%s' % self._prepare_params(params) |
| |
| resp, body = self.get(url) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def show_volume(self, volume_id): |
| """Returns the details of a single volume.""" |
| url = "volumes/%s" % volume_id |
| resp, body = self.get(url) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def create_volume(self, **kwargs): |
| """Creates a new Volume. |
| |
| 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 |
| """ |
| post_body = json.dumps({'volume': kwargs}) |
| resp, body = self.post('volumes', post_body) |
| body = json.loads(body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def update_volume(self, volume_id, **kwargs): |
| """Updates the Specified Volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#update-volume |
| """ |
| put_body = json.dumps({'volume': kwargs}) |
| resp, body = self.put('volumes/%s' % volume_id, put_body) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def delete_volume(self, volume_id, **params): |
| """Deletes the Specified Volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| https://developer.openstack.org/api-ref/block-storage/v2/#delete-volume |
| """ |
| url = 'volumes/%s' % volume_id |
| if params: |
| url += '?%s' % urllib.urlencode(params) |
| resp, body = self.delete(url) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def upload_volume(self, volume_id, **kwargs): |
| """Uploads a volume in Glance.""" |
| post_body = json.dumps({'os-volume_upload_image': kwargs}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| body = json.loads(body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def attach_volume(self, volume_id, **kwargs): |
| """Attaches a volume to a given instance on a given mountpoint. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#attach-volume-to-server |
| """ |
| post_body = json.dumps({'os-attach': kwargs}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def set_bootable_volume(self, volume_id, **kwargs): |
| """Set a bootable flag for a volume - true or false. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#update-volume-bootable-status |
| """ |
| post_body = json.dumps({'os-set_bootable': kwargs}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def detach_volume(self, volume_id): |
| """Detaches a volume from an instance.""" |
| post_body = json.dumps({'os-detach': {}}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def reserve_volume(self, volume_id): |
| """Reserves a volume.""" |
| post_body = json.dumps({'os-reserve': {}}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def unreserve_volume(self, volume_id): |
| """Restore a reserved volume .""" |
| post_body = json.dumps({'os-unreserve': {}}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def is_resource_deleted(self, id): |
| """Check the specified resource is deleted or not. |
| |
| :param id: A checked resource id |
| :raises lib_exc.DeleteErrorException: If the specified resource is on |
| the status the delete was failed. |
| """ |
| try: |
| volume = self.show_volume(id) |
| except lib_exc.NotFound: |
| return True |
| if volume["volume"]["status"] == "error_deleting": |
| raise lib_exc.DeleteErrorException(resource_id=id) |
| return False |
| |
| @property |
| def resource_type(self): |
| """Returns the primary type of resource this client works with.""" |
| return 'volume' |
| |
| def extend_volume(self, volume_id, **kwargs): |
| """Extend a volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#extend-volume-size |
| """ |
| post_body = json.dumps({'os-extend': kwargs}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def reset_volume_status(self, volume_id, **kwargs): |
| """Reset the Specified Volume's Status. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#reset-volume-statuses |
| """ |
| post_body = json.dumps({'os-reset_status': kwargs}) |
| resp, body = self.post('volumes/%s/action' % volume_id, post_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}) |
| url = 'volumes/%s/action' % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def force_delete_volume(self, volume_id): |
| """Force Delete Volume.""" |
| post_body = json.dumps({'os-force_delete': {}}) |
| resp, body = self.post('volumes/%s/action' % volume_id, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def create_volume_metadata(self, volume_id, metadata): |
| """Create metadata for the volume. |
| |
| 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-metadata |
| """ |
| put_body = json.dumps({'metadata': metadata}) |
| url = "volumes/%s/metadata" % volume_id |
| resp, body = self.post(url, put_body) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def show_volume_metadata(self, volume_id): |
| """Get metadata of the volume.""" |
| url = "volumes/%s/metadata" % volume_id |
| resp, body = self.get(url) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def update_volume_metadata(self, volume_id, metadata): |
| """Update metadata for the volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#update-volume-metadata |
| """ |
| put_body = json.dumps({'metadata': metadata}) |
| url = "volumes/%s/metadata" % volume_id |
| resp, body = self.put(url, put_body) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def show_volume_metadata_item(self, volume_id, id): |
| """Show metadata item for the volume.""" |
| url = "volumes/%s/metadata/%s" % (volume_id, id) |
| resp, body = self.get(url) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def update_volume_metadata_item(self, volume_id, id, meta_item): |
| """Update metadata item for the volume.""" |
| put_body = json.dumps({'meta': meta_item}) |
| url = "volumes/%s/metadata/%s" % (volume_id, id) |
| resp, body = self.put(url, put_body) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def delete_volume_metadata_item(self, volume_id, id): |
| """Delete metadata item for the volume.""" |
| url = "volumes/%s/metadata/%s" % (volume_id, id) |
| resp, body = self.delete(url) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def retype_volume(self, volume_id, **kwargs): |
| """Updates volume with new volume type. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| https://developer.openstack.org/api-ref/block-storage/v2/#retype-volume |
| """ |
| post_body = json.dumps({'os-retype': kwargs}) |
| resp, body = self.post('volumes/%s/action' % volume_id, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def force_detach_volume(self, volume_id, **kwargs): |
| """Force detach a volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| https://developer.openstack.org/api-ref/block-storage/v2/#force-detach-volume |
| """ |
| post_body = json.dumps({'os-force_detach': kwargs}) |
| url = 'volumes/%s/action' % volume_id |
| resp, body = self.post(url, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def update_volume_image_metadata(self, volume_id, **kwargs): |
| """Update image metadata for the volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#set-image-metadata-for-volume |
| """ |
| post_body = json.dumps({'os-set_image_metadata': {'metadata': kwargs}}) |
| url = "volumes/%s/action" % (volume_id) |
| resp, body = self.post(url, post_body) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def delete_volume_image_metadata(self, volume_id, key_name): |
| """Delete image metadata item for the volume.""" |
| post_body = json.dumps({'os-unset_image_metadata': {'key': key_name}}) |
| url = "volumes/%s/action" % (volume_id) |
| resp, body = self.post(url, post_body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def show_volume_image_metadata(self, volume_id): |
| """Show image metadata for the volume.""" |
| post_body = json.dumps({'os-show_image_metadata': {}}) |
| url = "volumes/%s/action" % volume_id |
| resp, body = self.post(url, post_body) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| @removals.remove(message="use list_pools from tempest.lib.services." |
| "volume.v2.scheduler_stats_client") |
| def show_pools(self, detail=False): |
| # List all the volumes pools (hosts) |
| url = 'scheduler-stats/get_pools' |
| if detail: |
| url += '?detail=True' |
| |
| resp, body = self.get(url) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| @removals.remove(message="use show_backend_capabilities from tempest.lib." |
| "services.volume.v2.capabilities_client") |
| def show_backend_capabilities(self, host): |
| """Shows capabilities for a storage back end. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| http://developer.openstack.org/api-ref/block-storage/v2/#show-back-end-capabilities |
| """ |
| url = 'capabilities/%s' % host |
| resp, body = self.get(url) |
| body = json.loads(body) |
| self.expected_success(200, resp.status) |
| return rest_client.ResponseBody(resp, body) |
| |
| def unmanage_volume(self, volume_id): |
| """Unmanage volume. |
| |
| For a full list of available parameters, please refer to the official |
| API reference: |
| https://developer.openstack.org/api-ref/block-storage/v2/#unmanage-volume |
| """ |
| post_body = json.dumps({'os-unmanage': {}}) |
| resp, body = self.post('volumes/%s/action' % volume_id, post_body) |
| self.expected_success(202, resp.status) |
| return rest_client.ResponseBody(resp, body) |