66a44f95c4
As we discussed on http://lists.openstack.org/pipermail/openstack-dev/2015-July/068864.html we need to write docstring for http POST/PUT methods. This patch adds docstring for create/update methods of compute client [s-v]*. In addition, this patch fixes some inconsistencies like "Creates" is changed to "Create". Change-Id: I48917b6ddd40f1b959f2a1e1f2c6306524aeec99
77 lines
2.7 KiB
Python
77 lines
2.7 KiB
Python
# Copyright 2015 Fujitsu(fnst) 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 oslo_serialization import jsonutils as json
|
|
from six.moves.urllib import parse as urllib
|
|
|
|
from tempest_lib.api_schema.response.compute.v2_1 import snapshots as schema
|
|
from tempest_lib.common import rest_client
|
|
from tempest_lib import exceptions as lib_exc
|
|
|
|
|
|
class SnapshotsClient(rest_client.RestClient):
|
|
|
|
def create_snapshot(self, volume_id, **kwargs):
|
|
"""Create a snapshot.
|
|
|
|
Available params: see http://developer.openstack.org/
|
|
api-ref-compute-v2.1.html#createSnapshot
|
|
"""
|
|
post_body = {
|
|
'volume_id': volume_id
|
|
}
|
|
post_body.update(kwargs)
|
|
post_body = json.dumps({'snapshot': post_body})
|
|
resp, body = self.post('os-snapshots', post_body)
|
|
body = json.loads(body)
|
|
self.validate_response(schema.create_get_snapshot, resp, body)
|
|
return rest_client.ResponseBody(resp, body)
|
|
|
|
def show_snapshot(self, snapshot_id):
|
|
url = "os-snapshots/%s" % snapshot_id
|
|
resp, body = self.get(url)
|
|
body = json.loads(body)
|
|
self.validate_response(schema.create_get_snapshot, resp, body)
|
|
return rest_client.ResponseBody(resp, body)
|
|
|
|
def list_snapshots(self, detail=False, params=None):
|
|
url = 'os-snapshots'
|
|
|
|
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_snapshots, resp, body)
|
|
return rest_client.ResponseBody(resp, body)
|
|
|
|
def delete_snapshot(self, snapshot_id):
|
|
resp, body = self.delete("os-snapshots/%s" % snapshot_id)
|
|
self.validate_response(schema.delete_snapshot, resp, body)
|
|
return rest_client.ResponseBody(resp, body)
|
|
|
|
def is_resource_deleted(self, id):
|
|
try:
|
|
self.show_snapshot(id)
|
|
except lib_exc.NotFound:
|
|
return True
|
|
return False
|
|
|
|
@property
|
|
def resource_type(self):
|
|
"""Return the primary type of resource this client works with."""
|
|
return 'snapshot'
|