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 import shlex
  15 from subprocess import Popen, PIPE, call
  16 from multiprocessing import Pool
  17 from tempfile import NamedTemporaryFile
  18 from os.path import basename
  19 from robot.api import logger
  20 from robot.libraries.BuiltIn import BuiltIn
  21 from ssh import SSH
  22 from constants import Constants as con
  23 from topology import NodeType
  24
  25 __all__ = ["SetupFramework"]
  26
  27
  28 def pack_framework_dir():
  29     """Pack the testing WS into temp file, return its name."""
  30
  31     tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-")
  32     file_name = tmpfile.name
  33     tmpfile.close()
  34
  35     proc = Popen(
  36         shlex.split("tar --exclude-vcs -zcf {0} .".format(file_name)),
  37         stdout=PIPE, stderr=PIPE)
  38     (stdout, stderr) = proc.communicate()
  39
  40     logger.debug(stdout)
  41     logger.debug(stderr)
  42
  43     return_code = proc.wait()
  44     if 0 != return_code:
  45         raise Exception("Could not pack testing framework.")
  46
  47     return file_name
  48
  49
  50 def copy_tarball_to_node(tarball, node):
  51     logger.console('Copying tarball to {0}'.format(node['host']))
  52     ssh = SSH()
  53     ssh.connect(node)
  54
  55     ssh.scp(tarball, "/tmp/")
  56
  57
  58 def extract_tarball_at_node(tarball, node):
  59     logger.console('Extracting tarball to {0} on {1}'.format(
  60         con.REMOTE_FW_DIR, node['host']))
  61     ssh = SSH()
  62     ssh.connect(node)
  63
  64     cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
  65         'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
  66     (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout=30)
  67     if 0 != ret_code:
  68         logger.error('Unpack error: {0}'.format(stderr))
  69         raise Exception('Failed to unpack {0} at node {1}'.format(
  70             tarball, node['host']))
  71
  72
  73 def create_env_directory_at_node(node):
  74     """Create fresh virtualenv to a directory, install pip requirements."""
  75     logger.console('Extracting virtualenv, installing requirements.txt '
  76                    'on {0}'.format(node['host']))
  77     ssh = SSH()
  78     ssh.connect(node)
  79     (ret_code, stdout, stderr) = ssh.exec_command(
  80             'cd {0} && rm -rf env && virtualenv env && '
  81             '. env/bin/activate && '
  82             'pip install -r requirements.txt'.format(con.REMOTE_FW_DIR))
  83     if 0 != ret_code:
  84         logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
  85         raise Exception('Virtualenv setup failed')
  86
  87
  88 def setup_node(args):
  89     tarball, remote_tarball, node = args
  90     copy_tarball_to_node(tarball, node)
  91     extract_tarball_at_node(remote_tarball, node)
  92     if node['type'] == NodeType.TG:
  93         create_env_directory_at_node(node)
  94
  95
  96 def delete_local_tarball(tarball):
  97     call(shlex.split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
  98
  99
 100 class SetupFramework(object):
 101     """Setup suite run on topology nodes.
 102
 103     Many VAT/CLI based tests need the scripts at remote hosts before executing
 104     them. This class packs the whole testing directory and copies it over
 105     to all nodes in topology under /tmp/
 106     """
 107
 108     def __init__(self):
 109         pass
 110
 111     def setup_framework(self, nodes):
 112         """Pack the whole directory and extract in temp on each node."""
 113
 114         tarball = pack_framework_dir()
 115         msg = 'Framework packed to {0}'.format(tarball)
 116         logger.console(msg)
 117         logger.trace(msg)
 118         remote_tarball = "/tmp/{0}".format(basename(tarball))
 119
 120         # Turn off loggining since we use multiprocessing
 121         log_level = BuiltIn().set_log_level('NONE')
 122         params = ((tarball, remote_tarball, node) for node in nodes.values())
 123         pool = Pool(processes=len(nodes))
 124         result = pool.map_async(setup_node, params)
 125         pool.close()
 126         pool.join()
 127
 128         logger.info(
 129             'Executed node setups in parallel, waiting for processes to end')
 130         result.wait()
 131
 132         logger.info('Results: {0}'.format(result.get()))
 133
 134         # Turn on loggining
 135         BuiltIn().set_log_level(log_level)
 136         logger.trace('Test framework copied to all topology nodes')
 137         delete_local_tarball(tarball)