blob: 5a79a296f7f3c1fe8395732ceac8d228b1e6e155 [file] [log] [blame]
ZhiQiang Fan39f97222013-09-20 04:49:44 +08001# Copyright 2012 OpenStack Foundation
dwallecke62b9f02012-10-10 23:34:42 -05002# All Rights Reserved.
3#
4# Licensed under the Apache License, Version 2.0 (the "License"); you may
5# not use this file except in compliance with the License. You may obtain
6# a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13# License for the specific language governing permissions and limitations
14# under the License.
15
Daryl Wallecke5b83d42011-11-10 14:39:02 -060016import json
Matthew Treinish26dd0fa2012-12-04 17:14:37 -050017import urllib
Daryl Wallecke5b83d42011-11-10 14:39:02 -060018
Haiwei Xuab924622014-03-05 04:33:51 +090019from tempest.common import rest_client
Matt Riedemannc00f3262013-12-14 12:03:55 -080020from tempest.common import waiters
Matthew Treinish684d8992014-01-30 16:27:40 +000021from tempest import config
Matthew Treinisha83a16e2012-12-07 13:44:02 -050022from tempest import exceptions
23
Matthew Treinish684d8992014-01-30 16:27:40 +000024CONF = config.CONF
25
Daryl Wallecke5b83d42011-11-10 14:39:02 -060026
Haiwei Xuab924622014-03-05 04:33:51 +090027class ImagesClientJSON(rest_client.RestClient):
Daryl Wallecke5b83d42011-11-10 14:39:02 -060028
Andrea Frittoli8bbdb162014-01-06 11:06:13 +000029 def __init__(self, auth_provider):
30 super(ImagesClientJSON, self).__init__(auth_provider)
Matthew Treinish684d8992014-01-30 16:27:40 +000031 self.service = CONF.compute.catalog_type
32 self.build_interval = CONF.compute.build_interval
33 self.build_timeout = CONF.compute.build_timeout
Daryl Wallecke5b83d42011-11-10 14:39:02 -060034
35 def create_image(self, server_id, name, meta=None):
Sean Daguef237ccb2013-01-04 15:19:14 -050036 """Creates an image of the original server."""
Daryl Wallecke5b83d42011-11-10 14:39:02 -060037
38 post_body = {
39 'createImage': {
40 'name': name,
41 }
42 }
43
Zhongyue Luoe471d6e2012-09-17 17:02:43 +080044 if meta is not None:
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060045 post_body['createImage']['metadata'] = meta
Daryl Wallecke5b83d42011-11-10 14:39:02 -060046
47 post_body = json.dumps(post_body)
Zhongyue Luoe0884a32012-09-25 17:24:17 +080048 resp, body = self.post('servers/%s/action' % str(server_id),
vponomaryovf4c27f92014-02-18 10:56:42 +020049 post_body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -060050 return resp, body
51
52 def list_images(self, params=None):
Sean Daguef237ccb2013-01-04 15:19:14 -050053 """Returns a list of all images filtered by any parameters."""
Daryl Wallecke5b83d42011-11-10 14:39:02 -060054 url = 'images'
Matthew Treinish26dd0fa2012-12-04 17:14:37 -050055 if params:
56 url += '?%s' % urllib.urlencode(params)
Daryl Wallecke5b83d42011-11-10 14:39:02 -060057
chris fattarsi5098fa22012-04-17 13:27:00 -070058 resp, body = self.get(url)
Daryl Wallecke5b83d42011-11-10 14:39:02 -060059 body = json.loads(body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060060 return resp, body['images']
Daryl Wallecke5b83d42011-11-10 14:39:02 -060061
62 def list_images_with_detail(self, params=None):
Sean Daguef237ccb2013-01-04 15:19:14 -050063 """Returns a detailed list of images filtered by any parameters."""
Daryl Wallecke5b83d42011-11-10 14:39:02 -060064 url = 'images/detail'
Matthew Treinish26dd0fa2012-12-04 17:14:37 -050065 if params:
66 url += '?%s' % urllib.urlencode(params)
Daryl Wallecke5b83d42011-11-10 14:39:02 -060067
chris fattarsi5098fa22012-04-17 13:27:00 -070068 resp, body = self.get(url)
Daryl Wallecke5b83d42011-11-10 14:39:02 -060069 body = json.loads(body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060070 return resp, body['images']
Daryl Wallecke5b83d42011-11-10 14:39:02 -060071
72 def get_image(self, image_id):
Sean Daguef237ccb2013-01-04 15:19:14 -050073 """Returns the details of a single image."""
chris fattarsi5098fa22012-04-17 13:27:00 -070074 resp, body = self.get("images/%s" % str(image_id))
Attila Fazekas54a42862013-07-28 22:31:06 +020075 self.expected_success(200, resp)
Daryl Wallecke5b83d42011-11-10 14:39:02 -060076 body = json.loads(body)
77 return resp, body['image']
78
79 def delete_image(self, image_id):
Sean Daguef237ccb2013-01-04 15:19:14 -050080 """Deletes the provided image."""
chris fattarsi5098fa22012-04-17 13:27:00 -070081 return self.delete("images/%s" % str(image_id))
Daryl Wallecke5b83d42011-11-10 14:39:02 -060082
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060083 def wait_for_image_status(self, image_id, status):
84 """Waits for an image to reach a given status."""
Matt Riedemannc00f3262013-12-14 12:03:55 -080085 waiters.wait_for_image_status(self, image_id, status)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060086
87 def list_image_metadata(self, image_id):
Sean Daguef237ccb2013-01-04 15:19:14 -050088 """Lists all metadata items for an image."""
chris fattarsi5098fa22012-04-17 13:27:00 -070089 resp, body = self.get("images/%s/metadata" % str(image_id))
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060090 body = json.loads(body)
Daryl Walleck416af922011-11-22 22:28:33 -060091 return resp, body['metadata']
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060092
93 def set_image_metadata(self, image_id, meta):
Sean Daguef237ccb2013-01-04 15:19:14 -050094 """Sets the metadata for an image."""
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060095 post_body = json.dumps({'metadata': meta})
vponomaryovf4c27f92014-02-18 10:56:42 +020096 resp, body = self.put('images/%s/metadata' % str(image_id), post_body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060097 body = json.loads(body)
Daryl Walleck416af922011-11-22 22:28:33 -060098 return resp, body['metadata']
Daryl Walleck73a9e7a2011-11-15 17:43:31 -060099
100 def update_image_metadata(self, image_id, meta):
Sean Daguef237ccb2013-01-04 15:19:14 -0500101 """Updates the metadata for an image."""
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600102 post_body = json.dumps({'metadata': meta})
vponomaryovf4c27f92014-02-18 10:56:42 +0200103 resp, body = self.post('images/%s/metadata' % str(image_id), post_body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600104 body = json.loads(body)
Daryl Walleck416af922011-11-22 22:28:33 -0600105 return resp, body['metadata']
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600106
107 def get_image_metadata_item(self, image_id, key):
Sean Daguef237ccb2013-01-04 15:19:14 -0500108 """Returns the value for a specific image metadata key."""
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800109 resp, body = self.get("images/%s/metadata/%s" % (str(image_id), key))
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600110 body = json.loads(body)
Daryl Walleck416af922011-11-22 22:28:33 -0600111 return resp, body['meta']
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600112
113 def set_image_metadata_item(self, image_id, key, meta):
Sean Daguef237ccb2013-01-04 15:19:14 -0500114 """Sets the value for a specific image metadata key."""
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600115 post_body = json.dumps({'meta': meta})
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800116 resp, body = self.put('images/%s/metadata/%s' % (str(image_id), key),
vponomaryovf4c27f92014-02-18 10:56:42 +0200117 post_body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600118 body = json.loads(body)
Daryl Walleck416af922011-11-22 22:28:33 -0600119 return resp, body['meta']
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600120
121 def delete_image_metadata_item(self, image_id, key):
Sean Daguef237ccb2013-01-04 15:19:14 -0500122 """Deletes a single image metadata key/value pair."""
chris fattarsi5098fa22012-04-17 13:27:00 -0700123 resp, body = self.delete("images/%s/metadata/%s" %
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800124 (str(image_id), key))
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600125 return resp, body
Matthew Treinish0d660492013-06-04 17:26:09 -0400126
127 def is_resource_deleted(self, id):
128 try:
129 self.get_image(id)
130 except exceptions.NotFound:
131 return True
132 return False