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
  26
  27 class Shaker(singlevm.SingleVm2):
  28     """Run shaker full+perf l2 and l3"""
  29     # pylint: disable=too-many-instance-attributes
  30
  31     __logger = logging.getLogger(__name__)
  32
  33     filename = '/home/opnfv/functest/images/shaker-image.qcow2'
  34     flavor_ram = 512
  35     flavor_vcpus = 1
  36     flavor_disk = 3
  37     username = 'ubuntu'
  38     port = 9000
  39     ssh_connect_loops = 12
  40     create_server_timeout = 300
  41     shaker_timeout = '3600'
  42
  43     def __init__(self, **kwargs):
  44         super(Shaker, self).__init__(**kwargs)
  45         self.role = None
  46
  47     def check_requirements(self):
  48         if len(self.orig_cloud.list_hypervisors()) < 2:
  49             self.__logger.warning("Shaker requires at least 2 hypervisors")
  50             self.is_skipped = True
  51             self.project.clean()
  52
  53     def prepare(self):
  54         super(Shaker, self).prepare()
  55         self.cloud.create_security_group_rule(
  56             self.sec.id, port_range_min=self.port, port_range_max=self.port,
  57             protocol='tcp', direction='ingress')
  58
  59     def execute(self):
  60         """
  61         Returns:
  62             - 0 if success
  63             - 1 on operation error
  64         """
  65         assert self.ssh
  66         endpoint = self.get_public_auth_url(self.orig_cloud)
  67         self.__logger.debug("keystone endpoint: %s", endpoint)
  68         if self.orig_cloud.get_role("admin"):
  69             role_name = "admin"
  70         elif self.orig_cloud.get_role("Admin"):
  71             role_name = "Admin"
  72         else:
  73             raise Exception("Cannot detect neither admin nor Admin")
  74         self.orig_cloud.grant_role(
  75             role_name, user=self.project.user.id,
  76             project=self.project.project.id,
  77             domain=self.project.domain.id)
  78         if not self.orig_cloud.get_role("heat_stack_owner"):
  79             self.role = self.orig_cloud.create_role("heat_stack_owner")
  80         self.orig_cloud.grant_role(
  81             "heat_stack_owner", user=self.project.user.id,
  82             project=self.project.project.id,
  83             domain=self.project.domain.id)
  84         scpc = scp.SCPClient(self.ssh.get_transport())
  85         scpc.put('/home/opnfv/functest/conf/env_file', remote_path='~/')
  86         if os.environ.get('OS_CACERT'):
  87             scpc.put(os.environ.get('OS_CACERT'), remote_path='~/os_cacert')
  88         (_, stdout, stderr) = self.ssh.exec_command(
  89             'source ~/env_file && '
  90             'export OS_INTERFACE=public && '
  91             'export OS_AUTH_URL={} && '
  92             'export OS_USERNAME={} && '
  93             'export OS_PROJECT_NAME={} && '
  94             'export OS_PROJECT_ID={} && '
  95             'unset OS_TENANT_NAME && '
  96             'unset OS_TENANT_ID && '
  97             'unset OS_ENDPOINT_TYPE && '
  98             'export OS_PASSWORD={} && '
  99             '{}'
 100             'env && '
 101             'timeout {} shaker --image-name {} --flavor-name {} '
 102             '--server-endpoint {}:9000 --scenario '
 103             'openstack/full_l2,'
 104             'openstack/full_l3_east_west,'
 105             'openstack/full_l3_north_south,'
 106             'openstack/perf_l3_north_south '
 107             '--report report.html --output report.json'.format(
 108                 endpoint, self.project.user.name, self.project.project.name,
 109                 self.project.project.id, self.project.password,
 110                 'export OS_CACERT=~/os_cacert && ' if os.environ.get(
 111                     'OS_CACERT') else '',
 112                 self.shaker_timeout, self.image.name, self.flavor.name,
 113                 self.fip.floating_ip_address))
 114         self.__logger.info("output:\n%s", stdout.read())
 115         self.__logger.info("error:\n%s", stderr.read())
 116         if not os.path.exists(self.res_dir):
 117             os.makedirs(self.res_dir)
 118         try:
 119             scpc.get('report.json', self.res_dir)
 120             scpc.get('report.html', self.res_dir)
 121         except scp.SCPException:
 122             self.__logger.exception("cannot get report files")
 123             return 1
 124         return stdout.channel.recv_exit_status()
 125
 126     def clean(self):
 127         super(Shaker, self).clean()
 128         if self.role:
 129             self.orig_cloud.delete_role(self.role.id)