blob: 4df47bf0f65adf7b6dc0b87fef7a75a74fb871d8 [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# voltctl 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 Scandolo142e6272020-04-29 17:36:59 -070025Resource ./utils.robot
Matteo Scandoloeb26a842020-05-08 10:06:24 -070026Resource ./flows.robot
Kailash6f5acb62019-08-28 14:38:45 -070027
28*** Keywords ***
Gilles Depatieb5682f82019-10-31 10:39:45 -040029Test Empty Device List
Zack Williamsa8fe75a2020-01-10 14:25:27 -070030 [Documentation] Verify that there are no devices in the system
Matteo Scandolo5899be12020-11-11 15:38:07 -080031 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -040032 Should Be Equal As Integers ${rc} 0
33 ${jsondata}= To Json ${output}
34 Log ${jsondata}
35 ${length}= Get Length ${jsondata}
David Bainbridgef81cd642019-11-20 00:14:47 +000036 Should Be Equal As Integers ${length} 0
Gilles Depatieb5682f82019-10-31 10:39:45 -040037
Kailash6f5acb62019-08-28 14:38:45 -070038Create Device
Matteo Scandolo142e6272020-04-29 17:36:59 -070039 [Arguments] ${ip} ${port} ${type}=openolt
You Wang2b550642019-10-07 14:39:48 -070040 [Documentation] Creates a device in VOLTHA
Kailash6f5acb62019-08-28 14:38:45 -070041 #create/preprovision device
Gilles Depatie675a2062019-10-22 12:44:42 -040042 ${rc} ${device_id}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080043 ... voltctl -c ${VOLTCTL_CONFIG} device create -t ${type} -H ${ip}:${port}
44 Log ${device_id}
Kailash6f5acb62019-08-28 14:38:45 -070045 Should Be Equal As Integers ${rc} 0
46 [Return] ${device_id}
47
48Enable Device
49 [Arguments] ${device_id}
Zack Williamsec53a1b2019-09-16 15:50:52 -070050 [Documentation] Enables a device in VOLTHA
Zack Williamsa8fe75a2020-01-10 14:25:27 -070051 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080052 ... voltctl -c ${VOLTCTL_CONFIG} device enable ${device_id}
Kailash6f5acb62019-08-28 14:38:45 -070053 Should Be Equal As Integers ${rc} 0
54
Suchitra Vemuri6db89412019-11-14 14:52:54 -080055Disable Device
56 [Arguments] ${device_id}
Hardik Windlassaaea3402020-03-10 19:45:45 +053057 [Documentation] Disables a device in VOLTHA
Zack Williamsa8fe75a2020-01-10 14:25:27 -070058 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080059 ... voltctl -c ${VOLTCTL_CONFIG} device disable ${device_id}
Suchitra Vemuri6db89412019-11-14 14:52:54 -080060 Should Be Equal As Integers ${rc} 0
61
Hardik Windlassaaea3402020-03-10 19:45:45 +053062Delete Device
63 [Arguments] ${device_id}
64 [Documentation] Deletes a device in VOLTHA
65 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080066 ... voltctl -c ${VOLTCTL_CONFIG} device delete ${device_id}
Hardik Windlassaaea3402020-03-10 19:45:45 +053067 Should Be Equal As Integers ${rc} 0
68
Hemadf003682020-04-28 21:22:22 +053069Reboot Device
70 [Arguments] ${device_id}
71 [Documentation] Reboot the OLT using voltctl command
72 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080073 ... voltctl -c ${VOLTCTL_CONFIG} device reboot ${device_id}
Hemadf003682020-04-28 21:22:22 +053074 Should Be Equal As Integers ${rc} 0
75
David Bainbridgef81cd642019-11-20 00:14:47 +000076Disable Devices In Voltha
77 [Documentation] Disables all the known devices in voltha
78 [Arguments] ${filter}
79 ${arg}= Set Variable ${EMPTY}
80 ${arg}= Run Keyword If len('${filter}'.strip()) != 0 Set Variable --filter ${filter}
Zack Williamsa8fe75a2020-01-10 14:25:27 -070081 ${rc} ${devices}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080082 ... voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB ${arg} --orderby Root -q | xargs echo -n
David Bainbridgef81cd642019-11-20 00:14:47 +000083 Should Be Equal As Integers ${rc} 0
Zack Williamsa8fe75a2020-01-10 14:25:27 -070084 ${rc} ${output}= Run Keyword If len('${devices}') != 0 Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080085 ... voltctl -c ${VOLTCTL_CONFIG} device disable ${devices}
David Bainbridgef81cd642019-11-20 00:14:47 +000086 Run Keyword If len('${devices}') != 0 Should Be Equal As Integers ${rc} 0
87
88Test Devices Disabled In Voltha
89 [Documentation] Tests to verify that all devices in VOLTHA are disabled
90 [Arguments] ${filter}
Zack Williamsa8fe75a2020-01-10 14:25:27 -070091 ${rc} ${count}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -080092 ... voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB --filter '${filter},AdminState!=DISABLED' -q | wc -l
David Bainbridgef81cd642019-11-20 00:14:47 +000093 Should Be Equal As Integers ${rc} 0
94 Should Be Equal As Integers ${count} 0
95
96Delete Devices In Voltha
97 [Documentation] Disables all the known devices in voltha
98 [Arguments] ${filter}
99 ${arg}= Set Variable ${EMPTY}
100 ${arg}= Run Keyword If len('${filter}'.strip()) != 0 Set Variable --filter ${filter}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700101 ${rc} ${devices}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800102 ... voltctl -c ${VOLTCTL_CONFIG} device list ${arg} -m 8MB --orderby Root -q | xargs echo -n
David Bainbridgef81cd642019-11-20 00:14:47 +0000103 Should Be Equal As Integers ${rc} 0
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700104 ${rc} ${output}= Run Keyword If len('${devices}') != 0 Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800105 ... voltctl -c ${VOLTCTL_CONFIG} device delete ${devices}
David Bainbridgef81cd642019-11-20 00:14:47 +0000106 Run Keyword If len('${devices}') != 0 Should Be Equal As Integers ${rc} 0
107
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700108Get Device Flows from Voltha
109 [Arguments] ${device_id}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700110 [Documentation] Gets device flows from VOLTHA
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700111 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800112 ... voltctl -c ${VOLTCTL_CONFIG} device flows ${device_id} -m 8MB
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700113 Should Be Equal As Integers ${rc} 0
114 [Return] ${output}
115
116Get Logical Device Output from Voltha
117 [Arguments] ${device_id}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700118 [Documentation] Gets logicaldevice flows and ports from VOLTHA
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700119 ${rc1} ${flows}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800120 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice flows ${device_id}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700121 ${rc2} ${ports}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800122 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice port list ${device_id}
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700123 Log ${flows}
124 Log ${ports}
125 Should Be Equal As Integers ${rc1} 0
126 Should Be Equal As Integers ${rc2} 0
127
128Get Device Output from Voltha
129 [Arguments] ${device_id}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700130 [Documentation] Gets device flows and ports from VOLTHA
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700131 ${rc1} ${flows}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800132 ... voltctl -c ${VOLTCTL_CONFIG} device flows ${device_id} -m 8MB
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700133 ${rc2} ${ports}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800134 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${device_id} -m 8MB
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700135 Log ${flows}
136 Log ${ports}
137 Should Be Equal As Integers ${rc1} 0
138 Should Be Equal As Integers ${rc2} 0
139
Suchitra Vemuri1a970a62019-11-26 12:52:16 -0800140Get Device List from Voltha
141 [Documentation] Gets Device List Output from Voltha
Matteo Scandolo5899be12020-11-11 15:38:07 -0800142 ${rc1} ${devices}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB
Suchitra Vemuri1a970a62019-11-26 12:52:16 -0800143 Log ${devices}
144 Should Be Equal As Integers ${rc1} 0
145
Matteo Scandolo616daab2020-05-13 11:49:24 -0700146Get Device List from Voltha by type
147 [Documentation] Gets Device List Output from Voltha applying filtering by device type
148 [Arguments] ${type}
149 ${rc1} ${devices}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800150 ... voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB -f Type=${type} -o json
Matteo Scandolo616daab2020-05-13 11:49:24 -0700151 Log ${devices}
152 Should Be Equal As Integers ${rc1} 0
153 Return From Keyword ${devices}
154
Matteo Scandolo142e6272020-04-29 17:36:59 -0700155Get Logical Device List from Voltha
156 [Documentation] Gets Logical Device List Output from Voltha (in json format)
Andrea Campanella80655eb2020-07-10 15:49:22 +0200157 ${rc1} ${devices}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800158 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice list -m 8MB -o json
Matteo Scandolo142e6272020-04-29 17:36:59 -0700159 Log ${devices}
160 Should Be Equal As Integers ${rc1} 0
161 Return From Keyword ${devices}
162
Kailash6f5acb62019-08-28 14:38:45 -0700163Validate Device
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700164 [Documentation]
ubuntu6b6e7d42020-03-02 12:35:42 -0800165 ... Parses the output of "voltctl device list" and inspects a device ${id}, specified as either
166 ... the serial number or device ID. Arguments are matched for device states of: "admin_state",
167 ... "oper_status", and "connect_status"
168 [Arguments] ${admin_state} ${oper_status} ${connect_status}
169 ... ${id}=${EMPTY} ${onu_reason}=${EMPTY} ${onu}=False
Matteo Scandolo5899be12020-11-11 15:38:07 -0800170 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400171 Should Be Equal As Integers ${rc} 0
Kailash6f5acb62019-08-28 14:38:45 -0700172 ${jsondata}= To Json ${output}
Kailash6f5acb62019-08-28 14:38:45 -0700173 ${length}= Get Length ${jsondata}
ubuntu6b6e7d42020-03-02 12:35:42 -0800174 ${matched}= Set Variable False
Zack Williamsec53a1b2019-09-16 15:50:52 -0700175 FOR ${INDEX} IN RANGE 0 ${length}
176 ${value}= Get From List ${jsondata} ${INDEX}
Scott Baker780b65f2020-05-22 14:03:15 -0700177 ${jsonCamelCaseFieldnames}= Run Keyword And Return Status
178 ... Dictionary Should Contain Key ${value} adminState
179 ${astate}= Run Keyword If ${jsonCamelCaseFieldNames}
180 ... Get From Dictionary ${value} adminState
181 ... ELSE
182 ... Get From Dictionary ${value} adminstate
183 ${opstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
184 ... Get From Dictionary ${value} operStatus
185 ... ELSE
186 ... Get From Dictionary ${value} operstatus
187 ${cstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
188 ... Get From Dictionary ${value} connectStatus
189 ... ELSE
190 ... Get From Dictionary ${value} connectstatus
191 ${sn}= Run Keyword If ${jsonCamelCaseFieldNames}
192 ... Get From Dictionary ${value} serialNumber
193 ... ELSE
194 ... Get From Dictionary ${value} serialnumber
Gilles Depatieb5682f82019-10-31 10:39:45 -0400195 ${devId}= Get From Dictionary ${value} id
Zack Williamsec53a1b2019-09-16 15:50:52 -0700196 ${mib_state}= Get From Dictionary ${value} reason
ubuntu6b6e7d42020-03-02 12:35:42 -0800197 ${matched}= Set Variable If '${sn}' == '${id}' or '${devId}' == '${id}' True False
Andy Bavierb63f6d22020-03-12 15:34:37 -0700198 Exit For Loop If ${matched}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700199 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700200 Should Be True ${matched} No match found for ${id} to validate device
Matteo Scandolo5e10b282019-11-25 10:54:32 -0700201 Log ${value}
ubuntu6b6e7d42020-03-02 12:35:42 -0800202 Should Be Equal '${astate}' '${admin_state}' Device ${sn} admin_state != ${admin_state}
Gilles Depatie675a2062019-10-22 12:44:42 -0400203 ... values=False
ubuntu6b6e7d42020-03-02 12:35:42 -0800204 Should Be Equal '${opstatus}' '${oper_status}' Device ${sn} oper_status != ${oper_status}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400205 ... values=False
ubuntu6b6e7d42020-03-02 12:35:42 -0800206 Should Be Equal '${cstatus}' '${connect_status}' Device ${sn} conn_status != ${connect_status}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400207 ... values=False
Matteo Scandolo74bd5c32020-12-08 09:52:19 -0800208 Run Keyword If '${onu}' == 'True' Should Contain '${onu_reason}' '${mib_state}'
ubuntu6b6e7d42020-03-02 12:35:42 -0800209 ... Device ${sn} mib_state incorrect (${mib_state}) values=False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400210
211Validate OLT Device
ubuntu6b6e7d42020-03-02 12:35:42 -0800212 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${id}=${EMPTY}
213 [Documentation] Parses the output of "voltctl device list" and inspects device ${id}, specified
214 ... as either its serial numbner or device ID. Match on OLT Serial number or Device Id and inspect states
215 Validate Device ${admin_state} ${oper_status} ${connect_status} ${id}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400216
Suchitra Vemuria6879aa2020-11-03 11:03:11 -0800217Validate OLT Devices
218 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${ids}=${EMPTY}
219 [Documentation] Parses the output of "voltctl device list" and inspects device ${id}, specified
220 ... as either its serial numbner or device ID. Match on OLT Serial number or Device Id and inspect states
221 FOR ${I} IN RANGE 0 ${olt_count}
222 ${olt_serial_number}= Get From Dictionary ${olt_ids}[${I}] sn
223 ${olt_device_id}= Get OLTDeviceID From OLT List ${olt_serial_number}
224 Validate Device ${admin_state} ${oper_status} ${connect_status} ${olt_device_id}
225 END
226
Gilles Depatieb5682f82019-10-31 10:39:45 -0400227Validate ONU Devices
228 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${List_ONU_Serial}
Andy Bavierf1f26ed2020-03-18 10:59:07 -0700229 ... ${onu_reason}=omci-flows-pushed
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700230 [Documentation] Parses the output of "voltctl device list" and inspects device ${List_ONU_Serial}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400231 ... Iteratively match on each Serial number contained in ${List_ONU_Serial} and inspect
232 ... states including MIB state
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700233 FOR ${serial_number} IN @{List_ONU_Serial}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400234 Validate Device ${admin_state} ${oper_status} ${connect_status} ${serial_number}
Andy Bavierf1f26ed2020-03-18 10:59:07 -0700235 ... onu_reason=${onu_reason} onu=True
Debasish28130d02020-03-16 11:05:26 +0000236 END
237
Gilles Depatieb5682f82019-10-31 10:39:45 -0400238Validate Device Port Types
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700239 [Documentation]
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800240 ... Parses the output of voltctl device port list <device_id> and matches the port types listed
Andy Bavier90eb1a12020-03-26 11:54:35 -0700241 [Arguments] ${device_id} ${pon_type} ${ethernet_type} ${all_active}=True
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700242 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800243 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${device_id} -m 8MB -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400244 Should Be Equal As Integers ${rc} 0
245 ${jsondata}= To Json ${output}
246 Log ${jsondata}
247 ${length}= Get Length ${jsondata}
248 FOR ${INDEX} IN RANGE 0 ${length}
249 ${value}= Get From List ${jsondata} ${INDEX}
Scott Baker780b65f2020-05-22 14:03:15 -0700250 ${jsonCamelCaseFieldnames}= Run Keyword And Return Status
251 ... Dictionary Should Contain Key ${value} adminState
252 ${astate}= Run Keyword If ${jsonCamelCaseFieldNames}
Hardik Windlass2b37e712020-06-12 02:13:17 +0530253 ... Get From Dictionary ${value} adminState
Scott Baker780b65f2020-05-22 14:03:15 -0700254 ... ELSE
Hardik Windlass2b37e712020-06-12 02:13:17 +0530255 ... Get From Dictionary ${value} adminstate
Scott Baker780b65f2020-05-22 14:03:15 -0700256 ${opstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
257 ... Get From Dictionary ${value} operStatus
258 ... ELSE
Hardik Windlass2b37e712020-06-12 02:13:17 +0530259 ... Get From Dictionary ${value} operstatus
Gilles Depatieb5682f82019-10-31 10:39:45 -0400260 ${type}= Get From Dictionary ${value} type
Hemaf64d34c2020-03-25 00:40:17 +0530261 Should Be Equal '${astate}' 'ENABLED' Device ${device_id} port admin_state != ENABLED values=False
Andy Bavier90eb1a12020-03-26 11:54:35 -0700262 Run Keyword If ${all_active} Should Be Equal '${opstatus}' 'ACTIVE'
263 ... Device ${device_id} port oper_status != ACTIVE values=False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400264 Should Be True '${type}' == '${pon_type}' or '${type}' == '${ethernet_type}'
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700265 ... Device ${device_id} port type is neither ${pon_type} or ${ethernet_type}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400266 END
267
268Validate OLT Port Types
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800269 [Documentation] Parses the output of voltctl device port list ${olt_device_id} and matches the port types listed
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700270 [Arguments] ${pon_type} ${ethernet_type}
271 Validate Device Port Types ${olt_device_id} ${pon_type} ${ethernet_type}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400272
273Validate ONU Port Types
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700274 [Arguments] ${List_ONU_Serial} ${pon_type} ${ethernet_type}
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800275 [Documentation] Parses the output of voltctl device port list for each ONU SN listed in ${List_ONU_Serial}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700276 ... and matches the port types listed
Gilles Depatieb5682f82019-10-31 10:39:45 -0400277 FOR ${serial_number} IN @{List_ONU_Serial}
278 ${onu_dev_id}= Get Device ID From SN ${serial_number}
Andy Bavier90eb1a12020-03-26 11:54:35 -0700279 # Only first UNI port is ACTIVE; the rest are in DISCOVERED operstatus
280 Validate Device Port Types ${onu_dev_id} ${pon_type} ${ethernet_type} all_active=False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400281 END
282
283Validate Device Flows
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000284 [Arguments] ${device_id} ${flow_count}=${EMPTY}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400285 [Documentation] Parses the output of voltctl device flows <device_id> and expects flow count > 0
Andrea Campanella80655eb2020-07-10 15:49:22 +0200286 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800287 ... voltctl -c ${VOLTCTL_CONFIG} device flows ${device_id} -m 8MB -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400288 Should Be Equal As Integers ${rc} 0
289 ${jsondata}= To Json ${output}
290 Log ${jsondata}
291 ${length}= Get Length ${jsondata}
292 Log 'Number of flows = ' ${length}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000293 Run Keyword If '${flow_count}' == '${EMPTY}' Should Be True ${length} > 0
Gilles Depatieb5682f82019-10-31 10:39:45 -0400294 ... Number of flows for ${device_id} was 0
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000295 ... ELSE Should Be True ${length} == ${flow_count}
296 ... Number of flows for ${device_id} was not ${flow_count}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400297
298Validate OLT Flows
Suchitra Vemuria6879aa2020-11-03 11:03:11 -0800299 [Arguments] ${flow_count}=${EMPTY} ${olt_device_id}=${EMPTY}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000300 [Documentation] Parses the output of voltctl device flows ${olt_device_id}
301 ... and expects flow count == ${flow_count}
302 Validate Device Flows ${olt_device_id} ${flow_count}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400303
304Validate ONU Flows
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000305 [Arguments] ${List_ONU_Serial} ${flow_count}=${EMPTY}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400306 [Documentation] Parses the output of voltctl device flows for each ONU SN listed in ${List_ONU_Serial}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000307 ... and expects flow count == ${flow_count}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700308 FOR ${serial_number} IN @{List_ONU_Serial}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400309 ${onu_dev_id}= Get Device ID From SN ${serial_number}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000310 Validate Device Flows ${onu_dev_id} ${flow_count}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400311 END
312
TorstenThieme401af432020-06-11 15:53:53 +0000313Validate ONU Devices With Duration
314 [Documentation]
315 ... Parses the output of "voltctl device list" and inspects all devices ${List_ONU_Serial},
316 ... Iteratively match on each Serial number contained in ${List_ONU_Serial} and inspect
317 ... states including MIB state.
318 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${onu_reason}
319 ... ${List_ONU_Serial} ${startTime} ${print2console}=False ${output_file}=${EMPTY}
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000320 ... ${alternate_reason}=${EMPTY}
TorstenThiemef78a9d82021-03-05 13:42:09 +0000321 ${cmd}= Catenate voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB -f Type=brcm_openomci_onu
Matteo Scandolo6f24ea92021-04-29 11:55:50 -0700322 ... --format "{{.SerialNumber}}\t{{.AdminState}}\t{{.OperStatus}}\t{{.ConnectStatus}}\t{{.Reason}}" | grep -v SERIALNUMBER
TorstenThiemef78a9d82021-03-05 13:42:09 +0000323 ${rc} ${output}= Run and Return Rc and Output ${cmd}
TorstenThieme401af432020-06-11 15:53:53 +0000324 Should Be Equal As Integers ${rc} 0
325 ${timeCurrent} = Get Current Date
326 ${timeTotalMs} = Subtract Date From Date ${timeCurrent} ${startTime} result_format=number
TorstenThiemef78a9d82021-03-05 13:42:09 +0000327 @{Results}= Split String ${output} \n
328 FOR ${Line} IN @{Results}
TorstenThieme401af432020-06-11 15:53:53 +0000329 ${matched}= Set Variable False
TorstenThiemef78a9d82021-03-05 13:42:09 +0000330 @{words}= Split String ${Line} \t
331 ${sn}= Set Variable ${words[0]}
332 ${astate}= Set Variable ${words[1]}
333 ${opstatus}= Set Variable ${words[2]}
334 ${cstatus}= Set Variable ${words[3]}
335 ${mib_state}= Set Variable ${words[4]}
TorstenThieme401af432020-06-11 15:53:53 +0000336 ${onu_id}= Get Index From List ${List_ONU_Serial} ${sn}
337 ${matched}= Set Variable If -1 != ${onu_id} True False
338 ${matched}= Set Variable If '${astate}' == '${admin_state}' ${matched} False
339 ${matched}= Set Variable If '${opstatus}' == '${oper_status}' ${matched} False
340 ${matched}= Set Variable If '${cstatus}' == '${connect_status}' ${matched} False
TorstenThiemec3c23232021-01-13 13:06:31 +0000341 ${len}= Get Length ${alternate_reason}
TorstenThieme105c5982021-01-21 09:50:27 +0000342 ${matches}= Run Keyword If ${len} >= 1 Get Match Count ${alternate_reason} ${mib_state}
343 ... ELSE Set Variable 0
TorstenThiemec3c23232021-01-13 13:06:31 +0000344 ${matched}= Set Variable If '${mib_state}' == '${onu_reason}' or ${matches} >= 1
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000345 ... ${matched} False
TorstenThieme401af432020-06-11 15:53:53 +0000346 Run Keyword If ${matched} and ${print2console} Log
347 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec. console=yes
348 Run Keyword If ${matched} and ('${output_file}'!='${EMPTY}') Append To File ${output_file}
349 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec.
350 Run Keyword If ${matched} Remove Values From List ${List_ONU_Serial} ${sn}
351 END
352 Should Be Empty ${List_ONU_Serial} List ${List_ONU_Serial} not empty
353
TorstenThieme9949b172020-06-16 10:00:15 +0000354Validate ONU Devices MIB State With Duration
355 [Documentation]
356 ... Parses the output of "voltctl device list" and inspects all devices ${List_ONU_Serial},
357 ... Iteratively match on each Serial number contained in ${List_ONU_Serial} and inspect MIB state.
358 [Arguments] ${onu_reason}
359 ... ${List_ONU_Serial} ${startTime} ${print2console}=False ${output_file}=${EMPTY}
360 ${type} = Set Variable brcm_openomci_onu
Andrea Campanella80655eb2020-07-10 15:49:22 +0200361 ${voltctl_commad} = Catenate SEPARATOR=
362 ... voltctl device list -m 8MB -f Type=${type} -f Reason=${onu_reason} --format '{{.SerialNumber}}'
363 ${rc} ${output}= Run and Return Rc and Output ${voltctl_commad}
TorstenThieme9949b172020-06-16 10:00:15 +0000364 Should Be Equal As Integers ${rc} 0
365 ${timeCurrent} = Get Current Date
366 ${timeTotalMs} = Subtract Date From Date ${timeCurrent} ${startTime} result_format=number
367 @{outputdata} = Split String ${output}
368 ${outputlength} = Get Length ${outputdata}
369 ${onulength} = Get Length ${List_ONU_Serial}
370 ${Matches} = Run Keyword If ${outputlength}<=${onulength}
371 ... Compare Lists ${outputdata} ${List_ONU_Serial}
372 ... ELSE Compare Lists ${List_ONU_Serial} ${outputdata}
373 ${length} = Get Length ${Matches}
374 FOR ${INDEX} IN RANGE 0 ${length}
375 ${sn}= Get From List ${Matches} ${INDEX}
376 Run Keyword If ${print2console} Log
377 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec. console=yes
378 Run Keyword If ('${output_file}'!='${EMPTY}') Append To File ${output_file}
379 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec.
380 Remove Values From List ${List_ONU_Serial} ${sn}
381 END
382 Should Be Empty ${List_ONU_Serial} List ${List_ONU_Serial} not empty
383
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000384Validate ONU Device By Device Id
385 [Documentation]
386 ... Parses the output of "voltctl device list" filtered by device id and inspects states including reason.
387 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${onu_reason} ${onu_id}
Matteo Scandolo5899be12020-11-11 15:38:07 -0800388 ${cmd} Catenate voltctl -c ${VOLTCTL_CONFIG} device list --filter=Id=${onu_id} -m 8MB -o json
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000389 ${rc} ${output}= Run and Return Rc and Output ${cmd}
390 Should Be Equal As Integers ${rc} 0
391 ${jsondata}= To Json ${output}
392 ${length}= Get Length ${jsondata}
393 Should Be Equal As Integers ${length} 1 No match found for ${onu_id} to validate device
394 ${value}= Get From List ${jsondata} 0
395 Log ${value}
396 ${jsonCamelCaseFieldnames}= Run Keyword And Return Status
397 ... Dictionary Should Contain Key ${value} adminState
398 ${astate}= Run Keyword If ${jsonCamelCaseFieldNames}
399 ... Get From Dictionary ${value} adminState
400 ... ELSE
401 ... Get From Dictionary ${value} adminstate
402 ${opstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
403 ... Get From Dictionary ${value} operStatus
404 ... ELSE
405 ... Get From Dictionary ${value} operstatus
406 ${cstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
407 ... Get From Dictionary ${value} connectStatus
408 ... ELSE
409 ... Get From Dictionary ${value} connectstatus
410 ${sn}= Run Keyword If ${jsonCamelCaseFieldNames}
411 ... Get From Dictionary ${value} serialNumber
412 ... ELSE
413 ... Get From Dictionary ${value} serialnumber
414 ${devId}= Get From Dictionary ${value} id
415 ${mib_state}= Get From Dictionary ${value} reason
416 Should Be Equal '${devId}' '${onu_id}' No match found for ${onu_id} to validate device
417 ... values=False
418 Should Be Equal '${astate}' '${admin_state}' Device ${sn} admin_state != ${admin_state}
419 ... values=False
420 Should Be Equal '${opstatus}' '${oper_status}' Device ${sn} oper_status != ${oper_status}
421 ... values=False
422 Should Be Equal '${cstatus}' '${connect_status}' Device ${sn} conn_status != ${connect_status}
423 ... values=False
424 Should Be Equal '${mib_state}' '${onu_reason}'
425 ... Device ${sn} mib_state incorrect (${mib_state}) values=False
426
427
TorstenThieme9949b172020-06-16 10:00:15 +0000428Compare Lists
429 [Documentation]
430 ... Compares both lists and put all matches in the returned list
431 [Arguments] ${ListIterate} ${ListCompare}
432 @{list} = Create List
433 ${length} = Get Length ${ListIterate}
434 FOR ${INDEX} IN RANGE 0 ${length}
435 ${sn}= Get From List ${ListIterate} ${INDEX}
436 ${onu_id}= Get Index From List ${ListCompare} ${sn}
437 Run Keyword If -1 != ${onu_id} Append To List ${list} ${sn}
438 END
439 [Return] ${list}
440
Gilles Depatieb5682f82019-10-31 10:39:45 -0400441Validate Logical Device
442 [Documentation] Validate Logical Device is listed
Matteo Scandolo5899be12020-11-11 15:38:07 -0800443 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} logicaldevice list -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400444 Should Be Equal As Integers ${rc} 0
445 ${jsondata}= To Json ${output}
446 Log ${jsondata}
447 ${length}= Get Length ${jsondata}
448 FOR ${INDEX} IN RANGE 0 ${length}
449 ${value}= Get From List ${jsondata} ${INDEX}
450 ${devid}= Get From Dictionary ${value} id
Scott Baker2ab2a0c2020-06-05 12:51:47 -0700451 ${rootdev}= Get From Dictionary ${value} rootDeviceId
452 ${desc}= Get From Dictionary ${value} desc
453 ${sn}= Get From Dictionary ${desc} serialNum
Gilles Depatieb5682f82019-10-31 10:39:45 -0400454 Exit For Loop
455 END
456 Should Be Equal '${rootdev}' '${olt_device_id}' Root Device does not match ${olt_device_id} values=False
457 Should Be Equal '${sn}' '${BBSIM_OLT_SN}' Logical Device ${sn} does not match ${BBSIM_OLT_SN}
458 ... values=False
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700459 [Return] ${devid}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400460
461Validate Logical Device Ports
462 [Arguments] ${logical_device_id}
463 [Documentation] Validate Logical Device Ports are listed and are > 0
464 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800465 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice port list ${logical_device_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400466 Should Be Equal As Integers ${rc} 0
467 ${jsondata}= To Json ${output}
468 Log ${jsondata}
469 ${length}= Get Length ${jsondata}
470 Should Be True ${length} > 0 Number of ports for ${logical_device_id} was 0
471
472Validate Logical Device Flows
473 [Arguments] ${logical_device_id}
474 [Documentation] Validate Logical Device Flows are listed and are > 0
475 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800476 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice flows ${logical_device_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400477 Should Be Equal As Integers ${rc} 0
478 ${jsondata}= To Json ${output}
479 Log ${jsondata}
480 ${length}= Get Length ${jsondata}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700481 Should Be True ${length} > 0 Number of flows for ${logical_device_id} was 0
Gilles Depatieb5682f82019-10-31 10:39:45 -0400482
Hardik Windlass16cdf962020-04-29 15:26:50 +0530483Retrieve OLT PON Ports
484 [Arguments] ${olt_device_id}
485 [Documentation] Retrieves the list of PON ports from the OLT device
486 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800487 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Hardik Windlass16cdf962020-04-29 15:26:50 +0530488 Should Be Equal As Integers ${rc} 0
489 ${jsondata}= To Json ${output}
490 Log ${jsondata}
491 ${length}= Get Length ${jsondata}
492 ${olt_pon_list}= Create List
493 FOR ${INDEX} IN RANGE 0 ${length}
494 ${value}= Get From List ${jsondata} ${INDEX}
495 ${type}= Get From Dictionary ${value} type
496 ${portno}= Get From Dictionary ${value} portNo
497 ${peers}= Get From Dictionary ${value} peers
498 ${len_peers}= Get Length ${peers}
499 Run Keyword If '${type}' == 'PON_OLT' and ${len_peers} > 0
500 ... Append To List ${olt_pon_list} ${portno}
501 END
502 [Return] ${olt_pon_list}
503
504Retrieve Peer List From OLT PON Port
505 [Arguments] ${olt_device_id} ${pon_port}
506 [Documentation] Retrieves the list of peer device ids list from the OLT PON port
507 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800508 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Hardik Windlass16cdf962020-04-29 15:26:50 +0530509 Should Be Equal As Integers ${rc} 0
510 ${jsondata}= To Json ${output}
511 Log ${jsondata}
512 ${length}= Get Length ${jsondata}
513 ${matched}= Set Variable False
514 FOR ${INDEX} IN RANGE 0 ${length}
515 ${value}= Get From List ${jsondata} ${INDEX}
516 ${type}= Get From Dictionary ${value} type
517 ${portno}= Get From Dictionary ${value} portNo
518 ${peers}= Get From Dictionary ${value} peers
519 ${matched}= Set Variable If '${type}' == 'PON_OLT' and '${portno}' == '${pon_port}' True False
520 Exit For Loop If ${matched}
521 END
522 Should Be True ${matched} No PON port found for OLT ${olt_device_id}
523 ${length}= Get Length ${peers}
524 ${olt_peer_list}= Create List
525 FOR ${INDEX} IN RANGE 0 ${length}
526 ${value}= Get From List ${peers} ${INDEX}
527 ${peer_id}= Get From Dictionary ${value} deviceId
528 Append To List ${olt_peer_list} ${peer_id}
529 END
530 [Return] ${olt_peer_list}
531
532Validate OLT PON Port Status
533 [Arguments] ${olt_device_id} ${pon_port} ${admin_state} ${oper_status}
534 [Documentation] Verifies the state of the PON port of the OLT
535 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800536 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Hardik Windlass16cdf962020-04-29 15:26:50 +0530537 Should Be Equal As Integers ${rc} 0
538 ${jsondata}= To Json ${output}
539 Log ${jsondata}
540 ${length}= Get Length ${jsondata}
541 ${matched}= Set Variable False
542 FOR ${INDEX} IN RANGE 0 ${length}
543 ${value}= Get From List ${jsondata} ${INDEX}
544 ${type}= Get From Dictionary ${value} type
545 ${portno}= Get From Dictionary ${value} portNo
546 ${astate}= Get From Dictionary ${value} adminState
547 ${opstatus}= Get From Dictionary ${value} operStatus
548 ${matched}= Set Variable If '${type}' == 'PON_OLT' and '${portno}' == '${pon_port}' True False
549 Exit For Loop If ${matched}
550 END
551 Should Be True ${matched} No PON port found for OLT ${olt_device_id} ${pon_port}
552 Log ${value}
553 Should Be Equal '${astate}' '${admin_state}' OLT PON Port admin_state != ${admin_state}
554 ... values=False
555 Should Be Equal '${opstatus}' '${oper_status}' OLT PON Port oper_status != ${oper_status}
556 ... values=False
557
558DisableOrEnable OLT PON Port
559 [Arguments] ${operation} ${olt_device_id} ${portno}
560 [Documentation] Disables or Enables the PON port of the OLT
561 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800562 ... voltctl -c ${VOLTCTL_CONFIG} device port ${operation} ${olt_device_id} ${portno}
Hardik Windlass16cdf962020-04-29 15:26:50 +0530563 Should Be Equal As Integers ${rc} 0
564
Gilles Depatieb5682f82019-10-31 10:39:45 -0400565Retrieve Peer List From OLT
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700566 [Arguments] ${olt_peer_list}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400567 [Documentation] Retrieve the list of peer device id list from port list
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700568 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800569 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400570 Should Be Equal As Integers ${rc} 0
571 ${jsondata}= To Json ${output}
572 Log ${jsondata}
573 ${length}= Get Length ${jsondata}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700574 ${matched}= Set Variable False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400575 FOR ${INDEX} IN RANGE 0 ${length}
576 ${value}= Get From List ${jsondata} ${INDEX}
577 ${type}= Get From Dictionary ${value} type
578 ${peers}= Get From Dictionary ${value} peers
Andy Bavierb63f6d22020-03-12 15:34:37 -0700579 ${matched}= Set Variable If '${type}' == 'PON_OLT' True False
580 Exit For Loop If ${matched}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400581 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700582 Should Be True ${matched} No PON port found for OLT ${olt_device_id}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400583 ${length}= Get Length ${peers}
584 FOR ${INDEX} IN RANGE 0 ${length}
585 ${value}= Get From List ${peers} ${INDEX}
Hardik Windlass16cdf962020-04-29 15:26:50 +0530586 ${peer_id}= Get From Dictionary ${value} deviceId
Gilles Depatieb5682f82019-10-31 10:39:45 -0400587 Append To List ${olt_peer_list} ${peer_id}
588 END
589
590Validate OLT Peer Id List
591 [Arguments] ${olt_peer_id_list}
592 [Documentation] Match each entry in the ${olt_peer_id_list} against ONU device ids.
593 FOR ${peer_id} IN @{olt_peer_id_list}
594 Match OLT Peer Id ${peer_id}
595 END
596
597Match OLT Peer Id
598 [Arguments] ${olt_peer_id}
599 [Documentation] Lookup the OLT Peer Id in against the list of ONU device Ids
Matteo Scandolo5899be12020-11-11 15:38:07 -0800600 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400601 Should Be Equal As Integers ${rc} 0
602 ${jsondata}= To Json ${output}
603 Log ${jsondata}
604 ${length}= Get Length ${jsondata}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700605 ${matched}= Set Variable False
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700606 FOR ${INDEX} IN RANGE 0 ${length}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400607 ${value}= Get From List ${jsondata} ${INDEX}
608 ${devid}= Get From Dictionary ${value} id
Andy Bavierb63f6d22020-03-12 15:34:37 -0700609 ${matched}= Set Variable If '${devid}' == '${olt_peer_id}' True False
610 Exit For Loop If ${matched}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400611 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700612 Should Be True ${matched} Peer id ${olt_peer_id} does not match any ONU device id
Gilles Depatieb5682f82019-10-31 10:39:45 -0400613
614Validate ONU Peer Id
615 [Arguments] ${olt_device_id} ${List_ONU_Serial}
616 [Documentation] Match each ONU peer to that of the OLT device id
617 FOR ${onu_serial} IN @{List_ONU_Serial}
618 ${onu_dev_id}= Get Device ID From SN ${onu_serial}
619 Match ONU Peer Id ${onu_dev_id}
620 END
621
622Match ONU Peer Id
623 [Arguments] ${onu_dev_id}
624 [Documentation] Match an ONU peer to that of the OLT device id
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800625 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800626 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${onu_dev_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400627 Should Be Equal As Integers ${rc} 0
628 ${jsondata}= To Json ${output}
629 Log ${jsondata}
630 ${length}= Get Length ${jsondata}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700631 ${matched}= Set Variable False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400632 FOR ${INDEX} IN RANGE 0 ${length}
633 ${value}= Get From List ${jsondata} ${INDEX}
634 ${type}= Get From Dictionary ${value} type
635 ${peers}= Get From Dictionary ${value} peers
Andy Bavierb63f6d22020-03-12 15:34:37 -0700636 ${matched}= Set Variable If '${type}' == 'PON_ONU' True False
637 Exit For Loop If ${matched}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400638 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700639 Should Be True ${matched} No PON port found for ONU ${onu_dev_id}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400640 ${length}= Get Length ${peers}
641 FOR ${INDEX} IN RANGE 0 ${length}
642 ${value}= Get From List ${peers} ${INDEX}
Hardik Windlass16cdf962020-04-29 15:26:50 +0530643 ${peer_id}= Get From Dictionary ${value} deviceId
Gilles Depatieb5682f82019-10-31 10:39:45 -0400644 END
645 Should Be Equal '${peer_id}' '${olt_device_id}'
646 ... Mismatch between ONU peer ${peer_id} and OLT device id ${olt_device_id} values=False
Kailash6f5acb62019-08-28 14:38:45 -0700647
Kailash6f5acb62019-08-28 14:38:45 -0700648Get Device ID From SN
649 [Arguments] ${serial_number}
650 [Documentation] Gets the device id by matching for ${serial_number}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700651 ${rc} ${id}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800652 ... voltctl -c ${VOLTCTL_CONFIG} device list --filter=SerialNumber=${serial_number} --format='{{.Id}}'
Matteo Scandolo2769d2b2021-04-14 10:29:24 -0700653 Should Be Equal As Integers ${rc} 0 "Error while fetching device list from VOLTHA"
Andy Bavier8fca0452019-12-16 15:30:11 -0700654 Log ${id}
Kailash6f5acb62019-08-28 14:38:45 -0700655 [Return] ${id}
656
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700657Get Logical Device ID From SN
658 [Arguments] ${serial_number}
659 [Documentation] Gets the device id by matching for ${serial_number}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700660 ${rc} ${id}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800661 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice list --filter=Desc.SerialNum=${serial_number} --format='{{.Id}}'
Andy Bavier8fca0452019-12-16 15:30:11 -0700662 Should Be Equal As Integers ${rc} 0
663 Log ${id}
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700664 [Return] ${id}
665
Gilles Depatieb5682f82019-10-31 10:39:45 -0400666Build ONU SN List
Andrea Campanella6391f842020-11-16 10:01:18 +0100667 [Arguments] ${serial_numbers} ${olt_serial_number}=${EMPTY} ${num_onus}=${num_all_onus}
668 [Documentation] Appends all ONU SNs for the given OLT to the ${serial_numbers} list
Gilles Depatieb5682f82019-10-31 10:39:45 -0400669 FOR ${INDEX} IN RANGE 0 ${num_onus}
Andrea Campanella6391f842020-11-16 10:01:18 +0100670 Run Keyword IF "${olt_serial_number}"=="${hosts.src[${INDEX}].olt}" or "${olt_serial_number}"=="${EMPTY}"
671 ... Append To List ${serial_numbers} ${hosts.src[${INDEX}].onu}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400672 END
673
674Get SN From Device ID
675 [Arguments] ${device_id}
676 [Documentation] Gets the device id by matching for ${device_id}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700677 ${rc} ${sn}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800678 ... voltctl -c ${VOLTCTL_CONFIG} device list --filter=Id=${device_id} --format='{{.SerialNumber}}'
Gilles Depatieb5682f82019-10-31 10:39:45 -0400679 Should Be Equal As Integers ${rc} 0
Andy Bavier8fca0452019-12-16 15:30:11 -0700680 Log ${sn}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400681 [Return] ${sn}
682
Scott Baker60e570d2020-02-02 22:10:13 -0800683Get Parent ID From Device ID
684 [Arguments] ${device_id}
685 [Documentation] Gets the device id by matching for ${device_id}
686 ${rc} ${pid}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800687 ... voltctl -c ${VOLTCTL_CONFIG} device list --filter=Id=${device_id} --format='{{.ParentId}}'
Scott Baker60e570d2020-02-02 22:10:13 -0800688 Should Be Equal As Integers ${rc} 0
689 Log ${pid}
690 [Return] ${pid}
691
Kailash6f5acb62019-08-28 14:38:45 -0700692Validate Device Removed
693 [Arguments] ${id}
694 [Documentation] Verifys that device, ${serial_number}, has been removed
Matteo Scandolo5899be12020-11-11 15:38:07 -0800695 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -o json
Andy Bavier8fca0452019-12-16 15:30:11 -0700696 Should Be Equal As Integers ${rc} 0
Kailash6f5acb62019-08-28 14:38:45 -0700697 ${jsondata}= To Json ${output}
698 Log ${jsondata}
699 ${length}= Get Length ${jsondata}
700 @{ids}= Create List
Zack Williamsec53a1b2019-09-16 15:50:52 -0700701 FOR ${INDEX} IN RANGE 0 ${length}
702 ${value}= Get From List ${jsondata} ${INDEX}
703 ${device_id}= Get From Dictionary ${value} id
704 Append To List ${ids} ${device_id}
705 END
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700706 List Should Not Contain Value ${ids} ${id}
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800707
Andrea Campanella4e507882020-11-26 11:33:11 +0100708Validate all ONUS for OLT Removed
709 [Arguments] ${num_all_onus} ${hosts} ${olt_serial_number} ${timeout}
710 [Documentation] Verifys that all the ONUS for OLT ${serial_number}, has been removed
711 FOR ${J} IN RANGE 0 ${num_all_onus}
712 ${src}= Set Variable ${hosts.src[${J}]}
713 Continue For Loop If "${olt_serial_number}"!="${src['olt']}"
714 Run Keyword And Continue On Failure Wait Until Keyword Succeeds ${timeout} 5s
715 ... Validate Device Removed ${src['onu']}
716 END
717
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800718Reboot ONU
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000719 [Arguments] ${onu_id} ${validate_device}=True
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800720 [Documentation] Using voltctl command reboot ONU and verify that ONU comes up to running state
Matteo Scandolo5899be12020-11-11 15:38:07 -0800721 ${rc} ${devices}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device reboot ${onu_id}
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800722 Should Be Equal As Integers ${rc} 0
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000723 Run Keyword If ${validate_device} Run Keyword And Continue On Failure Wait Until Keyword Succeeds
724 ... 60s 1s Validate ONU Device By Device Id ENABLED DISCOVERED REACHABLE rebooting ${onu_id}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700725
726Assert ONUs in Voltha
727 [Arguments] ${count}
728 [Documentation] Check that a certain number of devices reached the ACTIVE/ENABLE state
729 ${rc1} ${devices}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800730 ... voltctl -c ${VOLTCTL_CONFIG} -m 8M device list | grep -v OLT | grep ACTIVE | wc -l
Matteo Scandolo142e6272020-04-29 17:36:59 -0700731 Should Be Equal As Integers ${rc1} 0
732 Should Be Equal As Integers ${devices} ${count}
733
734Wait for ONUs in VOLTHA
735 [Arguments] ${count}
736 [Documentation] Waits until a certain number of devices reached the ACTIVE/ENABLE state
737 Wait Until Keyword Succeeds 10m 5s Assert ONUs In Voltha ${count}
738
739Count Logical Devices flows
740 [Documentation] Count the flows across logical devices in VOLTHA
741 [Arguments] ${targetFlows}
742 ${output}= Get Logical Device List From Voltha
743 ${logical_devices}= To Json ${output}
744 ${total_flows}= Set Variable 0
745 FOR ${device} IN @{logical_devices}
746 ${rc} ${flows}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800747 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice flows ${device['id']} | grep -v ID | wc -l
Matteo Scandolo142e6272020-04-29 17:36:59 -0700748 Should Be Equal As Integers ${rc} 0
749 ${total_flows}= Evaluate ${total_flows} + ${flows}
750 END
Matteo Scandolo616daab2020-05-13 11:49:24 -0700751 ${msg}= Format String Found {total_flows} flows of {targetFlows} expected
752 ... total_flows=${total_flows} targetFlows=${targetFlows}
753 Log ${msg}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700754 Should Be Equal As Integers ${targetFlows} ${total_flows}
755
756Wait for Logical Devices flows
757 [Documentation] Waits until the flows have been provisioned in the logical device
758 [Arguments] ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200759 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700760 ${targetFlows}= Calculate flows by workflow ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200761 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700762 Log ${targetFlows}
763 # TODO extend Validate Logical Device Flows to check the correct number of flows
764 Wait Until Keyword Succeeds 10m 5s Count Logical Devices flows ${targetFlows}
765
Matteo Scandolo616daab2020-05-13 11:49:24 -0700766Count OpenOLT Device Flows
767 [Documentation] Count the flows across openolt devices in VOLTHA
768 [Arguments] ${targetFlows}
769 ${output}= Get Device List from Voltha by type openolt
770 ${devices}= To Json ${output}
771 ${total_flows}= Set Variable 0
772 FOR ${device} IN @{devices}
773 ${rc} ${flows}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800774 ... voltctl -c ${VOLTCTL_CONFIG} device flows ${device['id']} | grep -v ID | wc -l
Matteo Scandolo616daab2020-05-13 11:49:24 -0700775 Should Be Equal As Integers ${rc} 0
776 ${total_flows}= Evaluate ${total_flows} + ${flows}
777 END
778 ${msg}= Format String Found {total_flows} flows of {targetFlows} expected
779 ... total_flows=${total_flows} targetFlows=${targetFlows}
780 Log ${msg}
781 Should Be Equal As Integers ${targetFlows} ${total_flows}
782
783Wait for OpenOLT Devices flows
784 [Documentation] Waits until the flows have been provisioned in the openolt devices
785 [Arguments] ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200786 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700787 ${beforeFlows}= Calculate flows by workflow ${workflow} ${uni_count} ${olt_count} ${provisioned}
788 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandoloda854b02020-09-01 16:20:51 -0700789 # In the physical device we only have 2 data plane flows (on the PON) instead of 4
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700790 ${afterFlows}= Evaluate ${beforeFlows} - (${uni_count} * 2)
Matteo Scandoloda854b02020-09-01 16:20:51 -0700791 # In the TT workflow we have multiple service,
792 # so we need to remove 6 flows per each UNI that are only on the ONU device
793 ${ttFlows}= Evaluate ${beforeFlows} - (${uni_count} * 6)
794 ${afterFlows}= Set Variable If $workflow=='tt' ${ttFlows} ${afterFlows}
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700795 ${targetFlows}= Set Variable If $provisioned=='true' ${afterFlows} ${beforeFlows}
Matteo Scandolo616daab2020-05-13 11:49:24 -0700796 Log ${targetFlows}
Hardik Windlass2b37e712020-06-12 02:13:17 +0530797 Wait Until Keyword Succeeds 10m 5s Count OpenOLT Device Flows ${targetFlows}
Hardik Windlass17bd1142021-03-12 08:15:25 +0000798
799Download ONU Device Image
800 [Documentation] Downloads the given ONU software image
801 [Arguments] ${id} ${image} ${url} ${ver} ${crc} ${local_dir}
802 ${rc}= Run and Return Rc
803 ... voltctl -c ${VOLTCTL_CONFIG} device image download ${id} ${image} ${url} ${ver} ${crc} ${local_dir}
804 Should Be Equal As Integers ${rc} 0
805
806Activate ONU Device Image
807 [Documentation] Activatess the given ONU software image
808 [Arguments] ${id} ${image} ${ver} ${crc} ${local_dir}
809 ${rc}= Run and Return Rc
810 ... voltctl -c ${VOLTCTL_CONFIG} device image activate ${id} ${image} ${ver} ${crc} ${local_dir}
811 Should Be Equal As Integers ${rc} 0
812
813Verify ONU Device Image
814 [Documentation] Verfies the ONU device image state
815 [Arguments] ${dev_id} ${download_state} ${image_state} ${expected_reason}
816 ${rc} ${output}= Run and Return Rc and Output
817 ... voltctl -c ${VOLTCTL_CONFIG} device image list ${dev_id} -o json
818 Should Be Equal As Integers ${rc} 0
819 ${jsondata}= To Json ${output}
820 Log ${jsondata}
821 ${length}= Get Length ${jsondata}
822 ${matched}= Set Variable False
823 FOR ${INDEX} IN RANGE 0 ${length}
824 ${value}= Get From List ${jsondata} ${INDEX}
825 ${id}= Get From Dictionary ${value} id
826 ${downloadstate}= Get From Dictionary ${value} downloadState
827 ${imagestate}= Get From Dictionary ${value} imageState
828 ${reason}= Get From Dictionary ${value} reason
829 ${matched}= Set Variable If '${id}' == '${dev_id}' True False
830 Exit For Loop If ${matched}
831 END
832 Should Be True ${matched} No ONU Device Image for Id: ${dev_id}
833 Should Be Equal '${downloadstate}' '${download_state}' ONU Device ${id} Image downloadState does not match
834 Should Be Equal '${imagestate}' '${image_state}' ONU Device ${id} Image imageState does not match
835 Should Be Equal '${reason}' '${expected_reason}' ONU Device ${id} Image reason does not match
TorstenThiemeff9c9142021-04-08 07:21:34 +0000836
837
838# pm-data relevant keywords
839Read Default Interval From Pmconfig
840 [Documentation] Reads default interval from pm config
841 [Arguments] ${device_id}
842 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig get ${device_id}
843 Should Be Equal As Integers ${rc} 0
844 log ${result}
845 @{words}= Split String ${result}
846 ${interval}= Get From List ${words} 3
847 log ${interval}
848 [return] ${interval}
849
850Read Group Interval From Pmconfig
851 [Documentation] Reads default interval from pm config
852 [Arguments] ${device_id} ${group}
853 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group list ${device_id} | grep ${group}
854 Should Be Equal As Integers ${rc} 0
855 log ${result}
856 @{words}= Split String ${result}
857 ${interval}= Get From List ${words} -1
858 log ${interval}
859 [return] ${interval}
860
861Set and Validate Default Interval
862 [Documentation] Sets and validates default interval of pm data
863 [Arguments] ${device_id} ${interval}
864 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig frequency set ${device_id} ${interval}
865 Should Be Equal As Integers ${rc} 0
866 log ${result}
867 # workaround until unit will be printed out in voltctl - remove unit
868 ${interval}= Get Substring ${interval} 0 -1
869 Should Contain ${result} ${interval}
870
871Set and Validate Group Interval
872 [Documentation] Sets and validates group interval of pm data
873 [Arguments] ${device_id} ${interval} ${group}
874 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group set ${device_id} ${group} ${interval}
875 Should Be Equal As Integers ${rc} 0
876 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group list ${device_id} | grep ${group}
877 Should Be Equal As Integers ${rc} 0
878 log ${result}
879 # workaround until unit will be printed out in voltctl - remove unit
880 ${interval}= Get Substring ${interval} 0 -1
881 Should Contain ${result} ${interval}
882
883Read Group List
884 [Documentation] Reads metric group list of given device
885 [Arguments] ${device_id}
886 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group list ${device_id} | grep -v GROUPNAME
887 Should Be Equal As Integers ${rc} 0
888 ${group_list} Create List
889 ${interval_dict} Create Dictionary
890 @{output}= Split String ${result} \n
891 FOR ${Line} IN @{output}
892 @{words}= Split String ${Line}
893 ${group}= Set Variable ${words[0]}
894 ${interval}= Set Variable ${words[2]}
895 Append To List ${group_list} ${group}
896 Set To Dictionary ${interval_dict} ${group}=${interval}
897 END
898 [return] ${group_list} ${interval_dict}
899
900Read Group Metric List
901 [Documentation] Reads group metric list of given device and group
902 [Arguments] ${device_id} ${group}
903 ${cmd}= Catenate voltctl device pmconfig groupmetric list ${device_id} ${group} | grep -v SAMPLEFREQ
904 ${rc} ${result}= Run and Return Rc and Output ${cmd}
905 Should Be Equal As Integers ${rc} 0
906 ${groupmetric_list} Create List
907 @{output}= Split String ${result} \n
908 FOR ${Line} IN @{output}
909 @{words}= Split String ${Line}
910 ${name}= Set Variable ${words[0]}
911 ${type}= Set Variable ${words[1]}
912 ${enabled}= Set Variable ${words[2]}
913 ${subdict}= Create Dictionary type=${type} enabled=${enabled}
914 ${dict}= Create Dictionary ${name}=${subdict}
915 Append To List ${groupmetric_list} ${dict}
916 END
917 [return] ${groupmetric_list}
918
919Read Group Metric Dict
920 [Documentation] Reads group metric list of given device and group
921 [Arguments] ${device_id} ${group}
922 ${cmd}= Catenate voltctl device pmconfig groupmetric list ${device_id} ${group} | grep -v SAMPLEFREQ
923 ${rc} ${result}= Run and Return Rc and Output ${cmd}
924 Should Be Equal As Integers ${rc} 0
925 ${groupmetric_dict} Create Dictionary
926 @{output}= Split String ${result} \n
927 FOR ${Line} IN @{output}
928 @{words}= Split String ${Line}
929 ${name}= Set Variable ${words[0]}
930 ${type}= Set Variable ${words[1]}
931 ${enabled}= Set Variable ${words[2]}
932 ${subdict}= Create Dictionary type=${type} enabled=${enabled}
933 Set To Dictionary ${groupmetric_dict} ${name}=${subdict}
934 END
935 [return] ${groupmetric_dict}