blob: 3e5413c63548e556d449acf0c129935652e62e0a [file] [log] [blame]
Dan Smithcf8fab62012-08-14 08:03:48 -07001# vim: tabstop=4 shiftwidth=4 softtabstop=4
2#
Kurt Taylor6a6f5be2013-04-02 18:53:47 -04003# Copyright 2012 IBM Corp.
nithya-ganesane6a36c82013-02-15 14:38:27 +00004# Copyright 2013 Hewlett-Packard Development Company, L.P.
Dan Smithcf8fab62012-08-14 08:03:48 -07005# All Rights Reserved.
6#
7# Licensed under the Apache License, Version 2.0 (the "License"); you may
8# not use this file except in compliance with the License. You may obtain
9# a copy of the License at
10#
11# http://www.apache.org/licenses/LICENSE-2.0
12#
13# Unless required by applicable law or agreed to in writing, software
14# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16# License for the specific language governing permissions and limitations
17# under the License.
18
Matthew Treinisha83a16e2012-12-07 13:44:02 -050019import time
20import urllib
21
Dan Smithcf8fab62012-08-14 08:03:48 -070022from lxml import etree
Matthew Treinisha83a16e2012-12-07 13:44:02 -050023
Dan Smithcf8fab62012-08-14 08:03:48 -070024from tempest.common.rest_client import RestClientXML
Attila Fazekas0abbc952013-07-01 19:19:42 +020025from tempest.common import waiters
Matthew Treinisha83a16e2012-12-07 13:44:02 -050026from tempest import exceptions
Matthew Treinishf4a9b0f2013-07-26 16:58:26 -040027from tempest.openstack.common import log as logging
dwallecke62b9f02012-10-10 23:34:42 -050028from tempest.services.compute.xml.common import Document
29from tempest.services.compute.xml.common import Element
30from tempest.services.compute.xml.common import Text
31from tempest.services.compute.xml.common import xml_to_json
32from tempest.services.compute.xml.common import XMLNS_11
Matthew Treinisha83a16e2012-12-07 13:44:02 -050033
Dan Smithcf8fab62012-08-14 08:03:48 -070034
35LOG = logging.getLogger(__name__)
36
37
Jaroslav Henner93f19e82012-12-12 20:24:17 +010038def _translate_ip_xml_json(ip):
39 """
40 Convert the address version to int.
41 """
42 ip = dict(ip)
43 version = ip.get('version')
44 if version:
45 ip['version'] = int(version)
Mauro S. M. Rodriguesf5166402013-04-01 10:25:26 -040046 # NOTE(maurosr): just a fast way to avoid the xml version with the
47 # expanded xml namespace.
48 type_ns_prefix = ('{http://docs.openstack.org/compute/ext/extended_ips/'
49 'api/v1.1}type')
Attila Fazekasb3d707c2013-09-10 19:01:15 +020050 mac_ns_prefix = ('{http://docs.openstack.org/compute/ext/extended_ips_mac'
51 '/api/v1.1}mac_addr')
52
Mauro S. M. Rodriguesf5166402013-04-01 10:25:26 -040053 if type_ns_prefix in ip:
Attila Fazekasb3d707c2013-09-10 19:01:15 +020054 ip['OS-EXT-IPS:type'] = ip.pop(type_ns_prefix)
55
56 if mac_ns_prefix in ip:
57 ip['OS-EXT-IPS-MAC:mac_addr'] = ip.pop(mac_ns_prefix)
Jaroslav Henner93f19e82012-12-12 20:24:17 +010058 return ip
59
60
61def _translate_network_xml_to_json(network):
62 return [_translate_ip_xml_json(ip.attrib)
63 for ip in network.findall('{%s}ip' % XMLNS_11)]
64
65
66def _translate_addresses_xml_to_json(xml_addresses):
67 return dict((network.attrib['id'], _translate_network_xml_to_json(network))
68 for network in xml_addresses.findall('{%s}network' % XMLNS_11))
69
70
71def _translate_server_xml_to_json(xml_dom):
Attila Fazekasb2902af2013-02-16 16:22:44 +010072 """Convert server XML to server JSON.
Jaroslav Henner93f19e82012-12-12 20:24:17 +010073
74 The addresses collection does not convert well by the dumb xml_to_json.
75 This method does some pre and post-processing to deal with that.
76
77 Translate XML addresses subtree to JSON.
78
79 Having xml_doc similar to
80 <api:server xmlns:api="http://docs.openstack.org/compute/api/v1.1">
81 <api:addresses>
82 <api:network id="foo_novanetwork">
83 <api:ip version="4" addr="192.168.0.4"/>
84 </api:network>
85 <api:network id="bar_novanetwork">
86 <api:ip version="4" addr="10.1.0.4"/>
87 <api:ip version="6" addr="2001:0:0:1:2:3:4:5"/>
88 </api:network>
89 </api:addresses>
90 </api:server>
91
92 the _translate_server_xml_to_json(etree.fromstring(xml_doc)) should produce
93 something like
94
95 {'addresses': {'bar_novanetwork': [{'addr': '10.1.0.4', 'version': 4},
96 {'addr': '2001:0:0:1:2:3:4:5',
97 'version': 6}],
98 'foo_novanetwork': [{'addr': '192.168.0.4', 'version': 4}]}}
99 """
100 nsmap = {'api': XMLNS_11}
101 addresses = xml_dom.xpath('/api:server/api:addresses', namespaces=nsmap)
102 if addresses:
103 if len(addresses) > 1:
104 raise ValueError('Expected only single `addresses` element.')
105 json_addresses = _translate_addresses_xml_to_json(addresses[0])
106 json = xml_to_json(xml_dom)
107 json['addresses'] = json_addresses
108 else:
109 json = xml_to_json(xml_dom)
Attila Fazekasb3d707c2013-09-10 19:01:15 +0200110 diskConfig = ('{http://docs.openstack.org'
111 '/compute/ext/disk_config/api/v1.1}diskConfig')
112 terminated_at = ('{http://docs.openstack.org/'
113 'compute/ext/server_usage/api/v1.1}terminated_at')
114 launched_at = ('{http://docs.openstack.org'
115 '/compute/ext/server_usage/api/v1.1}launched_at')
116 power_state = ('{http://docs.openstack.org'
117 '/compute/ext/extended_status/api/v1.1}power_state')
118 availability_zone = ('{http://docs.openstack.org'
119 '/compute/ext/extended_availability_zone/api/v2}'
120 'availability_zone')
121 vm_state = ('{http://docs.openstack.org'
122 '/compute/ext/extended_status/api/v1.1}vm_state')
123 task_state = ('{http://docs.openstack.org'
124 '/compute/ext/extended_status/api/v1.1}task_state')
ivan-zhua5141d92013-03-06 23:12:43 +0800125 if diskConfig in json:
Attila Fazekasb3d707c2013-09-10 19:01:15 +0200126 json['OS-DCF:diskConfig'] = json.pop(diskConfig)
127 if terminated_at in json:
128 json['OS-SRV-USG:terminated_at'] = json.pop(terminated_at)
129 if launched_at in json:
130 json['OS-SRV-USG:launched_at'] = json.pop(launched_at)
131 if power_state in json:
132 json['OS-EXT-STS:power_state'] = json.pop(power_state)
133 if availability_zone in json:
134 json['OS-EXT-AZ:availability_zone'] = json.pop(availability_zone)
135 if vm_state in json:
136 json['OS-EXT-STS:vm_state'] = json.pop(vm_state)
137 if task_state in json:
138 json['OS-EXT-STS:task_state'] = json.pop(task_state)
Jaroslav Henner93f19e82012-12-12 20:24:17 +0100139 return json
140
141
Dan Smithcf8fab62012-08-14 08:03:48 -0700142class ServersClientXML(RestClientXML):
143
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500144 def __init__(self, config, username, password, auth_url, tenant_name=None,
145 auth_version='v2'):
Dan Smithcf8fab62012-08-14 08:03:48 -0700146 super(ServersClientXML, self).__init__(config, username, password,
Brant Knudsonc7ca3342013-03-28 21:08:50 -0500147 auth_url, tenant_name,
148 auth_version=auth_version)
Dan Smithcf8fab62012-08-14 08:03:48 -0700149 self.service = self.config.compute.catalog_type
150
151 def _parse_key_value(self, node):
Sean Daguef237ccb2013-01-04 15:19:14 -0500152 """Parse <foo key='key'>value</foo> data into {'key': 'value'}."""
Dan Smithcf8fab62012-08-14 08:03:48 -0700153 data = {}
154 for node in node.getchildren():
155 data[node.get('key')] = node.text
156 return data
157
158 def _parse_links(self, node, json):
159 del json['link']
160 json['links'] = []
161 for linknode in node.findall('{http://www.w3.org/2005/Atom}link'):
162 json['links'].append(xml_to_json(linknode))
163
164 def _parse_server(self, body):
Jaroslav Henner93f19e82012-12-12 20:24:17 +0100165 json = _translate_server_xml_to_json(body)
166
Dan Smithcf8fab62012-08-14 08:03:48 -0700167 if 'metadata' in json and json['metadata']:
168 # NOTE(danms): if there was metadata, we need to re-parse
169 # that as a special type
170 metadata_tag = body.find('{%s}metadata' % XMLNS_11)
171 json["metadata"] = self._parse_key_value(metadata_tag)
172 if 'link' in json:
173 self._parse_links(body, json)
174 for sub in ['image', 'flavor']:
175 if sub in json and 'link' in json[sub]:
176 self._parse_links(body, json[sub])
Dan Smithcf8fab62012-08-14 08:03:48 -0700177 return json
178
Rami Vaknin7b9f36b2013-02-20 00:09:07 +0200179 def _parse_xml_virtual_interfaces(self, xml_dom):
180 """
181 Return server's virtual interfaces XML as JSON.
182 """
183 data = {"virtual_interfaces": []}
184 for iface in xml_dom.getchildren():
185 data["virtual_interfaces"].append(
186 {"id": iface.get("id"),
187 "mac_address": iface.get("mac_address")})
188 return data
189
Dan Smithcf8fab62012-08-14 08:03:48 -0700190 def get_server(self, server_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500191 """Returns the details of an existing server."""
Dan Smithcf8fab62012-08-14 08:03:48 -0700192 resp, body = self.get("servers/%s" % str(server_id), self.headers)
193 server = self._parse_server(etree.fromstring(body))
194 return resp, server
195
Zhu Zhu9643e512013-09-23 09:13:07 -0500196 def lock_server(self, server_id, **kwargs):
197 """Locks the given server."""
198 return self.action(server_id, 'lock', None, **kwargs)
199
200 def unlock_server(self, server_id, **kwargs):
201 """Unlocks the given server."""
202 return self.action(server_id, 'unlock', None, **kwargs)
203
Prem Karat6631f802013-07-04 12:07:33 +0530204 def suspend_server(self, server_id, **kwargs):
205 """Suspends the provided server."""
206 return self.action(server_id, 'suspend', None, **kwargs)
207
208 def resume_server(self, server_id, **kwargs):
209 """Un-suspends the provided server."""
210 return self.action(server_id, 'resume', None, **kwargs)
211
212 def pause_server(self, server_id, **kwargs):
213 """Pauses the provided server."""
214 return self.action(server_id, 'pause', None, **kwargs)
215
216 def unpause_server(self, server_id, **kwargs):
217 """Un-pauses the provided server."""
218 return self.action(server_id, 'unpause', None, **kwargs)
219
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900220 def shelve_server(self, server_id, **kwargs):
221 """Shelves the provided server."""
222 return self.action(server_id, 'shelve', None, **kwargs)
223
224 def unshelve_server(self, server_id, **kwargs):
225 """Un-shelves the provided server."""
226 return self.action(server_id, 'unshelve', None, **kwargs)
227
LingxianKongc26e6072013-09-28 21:16:52 +0800228 def reset_state(self, server_id, state='error'):
229 """Resets the state of a server to active/error."""
230 return self.action(server_id, 'os-resetState', None, state=state)
231
Dan Smithcf8fab62012-08-14 08:03:48 -0700232 def delete_server(self, server_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500233 """Deletes the given server."""
Dan Smithcf8fab62012-08-14 08:03:48 -0700234 return self.delete("servers/%s" % str(server_id))
235
236 def _parse_array(self, node):
237 array = []
238 for child in node.getchildren():
239 array.append(xml_to_json(child))
240 return array
241
242 def list_servers(self, params=None):
ivan-zhu58f9ba32013-03-13 16:52:41 +0800243 url = 'servers'
Matthew Treinish26dd0fa2012-12-04 17:14:37 -0500244 if params:
245 url += '?%s' % urllib.urlencode(params)
Dan Smithcf8fab62012-08-14 08:03:48 -0700246
Dan Smithcf8fab62012-08-14 08:03:48 -0700247 resp, body = self.get(url, self.headers)
248 servers = self._parse_array(etree.fromstring(body))
249 return resp, {"servers": servers}
250
251 def list_servers_with_detail(self, params=None):
252 url = 'servers/detail'
Matthew Treinish26dd0fa2012-12-04 17:14:37 -0500253 if params:
254 url += '?%s' % urllib.urlencode(params)
Dan Smithcf8fab62012-08-14 08:03:48 -0700255
Dan Smithcf8fab62012-08-14 08:03:48 -0700256 resp, body = self.get(url, self.headers)
257 servers = self._parse_array(etree.fromstring(body))
258 return resp, {"servers": servers}
259
260 def update_server(self, server_id, name=None, meta=None, accessIPv4=None,
ivan-zhu72d7d5b2013-10-16 17:30:58 +0800261 accessIPv6=None, disk_config=None):
Dan Smithcf8fab62012-08-14 08:03:48 -0700262 doc = Document()
263 server = Element("server")
264 doc.append(server)
265
Sean Daguee623f752013-02-27 14:52:15 -0500266 if name is not None:
Dan Smithcf8fab62012-08-14 08:03:48 -0700267 server.add_attr("name", name)
Sean Daguee623f752013-02-27 14:52:15 -0500268 if accessIPv4 is not None:
Dan Smithcf8fab62012-08-14 08:03:48 -0700269 server.add_attr("accessIPv4", accessIPv4)
Sean Daguee623f752013-02-27 14:52:15 -0500270 if accessIPv6 is not None:
Dan Smithcf8fab62012-08-14 08:03:48 -0700271 server.add_attr("accessIPv6", accessIPv6)
ivan-zhu72d7d5b2013-10-16 17:30:58 +0800272 if disk_config is not None:
273 server.add_attr('xmlns:OS-DCF', "http://docs.openstack.org/"
274 "compute/ext/disk_config/api/v1.1")
275 server.add_attr("OS-DCF:diskConfig", disk_config)
Sean Daguee623f752013-02-27 14:52:15 -0500276 if meta is not None:
Dan Smithcf8fab62012-08-14 08:03:48 -0700277 metadata = Element("metadata")
278 server.append(metadata)
279 for k, v in meta:
280 meta = Element("meta", key=k)
281 meta.append(Text(v))
282 metadata.append(meta)
283
284 resp, body = self.put('servers/%s' % str(server_id),
285 str(doc), self.headers)
286 return resp, xml_to_json(etree.fromstring(body))
287
288 def create_server(self, name, image_ref, flavor_ref, **kwargs):
289 """
290 Creates an instance of a server.
291 name (Required): The name of the server.
292 image_ref (Required): Reference to the image used to build the server.
293 flavor_ref (Required): The flavor used to build the server.
294 Following optional keyword arguments are accepted:
295 adminPass: Sets the initial root password.
296 key_name: Key name of keypair that was created earlier.
297 meta: A dictionary of values to be used as metadata.
298 personality: A list of dictionaries for files to be injected into
299 the server.
300 security_groups: A list of security group dicts.
301 networks: A list of network dicts with UUID and fixed_ip.
302 user_data: User data for instance.
303 availability_zone: Availability zone in which to launch instance.
304 accessIPv4: The IPv4 access address for the server.
305 accessIPv6: The IPv6 access address for the server.
306 min_count: Count of minimum number of instances to launch.
307 max_count: Count of maximum number of instances to launch.
308 disk_config: Determines if user or admin controls disk configuration.
309 """
310 server = Element("server",
311 xmlns=XMLNS_11,
312 imageRef=image_ref,
313 flavorRef=flavor_ref,
314 name=name)
315
Sean Daguee623f752013-02-27 14:52:15 -0500316 for attr in ["adminPass", "accessIPv4", "accessIPv6", "key_name",
Mauro S. M. Rodriguesc5da4f42013-03-04 23:57:10 -0500317 "user_data", "availability_zone", "min_count",
318 "max_count", "return_reservation_id"]:
Dan Smithcf8fab62012-08-14 08:03:48 -0700319 if attr in kwargs:
320 server.add_attr(attr, kwargs[attr])
321
ivan-zhua5141d92013-03-06 23:12:43 +0800322 if 'disk_config' in kwargs:
323 server.add_attr('xmlns:OS-DCF', "http://docs.openstack.org/"
324 "compute/ext/disk_config/api/v1.1")
325 server.add_attr('OS-DCF:diskConfig', kwargs['disk_config'])
326
Sean Daguee623f752013-02-27 14:52:15 -0500327 if 'security_groups' in kwargs:
328 secgroups = Element("security_groups")
329 server.append(secgroups)
330 for secgroup in kwargs['security_groups']:
331 s = Element("security_group", name=secgroup['name'])
332 secgroups.append(s)
333
334 if 'networks' in kwargs:
335 networks = Element("networks")
336 server.append(networks)
337 for network in kwargs['networks']:
338 s = Element("network", uuid=network['uuid'],
339 fixed_ip=network['fixed_ip'])
340 networks.append(s)
341
Dan Smithcf8fab62012-08-14 08:03:48 -0700342 if 'meta' in kwargs:
343 metadata = Element("metadata")
344 server.append(metadata)
345 for k, v in kwargs['meta'].items():
346 meta = Element("meta", key=k)
347 meta.append(Text(v))
348 metadata.append(meta)
349
Matthew Treinish2dfc2822012-08-16 16:57:08 -0400350 if 'personality' in kwargs:
351 personality = Element('personality')
352 server.append(personality)
353 for k in kwargs['personality']:
354 temp = Element('file', path=k['path'])
355 temp.append(Text(k['contents']))
356 personality.append(temp)
Dan Smithcf8fab62012-08-14 08:03:48 -0700357
358 resp, body = self.post('servers', str(Document(server)), self.headers)
359 server = self._parse_server(etree.fromstring(body))
360 return resp, server
361
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900362 def wait_for_server_status(self, server_id, status, extra_timeout=0):
Sean Daguef237ccb2013-01-04 15:19:14 -0500363 """Waits for a server to reach a given status."""
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900364 return waiters.wait_for_server_status(self, server_id, status,
365 extra_timeout=extra_timeout)
Dan Smithcf8fab62012-08-14 08:03:48 -0700366
367 def wait_for_server_termination(self, server_id, ignore_error=False):
Sean Daguef237ccb2013-01-04 15:19:14 -0500368 """Waits for server to reach termination."""
Dan Smithcf8fab62012-08-14 08:03:48 -0700369 start_time = int(time.time())
370 while True:
371 try:
372 resp, body = self.get_server(server_id)
373 except exceptions.NotFound:
374 return
375
376 server_status = body['status']
377 if server_status == 'ERROR' and not ignore_error:
378 raise exceptions.BuildErrorException
379
380 if int(time.time()) - start_time >= self.build_timeout:
381 raise exceptions.TimeoutException
382
383 time.sleep(self.build_interval)
384
385 def _parse_network(self, node):
386 addrs = []
387 for child in node.getchildren():
388 addrs.append({'version': int(child.get('version')),
zhhuabjcc51ccd2013-08-20 09:50:47 +0800389 'addr': child.get('addr')})
Dan Smithcf8fab62012-08-14 08:03:48 -0700390 return {node.get('id'): addrs}
391
392 def list_addresses(self, server_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500393 """Lists all addresses for a server."""
Dan Smithcf8fab62012-08-14 08:03:48 -0700394 resp, body = self.get("servers/%s/ips" % str(server_id), self.headers)
395
396 networks = {}
Matthew Treinishb53989b2013-03-04 16:54:12 -0500397 xml_list = etree.fromstring(body)
398 for child in xml_list.getchildren():
Dan Smithcf8fab62012-08-14 08:03:48 -0700399 network = self._parse_network(child)
400 networks.update(**network)
401
402 return resp, networks
403
404 def list_addresses_by_network(self, server_id, network_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500405 """Lists all addresses of a specific network type for a server."""
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800406 resp, body = self.get("servers/%s/ips/%s" % (str(server_id),
407 network_id),
408 self.headers)
Dan Smithcf8fab62012-08-14 08:03:48 -0700409 network = self._parse_network(etree.fromstring(body))
410
411 return resp, network
412
Attila Fazekasd4299282013-02-22 13:25:23 +0100413 def action(self, server_id, action_name, response_key, **kwargs):
414 if 'xmlns' not in kwargs:
415 kwargs['xmlns'] = XMLNS_11
416 doc = Document((Element(action_name, **kwargs)))
417 resp, body = self.post("servers/%s/action" % server_id,
418 str(doc), self.headers)
419 if response_key is not None:
420 body = xml_to_json(etree.fromstring(body))
421 return resp, body
422
ivan-zhuccc89462013-10-31 16:53:12 +0800423 def create_backup(self, server_id, backup_type, rotation, name):
424 """Backup a server instance."""
425 return self.action(server_id, "createBackup", None,
426 backup_type=backup_type,
427 rotation=rotation,
428 name=name)
429
Dan Smithcf8fab62012-08-14 08:03:48 -0700430 def change_password(self, server_id, password):
Attila Fazekasd4299282013-02-22 13:25:23 +0100431 return self.action(server_id, "changePassword", None,
432 adminPass=password)
Dan Smithcf8fab62012-08-14 08:03:48 -0700433
ivan-zhu6de5b042013-10-24 17:21:48 +0800434 def get_password(self, server_id):
435 resp, body = self.get("servers/%s/os-server-password" %
436 str(server_id), self.headers)
437 body = xml_to_json(etree.fromstring(body))
438 return resp, body
439
440 def delete_password(self, server_id):
441 """
442 Removes the encrypted server password from the metadata server
443 Note that this does not actually change the instance server
444 password.
445 """
446 return self.delete("servers/%s/os-server-password" %
447 str(server_id))
448
Dan Smithcf8fab62012-08-14 08:03:48 -0700449 def reboot(self, server_id, reboot_type):
Attila Fazekasd4299282013-02-22 13:25:23 +0100450 return self.action(server_id, "reboot", None, type=reboot_type)
Dan Smithcf8fab62012-08-14 08:03:48 -0700451
Attila Fazekasd4299282013-02-22 13:25:23 +0100452 def rebuild(self, server_id, image_ref, **kwargs):
453 kwargs['imageRef'] = image_ref
ivan-zhua5141d92013-03-06 23:12:43 +0800454 if 'disk_config' in kwargs:
455 kwargs['OS-DCF:diskConfig'] = kwargs['disk_config']
456 del kwargs['disk_config']
457 kwargs['xmlns:OS-DCF'] = "http://docs.openstack.org/"\
458 "compute/ext/disk_config/api/v1.1"
459 kwargs['xmlns:atom'] = "http://www.w3.org/2005/Atom"
Attila Fazekasd4299282013-02-22 13:25:23 +0100460 if 'xmlns' not in kwargs:
461 kwargs['xmlns'] = XMLNS_11
462
463 attrs = kwargs.copy()
464 if 'metadata' in attrs:
465 del attrs['metadata']
Dan Smithcf8fab62012-08-14 08:03:48 -0700466 rebuild = Element("rebuild",
Attila Fazekasd4299282013-02-22 13:25:23 +0100467 **attrs)
Dan Smithcf8fab62012-08-14 08:03:48 -0700468
Attila Fazekasd4299282013-02-22 13:25:23 +0100469 if 'metadata' in kwargs:
Dan Smithcf8fab62012-08-14 08:03:48 -0700470 metadata = Element("metadata")
471 rebuild.append(metadata)
Attila Fazekasd4299282013-02-22 13:25:23 +0100472 for k, v in kwargs['metadata'].items():
Dan Smithcf8fab62012-08-14 08:03:48 -0700473 meta = Element("meta", key=k)
474 meta.append(Text(v))
475 metadata.append(meta)
476
477 resp, body = self.post('servers/%s/action' % server_id,
478 str(Document(rebuild)), self.headers)
479 server = self._parse_server(etree.fromstring(body))
480 return resp, server
481
Attila Fazekasd4299282013-02-22 13:25:23 +0100482 def resize(self, server_id, flavor_ref, **kwargs):
483 if 'disk_config' in kwargs:
ivan-zhua5141d92013-03-06 23:12:43 +0800484 kwargs['OS-DCF:diskConfig'] = kwargs['disk_config']
485 del kwargs['disk_config']
486 kwargs['xmlns:OS-DCF'] = "http://docs.openstack.org/"\
487 "compute/ext/disk_config/api/v1.1"
488 kwargs['xmlns:atom'] = "http://www.w3.org/2005/Atom"
Attila Fazekasd4299282013-02-22 13:25:23 +0100489 kwargs['flavorRef'] = flavor_ref
490 return self.action(server_id, 'resize', None, **kwargs)
Dan Smithcf8fab62012-08-14 08:03:48 -0700491
Attila Fazekasd4299282013-02-22 13:25:23 +0100492 def confirm_resize(self, server_id, **kwargs):
493 return self.action(server_id, 'confirmResize', None, **kwargs)
Dan Smithcf8fab62012-08-14 08:03:48 -0700494
Attila Fazekasd4299282013-02-22 13:25:23 +0100495 def revert_resize(self, server_id, **kwargs):
496 return self.action(server_id, 'revertResize', None, **kwargs)
Dan Smithcf8fab62012-08-14 08:03:48 -0700497
Liu, Zhi Kun3fb36952013-07-18 00:05:05 +0800498 def stop(self, server_id, **kwargs):
499 return self.action(server_id, 'os-stop', None, **kwargs)
500
501 def start(self, server_id, **kwargs):
502 return self.action(server_id, 'os-start', None, **kwargs)
503
Attila Fazekasd4299282013-02-22 13:25:23 +0100504 def create_image(self, server_id, name):
505 return self.action(server_id, 'createImage', None, name=name)
Dan Smithcf8fab62012-08-14 08:03:48 -0700506
Attila Fazekasd4299282013-02-22 13:25:23 +0100507 def add_security_group(self, server_id, name):
508 return self.action(server_id, 'addSecurityGroup', None, name=name)
Dan Smithcf8fab62012-08-14 08:03:48 -0700509
Attila Fazekasd4299282013-02-22 13:25:23 +0100510 def remove_security_group(self, server_id, name):
511 return self.action(server_id, 'removeSecurityGroup', None, name=name)
Attila Fazekase4cb04c2013-01-29 09:51:58 +0100512
ravikumar-venkatesan753262b2013-03-21 12:43:57 +0000513 def live_migrate_server(self, server_id, dest_host, use_block_migration):
514 """This should be called with administrator privileges ."""
515
516 req_body = Element("os-migrateLive",
517 xmlns=XMLNS_11,
518 disk_over_commit=False,
519 block_migration=use_block_migration,
520 host=dest_host)
521
522 resp, body = self.post("servers/%s/action" % str(server_id),
523 str(Document(req_body)), self.headers)
524 return resp, body
525
meera-belurfd279d62013-02-15 15:35:46 -0800526 def list_server_metadata(self, server_id):
527 resp, body = self.get("servers/%s/metadata" % str(server_id),
528 self.headers)
529 body = self._parse_key_value(etree.fromstring(body))
530 return resp, body
531
Chris Yeohd0b52e72013-09-17 22:38:59 +0930532 def set_server_metadata(self, server_id, meta, no_metadata_field=False):
meera-belurfd279d62013-02-15 15:35:46 -0800533 doc = Document()
Chris Yeohd0b52e72013-09-17 22:38:59 +0930534 if not no_metadata_field:
535 metadata = Element("metadata")
536 doc.append(metadata)
537 for k, v in meta.items():
538 meta_element = Element("meta", key=k)
539 meta_element.append(Text(v))
540 metadata.append(meta_element)
meera-belurfd279d62013-02-15 15:35:46 -0800541 resp, body = self.put('servers/%s/metadata' % str(server_id),
542 str(doc), self.headers)
543 return resp, xml_to_json(etree.fromstring(body))
544
545 def update_server_metadata(self, server_id, meta):
546 doc = Document()
547 metadata = Element("metadata")
548 doc.append(metadata)
549 for k, v in meta.items():
550 meta_element = Element("meta", key=k)
551 meta_element.append(Text(v))
552 metadata.append(meta_element)
553 resp, body = self.post("/servers/%s/metadata" % str(server_id),
554 str(doc), headers=self.headers)
555 body = xml_to_json(etree.fromstring(body))
556 return resp, body
557
558 def get_server_metadata_item(self, server_id, key):
559 resp, body = self.get("servers/%s/metadata/%s" % (str(server_id), key),
560 headers=self.headers)
561 return resp, dict([(etree.fromstring(body).attrib['key'],
562 xml_to_json(etree.fromstring(body)))])
563
564 def set_server_metadata_item(self, server_id, key, meta):
565 doc = Document()
566 for k, v in meta.items():
567 meta_element = Element("meta", key=k)
568 meta_element.append(Text(v))
569 doc.append(meta_element)
570 resp, body = self.put('servers/%s/metadata/%s' % (str(server_id), key),
571 str(doc), self.headers)
572 return resp, xml_to_json(etree.fromstring(body))
573
574 def delete_server_metadata_item(self, server_id, key):
575 resp, body = self.delete("servers/%s/metadata/%s" %
576 (str(server_id), key))
577 return resp, body
578
Attila Fazekase4cb04c2013-01-29 09:51:58 +0100579 def get_console_output(self, server_id, length):
Attila Fazekasd4299282013-02-22 13:25:23 +0100580 return self.action(server_id, 'os-getConsoleOutput', 'output',
581 length=length)
Rami Vaknin76bc8bd2013-02-17 16:18:27 +0200582
583 def list_virtual_interfaces(self, server_id):
584 """
585 List the virtual interfaces used in an instance.
586 """
587 resp, body = self.get('/'.join(['servers', server_id,
588 'os-virtual-interfaces']), self.headers)
Rami Vaknin7b9f36b2013-02-20 00:09:07 +0200589 virt_int = self._parse_xml_virtual_interfaces(etree.fromstring(body))
590 return resp, virt_int
nithya-ganesane6a36c82013-02-15 14:38:27 +0000591
592 def rescue_server(self, server_id, adminPass=None):
593 """Rescue the provided server."""
594 return self.action(server_id, 'rescue', None, adminPass=adminPass)
595
596 def unrescue_server(self, server_id):
597 """Unrescue the provided server."""
598 return self.action(server_id, 'unrescue', None)
599
600 def attach_volume(self, server_id, volume_id, device='/dev/vdz'):
601 post_body = Element("volumeAttachment", volumeId=volume_id,
602 device=device)
603 resp, body = self.post('servers/%s/os-volume_attachments' % server_id,
604 str(Document(post_body)), self.headers)
605 return resp, body
606
607 def detach_volume(self, server_id, volume_id):
608 headers = {'Content-Type': 'application/xml',
609 'Accept': 'application/xml'}
610 resp, body = self.delete('servers/%s/os-volume_attachments/%s' %
611 (server_id, volume_id), headers)
612 return resp, body
Leo Toyodafaca6ff2013-04-22 16:52:53 +0900613
Zhu Zhuda070852013-09-25 08:07:57 -0500614 def get_server_diagnostics(self, server_id):
615 """Get the usage data for a server."""
616 resp, body = self.get("servers/%s/diagnostics" % server_id,
617 self.headers)
618 body = xml_to_json(etree.fromstring(body))
619 return resp, body
620
Leo Toyodafaca6ff2013-04-22 16:52:53 +0900621 def list_instance_actions(self, server_id):
622 """List the provided server action."""
623 resp, body = self.get("servers/%s/os-instance-actions" % server_id,
624 self.headers)
625 body = self._parse_array(etree.fromstring(body))
626 return resp, body
627
628 def get_instance_action(self, server_id, request_id):
629 """Returns the action details of the provided server."""
630 resp, body = self.get("servers/%s/os-instance-actions/%s" %
631 (server_id, request_id), self.headers)
632 body = xml_to_json(etree.fromstring(body))
633 return resp, body
Lingxian Kongaecc1092013-10-03 16:18:46 +0800634
635 def force_delete_server(self, server_id, **kwargs):
636 """Force delete a server."""
637 return self.action(server_id, 'forceDelete', None, **kwargs)
638
639 def restore_soft_deleted_server(self, server_id, **kwargs):
640 """Restore a soft-deleted server."""
641 return self.action(server_id, 'restore', None, **kwargs)