1 # Copyright (c) 2018 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
24 from os import environ
26 from robot.api import logger
27 from robot.libraries.BuiltIn import BuiltIn
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
33 __all__ = ["SetupFramework"]
36 def pack_framework_dir():
37 """Pack the testing WS into temp file, return its name.
39 :returns: Tarball file name.
41 :raises Exception: When failed to pack testing framework.
45 directory = environ["TMPDIR"]
49 if directory is not None:
50 tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="csit-testing-",
51 dir="{0}".format(directory))
53 tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="csit-testing-")
54 file_name = tmpfile.name
58 split("tar --sparse --exclude-vcs --exclude=output*.xml "
59 "--exclude=./tmp -zcf {0} ."
60 .format(file_name)), stdout=PIPE, stderr=PIPE)
61 (stdout, stderr) = proc.communicate()
66 return_code = proc.wait()
68 raise RuntimeError("Could not pack testing framework.")
73 def copy_tarball_to_node(tarball, node):
74 """Copy tarball file from local host to remote node.
76 :param tarball: Path to tarball to upload.
77 :param node: Dictionary created from topology.
82 logger.console('Copying tarball to {0}'.format(node['host']))
86 ssh.scp(tarball, "/tmp/")
87 logger.console('Copying tarball to {0} done'.format(node['host']))
90 def extract_tarball_at_node(tarball, node):
91 """Extract tarball at given node.
93 Extracts tarball using tar on given node to specific CSIT location.
95 :param tarball: Path to tarball to upload.
96 :param node: Dictionary created from topology.
100 :raises RuntimeError: When failed to unpack tarball.
102 logger.console('Extracting tarball to {0} on {1}'
103 .format(con.REMOTE_FW_DIR, node['host']))
106 (ret_code, _, _) = ssh.exec_command(
107 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; rm -f {0}'
108 .format(tarball, con.REMOTE_FW_DIR), timeout=30)
110 raise RuntimeError('Failed to extract {0} at node {1}'
111 .format(tarball, node['host']))
112 logger.console('Extracting tarball to {0} on {1} done'
113 .format(con.REMOTE_FW_DIR, node['host']))
116 def create_env_directory_at_node(node):
117 """Create fresh virtualenv to a directory, install pip requirements.
119 :param node: Node to create virtualenv on.
122 :raises RuntimeError: When failed to setup virtualenv.
124 logger.console('Virtualenv setup including requirements.txt on {0}'
125 .format(node['host']))
128 (ret_code, _, _) = ssh.exec_command(
129 'cd {0} && rm -rf env && '
130 'virtualenv --system-site-packages --never-download env && '
131 '. env/bin/activate && '
132 'pip install -r requirements.txt'
133 .format(con.REMOTE_FW_DIR), timeout=100)
135 raise RuntimeError('Virtualenv setup including requirements.txt on {0}'
136 .format(node['host']))
138 logger.console('Virtualenv on {0} created'.format(node['host']))
141 def setup_node(args):
142 """Run all set-up methods for a node.
144 This method is used as map_async parameter. It receives tuple with all
145 parameters as passed to map_async function.
147 :param args: All parameters needed to setup one node.
149 :returns: True - success, False - error
152 tarball, remote_tarball, node = args
154 copy_tarball_to_node(tarball, node)
155 extract_tarball_at_node(remote_tarball, node)
156 if node['type'] == NodeType.TG:
157 create_env_directory_at_node(node)
158 except RuntimeError as exc:
159 logger.error("Node {0} setup failed, error:'{1}'"
160 .format(node['host'], exc.message))
163 logger.console('Setup of node {0} done'.format(node['host']))
167 def delete_local_tarball(tarball):
168 """Delete local tarball to prevent disk pollution.
170 :param tarball: Path to tarball to upload.
174 call(split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
177 def delete_framework_dir(node):
178 """Delete framework directory in /tmp/ on given node.
180 :param node: Node to delete framework directory on.
183 logger.console('Deleting framework directory on {0}'
184 .format(node['host']))
187 (ret_code, _, _) = ssh.exec_command(
189 .format(con.REMOTE_FW_DIR), timeout=100)
191 raise RuntimeError('Deleting framework directory on {0} failed'
195 def cleanup_node(node):
196 """Run all clean-up methods for a node.
198 This method is used as map_async parameter. It receives tuple with all
199 parameters as passed to map_async function.
201 :param node: Node to do cleanup on.
203 :returns: True - success, False - error
207 delete_framework_dir(node)
209 logger.error("Cleanup of node {0} failed".format(node['host']))
212 logger.console('Cleanup of node {0} done'.format(node['host']))
216 class SetupFramework(object):
217 """Setup suite run on topology nodes.
219 Many VAT/CLI based tests need the scripts at remote hosts before executing
220 them. This class packs the whole testing directory and copies it over
221 to all nodes in topology under /tmp/
225 def setup_framework(nodes):
226 """Pack the whole directory and extract in temp on each node.
228 :param nodes: Topology nodes.
230 :raises RuntimeError: If setup framework failed.
233 tarball = pack_framework_dir()
234 msg = 'Framework packed to {0}'.format(tarball)
237 remote_tarball = "/tmp/{0}".format(basename(tarball))
239 # Turn off logging since we use multiprocessing
240 log_level = BuiltIn().set_log_level('NONE')
241 params = ((tarball, remote_tarball, node) for node in nodes.values())
242 pool = Pool(processes=len(nodes))
243 result = pool.map_async(setup_node, params)
248 BuiltIn().set_log_level(log_level)
251 'Executing node setups in parallel, waiting for processes to end')
254 results = result.get()
255 node_success = all(results)
256 logger.info('Results: {0}'.format(results))
258 delete_local_tarball(tarball)
260 logger.console('All nodes are ready')
262 raise RuntimeError('Failed to setup framework')
265 class CleanupFramework(object):
266 """Clean up suite run on topology nodes."""
269 def cleanup_framework(nodes):
270 """Perform cleaning on each node.
272 :param nodes: Topology nodes.
274 :raises RuntimeError: If cleanup framework failed.
276 # Turn off logging since we use multiprocessing
277 log_level = BuiltIn().set_log_level('NONE')
278 params = (node for node in nodes.values())
279 pool = Pool(processes=len(nodes))
280 result = pool.map_async(cleanup_node, params)
285 BuiltIn().set_log_level(log_level)
288 'Executing node cleanups in parallel, waiting for processes to end')
291 results = result.get()
292 node_success = all(results)
293 logger.info('Results: {0}'.format(results))
296 logger.console('All nodes cleaned up')
298 raise RuntimeError('Failed to cleaned up framework')