aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/robot/ip/nat.robot
blob: 202ade34a5bfa21a71504b4cf5f76d8866598d7f (plain)
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# Copyright (c) 2021 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.

*** Settings ***
| Library | resources.libraries.python.NATUtil
|
| Documentation | Keywords for NAT feature in VPP.

*** Keywords ***
| Configure inside and outside interfaces
| | [Documentation] | Configure inside and outside interfaces for NAT44.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node to set NAT44 interfaces on. Type: dictionary
| | ... | - int_in - Inside interface. Type: string
| | ... | - int_out - Outside interface. Type: string
| |
| | ... | *Example:*
| |
| | ... | \| Configure inside and outside interfaces \| ${nodes['DUT1']} \
| | ... | \| FortyGigabitEtherneta/0/0 \| FortyGigabitEtherneta/0/1 \|
| |
| | [Arguments] | ${node} | ${int_in} | ${int_out}
| |
| | ${int_in_name}= | Set variable | ${node['interfaces']['${int_in}']['name']}
| | ${int_out_name}= | Set variable
| | ... | ${node['interfaces']['${int_out}']['name']}
| | Set NAT44 Interfaces | ${node} | ${int_in_name} | ${int_out_name}

| Initialize NAT44 endpoint-dependent mode in circular topology
| | [Documentation] | Initialization of NAT44 endpoint-dependent mode on DUT1
| |
| | ... | This keyword also sets a test variable \${resetter}
| | ... | to hold a callable which resets VPP state.
| | ... | Keywords performing search will call it to get consistent trials.
| | ... | Tests which do not wish to reset NAT state should use ramp-up,
| | ... | so the resetter is not set if \${ramp_up_duration} variable
| | ... | is (defined and) nonzero.
| |
| | ... | *Test variables read:*
| | ... | - n_sessions - Expected number of opened sessions.
| |
| | ${max_sessions}= | Compute Max Translations Per Thread
| | ... | ${n_sessions} | ${thr_count_int}
| | Enable NAT44 Plugin | ${dut1} | mode=${nat_mode} | sessions=${max_sessions}
| | Configure inside and outside interfaces
| | ... | ${dut1} | ${DUT1_${int}1}[0] | ${DUT1_${int}2}[0]
| | ${resetter} = | Set NAT44 Address Range
| | ... | ${dut1} | ${out_net} | ${out_net_end}
| | ${ramp_up_rate} = | Get Ramp Up Rate
| | Return From Keyword If | ${ramp_up_rate}
| | Set Test Variable | \${resetter}

# TODO: Remove when 'ip4.Initialize IPv4 forwarding in circular topology' KW
# adapted to use IP values from variables
| Initialize IPv4 forwarding for NAT44 in circular topology
| | [Documentation]
| | ... | Set IPv4 forwarding for NAT44:
| | ... | - set interfaces up
| | ... | - set IP addresses
| | ... | - set ARP
| | ... | - create routes
| |
| | ${status} | ${value}= | Run Keyword And Ignore Error
| | ... | Variable Should Exist | ${dut2}
| | ${dut2_status}= | Set Variable If | '${status}' == 'PASS' | ${True}
| | ... | ${False}
| |
| | Set interfaces in path up
| |
| | VPP Interface Set IP Address
| | ... | ${dut1} | ${DUT1_${int}1}[0] | ${dut1_if1_ip4} | ${dut1_if1_mask}
| | VPP Interface Set IP Address
| | ... | ${dut1} | ${DUT1_${int}2}[0] | ${dut1_if2_ip4} | ${dut1_if2_mask}
| | Run Keyword If | ${dut2_status}
| | ... | VPP Interface Set IP Address
| | ... | ${dut2} | ${DUT2_${int}1}[0] | ${dut2_if1_ip4} | ${dut2_if1_mask}
| | Run Keyword If | ${dut2_status}
| | ... | VPP Interface Set IP Address
| | ... | ${dut2} | ${DUT2_${int}2}[0] | ${dut2_if2_ip4} | ${dut2_if2_mask}
| |
| | VPP Add IP Neighbor
| | ... | ${dut1} | ${DUT1_${int}1}[0] | ${tg_if1_ip4} | ${TG_pf1_mac}[0]
| | Run Keyword If |  ${dut2_status}
| | ... | VPP Add IP Neighbor
| | ... | ${dut1} | ${DUT1_${int}2}[0] | ${dut2_if1_ip4}
| | ... | ${DUT2_${int}1_mac}[0]
| | ... | ELSE | VPP Add IP Neighbor
| | ... | ${dut1} | ${DUT1_${int}2}[0] | ${tg_if2_ip4} | ${TG_pf2_mac}[0]
| | Run Keyword If |  ${dut2_status}
| | ... | VPP Add IP Neighbor
| | ... | ${dut2} | ${DUT2_${int}1}[0] | ${dut1_if1_ip4}
| | ... | ${DUT1_${int}2_mac}[0]
| | Run Keyword If |  ${dut2_status}
| | ... | VPP Add IP Neighbor
| | ... | ${dut2} | ${DUT2_${int}2}[0] | ${tg_if2_ip4}| ${TG_pf2_mac}[0]
| |
| | Vpp Route Add
| | ... | ${dut1} | ${in_net} | ${in_mask} | gateway=${tg_if1_ip4}
| | ... | interface=${DUT1_${int}1}[0]
| | Run Keyword If | ${dut2_status}
| | ... | Vpp Route Add
| | ... | ${dut1} | ${dest_net} | ${dest_mask} | gateway=${dut2_if1_ip4}
| | ... | interface=${DUT1_${int}2}[0]
| | ... | ELSE | Vpp Route Add
| | ... | ${dut1} | ${dest_net} | ${dest_mask} | gateway=${tg_if2_ip4}
| | ... | interface=${DUT1_${int}2}[0]
| | Run Keyword If | ${dut2_status}
| | ... | Vpp Route Add
| | ... | ${dut2} | ${dest_net} | ${dest_mask} | gateway=${tg_if2_ip4}
| | ... | interface=${DUT2_${int}2}[0]
| | Run Keyword If | ${dut2_status}
| | ... | Vpp Route Add
| | ... | ${dut2} | ${out_net} | ${out_mask} | gateway=${dut1_if2_ip4}
| | ... | interface=${DUT2_${int}1}[0]

| Verify NAT44 TCP sessions number on DUT1 node
| | [Documentation] | Verify that all required NAT44 TCP sessions are
| | ... | established on DUT1 node.
| |
| | Verify NAT44 sessions number | ${nodes['DUT1']} | ${n_sessions} | TCP

| Verify NAT44 UDP sessions number on DUT1 node
| | [Documentation] | Verify that all required NAT44 UDP sessions are
| | ... | established on DUT1 node.
| |
| | Verify NAT44 sessions number | ${nodes['DUT1']} | ${n_sessions} | UDP

| Verify NAT44 sessions number
| | [Documentation] | Verify that all required NAT44 sessions of required
| | ... | protocol are established.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node. Type: dictionary
| | ... | - exp_n_sessions - Expected number of NAT44 sessions. Type: integer
| | ... | - proto - Required protocol. Type: string
| |
| | ... | *Example:*
| |
| | ... | \| Verify NAT44 sessions number \| ${nodes['DUT1']} \| ${64512} \
| | ... | \| UDP \|
| |
| | [Arguments] | ${node} | ${exp_n_sessions} | ${proto}
| |
| | ${nat44_sessions}= | Get NAT44 Sessions Number | ${node} | ${proto}
| | Should Be Equal As Integers | ${nat44_sessions} | ${exp_n_sessions}
| | ... | Not all NAT44 ${proto} sessions have been established

# DET44 - NAT44 deterministic
| Enable DET44 plugin on DUT
| | [Documentation] | Enable DET44 plugin on DUT.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node to enablr DET44 on.
| | ... | Type: dictionary
| | ... | - inside_vrf - Inside VRF ID; default value: 0.
| | ... | Type: string or integer
| | ... | - outside_vrf - Outside VRF ID; default value: 0.
| | ... | Type: string or integer
| |
| | ... | *Example:*
| |
| | ... | \| Enable DET44 plugin on all DUTs \|
| |
| | [Arguments] | ${node} | ${inside_vrf}=${0} | ${outside_vrf}=${0}
| |
| | Enable DET44 Plugin
| | ... | ${node} | inside_vrf=${inside_vrf} | outside_vrf=${outside_vrf}

| Configure DET44 interfaces
| | [Documentation] | Configure inside and outside interfaces for DET44.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node to set DET44 interfaces on. Type: dictionary
| | ... | - int_in - Inside interface key. Type: string
| | ... | - int_out - Outside interface key. Type: string
| |
| | ... | *Example:*
| |
| | ... | \| Configure DET44 interfaces \| ${nodes['DUT1']} \| port5 \| port6 \|
| |
| | [Arguments] | ${node} | ${int_in} | ${int_out}
| |
| | Set DET44 Interface | ${dut1} | ${int_in} | is_inside=${True}
| | Set DET44 Interface | ${dut1} | ${int_out} | is_inside=${False}

| Configure deterministic mode for NAT44
| | [Documentation] | Set deterministic behaviour of NAT44 (DET44).
| |
| | ... | This keyword also sets a test variable \${resetter}
| | ... | to hold a callable which resets VPP state.
| | ... | Keywords performing search will call it to get consistent trials.
| | ... | Tests which do not wish to reset NAT state should use ramp-up,
| | ... | so the resetter is not set if \${ramp_up_duration} variable
| | ... | is (defined and) nonzero.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node to set deterministic mode for NAT44 on.
| | ... | Type: dictionary
| | ... | - ip_in - Inside IP. Type: string
| | ... | - subnet_in - Inside IP subnet. Type: string
| | ... | - ip_out - Outside IP. Type: string
| | ... | - subnet_out - Outside IP subnet. Type: string
| |
| | ... | *Example:*
| |
| | ... | \| Configure deterministic mode for NAT44 \| ${nodes['DUT1']} \
| | ... | \| 100.0.0.0 \| 12 \| 12.1.1.0 \| 24 \|
| |
| | [Arguments] | ${node} | ${ip_in} | ${subnet_in} | ${ip_out} | ${subnet_out}
| |
| | ${resetter} = | Set DET44 Mapping
| | ... | ${node} | ${ip_in} | ${subnet_in} | ${ip_out} | ${subnet_out}
| | ${ramp_up_rate} = | Get Ramp Up Rate
| | Return From Keyword If | ${ramp_up_rate}
| | Set Test Variable | \${resetter}

| Initialize NAT44 deterministic mode in circular topology
| | [Documentation] | Initialization of NAT44 deterministic mode (DET44)
| | ... | on DUT1 node.
| |
| | Enable DET44 plugin on DUT | ${dut1}
| | Configure DET44 interfaces
| | ... | ${dut1} | ${DUT1_${int}1}[0] | ${DUT1_${int}2}[0]
| | Configure deterministic mode for NAT44
| | ... | ${dut1} | ${in_net} | ${in_mask} | ${out_net} | ${out_mask}

| Show DET44 verbose
| | [Documentation] | Get DET44 settings on the node.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node to show NAT. Type: dictionary
| |
| | ... | *Example:*
| |
| | ... | \| Show DET44 verbose \| ${nodes['DUT1']} \|
| |
| | [Arguments] | ${node}
| |
| | Show DET44 | ${node}

| Verify DET44 sessions number on DUT1 node
| | [Documentation] | Verify that all required DET44 sessions are established on
| | ... | DUT1 node.
| |
| | Verify DET44 sessions number | ${nodes['DUT1']} | ${n_sessions}

| Verify DET44 sessions number
| | [Documentation] | Verify that all required DET44 sessions are established.
| |
| | ... | *Arguments:*
| | ... | - node - DUT node. Type: dictionary
| | ... | - exp_n_sessions - Expected number of DET44 sessions. Type: integer
| |
| | ... | *Example:*
| |
| | ... | \| Verify DET44 sessions number \| ${nodes['DUT1']} \| ${64512} \|
| |
| | [Arguments] | ${node} | ${exp_n_sessions}
| |
| | ${det44_sessions}= | Get DET44 Sessions Number | ${node}
| | Should Be Equal As Integers | ${det44_sessions} | ${exp_n_sessions}
| | ... | Not all DET44 sessions have been established