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     quota_instances = -1
  44
  45     def __init__(self, **kwargs):
  46         super(Shaker, self).__init__(**kwargs)
  47         self.role = None
  48
  49     def check_requirements(self):
  50         if len(self.orig_cloud.list_hypervisors()) < 2:
  51             self.__logger.warning("Shaker requires at least 2 hypervisors")
  52             self.is_skipped = True
  53             self.project.clean()
  54
  55     def prepare(self):
  56         super(Shaker, self).prepare()
  57         self.cloud.create_security_group_rule(
  58             self.sec.id, port_range_min=self.port, port_range_max=self.port,
  59             protocol='tcp', direction='ingress')
  60
  61     def execute(self):
  62         """
  63         Returns:
  64             - 0 if success
  65             - 1 on operation error
  66         """
  67         assert self.ssh
  68         endpoint = self.get_public_auth_url(self.orig_cloud)
  69         self.__logger.debug("keystone endpoint: %s", endpoint)
  70         if self.orig_cloud.get_role("admin"):
  71             role_name = "admin"
  72         elif self.orig_cloud.get_role("Admin"):
  73             role_name = "Admin"
  74         else:
  75             raise Exception("Cannot detect neither admin nor Admin")
  76         self.orig_cloud.grant_role(
  77             role_name, user=self.project.user.id,
  78             project=self.project.project.id,
  79             domain=self.project.domain.id)
  80         if not self.orig_cloud.get_role("heat_stack_owner"):
  81             self.role = self.orig_cloud.create_role("heat_stack_owner")
  82         self.orig_cloud.grant_role(
  83             "heat_stack_owner", user=self.project.user.id,
  84             project=self.project.project.id,
  85             domain=self.project.domain.id)
  86         self.orig_cloud.set_compute_quotas(
  87             self.project.project.name,
  88             instances=self.quota_instances)
  89         scpc = scp.SCPClient(self.ssh.get_transport())
  90         scpc.put('/home/opnfv/functest/conf/env_file', remote_path='~/')
  91         if os.environ.get('OS_CACERT'):
  92             scpc.put(os.environ.get('OS_CACERT'), remote_path='~/os_cacert')
  93         (_, stdout, stderr) = self.ssh.exec_command(
  94             'source ~/env_file && '
  95             'export OS_INTERFACE=public && '
  96             'export OS_AUTH_URL={} && '
  97             'export OS_USERNAME={} && '
  98             'export OS_PROJECT_NAME={} && '
  99             'export OS_PROJECT_ID={} && '
 100             'unset OS_TENANT_NAME && '
 101             'unset OS_TENANT_ID && '
 102             'unset OS_ENDPOINT_TYPE && '
 103             'export OS_PASSWORD="{}" && '
 104             '{}'
 105             'env && '
 106             'timeout {} shaker --image-name {} --flavor-name {} '
 107             '--server-endpoint {}:9000 --external-net {} --dns-nameservers {} '
 108             '--scenario openstack/full_l2,'
 109             'openstack/full_l3_east_west,'
 110             'openstack/full_l3_north_south,'
 111             'openstack/perf_l3_north_south '
 112             '--report report.html --output report.json'.format(
 113                 endpoint, self.project.user.name, self.project.project.name,
 114                 self.project.project.id, self.project.password,
 115                 'export OS_CACERT=~/os_cacert && ' if os.environ.get(
 116                     'OS_CACERT') else '',
 117                 self.shaker_timeout, self.image.name, self.flavor.name,
 118                 self.fip.floating_ip_address, self.ext_net.id,
 119                 env.get('NAMESERVER')))
 120         self.__logger.info("output:\n%s", stdout.read().decode("utf-8"))
 121         self.__logger.info("error:\n%s", stderr.read().decode("utf-8"))
 122         if not os.path.exists(self.res_dir):
 123             os.makedirs(self.res_dir)
 124         try:
 125             scpc.get('report.json', self.res_dir)
 126             scpc.get('report.html', self.res_dir)
 127         except scp.SCPException:
 128             self.__logger.exception("cannot get report files")
 129             return 1
 130         return stdout.channel.recv_exit_status()
 131
 132     def clean(self):
 133         super(Shaker, self).clean()
 134         if self.role:
 135             self.orig_cloud.delete_role(self.role.id)