blob: 4dc796777b6e29969ed12901fd5063ed98146632 [file] [log] [blame]
Kailash6f5acb62019-08-28 14:38:45 -07001# Copyright 2017-present Open Networking Foundation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
Kailash6f5acb62019-08-28 14:38:45 -070014# onos common functions
15
16*** Settings ***
17Documentation Library for various utilities
18Library SSHLibrary
Kailash6f5acb62019-08-28 14:38:45 -070019Library String
20Library DateTime
21Library Process
22Library Collections
23Library RequestsLibrary
24Library OperatingSystem
Matteo Scandoloeb26a842020-05-08 10:06:24 -070025Resource ./flows.robot
Kailash6f5acb62019-08-28 14:38:45 -070026
TorstenThiemeb198c482020-12-14 19:45:23 +000027*** Variables ***
28@{connection_list}
TorstenThieme2ddb6e82022-02-08 14:44:24 +000029${alias} ONOS_SSH
TorstenThieme1f58cac2022-02-10 15:58:38 +000030${ssh_read_timeout} 60s
TorstenThieme2ddb6e82022-02-08 14:44:24 +000031${ssh_prompt} karaf@root >
32${ssh_regexp_prompt} REGEXP:k.*a.*r.*a.*f.*@.*r.*o.*o.*t.* .*>.*
33${regexp_prompt} k.*a.*r.*a.*f.*@.*r.*o.*o.*t.* .*>.*
34${ssh_width} 400
35${disable_highlighter} setopt disable-highlighter
TorstenThieme36a38a82022-02-09 15:51:30 +000036# ${keep_alive_interval} is set to 0s means sending the keepalive packet is disabled!
37${keep_alive_interval} 0s
TorstenThiemeb198c482020-12-14 19:45:23 +000038
Kailash6f5acb62019-08-28 14:38:45 -070039*** Keywords ***
Matteo Scandolo37bca8d2020-07-31 11:28:40 -070040
41Open ONOS SSH Connection
42 [Documentation] Establishes an ssh connection to ONOS contoller
43 [Arguments] ${host} ${port} ${user}=karaf ${pass}=karaf
TorstenThieme2ddb6e82022-02-08 14:44:24 +000044 ${conn_id}= SSHLibrary.Open Connection ${host} port=${port} timeout=${ssh_read_timeout} alias=${alias}
TorstenThieme36a38a82022-02-09 15:51:30 +000045 SSHLibrary.Login username=${user} password=${pass} keep_alive_interval=${keep_alive_interval}
TorstenThieme1d1413b2022-02-04 12:41:01 +000046 # set excepted prompt and terminal width to suppress unwanted line feeds
TorstenThieme2ddb6e82022-02-08 14:44:24 +000047 SSHLibrary.Set Client Configuration prompt=${ssh_prompt} width=${ssh_width}
TorstenThiemeb198c482020-12-14 19:45:23 +000048 ${conn_list_entry}= Create Dictionary conn_id=${conn_id} user=${user} pass=${pass}
TorstenThieme1d1413b2022-02-04 12:41:01 +000049 ... host=${host} port=${port} alias=${alias}
TorstenThiemeb198c482020-12-14 19:45:23 +000050 Append To List ${connection_list} ${conn_list_entry}
51 ${conn_list_id}= Get Index From List ${connection_list} ${conn_list_entry}
52 Set Global Variable ${connection_list}
TorstenThieme1d1413b2022-02-04 12:41:01 +000053 # disable highlighting to suppress control sequences
TorstenThieme2ddb6e82022-02-08 14:44:24 +000054 ${output}= Execute Single ONOS CLI Command ${conn_id} ${disable_highlighter} do_reconnect=False
TorstenThiemeb198c482020-12-14 19:45:23 +000055 [Return] ${conn_list_id}
Matteo Scandolo37bca8d2020-07-31 11:28:40 -070056
TorstenThieme4e2168e2021-06-22 14:01:47 +000057Execute ONOS CLI Command use single connection
58 [Documentation] Execute ONOS CLI Command use an Open Connection
59 ... In case no connection is open a connection will be opened
TorstenThieme1d1413b2022-02-04 12:41:01 +000060 ... Using Write and Read instead of Execute Command to keep connection alive.
TorstenThieme4e2168e2021-06-22 14:01:47 +000061 [Arguments] ${host} ${port} ${cmd}
62 ${connection_list_id}= Get Conn List Id ${host} ${port}
63 ${connection_list_id}= Run Keyword If "${connection_list_id}"=="${EMPTY}"
64 ... Open ONOS SSH Connection ${host} ${port}
65 ... ELSE Set Variable ${connection_list_id}
66 ${connection_entry}= Get From List ${connection_list} ${connection_list_id}
TorstenThieme2ddb6e82022-02-08 14:44:24 +000067 ${output}= Execute Single ONOS CLI Command ${connection_entry.conn_id} ${cmd}
TorstenThieme36a38a82022-02-09 15:51:30 +000068 ... connection_list_id=${connection_list_id}
TorstenThieme2ddb6e82022-02-08 14:44:24 +000069 [Return] ${output}
70
71Execute Single ONOS CLI Command
72 [Documentation] Executes ONOS CLI Command on current connection
73 ... Using Write and Read instead of Execute Command to keep connection alive.
TorstenThieme36a38a82022-02-09 15:51:30 +000074 [Arguments] ${conn_id} ${cmd} ${do_reconnect}=True ${connection_list_id}=${EMPTY}
TorstenThieme2ddb6e82022-02-08 14:44:24 +000075 Log Command: ${cmd}
76 SSHLibrary.Switch Connection ${conn_id}
77 # get connection settings, has no functional reason, only for info
TorstenThieme1d1413b2022-02-04 12:41:01 +000078 ${connection_info}= SSHLibrary.Get Connection
TorstenThiemeedc50672022-02-14 10:32:10 +000079 # write the command until it is mirrored
80 ${PassOrFail} ${Written}= Run Keyword And Ignore Error Write Until Expected Output ${cmd} expected=${cmd}
81 ... timeout=5s retry_interval=1s
TorstenThieme2ddb6e82022-02-08 14:44:24 +000082 Run Keyword If '${PassOrFail}'=='FAIL' and ${do_reconnect} Reconnect ONOS SSH Connection ${connection_list_id}
TorstenThiemeedc50672022-02-14 10:32:10 +000083 Run Keyword If '${PassOrFail}'=='FAIL' Write Until Expected Output ${cmd}${\n} expected=${cmd} timeout=5s
84 ... retry_interval=1s
85 # set up the comand - press enter key!
86 ${Written}= Write ${EMPTY}
TorstenThieme2ddb6e82022-02-08 14:44:24 +000087 ${PassOrFail} ${output}= Run Keyword And Ignore Error Read Until Prompt strip_prompt=True
TorstenThieme1d1413b2022-02-04 12:41:01 +000088 Log Result_values: ${output}
TorstenThieme1f58cac2022-02-10 15:58:38 +000089 # remove error printout from ssh library in case of failure
90 ${output}= Run Keyword If '${PassOrFail}'=='FAIL' Fetch From Right ${output} Output:
91 ... ELSE Set Variable ${output}
92 ${output}= Run Keyword If '${PassOrFail}'=='FAIL' Get Substring ${output} 1
93 ... ELSE Set Variable ${output}
TorstenThieme2ddb6e82022-02-08 14:44:24 +000094 ${output_length}= Get Length ${output}
95 # remove regexp-prompt if available
96 ${output}= Remove String Using Regexp ${output} ${regexp_prompt}
97 ${output_after}= Get Length ${output}
98 Run Keyword If '${PassOrFail}'=='FAIL' and ${output_length}== ${output_after} FAIL SSH access failed for '${cmd}'!
TorstenThieme1d1413b2022-02-04 12:41:01 +000099 # we do not use strip of escape sequences integrated in ssh lib, we do it by ourself to have it under control
100 ${output}= Remove String Using Regexp ${output} \\x1b[>=]{0,1}(?:\\[[0-?]*(?:[hlm])[~]{0,1})*
101 # remove the endless spaces and two carrige returns at the end of output
102 ${output}= Remove String Using Regexp ${output} \\s*\\r \\r
103 # now we have the plain output text
104 Log Stripped Result_values: ${output}
TorstenThieme4e2168e2021-06-22 14:01:47 +0000105 [Return] ${output}
106
107Get Conn List Id
108 [Documentation] Looks up for an Open Connection with passed host and port in conection list
109 ... First match connection will be used.
110 [Arguments] ${host} ${port}
111 ${connection_list_id}= Set Variable ${EMPTY}
112 ${match}= Set Variable False
113 ${length}= Get Length ${connection_list}
114 FOR ${INDEX} IN RANGE 0 ${length}
115 #${Item}= Get From List ${connection_list} ${INDEX}
116 ${conndata}= Get Connection ${connection_list[${INDEX}].conn_id}
117 ${match}= Set Variable If '${conndata.host}'=='${host}' and '${conndata.port}'=='${port}' True False
118 ${connection_list_id}= Set Variable If ${match} ${INDEX} ${EMPTY}
119 Exit For Loop If ${match}
120 END
121 [Return] ${connection_list_id}
122
TorstenThiemeb198c482020-12-14 19:45:23 +0000123Reconnect ONOS SSH Connection
124 [Documentation] Reconnect an SSH Connection
125 [Arguments] ${connection_list_id}
126 ${connection_entry}= Get From List ${connection_list} ${connection_list_id}
127 ${user}= Get From Dictionary ${connection_entry} user
128 ${pass}= Get From Dictionary ${connection_entry} pass
129 ${oldconndata}= Get Connection ${connection_entry.conn_id}
TorstenThieme1d1413b2022-02-04 12:41:01 +0000130 ${match}= Set Variable If
131 ... "${oldconndata.host}"=="${connection_entry.host}" and "${oldconndata.port}"=="${connection_entry.port}"
132 ... True False
133 Run Keyword If ${match} SSHLibrary.Switch Connection ${connection_entry.conn_id}
134 Run Keyword If ${match} Run Keyword And Ignore Error SSHLibrary.Close Connection
135 ${conn_id}= SSHLibrary.Open Connection ${connection_entry.host} port=${connection_entry.port}
TorstenThieme2ddb6e82022-02-08 14:44:24 +0000136 ... timeout=${ssh_read_timeout} alias=${alias}
TorstenThieme36a38a82022-02-09 15:51:30 +0000137 SSHLibrary.Login username=${user} password=${pass} keep_alive_interval=${keep_alive_interval}
TorstenThieme1d1413b2022-02-04 12:41:01 +0000138 # set excepted prompt and terminal width to suppress unwanted line feeds
TorstenThieme2ddb6e82022-02-08 14:44:24 +0000139 SSHLibrary.Set Client Configuration prompt=${ssh_prompt} width=${ssh_width}
TorstenThiemeb198c482020-12-14 19:45:23 +0000140 ${conn_list_entry}= Create Dictionary conn_id=${conn_id} user=${user} pass=${pass}
TorstenThieme1d1413b2022-02-04 12:41:01 +0000141 ... host=${connection_entry.host} port=${connection_entry.port} alias=${alias}
TorstenThiemeb198c482020-12-14 19:45:23 +0000142 Set List Value ${connection_list} ${connection_list_id} ${conn_list_entry}
143 Set Global Variable ${connection_list}
TorstenThieme1d1413b2022-02-04 12:41:01 +0000144 # disable highlighting to suppress control sequences
TorstenThieme2ddb6e82022-02-08 14:44:24 +0000145 ${output}= Execute Single ONOS CLI Command ${conn_id} ${disable_highlighter} do_reconnect=False
TorstenThiemeb198c482020-12-14 19:45:23 +0000146
Matteo Scandolo37bca8d2020-07-31 11:28:40 -0700147Close ONOS SSH Connection
148 [Documentation] Close an SSH Connection
TorstenThiemeb198c482020-12-14 19:45:23 +0000149 [Arguments] ${connection_list_id}
150 ${connection_entry}= Get From List ${connection_list} ${connection_list_id}
151 ${connection_alias}= Get From Dictionary ${connection_entry} conn_id
152 ${oldconndata}= Get Connection ${connection_entry.conn_id}
Matteo Scandolo37bca8d2020-07-31 11:28:40 -0700153 SSHLibrary.Switch Connection ${connection_alias}
TorstenThiemebcf14612021-01-27 10:19:18 +0000154 Run Keyword And Ignore Error SSHLibrary.Close Connection
TorstenThiemeb198c482020-12-14 19:45:23 +0000155 Remove From List ${connection_list} ${connection_list_id}
156 Set Global Variable ${connection_list}
157
158Close All ONOS SSH Connections
159 [Documentation] Close all SSH Connection and clear connection list.
160 SSHLibrary.Close All Connections
161 @{connection_list} Create List
Matteo Scandolo37bca8d2020-07-31 11:28:40 -0700162
Kailash6f5acb62019-08-28 14:38:45 -0700163Validate OLT Device in ONOS
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700164 # FIXME use volt-olts to check that the OLT is ONOS
Kailash6f5acb62019-08-28 14:38:45 -0700165 [Arguments] ${serial_number}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700166 [Documentation] Checks if olt has been connected to ONOS
Kailash6f5acb62019-08-28 14:38:45 -0700167 ${resp}= Get Request ONOS onos/v1/devices
168 ${jsondata}= To Json ${resp.content}
169 Should Not Be Empty ${jsondata['devices']}
170 ${length}= Get Length ${jsondata['devices']}
171 @{serial_numbers}= Create List
Andy Bavierb63f6d22020-03-12 15:34:37 -0700172 ${matched}= Set Variable False
Zack Williamsec53a1b2019-09-16 15:50:52 -0700173 FOR ${INDEX} IN RANGE 0 ${length}
174 ${value}= Get From List ${jsondata['devices']} ${INDEX}
175 ${of_id}= Get From Dictionary ${value} id
176 ${sn}= Get From Dictionary ${value} serial
Andy Bavierb63f6d22020-03-12 15:34:37 -0700177 ${matched}= Set Variable If '${sn}' == '${serial_number}' True False
178 Exit For Loop If ${matched}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700179 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700180 Should Be True ${matched} No match for ${serial_number} found
Kailash57210eb2019-08-30 13:27:19 -0700181 [Return] ${of_id}
Kailash6f5acb62019-08-28 14:38:45 -0700182
Suchitra Vemuri102912a2019-09-24 00:35:42 -0700183Get ONU Port in ONOS
Hardik Windlass1ed2eee2021-06-25 09:51:03 +0000184 [Arguments] ${onu_serial_number} ${olt_of_id} ${onu_uni_id}=1
Suchitra Vemuri102912a2019-09-24 00:35:42 -0700185 [Documentation] Retrieves ONU port for the ONU in ONOS
Hardik Windlass1ed2eee2021-06-25 09:51:03 +0000186 ${onu_serial_number}= Catenate SEPARATOR=- ${onu_serial_number} ${onu_uni_id}
Suchitra Vemuri102912a2019-09-24 00:35:42 -0700187 ${resp}= Get Request ONOS onos/v1/devices/${olt_of_id}/ports
188 ${jsondata}= To Json ${resp.content}
189 Should Not Be Empty ${jsondata['ports']}
190 ${length}= Get Length ${jsondata['ports']}
191 @{ports}= Create List
Andy Bavierb63f6d22020-03-12 15:34:37 -0700192 ${matched}= Set Variable False
Zack Williamsec53a1b2019-09-16 15:50:52 -0700193 FOR ${INDEX} IN RANGE 0 ${length}
194 ${value}= Get From List ${jsondata['ports']} ${INDEX}
195 ${annotations}= Get From Dictionary ${value} annotations
196 ${onu_port}= Get From Dictionary ${value} port
197 ${portName}= Get From Dictionary ${annotations} portName
Andy Bavierb63f6d22020-03-12 15:34:37 -0700198 ${matched}= Set Variable If '${portName}' == '${onu_serial_number}' True False
199 Exit For Loop If ${matched}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700200 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700201 Should Be True ${matched} No match for ${onu_serial_number} found
Suchitra Vemuri102912a2019-09-24 00:35:42 -0700202 [Return] ${onu_port}
203
TorstenThieme9b25aab2021-12-16 15:59:45 +0000204Get Onu Ports in ONOS For ALL UNI per ONU
205 [Documentation] Retrieves ONU port(s) for the ONU in ONOS for all UNI-IDs, list of ports will return!
206 [Arguments] ${onu_serial_number} ${olt_of_id}
207 @{uni_id_list}= Create List
208 @{port_list}= Create List
209 FOR ${I} IN RANGE 0 ${num_all_onus}
210 ${src}= Set Variable ${hosts.src[${I}]}
211 Continue For Loop If "${src['onu']}" != "${onu_serial_number}"
212 ${uni_id}= Set Variable ${src['uni_id']}
213 # make sure all actions do only once per uni_id
214 ${id}= Get Index From List ${uni_id_list} ${uni_id}
215 Continue For Loop If -1 != ${id}
216 Append To List ${uni_id_list} ${uni_id}
217 ${onu_port}= Wait Until Keyword Succeeds ${timeout} 2s Get ONU Port in ONOS ${onu_serial_number}
218 ... ${olt_of_id} ${uni_id}
219 Append To List ${port_list} ${onu_port}
220 END
221 [return] ${port_list}
222
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530223Get NNI Port in ONOS
224 [Arguments] ${olt_of_id}
225 [Documentation] Retrieves NNI port for the OLT in ONOS
226 ${resp}= Get Request ONOS onos/v1/devices/${olt_of_id}/ports
227 ${jsondata}= To Json ${resp.content}
228 Should Not Be Empty ${jsondata['ports']}
229 ${length}= Get Length ${jsondata['ports']}
230 @{ports}= Create List
231 ${matched}= Set Variable False
232 FOR ${INDEX} IN RANGE 0 ${length}
233 ${value}= Get From List ${jsondata['ports']} ${INDEX}
234 ${annotations}= Get From Dictionary ${value} annotations
235 ${nni_port}= Get From Dictionary ${value} port
236 ${nniPortName}= Catenate SEPARATOR= nni- ${nni_port}
237 ${portName}= Get From Dictionary ${annotations} portName
238 ${matched}= Set Variable If '${portName}' == '${nniPortName}' True False
239 Exit For Loop If ${matched}
240 END
241 Should Be True ${matched} No match for NNI found for ${olt_of_id}
242 [Return] ${nni_port}
243
Suchitra Vemuri532f67a2019-09-25 11:50:42 -0700244Get FabricSwitch in ONOS
245 [Documentation] Returns of_id of the Fabric Switch in ONOS
246 ${resp}= Get Request ONOS onos/v1/devices
247 ${jsondata}= To Json ${resp.content}
248 Should Not Be Empty ${jsondata['devices']}
249 ${length}= Get Length ${jsondata['devices']}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700250 ${matched}= Set Variable False
Suchitra Vemuri532f67a2019-09-25 11:50:42 -0700251 FOR ${INDEX} IN RANGE 0 ${length}
252 ${value}= Get From List ${jsondata['devices']} ${INDEX}
253 ${of_id}= Get From Dictionary ${value} id
254 ${type}= Get From Dictionary ${value} type
Andy Bavierb63f6d22020-03-12 15:34:37 -0700255 ${matched}= Set Variable If '${type}' == "SWITCH" True False
256 Exit For Loop If ${matched}
Suchitra Vemuri532f67a2019-09-25 11:50:42 -0700257 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700258 Should Be True ${matched} No fabric switch found
Suchitra Vemuri532f67a2019-09-25 11:50:42 -0700259 [Return] ${of_id}
260
Andrea Campanella4c404632020-08-26 14:41:36 +0200261Get Master Instace in ONOS
262 [Arguments] ${of_id}
263 [Documentation] Returns nodeId of the Master instace for a giver device in ONOS
264 ${resp}= Get Request ONOS onos/v1/mastership/${of_id}/master
265 ${jsondata}= To Json ${resp.content}
266 Should Not Be Empty ${jsondata['nodeId']}
267 ${master_node}= Get From Dictionary ${jsondata} nodeId
268 [Return] ${master_node}
269
Matteo Scandolo7bdbe2d2021-11-29 15:48:25 -0800270Verify LLDP Flow Added
271 [Arguments] ${ip} ${port} ${olt_of_id} ${expected_flows}
272 [Documentation] Matches for total number of LLDP flows added for one OLT
273 ${lldp_flows_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
274 ... flows -s ADDED ${olt_of_id} | grep -v deviceId | grep ETH_TYPE:lldp | grep -v ETH_TYPE:arp
275 ${lldp_flows_added_count}= Get Line Count ${lldp_flows_added}
276 Should Be Equal As Integers ${lldp_flows_added_count} ${expected_flows}
277
Hardik Windlass21807632020-04-14 16:24:55 +0530278Verify Subscriber Access Flows Added for ONU
279 [Arguments] ${ip} ${port} ${olt_of_id} ${onu_port} ${nni_port} ${c_tag} ${s_tag}
280 [Documentation] Verifies if the Subscriber Access Flows are added in ONOS for the ONU
281 # Verify upstream table=0 flow
282 ${upstream_flow_0_cmd}= Catenate SEPARATOR=
283 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${onu_port} | grep VLAN_VID:0 |
284 ... grep VLAN_ID:${c_tag} | grep transition=TABLE:1
TorstenThieme4e2168e2021-06-22 14:01:47 +0000285 ${upstream_flow_0_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass21807632020-04-14 16:24:55 +0530286 ... ${upstream_flow_0_cmd}
287 Should Not Be Empty ${upstream_flow_0_added}
288 # Verify upstream table=1 flow
289 ${flow_vlan_push_cmd}= Catenate SEPARATOR=
290 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${onu_port} | grep VLAN_VID:${c_tag} |
291 ... grep VLAN_PUSH | grep VLAN_ID:${s_tag} | grep OUTPUT:${nni_port}
TorstenThieme4e2168e2021-06-22 14:01:47 +0000292 ${upstream_flow_1_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass21807632020-04-14 16:24:55 +0530293 ... ${flow_vlan_push_cmd}
294 Should Not Be Empty ${upstream_flow_1_added}
295 # Verify downstream table=0 flow
296 ${flow_vlan_pop_cmd}= Catenate SEPARATOR=
297 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${nni_port} | grep VLAN_VID:${s_tag} |
298 ... grep VLAN_POP | grep transition=TABLE:1
TorstenThieme4e2168e2021-06-22 14:01:47 +0000299 ${downstream_flow_0_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass21807632020-04-14 16:24:55 +0530300 ... ${flow_vlan_pop_cmd}
301 Should Not Be Empty ${downstream_flow_0_added}
302 # Verify downstream table=1 flow
303 ${downstream_flow_1_cmd}= Catenate SEPARATOR=
304 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${nni_port} | grep VLAN_VID:${c_tag} |
305 ... grep VLAN_ID:0 | grep OUTPUT:${onu_port}
TorstenThieme4e2168e2021-06-22 14:01:47 +0000306 ${downstream_flow_1_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass21807632020-04-14 16:24:55 +0530307 ... ${downstream_flow_1_cmd}
308 Should Not Be Empty ${downstream_flow_1_added}
309 # Verify ipv4 dhcp upstream flow
310 ${upstream_flow_ipv4_cmd}= Catenate SEPARATOR=
Andrea Campanella5e9051c2020-04-30 14:38:35 +0200311 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${onu_port} | grep ETH_TYPE:ipv4 |
Andrea Campanella08678e12020-09-18 17:40:22 +0200312 ... grep IP_PROTO:17 | grep UDP_SRC:68 | grep UDP_DST:67 | grep VLAN_ID:${c_tag} |
Andrea Campanella5e9051c2020-04-30 14:38:35 +0200313 ... grep OUTPUT:CONTROLLER
TorstenThieme4e2168e2021-06-22 14:01:47 +0000314 ${upstream_flow_ipv4_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass21807632020-04-14 16:24:55 +0530315 ... ${upstream_flow_ipv4_cmd}
Andrea Campanella5e9051c2020-04-30 14:38:35 +0200316 Should Not Be Empty ${upstream_flow_ipv4_added}
Hardik Windlass21807632020-04-14 16:24:55 +0530317 # Verify ipv4 dhcp downstream flow
318 # Note: This flow will be one per nni per olt
319 ${downstream_flow_ipv4_cmd}= Catenate SEPARATOR=
Andrea Campanella5e9051c2020-04-30 14:38:35 +0200320 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${nni_port} | grep ETH_TYPE:ipv4 |
321 ... grep IP_PROTO:17 | grep UDP_SRC:67 | grep UDP_DST:68 | grep OUTPUT:CONTROLLER
TorstenThieme4e2168e2021-06-22 14:01:47 +0000322 ${downstream_flow_ipv4_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass21807632020-04-14 16:24:55 +0530323 ... ${downstream_flow_ipv4_cmd}
Andrea Campanella5e9051c2020-04-30 14:38:35 +0200324 Should Not Be Empty ${downstream_flow_ipv4_added}
Hardik Windlass21807632020-04-14 16:24:55 +0530325
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530326Verify Subscriber Access Flows Added for ONU DT
Hardik Windlass25e11702020-03-30 20:05:19 +0530327 [Arguments] ${ip} ${port} ${olt_of_id} ${onu_port} ${nni_port} ${s_tag}
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530328 [Documentation] Verifies if the Subscriber Access Flows are added in ONOS for the ONU
329 # Verify upstream table=0 flow
TorstenThieme4e2168e2021-06-22 14:01:47 +0000330 ${upstream_flow_0_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass25e11702020-03-30 20:05:19 +0530331 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${onu_port} | grep VLAN_VID:Any | grep transition=TABLE:1
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530332 Should Not Be Empty ${upstream_flow_0_added}
333 # Verify upstream table=1 flow
334 ${flow_vlan_push_cmd}= Catenate SEPARATOR=
Hardik Windlass25e11702020-03-30 20:05:19 +0530335 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${onu_port} | grep VLAN_VID:Any |
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530336 ... grep VLAN_PUSH | grep VLAN_ID:${s_tag} | grep OUTPUT:${nni_port}
TorstenThieme4e2168e2021-06-22 14:01:47 +0000337 ${upstream_flow_1_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530338 ... ${flow_vlan_push_cmd}
339 Should Not Be Empty ${upstream_flow_1_added}
340 # Verify downstream table=0 flow
341 ${flow_vlan_pop_cmd}= Catenate SEPARATOR=
Hardik Windlass25e11702020-03-30 20:05:19 +0530342 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${nni_port} | grep VLAN_VID:${s_tag} |
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530343 ... grep VLAN_POP | grep transition=TABLE:1
TorstenThieme4e2168e2021-06-22 14:01:47 +0000344 ${downstream_flow_0_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530345 ... ${flow_vlan_pop_cmd}
346 Should Not Be Empty ${downstream_flow_0_added}
347 # Verify downstream table=1 flow
TorstenThieme4e2168e2021-06-22 14:01:47 +0000348 ${downstream_flow_1_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass25e11702020-03-30 20:05:19 +0530349 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${nni_port} | grep VLAN_VID:Any | grep OUTPUT:${onu_port}
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530350 Should Not Be Empty ${downstream_flow_1_added}
351
352Verify Subscriber Access Flows Added Count DT
Hardik Windlass25e11702020-03-30 20:05:19 +0530353 [Arguments] ${ip} ${port} ${olt_of_id} ${expected_flows}
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530354 [Documentation] Matches for total number of subscriber access flows added for all onus
TorstenThieme4e2168e2021-06-22 14:01:47 +0000355 ${access_flows_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700356 ... flows -s ADDED ${olt_of_id} | grep -v deviceId | grep -v ETH_TYPE:lldp | grep -v ETH_TYPE:arp
357 ${access_flows_added_count}= Get Line Count ${access_flows_added}
358 Should Be Equal As Integers ${access_flows_added_count} ${expected_flows}
Hardik Windlassfb5eace2020-03-26 14:49:01 +0530359
Huseyin Ahmet AYDIN45922c82021-05-27 12:37:32 +0000360Verify Added Flow Count for OLT TT
361 [Arguments] ${ip} ${port} ${olt_of_id} ${expected_flows}
362 [Documentation] Total number of added flows given OLT with subscriber flows
TorstenThieme4e2168e2021-06-22 14:01:47 +0000363 ${access_flows_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700364 ... flows -s ADDED ${olt_of_id} | grep -v deviceId
365 ${access_flows_added_count}= Get Line Count ${access_flows_added}
366 Should Be Equal As Integers ${access_flows_added_count} ${expected_flows}
Huseyin Ahmet AYDIN45922c82021-05-27 12:37:32 +0000367
Emrehan UZUN2884ed52021-05-04 15:36:31 +0000368Verify Default Downstream Flows are added in ONOS for OLT TT
369 [Arguments] ${ip} ${port} ${olt_of_id} ${nni_port}
370 [Documentation] Verifies if the Default Downstream Flows are added in ONOS for the OLT
371 # Verify lldp flow
372 ${downstream_flow_lldp_cmd}= Catenate SEPARATOR=
373 ... flows -s ADDED ${olt_of_id} | grep lldp |
374 ... grep OUTPUT:CONTROLLER
TorstenThieme4e2168e2021-06-22 14:01:47 +0000375 ${downstream_flow_lldp_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Emrehan UZUN2884ed52021-05-04 15:36:31 +0000376 ... ${downstream_flow_lldp_cmd}
377 Should Not Be Empty ${downstream_flow_lldp_added}
378 # Verify downstream dhcp flow
379 ${downstream_flow_dhcp_cmd}= Catenate SEPARATOR=
380 ... flows -s ADDED ${olt_of_id} | grep IP_PROTO:17 | grep UDP_SRC:67 | grep UDP_DST:68 |
381 ... grep OUTPUT:CONTROLLER
TorstenThieme4e2168e2021-06-22 14:01:47 +0000382 ${downstream_flow_dhcp_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Emrehan UZUN2884ed52021-05-04 15:36:31 +0000383 ... ${downstream_flow_dhcp_cmd}
384 Should Not Be Empty ${downstream_flow_dhcp_added}
385 # Verify downstream igmp flow
386 ${downstream_flow_igmp_cmd}= Catenate SEPARATOR=
387 ... flows -s ADDED ${olt_of_id} | grep IP_PROTO:2 |
388 ... grep OUTPUT:CONTROLLER
TorstenThieme4e2168e2021-06-22 14:01:47 +0000389 ${downstream_flow_igmp_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Emrehan UZUN2884ed52021-05-04 15:36:31 +0000390 ... ${downstream_flow_igmp_cmd}
391 Should Not Be Empty ${downstream_flow_igmp_added}
392
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530393Get Programmed Subscribers
394 [Arguments] ${ip} ${port} ${olt_of_id} ${onu_port}
395 [Documentation] Retrieves the subscriber details at a given location
396 ${sub_location}= Catenate SEPARATOR=/ ${olt_of_id} ${onu_port}
TorstenThieme4e2168e2021-06-22 14:01:47 +0000397 ${programmed_sub}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530398 ... volt-programmed-subscribers | grep ${sub_location}
399 [Return] ${programmed_sub}
400
401Get Upstream and Downstream Bandwidth Profile Name
402 [Arguments] ${programmed_sub}
403 [Documentation] Retrieves the upstream and downstream bandwidth profile name
404 ... from the programmed subscriber
405 @{programmed_sub_array}= Split String ${programmed_sub} ,
406 # Get upstream bandwidth profile name for the subscriber
407 @{param_val_pair}= Split String ${programmed_sub_array[9]} =
408 ${programmed_sub_param}= Set Variable ${param_val_pair[0]}
409 ${programmed_sub_val}= Set Variable ${param_val_pair[1]}
410 ${us_bw_profile}= Run Keyword If '${programmed_sub_param}' == ' upstreamBandwidthProfile'
411 ... Set Variable ${programmed_sub_val}
412 Log ${us_bw_profile}
413 # Get downstream bandwidth profile name for the subscriber
414 @{param_val_pair}= Split String ${programmed_sub_array[10]} =
415 ${programmed_sub_param}= Set Variable ${param_val_pair[0]}
416 ${programmed_sub_val}= Set Variable ${param_val_pair[1]}
417 ${ds_bw_profile}= Run Keyword If '${programmed_sub_param}' == ' downstreamBandwidthProfile'
418 ... Set Variable ${programmed_sub_val}
419 Log ${ds_bw_profile}
420 [Return] ${us_bw_profile} ${ds_bw_profile}
421
422Get Bandwidth Profile Details
423 [Arguments] ${ip} ${port} ${bw_profile}
424 [Documentation] Retrieves the details of the given bandwidth profile
TorstenThieme4e2168e2021-06-22 14:01:47 +0000425 ${bw_profile_values}= Execute ONOS CLI Command use single connection ${ONOS_SSH_IP} ${ONOS_SSH_PORT}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530426 ... bandwidthprofile ${bw_profile}
427 @{bw_profile_array}= Split String ${bw_profile_values} ,
428 @{param_val_pair}= Split String ${bw_profile_array[1]} =
429 ${bw_param}= Set Variable ${param_val_pair[0]}
430 ${bw_val}= Set Variable ${param_val_pair[1]}
431 ${cir} Run Keyword If '${bw_param}' == ' committedInformationRate'
432 ... Set Variable ${bw_val}
433 @{param_val_pair}= Split String ${bw_profile_array[2]} =
434 ${bw_param}= Set Variable ${param_val_pair[0]}
435 ${bw_val}= Set Variable ${param_val_pair[1]}
436 ${cbs} Run Keyword If '${bw_param}' == ' committedBurstSize'
437 ... Set Variable ${bw_val}
438 @{param_val_pair}= Split String ${bw_profile_array[3]} =
439 ${bw_param}= Set Variable ${param_val_pair[0]}
440 ${bw_val}= Set Variable ${param_val_pair[1]}
441 ${eir} Run Keyword If '${bw_param}' == ' exceededInformationRate'
442 ... Set Variable ${bw_val}
443 @{param_val_pair}= Split String ${bw_profile_array[4]} =
444 ${bw_param}= Set Variable ${param_val_pair[0]}
445 ${bw_val}= Set Variable ${param_val_pair[1]}
446 ${ebs} Run Keyword If '${bw_param}' == ' exceededBurstSize'
447 ... Set Variable ${bw_val}
448 @{param_val_pair}= Split String ${bw_profile_array[5]} =
449 ${bw_param}= Set Variable ${param_val_pair[0]}
450 ${bw_val}= Set Variable ${param_val_pair[1]}
451 @{bw_val_air}= Split String ${bw_val} }
452 ${air} Run Keyword If '${bw_param}' == ' assuredInformationRate'
453 ... Set Variable ${bw_val_air[0]}
454 [Return] ${cir} ${cbs} ${eir} ${ebs} ${air}
455
Hardik Windlassba5add42021-05-04 12:41:29 +0000456Get Bandwidth Profile Details Rest
457 [Arguments] ${bw_profile_id}
458 [Documentation] Retrieves the details of the given bandwidth profile using REST API
Girish Gowdracb8482a2021-05-27 09:06:13 -0700459 ${bw_profile_id}= Remove String ${bw_profile_id} ' "
Hardik Windlassba5add42021-05-04 12:41:29 +0000460 ${resp}= Get Request ONOS onos/sadis/bandwidthprofile/${bw_profile_id}
461 ${jsondata}= To Json ${resp.content}
462 Should Not Be Empty ${jsondata['entry']}
463 ${length}= Get Length ${jsondata['entry']}
464 ${matched}= Set Variable False
465 FOR ${INDEX} IN RANGE 0 ${length}
466 ${value}= Get From List ${jsondata['entry']} ${INDEX}
467 ${bw_id}= Get From Dictionary ${value} id
468 ${matched}= Set Variable If '${bw_id}' == '${bw_profile_id}' True False
469 ${eir}= Get From Dictionary ${value} eir
470 ${ebs}= Get From Dictionary ${value} ebs
471 ${cir}= Get From Dictionary ${value} cir
472 ${cbs}= Get From Dictionary ${value} cbs
473 ${air}= Get From Dictionary ${value} air
474 Exit For Loop If ${matched}
475 END
476 Should Be True ${matched} No bandwidth profile found for id: ${bw_profile_id}
477 [Return] ${cir} ${cbs} ${eir} ${ebs} ${air}
478
Hardik Windlass841979a2021-05-25 05:30:27 +0000479Get Bandwidth Profile Details Ietf Rest
480 [Arguments] ${bw_profile_id}
481 [Documentation] Retrieves the details of the given Ietf standard based bandwidth profile using REST API
482 ${bw_profile_id}= Remove String ${bw_profile_id} ' "
483 ${resp}= Get Request ONOS onos/sadis/bandwidthprofile/${bw_profile_id}
484 ${jsondata}= To Json ${resp.content}
485 Should Not Be Empty ${jsondata['entry']}
486 ${length}= Get Length ${jsondata['entry']}
487 ${matched}= Set Variable False
488 FOR ${INDEX} IN RANGE 0 ${length}
489 ${value}= Get From List ${jsondata['entry']} ${INDEX}
490 ${bw_id}= Get From Dictionary ${value} id
491 ${matched}= Set Variable If '${bw_id}' == '${bw_profile_id}' True False
492 ${pir}= Get From Dictionary ${value} pir
493 ${pbs}= Get From Dictionary ${value} pbs
494 ${cir}= Get From Dictionary ${value} cir
495 ${cbs}= Get From Dictionary ${value} cbs
496 ${gir}= Get From Dictionary ${value} gir
497 Exit For Loop If ${matched}
498 END
499 Should Be True ${matched} No bandwidth profile found for id: ${bw_profile_id}
500 [Return] ${cir} ${cbs} ${pir} ${pbs} ${gir}
501
Girish Gowdra21ec25d2021-05-24 10:07:01 -0700502Verify Meters in ONOS Ietf
503 [Arguments] ${ip} ${port} ${olt_of_id} ${onu_port}
504 [Documentation] Verifies the meters with BW Ietf format (currently, DT workflow uses this format)
505 # Get programmed subscriber
506 ${programmed_sub}= Get Programmed Subscribers ${ip} ${port}
507 ... ${olt_of_id} ${onu_port}
508 Log ${programmed_sub}
509 ${us_bw_profile} ${ds_bw_profile} Get Upstream and Downstream Bandwidth Profile Name
510 ... ${programmed_sub}
511 # Get upstream bandwidth profile details
512 ${us_cir} ${us_cbs} ${us_pir} ${us_pbs} ${us_gir} Get Bandwidth Profile Details Ietf Rest
513 ... ${us_bw_profile}
514 # Verify meter for upstream bandwidth profile
515 ${us_meter_cmd}= Run Keyword If ${us_gir} != 0 Catenate SEPARATOR=
516 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${us_cir}, burst-size=${us_cbs}"
517 ... | grep "rate=${us_pir}, burst-size=${us_pbs}" | grep "rate=${us_gir}, burst-size=0" | wc -l
518 ... ELSE Catenate SEPARATOR=
519 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${us_cir}, burst-size=${us_cbs}"
520 ... | grep "rate=${us_pir}, burst-size=${us_pbs}" | wc -l
TorstenThieme4e2168e2021-06-22 14:01:47 +0000521 ${upstream_meter_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Girish Gowdra21ec25d2021-05-24 10:07:01 -0700522 ... ${us_meter_cmd}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700523 Should Be Equal As Integers ${upstream_meter_added} 1 Upstream meter is missing
Girish Gowdra21ec25d2021-05-24 10:07:01 -0700524 # Get downstream bandwidth profile details
525 ${ds_cir} ${ds_cbs} ${ds_pir} ${ds_pbs} ${ds_gir} Get Bandwidth Profile Details Ietf Rest
526 ... ${ds_bw_profile}
527 # Verify meter for downstream bandwidth profile
528 ${ds_meter_cmd}= Run Keyword If ${ds_gir} != 0 Catenate SEPARATOR=
529 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${ds_cir}, burst-size=${ds_cbs}"
530 ... | grep "rate=${ds_pir}, burst-size=${ds_pbs}" | grep "rate=${ds_gir}, burst-size=0" | wc -l
531 ... ELSE Catenate SEPARATOR=
532 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${ds_cir}, burst-size=${ds_cbs}"
533 ... | grep "rate=${ds_pir}, burst-size=${ds_pbs}" | wc -l
TorstenThieme4e2168e2021-06-22 14:01:47 +0000534 ${downstream_meter_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Girish Gowdra21ec25d2021-05-24 10:07:01 -0700535 ... ${ds_meter_cmd}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700536 Should Be Equal As Integers ${downstream_meter_added} 1 Downstream meter is missing
Girish Gowdra21ec25d2021-05-24 10:07:01 -0700537
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530538Verify Meters in ONOS
539 [Arguments] ${ip} ${port} ${olt_of_id} ${onu_port}
540 [Documentation] Verifies the meters
541 # Get programmed subscriber
542 ${programmed_sub}= Get Programmed Subscribers ${ip} ${port}
543 ... ${olt_of_id} ${onu_port}
544 Log ${programmed_sub}
545 ${us_bw_profile} ${ds_bw_profile} Get Upstream and Downstream Bandwidth Profile Name
546 ... ${programmed_sub}
Matteo Scandolo2056ed72021-11-02 17:38:03 -0700547 # logging all meters to facilitate debug
548 ${all_meters}= Execute ONOS CLI Command use single connection ${ip} ${port} meters
549 Log ${all_meters}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530550 # Get upstream bandwidth profile details
551 ${us_cir} ${us_cbs} ${us_eir} ${us_ebs} ${us_air} Get Bandwidth Profile Details
552 ... ${ip} ${port} ${us_bw_profile}
553 Sleep 1s
Andrea Campanella2b367102021-05-04 19:33:46 +0200554 ${us_pbs}= Evaluate ${us_cbs}+${us_ebs}
555 ${us_pir}= Evaluate ${us_eir}+${us_cir}+${us_air}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530556 # Verify meter for upstream bandwidth profile
557 ${us_meter_cmd}= Catenate SEPARATOR=
Hardik Windlasse380bdb2020-07-30 19:09:25 +0530558 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${us_cir}, burst-size=${us_cbs}"
Andrea Campanella2b367102021-05-04 19:33:46 +0200559 ... | grep "rate=${us_pir}, burst-size=${us_pbs}" | grep "rate=${us_air}, burst-size=0" | wc -l
TorstenThieme4e2168e2021-06-22 14:01:47 +0000560 ${upstream_meter_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530561 ... ${us_meter_cmd}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700562 Should Be Equal As Integers ${upstream_meter_added} 1 Upstream meter is missing
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530563 Sleep 1s
564 # Get downstream bandwidth profile details
565 ${ds_cir} ${ds_cbs} ${ds_eir} ${ds_ebs} ${ds_air} Get Bandwidth Profile Details
566 ... ${ip} ${port} ${ds_bw_profile}
567 Sleep 1s
568 # Verify meter for downstream bandwidth profile
Andrea Campanella2b367102021-05-04 19:33:46 +0200569 ${ds_pbs}= Evaluate ${ds_cbs}+${ds_ebs}
570 ${ds_pir}= Evaluate ${ds_eir}+${ds_cir}+${ds_air}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530571 ${ds_meter_cmd}= Catenate SEPARATOR=
Hardik Windlasse380bdb2020-07-30 19:09:25 +0530572 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${ds_cir}, burst-size=${ds_cbs}"
Andrea Campanella2b367102021-05-04 19:33:46 +0200573 ... | grep "rate=${ds_pir}, burst-size=${ds_pbs}" | grep "rate=${ds_air}, burst-size=0" | wc -l
TorstenThieme4e2168e2021-06-22 14:01:47 +0000574 ${downstream_meter_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530575 ... ${ds_meter_cmd}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700576 Should Be Equal As Integers ${downstream_meter_added} 1 Downstream meter is missing
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530577
578Verify Default Meter Present in ONOS
579 [Arguments] ${ip} ${port} ${olt_of_id}
580 [Documentation] Verifies the single default meter entry is present
Hardik Windlasse380bdb2020-07-30 19:09:25 +0530581 # Get default bandwidth profile details
582 ${cir} ${cbs} ${eir} ${ebs} ${air} Get Bandwidth Profile Details
583 ... ${ip} ${port} 'Default'
584 Sleep 1s
Andrea Campanella2b367102021-05-04 19:33:46 +0200585 ${pbs}= Evaluate ${cbs}+${ebs}
586 ${pir}= Evaluate ${eir}+${cir}+${air}
Hardik Windlasse380bdb2020-07-30 19:09:25 +0530587 # Verify meter for default bandwidth profile
588 ${meter_cmd}= Catenate SEPARATOR=
589 ... meters ${olt_of_id} | grep state=ADDED | grep "rate=${cir}, burst-size=${cbs}"
Andrea Campanella2b367102021-05-04 19:33:46 +0200590 ... | grep "rate=${pir}, burst-size=${pbs}" | grep "rate=${air}, burst-size=0" | wc -l
TorstenThieme4e2168e2021-06-22 14:01:47 +0000591 ${default_meter_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlasse380bdb2020-07-30 19:09:25 +0530592 ... ${meter_cmd}
Matteo Scandolo2056ed72021-11-02 17:38:03 -0700593 # logging all meters to facilitate debug
594 ${all_meters}= Execute ONOS CLI Command use single connection ${ip} ${port} meters
595 Log ${all_meters}
596 # done logging all meters to facilitate debug
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700597 Should Be Equal As Integers ${default_meter_added} 1 Default Meter not present
Hardik Windlass2a9b1592020-07-23 18:28:13 +0530598
Hardik Windlass480f3e22020-04-02 20:14:14 +0530599Verify Device Flows Removed
600 [Arguments] ${ip} ${port} ${olt_of_id}
601 [Documentation] Verifies all flows are removed from the device
TorstenThieme4e2168e2021-06-22 14:01:47 +0000602 ${device_flows}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo45645bd2021-11-02 10:09:07 -0700603 ... flows -s -f ${olt_of_id} | grep -v deviceId
604 ${flow_count}= Get Line Count ${device_flows}
605 Should Be Equal As Integers ${flow_count} 0 Flows not removed
Hardik Windlass480f3e22020-04-02 20:14:14 +0530606
Kailash6f5acb62019-08-28 14:38:45 -0700607Verify Eapol Flows Added
Andy Bavierb0c06232019-08-29 12:58:53 -0700608 [Arguments] ${ip} ${port} ${expected_flows}
Kailash6f5acb62019-08-28 14:38:45 -0700609 [Documentation] Matches for number of eapol flows based on number of onus
TorstenThieme4e2168e2021-06-22 14:01:47 +0000610 ${eapol_flows_added}= Execute ONOS CLI Command use single connection ${ip} ${port}
Gilles Depatie675a2062019-10-22 12:44:42 -0400611 ... flows -s -f ADDED | grep eapol | grep IN_PORT | wc -l
Andy Bavierb0c06232019-08-29 12:58:53 -0700612 Should Contain ${eapol_flows_added} ${expected_flows}
Kailash6f5acb62019-08-28 14:38:45 -0700613
Suchitra Vemuri9da44302020-03-04 14:24:49 -0800614Verify No Pending Flows For ONU
615 [Arguments] ${ip} ${port} ${onu_port}
616 [Documentation] Verifies that there are no flows "PENDING" state for the ONU in ONOS
TorstenThieme4e2168e2021-06-22 14:01:47 +0000617 ${pending_flows}= Execute ONOS CLI Command use single connection ${ip} ${port}
Suchitra Vemuri9da44302020-03-04 14:24:49 -0800618 ... flows -s | grep IN_PORT:${onu_port} | grep PENDING
619 Should Be Empty ${pending_flows}
620
Suchitra Vemuri3dd2f832019-10-18 13:14:54 -0700621Verify Eapol Flows Added For ONU
Matteo Scandolo7e519fb2021-08-13 11:35:16 -0700622 [Arguments] ${ip} ${port} ${olt_of_id} ${onu_port} ${c_tag}=4091
Suchitra Vemuri3dd2f832019-10-18 13:14:54 -0700623 [Documentation] Verifies if the Eapol Flows are added in ONOS for the ONU
Matteo Scandolo7e519fb2021-08-13 11:35:16 -0700624 ${eapol_flow_cmd}= Catenate SEPARATOR=
625 ... flows -s ADDED ${olt_of_id} | grep IN_PORT:${onu_port} | grep ETH_TYPE:eapol |
626 ... grep VLAN_ID:${c_tag} | grep OUTPUT:CONTROLLER
627 ${eapol_flows_added}= Execute ONOS CLI Command use single connection ${ip} ${port} ${eapol_flow_cmd}
Suchitra Vemuri3dd2f832019-10-18 13:14:54 -0700628 Should Not Be Empty ${eapol_flows_added}
629
Hardik Windlass39015672021-07-05 05:48:08 +0000630Verify UNI Port Is Enabled
Hardik Windlass1ed2eee2021-06-25 09:51:03 +0000631 [Arguments] ${ip} ${port} ${onu_name} ${onu_uni_id}=1
Hardik Windlass39015672021-07-05 05:48:08 +0000632 [Documentation] Verifies if the ONU's UNI port is enabled in ONOS
TorstenThieme4e2168e2021-06-22 14:01:47 +0000633 ${onu_port_enabled}= Execute ONOS CLI Command use single connection ${ip} ${port}
Hardik Windlass1ed2eee2021-06-25 09:51:03 +0000634 ... ports -e | grep portName=${onu_name}-${onu_uni_id}
Suchitra Vemuri8078b972020-02-06 19:07:41 -0800635 Log ${onu_port_enabled}
636 Should Not Be Empty ${onu_port_enabled}
637
Hardik Windlass39015672021-07-05 05:48:08 +0000638Verify UNI Port Is Disabled
Hardik Windlass1ed2eee2021-06-25 09:51:03 +0000639 [Arguments] ${ip} ${port} ${onu_name} ${onu_uni_id}=1
Hardik Windlass39015672021-07-05 05:48:08 +0000640 [Documentation] Verifies if the ONU's UNI port is disabled in ONOS
TorstenThieme4e2168e2021-06-22 14:01:47 +0000641 ${onu_port_disabled}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo02768532021-10-21 15:14:12 -0700642 ... ports | grep portName=${onu_name}-${onu_uni_id} | grep state=disabled
Hardik Windlass63d5e002020-03-06 21:07:09 +0530643 Log ${onu_port_disabled}
Matteo Scandolo02768532021-10-21 15:14:12 -0700644 Should Not Be Empty ${onu_port_disabled}
Hardik Windlass63d5e002020-03-06 21:07:09 +0530645
TorstenThieme9b25aab2021-12-16 15:59:45 +0000646Wait For All UNI Ports Are Disabled per ONU
647 [Documentation] Verifies all UNI Ports of passed ONU are disabled
648 [Arguments] ${ip} ${port} ${onu_serial_number}
649 @{uni_id_list}= Create List
650 FOR ${I} IN RANGE 0 ${num_all_onus}
651 ${src}= Set Variable ${hosts.src[${I}]}
652 Continue For Loop If "${src['onu']}" != "${onu_serial_number}"
653 ${uni_id}= Set Variable ${src['uni_id']}
654 # make sure all actions do only once per uni_id
655 ${id}= Get Index From List ${uni_id_list} ${uni_id}
656 Continue For Loop If -1 != ${id}
657 Append To List ${uni_id_list} ${uni_id}
658 Wait Until Keyword Succeeds ${timeout} 2s
659 ... Verify UNI Port Is Disabled ${ip} ${port} ${onu_serial_number} ${uni_id}
660 END
661
662Wait For All UNI Ports Are Enabled per ONU
663 [Documentation] Verifies all UNI Ports of passed ONU are enabled
664 [Arguments] ${ip} ${port} ${onu_serial_number}
665 @{uni_id_list}= Create List
666 FOR ${I} IN RANGE 0 ${num_all_onus}
667 ${src}= Set Variable ${hosts.src[${I}]}
668 Continue For Loop If "${src['onu']}" != "${onu_serial_number}"
669 ${uni_id}= Set Variable ${src['uni_id']}
670 # make sure all actions do only once per uni_id
671 ${id}= Get Index From List ${uni_id_list} ${uni_id}
672 Continue For Loop If -1 != ${id}
673 Append To List ${uni_id_list} ${uni_id}
674 Wait Until Keyword Succeeds ${timeout} 2s
675 ... Verify UNI Port Is Enabled ${ip} ${port} ${onu_serial_number} ${uni_id}
676 END
677
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -0700678Verify ONU in AAA-Users
679 [Arguments] ${ip} ${port} ${onu_port}
680 [Documentation] Verifies that the specified onu_port exists in aaa-users output
TorstenThieme4e2168e2021-06-22 14:01:47 +0000681 ${aaa_users}= Execute ONOS CLI Command use single connection ${ip} ${port}
682 ... aaa-users | grep AUTHORIZED | grep ${onu_port}
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -0700683 Should Not Be Empty ${aaa_users} ONU port ${onu_port} not found in aaa-users
684
Hardik Windlass513afd12021-02-03 15:19:46 +0000685Verify Empty Group in ONOS
686 [Documentation] Verifies zero group count on the device
TorstenThieme731a7592021-07-01 14:26:54 +0000687 [Arguments] ${ip} ${port} ${deviceId}
688 ${groups}= Execute ONOS CLI Command use single connection ${ip} ${port} groups | grep ${deviceId}
Hardik Windlass513afd12021-02-03 15:19:46 +0000689 @{groups_arr}= Split String ${groups} ,
690 @{group_count_arr}= Split String ${groups_arr[1]} =
691 ${group_count}= Set Variable ${group_count_arr[1]}
692 Should Be Equal As Integers ${group_count} 0
693
694Verify ONUs in Group Count in ONOS
695 [Documentation] Verifies there exists a group bucket list with certain entries/count
696 ... Note: Currently, this validates only if all ONUs of an OLT joined the same igmp group
TorstenThieme731a7592021-07-01 14:26:54 +0000697 [Arguments] ${ip} ${port} ${count} ${deviceId}
698 ${result}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolofd36e212021-03-02 11:36:10 -0800699 ... groups added ${deviceId} | grep bucket | wc -l
700 Should Be Equal As Integers ${result} ${count} Bucket list count for a group: Found=${result} Expected=${count}
Hardik Windlass513afd12021-02-03 15:19:46 +0000701
702Verify ONU in Group Bucket
703 [Documentation] Matches if ONU port in Group Bucket
704 [Arguments] ${group_bucket_values} ${onu_port}
705 ${len}= Get Length ${group_bucket_values}
706 ${matched}= Set Variable False
707 FOR ${INDEX} IN RANGE 0 ${len}
708 ${value_bucket}= Get From List ${group_bucket_values} ${INDEX}
709 ${treatment}= Get From Dictionary ${value_bucket} treatment
710 ${instructions}= Get From Dictionary ${treatment} instructions
711 ${instructions_val}= Get From List ${instructions} 0
712 ${port}= Get From Dictionary ${instructions_val} port
713 ${matched}= Set Variable If '${port}'=='${onu_port}' True False
714 Exit For Loop If ${matched}
715 END
716 [Return] ${matched}
717
Matteo Scandoloa80b4732020-09-04 13:51:10 -0700718Verify ONU in Groups
719 [Arguments] ${ip_onos} ${port_onos} ${deviceId} ${onu_port} ${group_exist}=True
720 [Documentation] Verifies that the specified onu_port exists in groups output
TorstenThieme4e2168e2021-06-22 14:01:47 +0000721 ${result}= Execute ONOS CLI Command use single connection ${ip_onos} ${port_onos} groups -j
Matteo Scandoloa80b4732020-09-04 13:51:10 -0700722 Log Groups: ${result}
723 ${groups}= To Json ${result}
724 ${length}= Get Length ${groups}
725 ${buckets}= Create List
726 ${matched}= Set Variable False
727 FOR ${INDEX} IN RANGE 0 ${length}
728 ${value}= Get From List ${groups} ${INDEX}
729 ${devId}= Get From Dictionary ${value} deviceId
730 ${bucket}= Get From Dictionary ${value} buckets
731 Run Keyword If '${devId}'=='${deviceId}'
732 ... Append To List ${buckets} ${bucket}
733 END
734 ${bucket_len}= Get Length ${buckets}
Hardik Windlass513afd12021-02-03 15:19:46 +0000735 FOR ${INDEX_1} IN RANGE 0 ${bucket_len}
736 ${value}= Get From List ${buckets} ${INDEX_1}
737 ${matched}= Verify ONU in Group Bucket ${value} ${onu_port}
Matteo Scandoloa80b4732020-09-04 13:51:10 -0700738 Exit For Loop If ${matched}
739 END
740 Run Keyword If ${group_exist}
741 ... Should Be True ${matched} No match for ${deviceId} and ${onu_port} found in ONOS groups
742 ... ELSE
743 ... Should Be True '${matched}'=='False' Match for ${deviceId} and ${onu_port} found in ONOS groups
744
Matteo Scandolo142e6272020-04-29 17:36:59 -0700745Assert Number of AAA-Users
TorstenThieme731a7592021-07-01 14:26:54 +0000746 [Arguments] ${ip} ${port} ${expected_onus} ${deviceId}
Kailash6f5acb62019-08-28 14:38:45 -0700747 [Documentation] Matches for number of aaa-users authorized based on number of onus
TorstenThieme731a7592021-07-01 14:26:54 +0000748 ${aaa_users}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo50be75c2020-11-12 11:14:12 -0800749 ... aaa-users | grep ${deviceId} | grep AUTHORIZED | wc -l
750 Log Found ${aaa_users} of ${expected_onus} expected authenticated users on device ${deviceId}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700751 Should Be Equal As Integers ${aaa_users} ${expected_onus}
Kailash6f5acb62019-08-28 14:38:45 -0700752
753Validate DHCP Allocations
TorstenThieme731a7592021-07-01 14:26:54 +0000754 [Arguments] ${ip} ${port} ${count} ${workflow} ${deviceId}
Kailash6f5acb62019-08-28 14:38:45 -0700755 [Documentation] Matches for number of dhcpacks based on number of onus
TorstenThieme731a7592021-07-01 14:26:54 +0000756 ${allocations}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo50be75c2020-11-12 11:14:12 -0800757 ... dhcpl2relay-allocations | grep ${deviceId} | grep DHCPACK | wc -l
Matteo Scandoloda854b02020-09-01 16:20:51 -0700758 # if the workflow is TT we'll have 2 allocations for each ONU
759 ${ttAllocations}= Evaluate (${count} * 2)
760 ${count}= Set Variable If $workflow=='tt' ${ttAllocations} ${count}
Matteo Scandolo50be75c2020-11-12 11:14:12 -0800761 Log Found ${allocations} of ${count} expected DHCPACK on device ${deviceId}
Matteo Scandoloda854b02020-09-01 16:20:51 -0700762 Should Be Equal As Integers ${allocations} ${count}
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -0700763
764Validate Subscriber DHCP Allocation
Suchitra Vemuri42819412020-10-01 17:45:43 -0700765 [Arguments] ${ip} ${port} ${onu_port} ${vlan}=''
Suchitra Vemuri8a9c3782019-10-23 12:43:01 -0700766 [Documentation] Verifies that the specified subscriber is found in DHCP allocations
767 ##TODO: Enhance the keyword to include DHCP allocated address is not 0.0.0.0
TorstenThieme4e2168e2021-06-22 14:01:47 +0000768 ${allocations}= Execute ONOS CLI Command use single connection ${ip} ${port}
Suchitra Vemuri42819412020-10-01 17:45:43 -0700769 ... dhcpl2relay-allocations | grep DHCPACK | grep ${onu_port} | grep ${vlan}
Gilles Depatie675a2062019-10-22 12:44:42 -0400770 Should Not Be Empty ${allocations} ONU port ${onu_port} not found in dhcpl2relay-allocations
David Bainbridgef81cd642019-11-20 00:14:47 +0000771
772Device Is Available In ONOS
Matteo Scandolo3218d5b2021-05-26 11:50:10 -0700773 [Arguments] ${url} ${dpid} ${available}=true
774 [Documentation] Validates the device exists and it has the expected availability in ONOS
David Bainbridgef81cd642019-11-20 00:14:47 +0000775 ${rc} ${json} Run And Return Rc And Output curl --fail -sSL ${url}/onos/v1/devices/${dpid}
776 Should Be Equal As Integers 0 ${rc}
777 ${rc} ${value} Run And Return Rc And Output echo '${json}' | jq -r .available
778 Should Be Equal As Integers 0 ${rc}
Matteo Scandolo3218d5b2021-05-26 11:50:10 -0700779 Should Be Equal ${available} ${value}
David Bainbridgef81cd642019-11-20 00:14:47 +0000780
781Remove All Devices From ONOS
782 [Arguments] ${url}
783 [Documentation] Executes the device-remove command on each device in ONOS
TorstenThiemebccd3ae2020-02-20 12:56:44 +0000784 ${rc} ${output} Run And Return Rc And Output
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700785 ... curl --fail -sSL ${url}/onos/v1/devices | jq -r '.devices[].id'
David Bainbridgef81cd642019-11-20 00:14:47 +0000786 Should Be Equal As Integers ${rc} 0
TorstenThiemebccd3ae2020-02-20 12:56:44 +0000787 @{dpids} Split String ${output}
David Bainbridgef81cd642019-11-20 00:14:47 +0000788 ${count}= Get length ${dpids}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700789 FOR ${dpid} IN @{dpids}
790 ${rc}= Run Keyword If '${dpid}' != ''
791 ... Run And Return Rc curl -XDELETE --fail -sSL ${url}/onos/v1/devices/${dpid}
792 Run Keyword If '${dpid}' != ''
793 ... Should Be Equal As Integers ${rc} 0
794 END
Matteo Scandolo142e6272020-04-29 17:36:59 -0700795
TorstenThieme440b7c02020-12-18 15:42:57 +0000796Assert ONU Port Is Disabled
TorstenThieme731a7592021-07-01 14:26:54 +0000797 [Arguments] ${ip} ${port} ${deviceId} ${onu_port}
TorstenThieme440b7c02020-12-18 15:42:57 +0000798 [Documentation] Verifies if the ONU port is disabled in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000799 ${onu_port_disabled}= Execute ONOS CLI Command use single connection ${ip} ${port}
TorstenThieme440b7c02020-12-18 15:42:57 +0000800 ... ports -d ${deviceId} | grep port=${onu_port}
801 Log ${onu_port_disabled}
802 Should Not Be Empty ${onu_port_disabled}
803
Matteo Scandolo7d1a80d2021-04-09 14:30:43 -0700804Assert Olts in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000805 [Arguments] ${ip} ${port} ${count}
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700806 [Documentation] DEPRECATED use Assert Olt in ONOS
807 ... Check that a certain number of olts are known to ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000808 ${olts}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700809 ... volt-olts | wc -l
Matteo Scandolo7d1a80d2021-04-09 14:30:43 -0700810 Log Found ${olts} of ${count} expected Olts
811 Should Be Equal As Integers ${olts} ${count}
812
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700813Assert Olt in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000814 [Arguments] ${ip} ${port} ${deviceId}
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700815 [Documentation] Check that a particular olt is known to ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000816 ${olts}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700817 ... volt-olts | grep ${deviceId} | wc -l
818 Should Be Equal As Integers ${olts} 1 "Device ${deviceId} is not recognized as an OLT"
819
Matteo Scandolo7d1a80d2021-04-09 14:30:43 -0700820Wait for Olts in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000821 [Arguments] ${ip} ${port} ${count} ${max_wait_time}=10m
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700822 [Documentation] DEPRECATED use Wait for Olt in ONOS
823 ... Waits untill a certain number of ports are enabled in ONOS for a particular deviceId
Matteo Scandolo7d1a80d2021-04-09 14:30:43 -0700824 Wait Until Keyword Succeeds ${max_wait_time} 5s Assert Olts in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000825 ... ${ip} ${port} ${count}
Matteo Scandolo7d1a80d2021-04-09 14:30:43 -0700826
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700827Wait for Olt in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000828 [Arguments] ${ip} ${port} ${deviceId} ${max_wait_time}=10m
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700829 [Documentation] Waits until a particular deviceId is recognized by ONOS as an OLT
830 Wait Until Keyword Succeeds ${max_wait_time} 5s Assert Olt in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000831 ... ${ip} ${port} ${deviceId}
Matteo Scandolo520f77e2021-06-01 16:14:47 -0700832
Matteo Scandolo142e6272020-04-29 17:36:59 -0700833Assert Ports in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000834 [Arguments] ${ip} ${port} ${count} ${deviceId} ${filter}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700835 [Documentation] Check that a certain number of ports are enabled in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000836 ${ports}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo50be75c2020-11-12 11:14:12 -0800837 ... ports -e ${deviceId} | grep ${filter} | wc -l
838 Log Found ${ports} of ${count} expected ports on device ${deviceId}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700839 Should Be Equal As Integers ${ports} ${count}
840
841Wait for Ports in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000842 [Arguments] ${ip} ${port} ${count} ${deviceId} ${filter} ${max_wait_time}=10m
Matteo Scandolo50be75c2020-11-12 11:14:12 -0800843 [Documentation] Waits untill a certain number of ports are enabled in ONOS for a particular deviceId
TorstenThiemed4f48962020-12-08 12:17:19 +0000844 Wait Until Keyword Succeeds ${max_wait_time} 5s Assert Ports in ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000845 ... ${ip} ${port} ${count} ${deviceId} ${filter}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700846
847Wait for AAA Authentication
TorstenThieme731a7592021-07-01 14:26:54 +0000848 [Arguments] ${ip} ${port} ${count} ${deviceId} ${max_wait_time}=10m
Matteo Scandolo142e6272020-04-29 17:36:59 -0700849 [Documentation] Waits untill a certain number of subscribers are authenticated in ONOS
TorstenThiemed4f48962020-12-08 12:17:19 +0000850 Wait Until Keyword Succeeds ${max_wait_time} 5s Assert Number of AAA-Users
TorstenThieme731a7592021-07-01 14:26:54 +0000851 ... ${ip} ${port} ${count} ${deviceId}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700852
853Wait for DHCP Ack
TorstenThieme731a7592021-07-01 14:26:54 +0000854 [Arguments] ${ip} ${port} ${count} ${workflow} ${deviceId} ${max_wait_time}=10m
Matteo Scandolo142e6272020-04-29 17:36:59 -0700855 [Documentation] Waits untill a certain number of subscribers have received a DHCP_ACK
TorstenThiemed4f48962020-12-08 12:17:19 +0000856 Wait Until Keyword Succeeds ${max_wait_time} 5s Validate DHCP Allocations
TorstenThieme731a7592021-07-01 14:26:54 +0000857 ... ${ip} ${port} ${count} ${workflow} ${deviceId}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700858
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700859Provision subscriber REST
860 [Documentation] Uses the rest APIs to provision a subscriber
TorstenThieme731a7592021-07-01 14:26:54 +0000861 [Arguments] ${of_id} ${onu_port}
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700862 ${resp}= Post Request ONOS
863 ... /onos/olt/oltapp/${of_id}/${onu_port}
864 Should Be Equal As Strings ${resp.status_code} 200
865
Hardik Windlassea4caf72021-07-30 07:22:12 +0000866Count Enabled UNI Ports
867 [Documentation] Count all the UNI Ports on a Device
868 [Arguments] ${ip} ${port} ${of_id}
869 ${count}= Execute ONOS CLI Command use single connection ${ip} ${port}
870 ... ports -e ${of_id} | grep -v SWITCH | grep -v nni | wc -l
871 Log ${count}
872 [Return] ${count}
873
Matteo Scandolo142e6272020-04-29 17:36:59 -0700874List Enabled UNI Ports
875 [Documentation] List all the UNI Ports, the only way we have is to filter out the one called NNI
876 ... Creates a list of dictionaries
TorstenThieme731a7592021-07-01 14:26:54 +0000877 [Arguments] ${ip} ${port} ${of_id}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700878 [Return] [{'port': '16', 'of_id': 'of:00000a0a0a0a0a00'}, {'port': '32', 'of_id': 'of:00000a0a0a0a0a00'}]
879 ${result}= Create List
TorstenThieme731a7592021-07-01 14:26:54 +0000880 ${out}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700881 ... ports -e ${of_id} | grep -v SWITCH | grep -v nni
TorstenThiemebccd3ae2020-02-20 12:56:44 +0000882 @{unis}= Split To Lines ${out}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700883 FOR ${uni} IN @{unis}
TorstenThiemebccd3ae2020-02-20 12:56:44 +0000884 ${matches} = Get Regexp Matches ${uni} .*port=([0-9]+),.* 1
Matteo Scandolo142e6272020-04-29 17:36:59 -0700885 &{portDict} Create Dictionary of_id=${of_id} port=${matches[0]}
886 Append To List ${result} ${portDict}
887 END
888 Log ${result}
889 Return From Keyword ${result}
890
891Provision all subscribers on device
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700892 [Documentation] Provisions a subscriber in ONOS for all the enabled UNI ports on a particular device
TorstenThieme731a7592021-07-01 14:26:54 +0000893 [Arguments] ${ip} ${port} ${onos_ip} ${onos_rest_port} ${of_id}
894 ${unis}= List Enabled UNI Ports ${ip} ${port} ${of_id}
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700895 ${onos_auth}= Create List karaf karaf
896 Create Session ONOS http://${onos_ip}:${onos_rest_port} auth=${onos_auth}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700897 FOR ${uni} IN @{unis}
TorstenThieme731a7592021-07-01 14:26:54 +0000898 Provision Subscriber REST ${uni['of_id']} ${uni['port']}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700899 END
900
901List OLTs
Matteo Scandolo50be75c2020-11-12 11:14:12 -0800902 # NOTE this method is not currently used but it can come useful in the future
903 [Documentation] Returns a list of all OLTs known to ONOS
TorstenThieme731a7592021-07-01 14:26:54 +0000904 [Arguments] ${ip} ${port}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700905 [Return] ['of:00000a0a0a0a0a00', 'of:00000a0a0a0a0a01']
906 ${result}= Create List
TorstenThieme731a7592021-07-01 14:26:54 +0000907 ${out}= Execute ONOS CLI Command use single connection ${ip} ${port}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700908 ... volt-olts
TorstenThiemebccd3ae2020-02-20 12:56:44 +0000909 @{olts}= Split To Lines ${out}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700910 FOR ${olt} IN @{olts}
911 Log ${olt}
TorstenThiemebccd3ae2020-02-20 12:56:44 +0000912 ${matches} = Get Regexp Matches ${olt} ^OLT (.+)$ 1
Matteo Scandolo142e6272020-04-29 17:36:59 -0700913 # there may be some logs mixed with the output so only append if we have a match
914 ${matches_length}= Get Length ${matches}
915 Run Keyword If ${matches_length}==1
916 ... Append To List ${result} ${matches[0]}
917 END
918 Return From Keyword ${result}
919
Matteo Scandolo75911092021-11-16 17:05:36 -0800920Count flows
921 [Documentation] Count flows in a particular ${state} in ONOS
TorstenThiemef7cd2be2021-12-06 14:30:11 +0000922 ... Optionally for a certain onu-port.
923 [Arguments] ${ip} ${port} ${deviceId} ${state} ${onu_port}=${EMPTY}
924 ${cmd}= Catenate SEPARATOR= flows -s ${state} ${deviceId} | grep -v deviceId
925 ${cmd}= Run Keyword If "${onu_port}"!="${EMPTY}" Catenate SEPARATOR= ${cmd} | grep ${onu_port}
926 ... ELSE Set Variable ${cmd}
927 ${cmd}= Catenate SEPARATOR= ${cmd} | wc -l
928 ${flows}= Execute ONOS CLI Command use single connection ${ip} ${port} ${cmd}
929 [return] ${flows}
930
931Validate number of flows
932 [Documentation] Validates number of flows in a particular ${state} in ONOS
933 ... Optionally for a certain onu-port.
934 [Arguments] ${ip} ${port} ${targetFlows} ${deviceId} ${state} ${onu_port}=${EMPTY}
935 ${flows}= Count flows ${ip} ${port} ${deviceId} ${state} ${onu_port}
Matteo Scandolo75911092021-11-16 17:05:36 -0800936 Log Found ${state} ${flows} of ${targetFlows} expected flows on device ${deviceId}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700937 Should Be Equal As Integers ${targetFlows} ${flows}
938
939Wait for all flows to in ADDED state
940 [Documentation] Waits until the flows have been provisioned
TorstenThieme731a7592021-07-01 14:26:54 +0000941 [Arguments] ${ip} ${port} ${deviceId} ${workflow} ${uni_count} ${olt_count}
TorstenThiemeb198c482020-12-14 19:45:23 +0000942 ... ${provisioned} ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700943 ${targetFlows}= Calculate flows by workflow ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200944 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
TorstenThiemef7cd2be2021-12-06 14:30:11 +0000945 Wait Until Keyword Succeeds 10m 5s Validate number of flows
Matteo Scandolo75911092021-11-16 17:05:36 -0800946 ... ${ip} ${port} ${targetFlows} ${deviceId} added
947
948Wait for all flows to be removed
949 [Documentation] Wait for all flows to be removed from a particular device
950 [Arguments] ${ip} ${port} ${deviceId}
TorstenThiemef7cd2be2021-12-06 14:30:11 +0000951 Wait Until Keyword Succeeds 10m 5s Validate number of flows
Matteo Scandolo75911092021-11-16 17:05:36 -0800952 ... ${ip} ${port} 0 ${deviceId} any
953
TorstenThieme700ccbf2022-02-11 10:24:05 +0000954Check All Flows Removed
955 [Documentation] Checks all flows removed per OLT
956 FOR ${I} IN RANGE 0 ${num_olts}
957 ${olt_serial_number}= Set Variable ${list_olts}[${I}][sn]
958 ${onu_port_list}= Get ONU Ports per OLT ${olt_serial_number}
959 ${of_id}= Wait Until Keyword Succeeds ${timeout} 15s Validate OLT Device in ONOS ${olt_serial_number}
960 Check All Flows Removed per OLT ${of_id} ${onu_port_list}
961 END
962
963Check All Flows Removed per OLT
964 [Documentation] Checks all flows removed per OLT, in case of flow remove, not after delete device!
965 ... Attention: For ATT there must be the eapol flow still available!
966 [Arguments] ${of_id} ${onu_port_list}
967 ${expected_flows_onu}= Set Variable If "${workflow}"=="ATT" 1 0
968 FOR ${onu_port} IN @{onu_port_list}
969 Wait Until Keyword Succeeds ${timeout} 2s Validate number of flows ${ONOS_SSH_IP} ${ONOS_SSH_PORT}
970 ... ${expected_flows_onu} ${of_id} any ${onu_port}
971 END
972
973Get ONU Ports per OLT
974 [Documentation] Collects all ONU ports per OLT
975 [Arguments] ${olt}
976 ${onu_port_list} Create List
977 FOR ${I} IN RANGE 0 ${num_all_onus}
978 ${src}= Set Variable ${hosts.src[${I}]}
979 Continue For Loop If "${olt}"!="${src['olt']}"
980 ${of_id}= Wait Until Keyword Succeeds ${timeout} 15s Validate OLT Device in ONOS ${src['olt']}
981 ${onu_port}= Wait Until Keyword Succeeds ${timeout} 2s Get ONU Port in ONOS ${src['onu']}
982 ... ${of_id} ${src['uni_id']}
983 ${port_id}= Get Index From List ${onu_port_list} ${onu_port}
984 Continue For Loop If -1 != ${port_id}
985 Append To List ${onu_port_list} ${onu_port}
986 END
987 [return] ${onu_port_list}
Gayathri.Selvan92d16862020-03-19 14:47:58 +0000988
Girish Gowdrad769b412021-05-16 11:09:46 -0700989Get Limiting Bandwidth Details
Gayathri.Selvan92d16862020-03-19 14:47:58 +0000990 [Arguments] ${bandwidth_profile_name}
991 [Documentation] Collects the bandwidth profile details for the given bandwidth profile and
992 ... returns the limiting bandwidth
Girish Gowdracb8482a2021-05-27 09:06:13 -0700993 ${cir} ${cbs} ${eir} ${ebs} ${air}= Get Bandwidth Profile Details Rest
994 ... ${bandwidth_profile_name}
Girish Gowdrad769b412021-05-16 11:09:46 -0700995 ${limiting_BW}= Evaluate ${eir}+${cir}+${air}
Gayathri.Selvan92d16862020-03-19 14:47:58 +0000996 [Return] ${limiting_BW}
Hardik Windlasse8b99222021-01-25 10:03:14 +0000997
Emrehan UZUNd6f85892021-07-01 13:54:26 +0000998Get Limiting Bandwidth Details for Fixed and Committed
999 [Arguments] ${bandwidth_profile_name}
1000 [Documentation] Collects the bandwidth profile details for the given bandwidth profile and
1001 ... returns the limiting bandwidth for fixed and committed
1002 ${cir} ${cbs} ${eir} ${ebs} ${air}= Get Bandwidth Profile Details Rest
1003 ... ${bandwidth_profile_name}
1004 ${limiting_BW}= Evaluate ${cir}+${air}
1005 [Return] ${limiting_BW}
1006
Hardik Windlasse8b99222021-01-25 10:03:14 +00001007Validate Deleted Device Cleanup In ONOS
1008 [Arguments] ${ip} ${port} ${olt_serial_number}
1009 [Documentation] The keyword verifies that ports, flows, meters, subscribers, dhcp are all cleared in ONOS
1010 # Fetch OF Id for OLT
1011 ${olt_of_id}= Wait Until Keyword Succeeds ${timeout} 5s Validate OLT Device in ONOS ${olt_serial_number}
Hardik Windlasse8b99222021-01-25 10:03:14 +00001012 # Verify Ports are Removed
Matteo Scandolo45645bd2021-11-02 10:09:07 -07001013 ${ports}= Execute ONOS CLI Command use single connection ${ip} ${port}
1014 ... ports ${olt_of_id} | grep -v ${olt_of_id}
1015 ${port_count}= Get Line Count ${ports}
1016 Should Be Equal As Integers ${port_count} 0 Ports have not been removed from ONOS after cleanup
Hardik Windlasse8b99222021-01-25 10:03:14 +00001017 # Verify Subscribers are Removed
Matteo Scandolo45645bd2021-11-02 10:09:07 -07001018 ${sub}= Execute ONOS CLI Command use single connection ${ip} ${port}
1019 ... volt-programmed-subscribers | grep ${olt_of_id}
1020 ${sub_count}= Get Line Count ${sub}
1021 Should Be Equal As Integers ${sub_count} 0 Subscribers have not been removed from ONOS after cleanup
Hardik Windlasse8b99222021-01-25 10:03:14 +00001022 # Verify Flows are Removed
Matteo Scandolo45645bd2021-11-02 10:09:07 -07001023 ${flow}= Execute ONOS CLI Command use single connection ${ip} ${port}
1024 ... flows -s -f ${olt_of_id} | grep -v deviceId
1025 ${flow_count}= Get Line Count ${flow}
1026 Should Be Equal As Integers ${flow_count} 0 Flows have not been removed from ONOS after cleanup
Hardik Windlasse8b99222021-01-25 10:03:14 +00001027 # Verify Meters are Removed
Matteo Scandolo45645bd2021-11-02 10:09:07 -07001028 ${meter}= Execute ONOS CLI Command use single connection ${ip} ${port}
1029 ... meters ${olt_of_id}
1030 ${meter_count}= Get Line Count ${meter}
1031 Should Be Equal As Integers ${meter_count} 0 Meters have not been removed from ONOS after cleanup
Hardik Windlasse8b99222021-01-25 10:03:14 +00001032 # Verify AAA-Users are Removed
Matteo Scandolo45645bd2021-11-02 10:09:07 -07001033 ${aaa}= Execute ONOS CLI Command use single connection ${ip} ${port}
1034 ... aaa-users ${olt_of_id}
1035 ${aaa_count}= Get Line Count ${aaa}
1036 Should Be Equal As Integers ${aaa_count} 0 AAA Users have not been removed from ONOS after cleanup
Hardik Windlasse8b99222021-01-25 10:03:14 +00001037 # Verify Dhcp-Allocations are Removed
Matteo Scandolo45645bd2021-11-02 10:09:07 -07001038 ${dhcp}= Execute ONOS CLI Command use single connection ${ip} ${port}
1039 ... dhcpl2relay-allocations ${olt_of_id}
1040 ${dhcp_count}= Get Line Count ${dhcp}
1041 Should Be Equal As Integers ${dhcp_count} 0 DHCP Allocations have not been removed from ONOS after cleanup
Hardik Windlassdd1a9a12021-02-23 15:34:50 +00001042
1043Delete ONOS App
1044 [Arguments] ${url} ${app_name}
1045 [Documentation] This keyword deactivates and uninstalls the given ONOS App
1046 ${rc}= Run And Return Rc curl --fail -sSL -X DELETE ${url}/onos/v1/applications/${app_name}
Matteo Scandolo2769d2b2021-04-14 10:29:24 -07001047 Should Be Equal As Integers ${rc} 0 Can't delete ${app_name} from ONOS
Hardik Windlassdd1a9a12021-02-23 15:34:50 +00001048
1049Verify ONOS App Active
1050 [Arguments] ${url} ${app_name} ${app_version}=${EMPTY}
1051 [Documentation] This keyword verifies that the given ONOS App status is Active
1052 ${rc} ${output} Run And Return Rc And Output
1053 ... curl --fail -sSL ${url}/onos/v1/applications/${app_name} | jq -r .state
1054 Should Be Equal As Integers ${rc} 0
1055 Should Be Equal '${output}' 'ACTIVE'
1056 ${rc1} ${output1} Run And Return Rc And Output
1057 ... curl --fail -sSL ${url}/onos/v1/applications/${app_name} | jq -r .version
1058 Run Keyword If '${app_version}'!='${EMPTY}'
1059 ... Run Keywords
Matteo Scandolo2769d2b2021-04-14 10:29:24 -07001060 ... Should Be Equal As Integers ${rc1} 0 Can't read app ${app_name} status from ONOS
Hardik Windlassdd1a9a12021-02-23 15:34:50 +00001061 ... AND Should Be Equal '${output1}' '${app_version}'
1062
1063Install And Activate ONOS App
1064 [Arguments] ${url} ${app_oar_file}
1065 [Documentation] This keyword installs and activates the given ONOS App
1066 ${cmd}= Catenate SEPARATOR=
1067 ... curl --fail -sSL -H Content-Type:application/octet-stream -
1068 ... X POST ${url}/onos/v1/applications?activate=true --data-binary \@${app_oar_file}
1069 ${rc} ${output} Run And Return Rc And Output ${cmd}
Matteo Scandolo2769d2b2021-04-14 10:29:24 -07001070 Should Be Equal As Integers ${rc} 0 Can't load onos app ${app_oar_file} to ONOS"
Hardik Windlassdd1a9a12021-02-23 15:34:50 +00001071 Log ${output}
Hardik Windlassdc2610f2021-03-09 07:33:51 +00001072
1073Get ONOS App Details
1074 [Arguments] ${url} ${app_name}
1075 [Documentation] Retrieves ONOS App Details
1076 ${rc} ${output} Run And Return Rc And Output
1077 ... curl --fail -sSL ${url}/onos/v1/applications/${app_name}
Matteo Scandolo2769d2b2021-04-14 10:29:24 -07001078 Should Be Equal As Integers ${rc} 0 Can't read app ${app_name} details from ONOS
Hardik Windlassdc2610f2021-03-09 07:33:51 +00001079 [Return] ${output}
Hardik Windlass88075f92022-01-25 12:19:45 +00001080
1081Verify UniTag Subscriber
1082 [Documentation] Verifies the unitag subscriber is provisioned/un-provisioned
1083 [Arguments] ${ip} ${port} ${dev_id} ${onu_port} ${stag} ${ctag} ${tpid} ${sub_added}=True
1084 ${cmd}= Catenate SEPARATOR=
1085 ... volt-programmed-subscribers ${dev_id} ${onu_port} | grep "ponCTag=${ctag}, ponSTag=${stag}" | grep technologyProfileId
1086 ... =${tpid} --color=none
1087 ${subscriber}= Execute ONOS CLI Command use single connection ${ip} ${port} ${cmd}
1088 Log ${subscriber}
1089 ${sub_count}= Get Line Count ${subscriber}
1090 Run Keyword If ${sub_added}
1091 ... Should Be Equal As Integers ${sub_count} 1 UniTag Subscriber Not Added
1092 ... ELSE
1093 ... Should Be Equal As Integers ${sub_count} 0 UniTag Subscriber Not Removed