1 # Copyright (c) 2017 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
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.TLDK.TLDKConstants import TLDKConstants as con
31 from resources.libraries.python.topology import NodeType
32 from resources.libraries.python.TLDK.gen_pcap import gen_all_pcap
34 __all__ = ["SetupTLDKTest"]
37 def pack_framework_dir():
38 """Pack the testing WS into temp file, return its name.
41 :raises RuntimeError: If pack the testing framework failed.
43 # Remove the TLDK and DPDK dir existted.
44 os.system("rm -rf tldk")
45 os.system("rm -rf dpdk")
46 os.system("rm -f dpdk-16.11.1.tar.xz")
48 # Get the latest TLDK and dpdk code.
49 os.system("git clone https://gerrit.fd.io/r/tldk")
50 os.system("wget http://fast.dpdk.org/rel/dpdk-16.11.1.tar.xz")
52 # Generate pcap file used to execute test case.
55 tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="TLDK-testing-")
56 file_name = tmpfile.name
60 split("tar --exclude-vcs -zcf {0} .".format(file_name)),
61 stdout=PIPE, stderr=PIPE)
62 (stdout, stderr) = proc.communicate()
67 return_code = proc.wait()
69 raise RuntimeError("Could not pack testing framework.")
74 def copy_tarball_to_node(tarball, node):
75 """Copy tarball file from local host to remote node.
77 :param tarball: Path to tarball to upload.
78 :param node: Dictionary created from topology.
83 logger.console('Copying tarball to {0}'.format(node['host']))
87 ssh.scp(tarball, "/tmp/")
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.
94 Raise runtime errors when failed.
96 :param tarball: Path to tarball to upload.
97 :param node: Dictionary created from topology.
101 :raises RuntimeError: If extract tarball failed.
103 logger.console('Extracting tarball to {0} on {1}'.format(
104 con.REMOTE_FW_DIR, node['host']))
108 cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
109 'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
110 (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
112 logger.error('Unpack error: {0}'.format(stderr))
113 raise RuntimeError('Failed to unpack {0} at node {1}'.format(
114 tarball, node['host']))
117 def create_env_directory_at_node(node):
119 Create fresh virtualenv to a directory, install pip requirements.
121 :param node: Dictionary created from topology, will only install in the TG.
124 :raises RuntimeError: If the setup of virtualenv failed.
126 logger.console('Extracting virtualenv, installing requirements.txt '
127 'on {0}'.format(node['host']))
130 (ret_code, stdout, stderr) = ssh.exec_command(
131 'cd {0} && rm -rf env && '
132 'virtualenv --system-site-packages --never-download env && '
133 '. env/bin/activate && pip install -r requirements.txt'
134 .format(con.REMOTE_FW_DIR), timeout=100)
136 logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
137 raise RuntimeError('Virtualenv setup failed')
139 logger.console('Virtualenv created on {0}'.format(node['host']))
141 def install_tldk_test(node):
142 """Prepare the TLDK test envrionment.
143 Raise errors when failed.
145 :param node: Dictionary created from topology.
148 :raises RuntimeError: If install tldk failed.
150 logger.console('Install the TLDK on {0}'.format(node['host']))
155 (ret_code, _, stderr) = ssh.exec_command(
156 'cd {0}/{1} && ./install_tldk.sh'
157 .format(con.REMOTE_FW_DIR, con.TLDK_SCRIPTS), timeout=600)
160 logger.error('Install the TLDK error: {0}'.format(stderr))
161 raise RuntimeError('Install the TLDK failed')
163 logger.console('Install the TLDK on {0} success!'.format(node['host']))
165 def setup_node(args):
166 """Run all set-up methods for a node.
168 This method is used as map_async parameter. It receives tuple with all
169 parameters as passed to map_async function.
171 :param args: All parameters needed to setup one node.
173 :returns: True - success, False - error
175 :raises RuntimeError: If node setup failed.
177 tarball, remote_tarball, node = args
179 copy_tarball_to_node(tarball, node)
180 extract_tarball_at_node(remote_tarball, node)
181 if node['type'] == NodeType.DUT:
182 install_tldk_test(node)
183 if node['type'] == NodeType.TG:
184 create_env_directory_at_node(node)
185 except RuntimeError as exc:
186 logger.error("Node setup failed, error:'{0}'".format(exc.message))
189 logger.console('Setup of node {0} done'.format(node['host']))
192 def delete_local_tarball(tarball):
193 """Delete local tarball to prevent disk pollution.
195 :param tarball: Path to tarball to upload.
199 call(split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
202 class SetupTLDKTest(object):
203 """Setup suite run on topology nodes.
205 Many VAT/CLI based tests need the scripts at remote hosts before executing
206 them. This class packs the whole testing directory and copies it over
207 to all nodes in topology under /tmp/
211 def setup_tldk_test(nodes):
212 """Pack the whole directory and extract in temp on each node."""
214 tarball = pack_framework_dir()
215 msg = 'Framework packed to {0}'.format(tarball)
218 remote_tarball = "/tmp/{0}".format(basename(tarball))
220 # Turn off logging since we use multiprocessing.
221 log_level = BuiltIn().set_log_level('NONE')
222 params = ((tarball, remote_tarball, node) for node in nodes.values())
223 pool = Pool(processes=len(nodes))
224 result = pool.map_async(setup_node, params)
229 BuiltIn().set_log_level(log_level)
232 'Executed node setups in parallel, waiting for processes to end')
235 logger.info('Results: {0}'.format(result.get()))
237 logger.trace('Test framework copied to all topology nodes')
238 delete_local_tarball(tarball)
239 logger.console('All nodes are ready')