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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
# Copyright (c) 2018 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.
"""VPP util library."""
from resources.libraries.python.constants import Constants
from resources.libraries.python.DUTSetup import DUTSetup
from resources.libraries.python.ssh import exec_cmd_no_error
from resources.libraries.python.topology import NodeType
from resources.libraries.python.VatExecutor import VatExecutor
class VPPUtil(object):
"""General class for any VPP related methods/functions."""
@staticmethod
def show_vpp_settings(node, *additional_cmds):
"""Print default VPP settings. In case others are needed, can be
accepted as next parameters (each setting one parameter), preferably
in form of a string.
:param node: VPP node.
:param additional_cmds: Additional commands that the vpp should print
settings for.
:type node: dict
:type additional_cmds: tuple
"""
def_setting_tb_displayed = {
'IPv6 FIB': 'ip6 fib',
'IPv4 FIB': 'ip fib',
'Interface IP': 'int addr',
'Interfaces': 'int',
'ARP': 'ip arp',
'Errors': 'err'
}
if additional_cmds:
for cmd in additional_cmds:
def_setting_tb_displayed['Custom Setting: {}'.format(cmd)] = cmd
for _, cmd in def_setting_tb_displayed.items():
command = 'vppctl sh {cmd}'.format(cmd=cmd)
exec_cmd_no_error(node, command, timeout=30, sudo=True)
@staticmethod
def start_vpp_service(node):
"""Start VPP service on the specified node.
:param node: VPP node.
:type node: dict
:raises RuntimeError: If VPP service fails to start.
"""
DUTSetup.start_service(node, Constants.VPP_UNIT)
DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
@staticmethod
def start_vpp_service_on_all_duts(nodes):
"""Start up the VPP service on all nodes.
:param nodes: Nodes in the topology.
:type nodes: dict
"""
DUTSetup.start_service_on_all_duts(nodes, Constants.VPP_UNIT)
@staticmethod
def stop_vpp_service(node):
"""Stop VPP service on the specified node.
:param node: VPP node.
:type node: dict
:raises RuntimeError: If VPP service fails to stop.
"""
DUTSetup.stop_service(node, Constants.VPP_UNIT)
@staticmethod
def stop_vpp_service_on_all_duts(nodes):
"""Stop VPP service on all nodes.
:param nodes: Nodes in the topology.
:type nodes: dict
"""
DUTSetup.stop_service_on_all_duts(nodes, Constants.VPP_UNIT)
@staticmethod
def verify_vpp_on_dut(node):
"""Verify that VPP is installed on DUT node.
:param node: DUT node.
:type node: dict
:raises RuntimeError: If failed to restart VPP, get VPP version
or get VPP interfaces.
"""
VPPUtil.vpp_show_version_verbose(node)
VPPUtil.vpp_show_interfaces(node)
@staticmethod
def verify_vpp_on_all_duts(nodes):
"""Verify that VPP is installed on all DUT nodes.
:param nodes: Nodes in the topology.
:type nodes: dict
"""
for node in nodes.values():
if node['type'] == NodeType.DUT:
DUTSetup.start_service(node, Constants.VPP_UNIT)
VPPUtil.vpp_show_version_verbose(node)
VPPUtil.vpp_show_interfaces(node)
@staticmethod
def vpp_show_version_verbose(node):
"""Run "show version verbose" CLI command.
:param node: Node to run command on.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("show_version_verbose.vat", node, json_out=False)
try:
vat.script_should_have_passed()
except AssertionError:
raise RuntimeError('Failed to get VPP version on host: {name}'.
format(name=node['host']))
@staticmethod
def show_vpp_version_on_all_duts(nodes):
"""Show VPP version verbose on all DUTs.
:param nodes: VPP nodes.
:type nodes: dict
"""
for node in nodes.values():
if node['type'] == NodeType.DUT:
VPPUtil.vpp_show_version_verbose(node)
@staticmethod
def vpp_show_interfaces(node):
"""Run "show interface" CLI command.
:param node: Node to run command on.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("show_interface.vat", node, json_out=False)
try:
vat.script_should_have_passed()
except AssertionError:
raise RuntimeError('Failed to get VPP interfaces on host: {name}'.
format(name=node['host']))
@staticmethod
def vpp_show_crypto_device_mapping(node):
"""Run "show crypto device mapping" CLI command.
:param node: Node to run command on.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("show_crypto_device_mapping.vat", node,
json_out=False)
@staticmethod
def vpp_api_trace_dump(node):
"""Run "api trace custom-dump" CLI command.
:param node: Node to run command on.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("api_trace_dump.vat", node, json_out=False)
@staticmethod
def vpp_api_trace_save(node):
"""Run "api trace save" CLI command.
:param node: Node to run command on.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("api_trace_save.vat", node, json_out=False)
@staticmethod
def vpp_enable_traces_on_dut(node):
"""Enable vpp packet traces on the DUT node.
:param node: DUT node to set up.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("enable_dpdk_traces.vat", node, json_out=False)
vat.execute_script("enable_vhost_user_traces.vat", node, json_out=False)
vat.execute_script("enable_memif_traces.vat", node, json_out=False)
@staticmethod
def vpp_enable_traces_on_all_duts(nodes):
"""Enable vpp packet traces on all DUTs in the given topology.
:param nodes: Nodes in the topology.
:type nodes: dict
"""
for node in nodes.values():
if node['type'] == NodeType.DUT:
VPPUtil.vpp_enable_traces_on_dut(node)
@staticmethod
def vpp_enable_elog_traces_on_dut(node):
"""Enable API/CLI/Barrier traces on the DUT node.
:param node: DUT node to set up.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("elog_trace_api_cli_barrier.vat", node,
json_out=False)
@staticmethod
def vpp_enable_elog_traces_on_all_duts(nodes):
"""Enable API/CLI/Barrier traces on all DUTs in the given topology.
:param nodes: Nodes in the topology.
:type nodes: dict
"""
for node in nodes.values():
if node['type'] == NodeType.DUT:
VPPUtil.vpp_enable_elog_traces_on_dut(node)
@staticmethod
def show_event_logger_on_dut(node):
"""Show event logger on the DUT node.
:param node: DUT node to show traces on.
:type node: dict
"""
vat = VatExecutor()
vat.execute_script("show_event_logger.vat", node, json_out=False)
@staticmethod
def show_event_logger_on_all_duts(nodes):
"""Show event logger on all DUTs in the given topology.
:param nodes: Nodes in the topology.
:type nodes: dict
"""
for node in nodes.values():
if node['type'] == NodeType.DUT:
VPPUtil.show_event_logger_on_dut(node)
|
