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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
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.
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
25 from robot.api import logger
26 from robot.libraries.BuiltIn import BuiltIn
28 from resources.libraries.python.ssh import SSH
29 from resources.libraries.python.constants import Constants as con
30 from resources.libraries.python.topology import NodeType
32 __all__ = ["SetupFramework"]
35 def pack_framework_dir():
36 """Pack the testing WS into temp file, return its name."""
38 tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-")
39 file_name = tmpfile.name
43 split("tar --exclude-vcs -zcf {0} .".format(file_name)),
44 stdout=PIPE, stderr=PIPE)
45 (stdout, stderr) = proc.communicate()
50 return_code = proc.wait()
52 raise Exception("Could not pack testing framework.")
57 def copy_tarball_to_node(tarball, node):
58 """Copy tarball file from local host to remote node.
60 :param tarball: Path to tarball to upload.
61 :param node: Dictionary created from topology.
66 logger.console('Copying tarball to {0}'.format(node['host']))
70 ssh.scp(tarball, "/tmp/")
73 def extract_tarball_at_node(tarball, node):
74 """Extract tarball at given node.
76 Extracts tarball using tar on given node to specific CSIT loocation.
78 :param tarball: Path to tarball to upload.
79 :param node: Dictionary created from topology.
84 logger.console('Extracting tarball to {0} on {1}'.format(
85 con.REMOTE_FW_DIR, node['host']))
89 cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
90 'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
91 (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
93 logger.error('Unpack error: {0}'.format(stderr))
94 raise Exception('Failed to unpack {0} at node {1}'.format(
95 tarball, node['host']))
98 def create_env_directory_at_node(node):
99 """Create fresh virtualenv to a directory, install pip requirements."""
100 logger.console('Extracting virtualenv, installing requirements.txt '
101 'on {0}'.format(node['host']))
104 (ret_code, stdout, stderr) = ssh.exec_command(
105 'cd {0} && rm -rf env && virtualenv --system-site-packages env && . env/bin/activate && '
106 'pip install -r requirements.txt'
107 .format(con.REMOTE_FW_DIR), timeout=100)
109 logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
110 raise Exception('Virtualenv setup failed')
112 logger.console('Virtualenv created on {0}'.format(node['host']))
115 def setup_node(args):
116 """Run all set-up methods for a node.
118 This method is used as map_async parameter. It receives tuple with all
119 parameters as passed to map_async function.
121 :param args: All parameters needed to setup one node.
125 tarball, remote_tarball, node = args
126 copy_tarball_to_node(tarball, node)
127 extract_tarball_at_node(remote_tarball, node)
128 if node['type'] == NodeType.TG:
129 create_env_directory_at_node(node)
130 logger.console('Setup of node {0} done'.format(node['host']))
133 def delete_local_tarball(tarball):
134 """Delete local tarball to prevent disk pollution.
136 :param tarball: Path to tarball to upload.
140 call(split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
143 class SetupFramework(object): # pylint: disable=too-few-public-methods
144 """Setup suite run on topology nodes.
146 Many VAT/CLI based tests need the scripts at remote hosts before executing
147 them. This class packs the whole testing directory and copies it over
148 to all nodes in topology under /tmp/
152 def setup_framework(nodes):
153 """Pack the whole directory and extract in temp on each node."""
155 tarball = pack_framework_dir()
156 msg = 'Framework packed to {0}'.format(tarball)
159 remote_tarball = "/tmp/{0}".format(basename(tarball))
161 # Turn off logging since we use multiprocessing
162 log_level = BuiltIn().set_log_level('NONE')
163 params = ((tarball, remote_tarball, node) for node in nodes.values())
164 pool = Pool(processes=len(nodes))
165 result = pool.map_async(setup_node, params)
170 'Executed node setups in parallel, waiting for processes to end')
173 logger.info('Results: {0}'.format(result.get()))
176 BuiltIn().set_log_level(log_level)
177 logger.trace('Test framework copied to all topology nodes')
178 delete_local_tarball(tarball)
179 logger.console('All nodes are ready')