1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
# Copyright (c) 2017 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This module exists to provide setup utilities for the framework on topology
nodes. All tasks required to be run before the actual tests are started is
supposed to end up here.
"""
from shlex import split
from subprocess import Popen, PIPE, call
from multiprocessing import Pool
from tempfile import NamedTemporaryFile
from os.path import basename
from robot.api import logger
from robot.libraries.BuiltIn import BuiltIn
from resources.libraries.python.ssh import SSH
from resources.libraries.python.constants import Constants as con
from resources.libraries.python.topology import NodeType
from resources.libraries.python.topology import Topology
__all__ = ["SetupSFCTest"]
def pack_framework_dir():
"""Pack the testing WS into temp file, return its name.
:returns: the temporary package file name.
:rtype: str
:raises: If execute the tar command failed.
"""
tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="SFC-testing-")
file_name = tmpfile.name
tmpfile.close()
proc = Popen(
split("tar --exclude-vcs --exclude=./tmp -zcf {0} .".format(file_name)),
stdout=PIPE, stderr=PIPE)
(stdout, stderr) = proc.communicate()
logger.debug(stdout)
logger.debug(stderr)
return_code = proc.wait()
if return_code != 0:
raise RuntimeError("Could not pack testing framework.")
return file_name
def copy_tarball_to_node(tarball, node):
"""Copy tarball file from local host to remote node.
:param tarball: Path to tarball to upload.
:param node: Node in the topology where the tarball will be copied to.
:type tarball: str
:type node: dict
:returns: nothing
"""
logger.console('Copying tarball to {0}'.format(node['host']))
ssh = SSH()
ssh.connect(node)
ssh.scp(tarball, "/tmp/")
def extract_tarball_at_node(tarball, node):
"""Extract tarball at given node.
Extracts tarball using tar on given node to specific CSIT loocation.
:param tarball: Path to tarball to upload.
:param node: Dictionary created from topology.
:type tarball: str
:type node: dict
:returns: nothing
:raises: If unpack the file failed.
"""
logger.console('Extracting tarball to {0} on {1}'.format(
con.REMOTE_FW_DIR, node['host']))
ssh = SSH()
ssh.connect(node)
cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
(ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
if ret_code != 0:
logger.error('Unpack error: {0}'.format(stderr))
raise RuntimeError('Failed to unpack {0} at node {1}'.format(
tarball, node['host']))
def create_env_directory_at_node(node):
"""Create fresh virtualenv to a directory, install pip requirements.
:param node: Dictionary created from topology, will only install in the TG
:type node: dict
:returns: nothing
"""
logger.console('Extracting virtualenv, installing requirements.txt '
'on {0}'.format(node['host']))
ssh = SSH()
ssh.connect(node)
(ret_code, stdout, stderr) = ssh.exec_command(
'cd {0} && rm -rf env && '
'virtualenv --system-site-packages --never-download env && '
'. env/bin/activate && pip install -r requirements.txt'
.format(con.REMOTE_FW_DIR), timeout=100)
if ret_code != 0:
logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
raise RuntimeError('Virtualenv setup failed')
else:
logger.console('Virtualenv created on {0}'.format(node['host']))
def install_sfc_test(node):
"""Prepare the NSH SFC test envrionment.
:param node: Dictionary created from topology
:type node: dict
:returns: nothing
"""
logger.console('Install the NSH SFC on {0}'.format(node['host']))
if_name_list = Topology.get_node_interfaces(node)
ssh = SSH()
ssh.connect(node)
(ret_code, _, stderr) = ssh.exec_command(
'cd {0}/tests/nsh_sfc/sfc_scripts/ && ./install_sfc.sh {1} {2}'
.format(con.REMOTE_FW_DIR, if_name_list[0], if_name_list[1]), \
timeout=600)
if ret_code != 0:
logger.error('Install the NSH SFC error: {0}'.format(stderr))
raise RuntimeError('Install the NSH SFC failed')
else:
logger.console('Install the NSH SFC on {0} success!'.
format(node['host']))
def setup_node(args):
"""Run all set-up methods for a node.
This method is used as map_async parameter. It receives tuple with all
parameters as passed to map_async function.
:param args: All parameters needed to setup one node.
:type args: tuple
:returns: True - success, False - error
:rtype: bool
"""
tarball, remote_tarball, node = args
try:
copy_tarball_to_node(tarball, node)
extract_tarball_at_node(remote_tarball, node)
if node['type'] == NodeType.DUT:
install_sfc_test(node)
if node['type'] == NodeType.TG:
create_env_directory_at_node(node)
except RuntimeError as exc:
logger.error("Node setup failed, error:'{0}'".format(exc.message))
return False
else:
logger.console('Setup of node {0} done'.format(node['host']))
return True
def delete_local_tarball(tarball):
"""Delete local tarball to prevent disk pollution.
:param tarball: Path to tarball to upload.
:type tarball: str
:returns: nothing
"""
call(split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
class SetupSFCTest(object):
"""Setup suite run on topology nodes.
Many VAT/CLI based tests need the scripts at remote hosts before executing
them. This class packs the whole testing directory and copies it over
to all nodes in topology under /tmp/
"""
@staticmethod
def setup_nsh_sfc_test(nodes):
"""Pack the whole directory and extract in temp on each node."""
tarball = pack_framework_dir()
msg = 'Framework packed to {0}'.format(tarball)
logger.console(msg)
logger.trace(msg)
remote_tarball = "/tmp/{0}".format(basename(tarball))
# Turn off logging since we use multiprocessing
log_level = BuiltIn().set_log_level('NONE')
params = ((tarball, remote_tarball, node) for node in nodes.values())
pool = Pool(processes=len(nodes))
result = pool.map_async(setup_node, params)
pool.close()
pool.join()
# Turn on logging
BuiltIn().set_log_level(log_level)
logger.info(
'Executed node setups in parallel, waiting for processes to end')
result.wait()
logger.info('Results: {0}'.format(result.get()))
logger.trace('Test framework copied to all topology nodes')
delete_local_tarball(tarball)
logger.console('All nodes are ready')
|
