1ee669ce3c0cdd048e416ad24a71cf5187064757
[functest.git] / functest / opnfv_tests / openstack / shaker / shaker.py
1 #!/usr/bin/env python
2
3 # Copyright (c) 2018 Orange and others.
4 #
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
9
10 """
11 Shaker_ wraps around popular system network testing tools like iperf, iperf3
12 and netperf (with help of flent). Shaker is able to deploy OpenStack instances
13 and networks in different topologies. Shaker scenario specifies the deployment
14 and list of tests to execute.
15
16 .. _Shaker: http://pyshaker.readthedocs.io/en/latest/
17 """
18
19 import logging
20 import os
21
22 import scp
23
24 from functest.core import singlevm
25 from functest.utils import env
26
27
28 class Shaker(singlevm.SingleVm2):
29     """Run shaker full+perf l2 and l3"""
30     # pylint: disable=too-many-instance-attributes
31
32     __logger = logging.getLogger(__name__)
33
34     filename = '/home/opnfv/functest/images/shaker-image.qcow2'
35     flavor_ram = 512
36     flavor_vcpus = 1
37     flavor_disk = 3
38     username = 'ubuntu'
39     port = 9000
40     ssh_connect_loops = 12
41     create_server_timeout = 300
42     shaker_timeout = '3600'
43
44     def __init__(self, **kwargs):
45         super(Shaker, self).__init__(**kwargs)
46         self.role = None
47
48     def check_requirements(self):
49         if len(self.orig_cloud.list_hypervisors()) < 2:
50             self.__logger.warning("Shaker requires at least 2 hypervisors")
51             self.is_skipped = True
52             self.project.clean()
53
54     def prepare(self):
55         super(Shaker, self).prepare()
56         self.cloud.create_security_group_rule(
57             self.sec.id, port_range_min=self.port, port_range_max=self.port,
58             protocol='tcp', direction='ingress')
59
60     def execute(self):
61         """
62         Returns:
63             - 0 if success
64             - 1 on operation error
65         """
66         assert self.ssh
67         endpoint = self.get_public_auth_url(self.orig_cloud)
68         self.__logger.debug("keystone endpoint: %s", endpoint)
69         if self.orig_cloud.get_role("admin"):
70             role_name = "admin"
71         elif self.orig_cloud.get_role("Admin"):
72             role_name = "Admin"
73         else:
74             raise Exception("Cannot detect neither admin nor Admin")
75         self.orig_cloud.grant_role(
76             role_name, user=self.project.user.id,
77             project=self.project.project.id,
78             domain=self.project.domain.id)
79         if not self.orig_cloud.get_role("heat_stack_owner"):
80             self.role = self.orig_cloud.create_role("heat_stack_owner")
81         self.orig_cloud.grant_role(
82             "heat_stack_owner", user=self.project.user.id,
83             project=self.project.project.id,
84             domain=self.project.domain.id)
85         scpc = scp.SCPClient(self.ssh.get_transport())
86         scpc.put('/home/opnfv/functest/conf/env_file', remote_path='~/')
87         if os.environ.get('OS_CACERT'):
88             scpc.put(os.environ.get('OS_CACERT'), remote_path='~/os_cacert')
89         (_, stdout, stderr) = self.ssh.exec_command(
90             'source ~/env_file && '
91             'export OS_INTERFACE=public && '
92             'export OS_AUTH_URL={} && '
93             'export OS_USERNAME={} && '
94             'export OS_PROJECT_NAME={} && '
95             'export OS_PROJECT_ID={} && '
96             'unset OS_TENANT_NAME && '
97             'unset OS_TENANT_ID && '
98             'unset OS_ENDPOINT_TYPE && '
99             'export OS_PASSWORD={} && '
100             '{}'
101             'env && '
102             'timeout {} shaker --image-name {} --flavor-name {} '
103             '--server-endpoint {}:9000 --external-net {} --dns-nameservers {} '
104             '--scenario openstack/full_l2,'
105             'openstack/full_l3_east_west,'
106             'openstack/full_l3_north_south,'
107             'openstack/perf_l3_north_south '
108             '--report report.html --output report.json'.format(
109                 endpoint, self.project.user.name, self.project.project.name,
110                 self.project.project.id, self.project.password,
111                 'export OS_CACERT=~/os_cacert && ' if os.environ.get(
112                     'OS_CACERT') else '',
113                 self.shaker_timeout, self.image.name, self.flavor.name,
114                 self.fip.floating_ip_address, self.ext_net.id,
115                 env.get('NAMESERVER')))
116         self.__logger.info("output:\n%s", stdout.read().decode("utf-8"))
117         self.__logger.info("error:\n%s", stderr.read().decode("utf-8"))
118         if not os.path.exists(self.res_dir):
119             os.makedirs(self.res_dir)
120         try:
121             scpc.get('report.json', self.res_dir)
122             scpc.get('report.html', self.res_dir)
123         except scp.SCPException:
124             self.__logger.exception("cannot get report files")
125             return 1
126         return stdout.channel.recv_exit_status()
127
128     def clean(self):
129         super(Shaker, self).clean()
130         if self.role:
131             self.orig_cloud.delete_role(self.role.id)