ZhiQiang Fan | 39f9722 | 2013-09-20 04:49:44 +0800 | [diff] [blame] | 1 | # Copyright 2012 OpenStack Foundation |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 2 | # 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 | |
| 16 | import json |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 17 | import urllib |
Matthew Treinish | 96e9e88 | 2014-06-09 18:37:19 -0400 | [diff] [blame] | 18 | from xml.etree import ElementTree as etree |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 19 | |
Eiichi Aikawa | ca3d9bd | 2014-03-06 15:06:21 +0900 | [diff] [blame] | 20 | from tempest.common import rest_client |
Matthew Treinish | 684d899 | 2014-01-30 16:27:40 +0000 | [diff] [blame] | 21 | from tempest import config |
| 22 | |
| 23 | CONF = config.CONF |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 24 | |
| 25 | |
Eiichi Aikawa | ca3d9bd | 2014-03-06 15:06:21 +0900 | [diff] [blame] | 26 | class ContainerClient(rest_client.RestClient): |
Andrea Frittoli | 8bbdb16 | 2014-01-06 11:06:13 +0000 | [diff] [blame] | 27 | def __init__(self, auth_provider): |
| 28 | super(ContainerClient, self).__init__(auth_provider) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 29 | |
Eiichi Aikawa | ca3d9bd | 2014-03-06 15:06:21 +0900 | [diff] [blame] | 30 | # Overwrites json-specific header encoding in rest_client.RestClient |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 31 | self.headers = {} |
Matthew Treinish | 684d899 | 2014-01-30 16:27:40 +0000 | [diff] [blame] | 32 | self.service = CONF.object_storage.catalog_type |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 33 | self.format = 'json' |
| 34 | |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 35 | def create_container( |
| 36 | self, container_name, |
| 37 | metadata=None, |
| 38 | remove_metadata=None, |
| 39 | metadata_prefix='X-Container-Meta-', |
| 40 | remove_metadata_prefix='X-Remove-Container-Meta-'): |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 41 | """ |
| 42 | Creates a container, with optional metadata passed in as a |
Chang Bo Guo | cc1623c | 2013-09-13 20:11:27 -0700 | [diff] [blame] | 43 | dictionary |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 44 | """ |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 45 | url = str(container_name) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 46 | headers = {} |
| 47 | |
| 48 | if metadata is not None: |
| 49 | for key in metadata: |
| 50 | headers[metadata_prefix + key] = metadata[key] |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 51 | if remove_metadata is not None: |
| 52 | for key in remove_metadata: |
| 53 | headers[remove_metadata_prefix + key] = remove_metadata[key] |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 54 | |
| 55 | resp, body = self.put(url, body=None, headers=headers) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 56 | self.expected_success([201, 202], resp.status) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 57 | return resp, body |
| 58 | |
| 59 | def delete_container(self, container_name): |
Sean Dague | f237ccb | 2013-01-04 15:19:14 -0500 | [diff] [blame] | 60 | """Deletes the container (if it's empty).""" |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 61 | url = str(container_name) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 62 | resp, body = self.delete(url) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 63 | self.expected_success(204, resp.status) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 64 | return resp, body |
| 65 | |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 66 | def update_container_metadata( |
| 67 | self, container_name, |
| 68 | metadata=None, |
| 69 | remove_metadata=None, |
| 70 | metadata_prefix='X-Container-Meta-', |
| 71 | remove_metadata_prefix='X-Remove-Container-Meta-'): |
Sean Dague | f237ccb | 2013-01-04 15:19:14 -0500 | [diff] [blame] | 72 | """Updates arbitrary metadata on container.""" |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 73 | url = str(container_name) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 74 | headers = {} |
| 75 | |
| 76 | if metadata is not None: |
| 77 | for key in metadata: |
| 78 | headers[metadata_prefix + key] = metadata[key] |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 79 | if remove_metadata is not None: |
| 80 | for key in remove_metadata: |
| 81 | headers[remove_metadata_prefix + key] = remove_metadata[key] |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 82 | |
| 83 | resp, body = self.post(url, body=None, headers=headers) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 84 | self.expected_success(204, resp.status) |
Larisa Ustalov | 6c3c780 | 2012-11-05 12:25:19 +0200 | [diff] [blame] | 85 | return resp, body |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 86 | |
Larisa Ustalov | 6c3c780 | 2012-11-05 12:25:19 +0200 | [diff] [blame] | 87 | def delete_container_metadata(self, container_name, metadata, |
| 88 | metadata_prefix='X-Remove-Container-Meta-'): |
Sean Dague | f237ccb | 2013-01-04 15:19:14 -0500 | [diff] [blame] | 89 | """Deletes arbitrary metadata on container.""" |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 90 | url = str(container_name) |
Larisa Ustalov | 6c3c780 | 2012-11-05 12:25:19 +0200 | [diff] [blame] | 91 | headers = {} |
| 92 | |
| 93 | if metadata is not None: |
| 94 | for item in metadata: |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 95 | headers[metadata_prefix + item] = metadata[item] |
Larisa Ustalov | 6c3c780 | 2012-11-05 12:25:19 +0200 | [diff] [blame] | 96 | |
| 97 | resp, body = self.post(url, body=None, headers=headers) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 98 | self.expected_success(204, resp.status) |
Larisa Ustalov | 6c3c780 | 2012-11-05 12:25:19 +0200 | [diff] [blame] | 99 | return resp, body |
| 100 | |
| 101 | def list_container_metadata(self, container_name): |
| 102 | """ |
| 103 | Retrieves container metadata headers |
| 104 | """ |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 105 | url = str(container_name) |
Chmouel Boudjnah | dcf40ea | 2014-01-06 18:35:34 -0800 | [diff] [blame] | 106 | resp, body = self.head(url) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 107 | self.expected_success(204, resp.status) |
Larisa Ustalov | 6c3c780 | 2012-11-05 12:25:19 +0200 | [diff] [blame] | 108 | return resp, body |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 109 | |
| 110 | def list_all_container_objects(self, container, params=None): |
| 111 | """ |
| 112 | Returns complete list of all objects in the container, even if |
| 113 | item count is beyond 10,000 item listing limit. |
Chang Bo Guo | cc1623c | 2013-09-13 20:11:27 -0700 | [diff] [blame] | 114 | Does not require any parameters aside from container name. |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 115 | """ |
Chang Bo Guo | cc1623c | 2013-09-13 20:11:27 -0700 | [diff] [blame] | 116 | # TODO(dwalleck): Rewrite using json format to avoid newlines at end of |
Attila Fazekas | a8b5fe7 | 2013-08-01 16:59:06 +0200 | [diff] [blame] | 117 | # obj names. Set limit to API limit - 1 (max returned items = 9999) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 118 | limit = 9999 |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 119 | if params is not None: |
| 120 | if 'limit' in params: |
| 121 | limit = params['limit'] |
| 122 | |
| 123 | if 'marker' in params: |
| 124 | limit = params['marker'] |
| 125 | |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 126 | resp, objlist = self.list_container_contents( |
| 127 | container, |
| 128 | params={'limit': limit, 'format': 'json'}) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 129 | self.expected_success(200, resp.status) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 130 | return objlist |
| 131 | """tmp = [] |
| 132 | for obj in objlist: |
| 133 | tmp.append(obj['name']) |
| 134 | objlist = tmp |
| 135 | |
| 136 | if len(objlist) >= limit: |
| 137 | |
Attila Fazekas | a8b5fe7 | 2013-08-01 16:59:06 +0200 | [diff] [blame] | 138 | # Increment marker |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 139 | marker = objlist[len(objlist) - 1] |
| 140 | |
Attila Fazekas | a8b5fe7 | 2013-08-01 16:59:06 +0200 | [diff] [blame] | 141 | # Get the next chunk of the list |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 142 | objlist.extend(_list_all_container_objects(container, |
| 143 | params={'marker': marker, |
| 144 | 'limit': limit})) |
| 145 | return objlist |
| 146 | else: |
Attila Fazekas | a8b5fe7 | 2013-08-01 16:59:06 +0200 | [diff] [blame] | 147 | # Return final, complete list |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 148 | return objlist""" |
| 149 | |
| 150 | def list_container_contents(self, container, params=None): |
| 151 | """ |
| 152 | List the objects in a container, given the container name |
| 153 | |
| 154 | Returns the container object listing as a plain text list, or as |
| 155 | xml or json if that option is specified via the 'format' argument. |
| 156 | |
| 157 | Optional Arguments: |
| 158 | limit = integer |
| 159 | For an integer value n, limits the number of results to at most |
| 160 | n values. |
| 161 | |
| 162 | marker = 'string' |
| 163 | Given a string value x, return object names greater in value |
| 164 | than the specified marker. |
| 165 | |
| 166 | prefix = 'string' |
| 167 | For a string value x, causes the results to be limited to names |
| 168 | beginning with the substring x. |
| 169 | |
| 170 | format = 'json' or 'xml' |
| 171 | Specify either json or xml to return the respective serialized |
| 172 | response. |
| 173 | If json, returns a list of json objects |
| 174 | if xml, returns a string of xml |
| 175 | |
| 176 | path = 'string' |
| 177 | For a string value x, return the object names nested in the |
| 178 | pseudo path (assuming preconditions are met - see below). |
| 179 | |
| 180 | delimiter = 'character' |
| 181 | For a character c, return all the object names nested in the |
| 182 | container (without the need for the directory marker objects). |
| 183 | """ |
| 184 | |
| 185 | url = str(container) |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 186 | if params: |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 187 | url += '?' |
Matthew Treinish | 26dd0fa | 2012-12-04 17:14:37 -0500 | [diff] [blame] | 188 | url += '&%s' % urllib.urlencode(params) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 189 | |
vponomaryov | 67b58fe | 2014-02-06 19:05:41 +0200 | [diff] [blame] | 190 | resp, body = self.get(url, headers={}) |
Daisuke Morita | 1d59158 | 2014-01-14 19:49:23 +0900 | [diff] [blame] | 191 | if params and params.get('format') == 'json': |
| 192 | body = json.loads(body) |
| 193 | elif params and params.get('format') == 'xml': |
| 194 | body = etree.fromstring(body) |
JordanP | a84dde3 | 2014-11-14 15:47:42 +0100 | [diff] [blame] | 195 | self.expected_success([200, 204], resp.status) |
dwalleck | 5d73443 | 2012-10-04 01:11:47 -0500 | [diff] [blame] | 196 | return resp, body |