resources/libraries/python/SetupFramework.py

   1 # Copyright (c) 2016 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """This module exists to provide setup utilities for the framework on topology
  15 nodes. All tasks required to be run before the actual tests are started is
  16 supposed to end up here.
  17 """
  18
  19 from shlex import split
  20 from subprocess import Popen, PIPE, call
  21 from multiprocessing import Pool
  22 from tempfile import NamedTemporaryFile
  23 from os.path import basename
  24 from os import environ
  25
  26 from robot.api import logger
  27 from robot.libraries.BuiltIn import BuiltIn
  28
  29 from resources.libraries.python.ssh import SSH
  30 from resources.libraries.python.constants import Constants as con
  31 from resources.libraries.python.topology import NodeType
  32
  33 __all__ = ["SetupFramework"]
  34
  35
  36 def pack_framework_dir():
  37     """Pack the testing WS into temp file, return its name."""
  38
  39     try:
  40         directory = environ["TMPDIR"]
  41     except Keyerror:
  42         directory = None
  43
  44     if directory is not None:
  45         tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-",\
  46                                      dir="{0}".format(directory))
  47     else:
  48         tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-")
  49     file_name = tmpfile.name
  50     tmpfile.close()
  51
  52     proc = Popen(
  53         split("tar --exclude-vcs -zcf {0} .".format(file_name)),
  54         stdout=PIPE, stderr=PIPE)
  55     (stdout, stderr) = proc.communicate()
  56
  57     logger.debug(stdout)
  58     logger.debug(stderr)
  59
  60     return_code = proc.wait()
  61     if 0 != return_code:
  62         raise Exception("Could not pack testing framework.")
  63
  64     return file_name
  65
  66
  67 def copy_tarball_to_node(tarball, node):
  68     """Copy tarball file from local host to remote node.
  69
  70     :param tarball: Path to tarball to upload.
  71     :param node: Dictionary created from topology.
  72     :type tarball: str
  73     :type node: dict
  74     :return: nothing
  75     """
  76     logger.console('Copying tarball to {0}'.format(node['host']))
  77     ssh = SSH()
  78     ssh.connect(node)
  79
  80     ssh.scp(tarball, "/tmp/")
  81
  82
  83 def extract_tarball_at_node(tarball, node):
  84     """Extract tarball at given node.
  85
  86     Extracts tarball using tar on given node to specific CSIT loocation.
  87
  88     :param tarball: Path to tarball to upload.
  89     :param node: Dictionary created from topology.
  90     :type tarball: str
  91     :type node: dict
  92     :return: nothing
  93     """
  94     logger.console('Extracting tarball to {0} on {1}'.format(
  95         con.REMOTE_FW_DIR, node['host']))
  96     ssh = SSH()
  97     ssh.connect(node)
  98
  99     cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
 100         'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
 101     (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
 102     if 0 != ret_code:
 103         logger.error('Unpack error: {0}'.format(stderr))
 104         raise Exception('Failed to unpack {0} at node {1}'.format(
 105             tarball, node['host']))
 106
 107
 108 def create_env_directory_at_node(node):
 109     """Create fresh virtualenv to a directory, install pip requirements."""
 110     logger.console('Extracting virtualenv, installing requirements.txt '
 111                    'on {0}'.format(node['host']))
 112     ssh = SSH()
 113     ssh.connect(node)
 114     (ret_code, stdout, stderr) = ssh.exec_command(
 115         'cd {0} && rm -rf env && virtualenv --system-site-packages env && . env/bin/activate && '
 116         'pip install -r requirements.txt'
 117         .format(con.REMOTE_FW_DIR), timeout=100)
 118     if 0 != ret_code:
 119         logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
 120         raise Exception('Virtualenv setup failed')
 121     else:
 122         logger.console('Virtualenv created on {0}'.format(node['host']))
 123
 124 #pylint: disable=broad-except
 125 def setup_node(args):
 126     """Run all set-up methods for a node.
 127
 128     This method is used as map_async parameter. It receives tuple with all
 129     parameters as passed to map_async function.
 130
 131     :param args: All parameters needed to setup one node.
 132     :type args: tuple
 133     :return: nothing
 134     :return: True - success, False - error
 135     :rtype: bool
 136     """
 137     tarball, remote_tarball, node = args
 138     try:
 139         copy_tarball_to_node(tarball, node)
 140         extract_tarball_at_node(remote_tarball, node)
 141         if node['type'] == NodeType.TG:
 142             create_env_directory_at_node(node)
 143     except Exception as exc:
 144         logger.error("Node setup failed, error:'{0}'".format(exc.message))
 145         return False
 146     else:
 147         logger.console('Setup of node {0} done'.format(node['host']))
 148         return True
 149
 150 def delete_local_tarball(tarball):
 151     """Delete local tarball to prevent disk pollution.
 152
 153     :param tarball: Path to tarball to upload.
 154     :type tarball: str
 155     :return: nothing
 156     """
 157     call(split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
 158
 159
 160 class SetupFramework(object): # pylint: disable=too-few-public-methods
 161     """Setup suite run on topology nodes.
 162
 163     Many VAT/CLI based tests need the scripts at remote hosts before executing
 164     them. This class packs the whole testing directory and copies it over
 165     to all nodes in topology under /tmp/
 166     """
 167
 168     @staticmethod
 169     def setup_framework(nodes):
 170         """Pack the whole directory and extract in temp on each node."""
 171
 172         tarball = pack_framework_dir()
 173         msg = 'Framework packed to {0}'.format(tarball)
 174         logger.console(msg)
 175         logger.trace(msg)
 176         remote_tarball = "/tmp/{0}".format(basename(tarball))
 177
 178         # Turn off logging since we use multiprocessing
 179         log_level = BuiltIn().set_log_level('NONE')
 180         params = ((tarball, remote_tarball, node) for node in nodes.values())
 181         pool = Pool(processes=len(nodes))
 182         result = pool.map_async(setup_node, params)
 183         pool.close()
 184         pool.join()
 185
 186         # Turn on logging
 187         BuiltIn().set_log_level(log_level)
 188
 189         logger.info(
 190             'Executed node setups in parallel, waiting for processes to end')
 191         result.wait()
 192
 193         logger.info('Results: {0}'.format(result.get()))
 194
 195         logger.trace('Test framework copied to all topology nodes')
 196         delete_local_tarball(tarball)
 197         logger.console('All nodes are ready')
 198