1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
|
##############################################################################
# Copyright (c) 2016 Huawei Technologies Co.,Ltd and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
from __future__ import absolute_import
import os
import time
import logging
from keystoneauth1 import loading
from keystoneauth1 import session
from novaclient import client as novaclient
from glanceclient import client as glanceclient
from neutronclient.neutron import client as neutronclient
log = logging.getLogger(__name__)
DEFAULT_HEAT_API_VERSION = '1'
DEFAULT_API_VERSION = '2'
# *********************************************
# CREDENTIALS
# *********************************************
def get_credentials():
"""Returns a creds dictionary filled with parsed from env"""
creds = {}
keystone_api_version = os.getenv('OS_IDENTITY_API_VERSION')
if keystone_api_version is None or keystone_api_version == '2':
keystone_v3 = False
tenant_env = 'OS_TENANT_NAME'
tenant = 'tenant_name'
else:
keystone_v3 = True
tenant_env = 'OS_PROJECT_NAME'
tenant = 'project_name'
# The most common way to pass these info to the script is to do it
# through environment variables.
creds.update({
"username": os.environ.get("OS_USERNAME"),
"password": os.environ.get("OS_PASSWORD"),
"auth_url": os.environ.get("OS_AUTH_URL"),
tenant: os.environ.get(tenant_env)
})
if keystone_v3:
if os.getenv('OS_USER_DOMAIN_NAME') is not None:
creds.update({
"user_domain_name": os.getenv('OS_USER_DOMAIN_NAME')
})
if os.getenv('OS_PROJECT_DOMAIN_NAME') is not None:
creds.update({
"project_domain_name": os.getenv('OS_PROJECT_DOMAIN_NAME')
})
return creds
def get_session_auth():
loader = loading.get_plugin_loader('password')
creds = get_credentials()
auth = loader.load_from_options(**creds)
return auth
def get_session():
auth = get_session_auth()
try:
cacert = os.environ['OS_CACERT']
except KeyError:
return session.Session(auth=auth)
else:
return session.Session(auth=auth, verify=cacert)
def get_endpoint(service_type, endpoint_type='publicURL'):
auth = get_session_auth()
return get_session().get_endpoint(auth=auth,
service_type=service_type,
endpoint_type=endpoint_type)
# *********************************************
# CLIENTS
# *********************************************
def get_heat_api_version(): # pragma: no cover
try:
api_version = os.environ['HEAT_API_VERSION']
except KeyError:
return DEFAULT_HEAT_API_VERSION
else:
log.info("HEAT_API_VERSION is set in env as '%s'", api_version)
return api_version
def get_nova_client_version(): # pragma: no cover
try:
api_version = os.environ['OS_COMPUTE_API_VERSION']
except KeyError:
return DEFAULT_API_VERSION
else:
log.info("OS_COMPUTE_API_VERSION is set in env as '%s'", api_version)
return api_version
def get_nova_client(): # pragma: no cover
sess = get_session()
return novaclient.Client(get_nova_client_version(), session=sess)
def get_neutron_client_version(): # pragma: no cover
try:
api_version = os.environ['OS_NETWORK_API_VERSION']
except KeyError:
return DEFAULT_API_VERSION
else:
log.info("OS_NETWORK_API_VERSION is set in env as '%s'", api_version)
return api_version
def get_neutron_client(): # pragma: no cover
sess = get_session()
return neutronclient.Client(get_neutron_client_version(), session=sess)
def get_glance_client_version(): # pragma: no cover
try:
api_version = os.environ['OS_IMAGE_API_VERSION']
except KeyError:
return DEFAULT_API_VERSION
else:
log.info("OS_IMAGE_API_VERSION is set in env as '%s'", api_version)
return api_version
def get_glance_client(): # pragma: no cover
sess = get_session()
return glanceclient.Client(get_glance_client_version(), session=sess)
# *********************************************
# NOVA
# *********************************************
def get_instances(nova_client): # pragma: no cover
try:
return nova_client.servers.list(search_opts={'all_tenants': 1})
except Exception:
log.exception("Error [get_instances(nova_client)]")
def get_instance_status(nova_client, instance): # pragma: no cover
try:
return nova_client.servers.get(instance.id).status
except Exception:
log.exception("Error [get_instance_status(nova_client)]")
def get_instance_by_name(nova_client, instance_name): # pragma: no cover
try:
return nova_client.servers.find(name=instance_name)
except Exception:
log.exception("Error [get_instance_by_name(nova_client, '%s')]",
instance_name)
def get_aggregates(nova_client): # pragma: no cover
try:
return nova_client.aggregates.list()
except Exception:
log.exception("Error [get_aggregates(nova_client)]")
def get_availability_zones(nova_client): # pragma: no cover
try:
return nova_client.availability_zones.list()
except Exception:
log.exception("Error [get_availability_zones(nova_client)]")
def get_availability_zone_names(nova_client): # pragma: no cover
try:
return [az.zoneName for az in get_availability_zones(nova_client)]
except Exception:
log.exception("Error [get_availability_zone_names(nova_client)]")
def create_aggregate(nova_client, aggregate_name, av_zone): # pragma: no cover
try:
nova_client.aggregates.create(aggregate_name, av_zone)
except Exception:
log.exception("Error [create_aggregate(nova_client, %s, %s)]",
aggregate_name, av_zone)
return False
else:
return True
def get_aggregate_id(nova_client, aggregate_name): # pragma: no cover
try:
aggregates = get_aggregates(nova_client)
_id = next((ag.id for ag in aggregates if ag.name == aggregate_name))
except Exception:
log.exception("Error [get_aggregate_id(nova_client, %s)]",
aggregate_name)
else:
return _id
def add_host_to_aggregate(nova_client, aggregate_name,
compute_host): # pragma: no cover
try:
aggregate_id = get_aggregate_id(nova_client, aggregate_name)
nova_client.aggregates.add_host(aggregate_id, compute_host)
except Exception:
log.exception("Error [add_host_to_aggregate(nova_client, %s, %s)]",
aggregate_name, compute_host)
return False
else:
return True
def create_aggregate_with_host(nova_client, aggregate_name, av_zone,
compute_host): # pragma: no cover
try:
create_aggregate(nova_client, aggregate_name, av_zone)
add_host_to_aggregate(nova_client, aggregate_name, compute_host)
except Exception:
log.exception("Error [create_aggregate_with_host("
"nova_client, %s, %s, %s)]",
aggregate_name, av_zone, compute_host)
return False
else:
return True
def create_instance(flavor_name,
image_id,
network_id,
instance_name="instance-vm",
confdrive=True,
userdata=None,
av_zone='',
fixed_ip=None,
files=None): # pragma: no cover
nova_client = get_nova_client()
try:
flavor = nova_client.flavors.find(name=flavor_name)
except:
flavors = nova_client.flavors.list()
log.exception("Error: Flavor '%s' not found. Available flavors are: "
"\n%s", flavor_name, flavors)
return None
if fixed_ip is not None:
nics = {"net-id": network_id, "v4-fixed-ip": fixed_ip}
else:
nics = {"net-id": network_id}
if userdata is None:
instance = nova_client.servers.create(
name=instance_name,
flavor=flavor,
image=image_id,
nics=[nics],
availability_zone=av_zone,
files=files
)
else:
instance = nova_client.servers.create(
name=instance_name,
flavor=flavor,
image=image_id,
nics=[nics],
config_drive=confdrive,
userdata=userdata,
availability_zone=av_zone,
files=files
)
return instance
def create_instance_and_wait_for_active(flavor_name,
image_id,
network_id,
instance_name="instance-vm",
config_drive=False,
userdata="",
av_zone='',
fixed_ip=None,
files=None): # pragma: no cover
SLEEP = 3
VM_BOOT_TIMEOUT = 180
nova_client = get_nova_client()
instance = create_instance(flavor_name,
image_id,
network_id,
instance_name,
config_drive,
userdata,
av_zone=av_zone,
fixed_ip=fixed_ip,
files=files)
count = VM_BOOT_TIMEOUT / SLEEP
for n in range(count, -1, -1):
status = get_instance_status(nova_client, instance)
if status.lower() == "active":
return instance
elif status.lower() == "error":
log.error("The instance %s went to ERROR status.", instance_name)
return None
time.sleep(SLEEP)
log.error("Timeout booting the instance %s.", instance_name)
return None
def delete_instance(nova_client, instance_id): # pragma: no cover
try:
nova_client.servers.force_delete(instance_id)
except Exception:
log.exception("Error [delete_instance(nova_client, '%s')]",
instance_id)
return False
else:
return True
def remove_host_from_aggregate(nova_client, aggregate_name,
compute_host): # pragma: no cover
try:
aggregate_id = get_aggregate_id(nova_client, aggregate_name)
nova_client.aggregates.remove_host(aggregate_id, compute_host)
except Exception:
log.exception("Error remove_host_from_aggregate(nova_client, %s, %s)",
aggregate_name, compute_host)
return False
else:
return True
def remove_hosts_from_aggregate(nova_client,
aggregate_name): # pragma: no cover
aggregate_id = get_aggregate_id(nova_client, aggregate_name)
hosts = nova_client.aggregates.get(aggregate_id).hosts
assert(
all(remove_host_from_aggregate(nova_client, aggregate_name, host)
for host in hosts))
def delete_aggregate(nova_client, aggregate_name): # pragma: no cover
try:
remove_hosts_from_aggregate(nova_client, aggregate_name)
nova_client.aggregates.delete(aggregate_name)
except Exception:
log.exception("Error [delete_aggregate(nova_client, %s)]",
aggregate_name)
return False
else:
return True
def get_server_by_name(name): # pragma: no cover
try:
return get_nova_client().servers.list(search_opts={'name': name})[0]
except IndexError:
log.exception('Failed to get nova client')
raise
def get_image_by_name(name): # pragma: no cover
images = get_nova_client().images.list()
try:
return next((a for a in images if a.name == name))
except StopIteration:
log.exception('No image matched')
def get_flavor_by_name(name): # pragma: no cover
flavors = get_nova_client().flavors.list()
try:
return next((a for a in flavors if a.name == name))
except StopIteration:
log.exception('No flavor matched')
def check_status(status, name, iterations, interval): # pragma: no cover
for i in range(iterations):
try:
server = get_server_by_name(name)
except IndexError:
log.error('Cannot found %s server', name)
raise
if server.status == status:
return True
time.sleep(interval)
return False
# *********************************************
# NEUTRON
# *********************************************
def get_network_id(neutron_client, network_name): # pragma: no cover
networks = neutron_client.list_networks()['networks']
return next((n['id'] for n in networks if n['name'] == network_name), None)
def get_port_id_by_ip(neutron_client, ip_address): # pragma: no cover
ports = neutron_client.list_ports()['ports']
return next((i['id'] for i in ports for j in i.get(
'fixed_ips') if j['ip_address'] == ip_address), None)
# *********************************************
# GLANCE
# *********************************************
def get_image_id(glance_client, image_name): # pragma: no cover
images = glance_client.images.list()
return next((i.id for i in images if i.name == image_name), None)
|