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.
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"]
34 def pack_framework_dir():
35 """Pack the testing WS into temp file, return its name."""
37 tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-")
38 file_name = tmpfile.name
42 shlex.split("tar --exclude-vcs -zcf {0} .".format(file_name)),
43 stdout=PIPE, stderr=PIPE)
44 (stdout, stderr) = proc.communicate()
49 return_code = proc.wait()
51 raise Exception("Could not pack testing framework.")
56 def copy_tarball_to_node(tarball, node):
57 """Copy tarball file from local host to remote node.
59 :param tarball: path to tarball to upload
60 :param node: dictionary created from topology
65 logger.console('Copying tarball to {0}'.format(node['host']))
69 ssh.scp(tarball, "/tmp/")
72 def extract_tarball_at_node(tarball, node):
73 """Extract tarball at given node.
75 Extracts tarball using tar on given node to specific CSIT loocation.
77 :param tarball: path to tarball to upload
78 :param node: dictionary created from topology
83 logger.console('Extracting tarball to {0} on {1}'.format(
84 con.REMOTE_FW_DIR, node['host']))
88 cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
89 'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
90 (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
92 logger.error('Unpack error: {0}'.format(stderr))
93 raise Exception('Failed to unpack {0} at node {1}'.format(
94 tarball, node['host']))
97 def create_env_directory_at_node(node):
98 """Create fresh virtualenv to a directory, install pip requirements."""
99 logger.console('Extracting virtualenv, installing requirements.txt '
100 'on {0}'.format(node['host']))
103 (ret_code, stdout, stderr) = ssh.exec_command(
104 'cd {0} && rm -rf env && virtualenv env && . env/bin/activate && '
105 'pip install -r requirements.txt'.format(con.REMOTE_FW_DIR),
108 logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
109 raise Exception('Virtualenv setup failed')
111 logger.console('Virtualenv created on {0}'.format(node['host']))
113 def setup_node(args):
114 """Run all set-up methods for a node.
116 This method is used as map_async parameter. It receives tuple with all
117 parameters as passed to map_async function.
119 :param args: all parameters needed to setup one node
123 tarball, remote_tarball, node = args
124 copy_tarball_to_node(tarball, node)
125 extract_tarball_at_node(remote_tarball, node)
126 if node['type'] == NodeType.TG:
127 create_env_directory_at_node(node)
128 logger.console('Setup of node {0} done'.format(node['host']))
130 def delete_local_tarball(tarball):
131 """Delete local tarball to prevent disk pollution.
133 :param tarball: path to tarball to upload
134 :type tarball: string
137 call(shlex.split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
139 class SetupFramework(object): # pylint: disable=too-few-public-methods
140 """Setup suite run on topology nodes.
142 Many VAT/CLI based tests need the scripts at remote hosts before executing
143 them. This class packs the whole testing directory and copies it over
144 to all nodes in topology under /tmp/
151 def setup_framework(nodes):
152 """Pack the whole directory and extract in temp on each node."""
154 tarball = pack_framework_dir()
155 msg = 'Framework packed to {0}'.format(tarball)
158 remote_tarball = "/tmp/{0}".format(basename(tarball))
160 # Turn off loggining since we use multiprocessing
161 log_level = BuiltIn().set_log_level('NONE')
162 params = ((tarball, remote_tarball, node) for node in nodes.values())
163 pool = Pool(processes=len(nodes))
164 result = pool.map_async(setup_node, params)
169 'Executed node setups in parallel, waiting for processes to end')
172 logger.info('Results: {0}'.format(result.get()))
175 BuiltIn().set_log_level(log_level)
176 logger.trace('Test framework copied to all topology nodes')
177 delete_local_tarball(tarball)
178 logger.console('All nodes are ready')