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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
#!/usr/bin/env python
# Copyright (c) 2018 Orange 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
"""Ease deploying a single VM reachable via ssh
It offers a simple way to create all tenant network resources + a VM for
advanced testcases (e.g. deploying an orchestrator).
"""
import logging
import re
import tempfile
import time
import paramiko
from xtesting.core import testcase
from functest.core import tenantnetwork
from functest.utils import config
class VmReady1(tenantnetwork.TenantNetwork1):
"""Prepare a single VM (scenario1)
It inherits from TenantNetwork1 which creates all network resources and
prepares a future VM attached to that network.
It ensures that all testcases inheriting from SingleVm1 could work
without specific configurations (or at least read the same config data).
"""
# pylint: disable=too-many-instance-attributes
__logger = logging.getLogger(__name__)
filename = '/home/opnfv/functest/images/cirros-0.4.0-x86_64-disk.img'
image_format = 'qcow2'
extra_properties = {}
filename_alt = filename
image_alt_format = image_format
extra_alt_properties = extra_properties
visibility = 'private'
flavor_ram = 512
flavor_vcpus = 1
flavor_disk = 1
flavor_extra_specs = {}
flavor_alt_ram = 1024
flavor_alt_vcpus = 1
flavor_alt_disk = 1
flavor_alt_extra_specs = flavor_extra_specs
create_server_timeout = 180
def __init__(self, **kwargs):
if "case_name" not in kwargs:
kwargs["case_name"] = 'vmready1'
super(VmReady1, self).__init__(**kwargs)
self.orig_cloud = self.cloud
self.image = None
self.flavor = None
def publish_image(self, name=None):
"""Publish image
It allows publishing multiple images for the child testcases. It forces
the same configuration for all subtestcases.
Returns: image
Raises: expection on error
"""
assert self.cloud
extra_properties = self.extra_properties.copy()
extra_properties.update(
getattr(config.CONF, '{}_extra_properties'.format(
self.case_name), {}))
image = self.cloud.create_image(
name if name else '{}-img_{}'.format(self.case_name, self.guid),
filename=getattr(
config.CONF, '{}_image'.format(self.case_name),
self.filename),
meta=extra_properties,
disk_format=getattr(
config.CONF, '{}_image_format'.format(self.case_name),
self.image_format),
visibility=getattr(
config.CONF, '{}_visibility'.format(self.case_name),
self.visibility),
wait=True)
self.__logger.debug("image: %s", image)
return image
def publish_image_alt(self, name=None):
"""Publish alternative image
It allows publishing multiple images for the child testcases. It forces
the same configuration for all subtestcases.
Returns: image
Raises: expection on error
"""
assert self.cloud
extra_alt_properties = self.extra_alt_properties.copy()
extra_alt_properties.update(
getattr(config.CONF, '{}_extra_alt_properties'.format(
self.case_name), {}))
image = self.cloud.create_image(
name if name else '{}-img_alt_{}'.format(
self.case_name, self.guid),
filename=getattr(
config.CONF, '{}_image_alt'.format(self.case_name),
self.filename_alt),
meta=extra_alt_properties,
disk_format=getattr(
config.CONF, '{}_image_alt_format'.format(self.case_name),
self.image_format),
visibility=getattr(
config.CONF, '{}_visibility'.format(self.case_name),
self.visibility),
wait=True)
self.__logger.debug("image: %s", image)
return image
def create_flavor(self, name=None):
"""Create flavor
It allows creating multiple flavors for the child testcases. It forces
the same configuration for all subtestcases.
Returns: flavor
Raises: expection on error
"""
assert self.orig_cloud
flavor = self.orig_cloud.create_flavor(
name if name else '{}-flavor_{}'.format(self.case_name, self.guid),
getattr(config.CONF, '{}_flavor_ram'.format(self.case_name),
self.flavor_ram),
getattr(config.CONF, '{}_flavor_vcpus'.format(self.case_name),
self.flavor_vcpus),
getattr(config.CONF, '{}_flavor_disk'.format(self.case_name),
self.flavor_disk))
self.__logger.debug("flavor: %s", flavor)
flavor_extra_specs = self.flavor_extra_specs.copy()
flavor_extra_specs.update(
getattr(config.CONF,
'{}_flavor_extra_specs'.format(self.case_name), {}))
self.orig_cloud.set_flavor_specs(flavor.id, flavor_extra_specs)
return flavor
def create_flavor_alt(self, name=None):
"""Create flavor
It allows creating multiple alt flavors for the child testcases. It
forces the same configuration for all subtestcases.
Returns: flavor
Raises: expection on error
"""
assert self.orig_cloud
flavor = self.orig_cloud.create_flavor(
name if name else '{}-flavor_alt_{}'.format(
self.case_name, self.guid),
getattr(config.CONF, '{}_flavor_alt_ram'.format(self.case_name),
self.flavor_alt_ram),
getattr(config.CONF, '{}_flavor_alt_vcpus'.format(self.case_name),
self.flavor_alt_vcpus),
getattr(config.CONF, '{}_flavor_alt_disk'.format(self.case_name),
self.flavor_alt_disk))
self.__logger.debug("flavor: %s", flavor)
flavor_alt_extra_specs = self.flavor_alt_extra_specs.copy()
flavor_alt_extra_specs.update(
getattr(config.CONF,
'{}_flavor_alt_extra_specs'.format(self.case_name), {}))
self.orig_cloud.set_flavor_specs(
flavor.id, flavor_alt_extra_specs)
return flavor
def boot_vm(self, name=None, **kwargs):
"""Boot the virtual machine
It allows booting multiple machines for the child testcases. It forces
the same configuration for all subtestcases.
Returns: vm
Raises: expection on error
"""
assert self.cloud
vm1 = self.cloud.create_server(
name if name else '{}-vm_{}'.format(self.case_name, self.guid),
image=self.image.id, flavor=self.flavor.id,
auto_ip=False, network=self.network.id,
timeout=self.create_server_timeout, wait=True, **kwargs)
self.__logger.debug("vm: %s", vm1)
return vm1
def check_regex_in_console(self, name, regex=' login: ', loop=1):
"""Wait for specific message in console
Returns: True or False on errors
"""
assert self.cloud
for iloop in range(loop):
console = self.cloud.get_server_console(name)
self.__logger.debug("console: \n%s", console)
if re.search(regex, console):
self.__logger.debug("regex found: ''%s' in console", regex)
return True
else:
self.__logger.debug(
"try %s: cannot find regex '%s' in console",
iloop + 1, regex)
time.sleep(10)
self.__logger.error("cannot find regex '%s' in console", regex)
return False
def run(self, **kwargs):
"""Boot the new VM
Here are the main actions:
- publish the image
- create the flavor
Returns:
- TestCase.EX_OK
- TestCase.EX_RUN_ERROR on error
"""
status = testcase.TestCase.EX_RUN_ERROR
try:
assert self.cloud
assert super(VmReady1, self).run(
**kwargs) == testcase.TestCase.EX_OK
self.image = self.publish_image()
self.flavor = self.create_flavor()
self.result = 100
status = testcase.TestCase.EX_OK
except Exception: # pylint: disable=broad-except
self.__logger.exception('Cannot run %s', self.case_name)
self.result = 0
finally:
self.stop_time = time.time()
return status
def clean(self):
try:
assert self.orig_cloud
assert self.cloud
super(VmReady1, self).clean()
if self.image:
self.cloud.delete_image(self.image.id)
if self.flavor:
self.orig_cloud.delete_flavor(self.flavor.id)
except Exception: # pylint: disable=broad-except
self.__logger.exception("Cannot clean all resources")
class VmReady2(VmReady1):
"""Deploy a single VM reachable via ssh (scenario2)
It creates new user/project before creating and configuring all tenant
network resources, flavors, images, etc. required by advanced testcases.
It ensures that all testcases inheriting from SingleVm2 could work
without specific configurations (or at least read the same config data).
"""
__logger = logging.getLogger(__name__)
def __init__(self, **kwargs):
if "case_name" not in kwargs:
kwargs["case_name"] = 'vmready2'
super(VmReady2, self).__init__(**kwargs)
try:
assert self.orig_cloud
self.project = tenantnetwork.NewProject(
self.orig_cloud, self.case_name, self.guid)
self.project.create()
self.cloud = self.project.cloud
except Exception: # pylint: disable=broad-except
self.__logger.exception("Cannot create user or project")
self.cloud = None
self.project = None
def clean(self):
try:
super(VmReady2, self).clean()
assert self.project
self.project.clean()
except Exception: # pylint: disable=broad-except
self.__logger.exception("Cannot clean all resources")
class SingleVm1(VmReady1):
"""Deploy a single VM reachable via ssh (scenario1)
It inherits from TenantNetwork1 which creates all network resources and
completes it by booting a VM attached to that network.
It ensures that all testcases inheriting from SingleVm1 could work
without specific configurations (or at least read the same config data).
"""
# pylint: disable=too-many-instance-attributes
__logger = logging.getLogger(__name__)
username = 'cirros'
ssh_connect_timeout = 1
ssh_connect_loops = 6
create_floating_ip_timeout = 120
def __init__(self, **kwargs):
if "case_name" not in kwargs:
kwargs["case_name"] = 'singlevm1'
super(SingleVm1, self).__init__(**kwargs)
self.sshvm = None
self.sec = None
self.fip = None
self.keypair = None
self.ssh = None
(_, self.key_filename) = tempfile.mkstemp()
def prepare(self):
"""Create the security group and the keypair
It can be overriden to set other rules according to the services
running in the VM
Raises: Exception on error
"""
assert self.cloud
self.keypair = self.cloud.create_keypair(
'{}-kp_{}'.format(self.case_name, self.guid))
self.__logger.debug("keypair: %s", self.keypair)
self.__logger.debug("private_key: %s", self.keypair.private_key)
with open(self.key_filename, 'w') as private_key_file:
private_key_file.write(self.keypair.private_key)
self.sec = self.cloud.create_security_group(
'{}-sg_{}'.format(self.case_name, self.guid),
'created by OPNFV Functest ({})'.format(self.case_name))
self.cloud.create_security_group_rule(
self.sec.id, port_range_min='22', port_range_max='22',
protocol='tcp', direction='ingress')
self.cloud.create_security_group_rule(
self.sec.id, protocol='icmp', direction='ingress')
def connect(self, vm1):
"""Connect to a virtual machine via ssh
It first adds a floating ip to the virtual machine and then establishes
the ssh connection.
Returns:
- (fip, ssh)
- None on error
"""
assert vm1
fip = self.cloud.create_floating_ip(
network=self.ext_net.id, server=vm1, wait=True,
timeout=self.create_floating_ip_timeout)
self.__logger.debug("floating_ip: %s", fip)
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.client.AutoAddPolicy())
for loop in range(self.ssh_connect_loops):
try:
p_console = self.cloud.get_server_console(vm1)
self.__logger.debug("vm console: \n%s", p_console)
ssh.connect(
fip.floating_ip_address,
username=getattr(
config.CONF,
'{}_image_user'.format(self.case_name), self.username),
key_filename=self.key_filename,
timeout=getattr(
config.CONF,
'{}_vm_ssh_connect_timeout'.format(self.case_name),
self.ssh_connect_timeout))
break
except Exception as exc: # pylint: disable=broad-except
self.__logger.debug(
"try %s: cannot connect to %s: %s", loop + 1,
fip.floating_ip_address, exc)
time.sleep(9)
else:
self.__logger.error(
"cannot connect to %s", fip.floating_ip_address)
return None
return (fip, ssh)
def execute(self):
"""Say hello world via ssh
It can be overriden to execute any command.
Returns: echo exit codes
"""
(_, stdout, stderr) = self.ssh.exec_command('echo Hello World')
self.__logger.debug("output:\n%s", stdout.read())
self.__logger.debug("error:\n%s", stderr.read())
return stdout.channel.recv_exit_status()
def run(self, **kwargs):
"""Boot the new VM
Here are the main actions:
- add a new ssh key
- boot the VM
- create the security group
- execute the right command over ssh
Returns:
- TestCase.EX_OK
- TestCase.EX_RUN_ERROR on error
"""
status = testcase.TestCase.EX_RUN_ERROR
try:
assert self.cloud
assert super(SingleVm1, self).run(
**kwargs) == testcase.TestCase.EX_OK
self.result = 0
self.prepare()
self.sshvm = self.boot_vm(
key_name=self.keypair.id, security_groups=[self.sec.id])
(self.fip, self.ssh) = self.connect(self.sshvm)
if not self.execute():
self.result = 100
status = testcase.TestCase.EX_OK
except Exception: # pylint: disable=broad-except
self.__logger.exception('Cannot run %s', self.case_name)
finally:
self.stop_time = time.time()
return status
def clean(self):
try:
assert self.orig_cloud
assert self.cloud
if self.fip:
self.cloud.delete_floating_ip(self.fip.id)
if self.sshvm:
self.cloud.delete_server(self.sshvm, wait=True)
if self.sec:
self.cloud.delete_security_group(self.sec.id)
if self.keypair:
self.cloud.delete_keypair(self.keypair.name)
super(SingleVm1, self).clean()
except Exception: # pylint: disable=broad-except
self.__logger.exception("Cannot clean all resources")
class SingleVm2(SingleVm1):
"""Deploy a single VM reachable via ssh (scenario2)
It creates new user/project before creating and configuring all tenant
network resources and vms required by advanced testcases.
It ensures that all testcases inheriting from SingleVm2 could work
without specific configurations (or at least read the same config data).
"""
__logger = logging.getLogger(__name__)
def __init__(self, **kwargs):
if "case_name" not in kwargs:
kwargs["case_name"] = 'singlevm2'
super(SingleVm2, self).__init__(**kwargs)
try:
assert self.orig_cloud
self.project = tenantnetwork.NewProject(
self.orig_cloud, self.case_name, self.guid)
self.project.create()
self.cloud = self.project.cloud
except Exception: # pylint: disable=broad-except
self.__logger.exception("Cannot create user or project")
self.cloud = None
self.project = None
def clean(self):
try:
super(SingleVm2, self).clean()
assert self.project
self.project.clean()
except Exception: # pylint: disable=broad-except
self.__logger.exception("Cannot clean all resources")
|