blob: 9e4f2c7d21ec7b351e1f6910e12d04a217633390 [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"
Hardik Windlass8b446492021-06-10 06:25:23 +0000168 ... Note: Set "by_dev_id" to True if Device Id is passed for validation
169 ... otherwise look up will be based on Device Serial Number
ubuntu6b6e7d42020-03-02 12:35:42 -0800170 [Arguments] ${admin_state} ${oper_status} ${connect_status}
Hardik Windlass8b446492021-06-10 06:25:23 +0000171 ... ${id} ${onu_reason}=${EMPTY} ${onu}=False ${by_dev_id}=False
172 ${rc} ${output}= Run Keyword If ${by_dev_id} Run and Return Rc and Output
173 ... voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB -f Id=${id} -o json
174 ... ELSE Run and Return Rc and Output
175 ... voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB -f SerialNumber=${id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400176 Should Be Equal As Integers ${rc} 0
Kailash6f5acb62019-08-28 14:38:45 -0700177 ${jsondata}= To Json ${output}
Matteo Scandolobfb74382021-05-10 15:45:16 -0700178 Log ${output}
Kailash6f5acb62019-08-28 14:38:45 -0700179 ${length}= Get Length ${jsondata}
ubuntu6b6e7d42020-03-02 12:35:42 -0800180 ${matched}= Set Variable False
Zack Williamsec53a1b2019-09-16 15:50:52 -0700181 FOR ${INDEX} IN RANGE 0 ${length}
182 ${value}= Get From List ${jsondata} ${INDEX}
Scott Baker780b65f2020-05-22 14:03:15 -0700183 ${jsonCamelCaseFieldnames}= Run Keyword And Return Status
184 ... Dictionary Should Contain Key ${value} adminState
185 ${astate}= Run Keyword If ${jsonCamelCaseFieldNames}
186 ... Get From Dictionary ${value} adminState
187 ... ELSE
188 ... Get From Dictionary ${value} adminstate
189 ${opstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
190 ... Get From Dictionary ${value} operStatus
191 ... ELSE
192 ... Get From Dictionary ${value} operstatus
193 ${cstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
194 ... Get From Dictionary ${value} connectStatus
195 ... ELSE
196 ... Get From Dictionary ${value} connectstatus
197 ${sn}= Run Keyword If ${jsonCamelCaseFieldNames}
198 ... Get From Dictionary ${value} serialNumber
199 ... ELSE
200 ... Get From Dictionary ${value} serialnumber
Gilles Depatieb5682f82019-10-31 10:39:45 -0400201 ${devId}= Get From Dictionary ${value} id
Zack Williamsec53a1b2019-09-16 15:50:52 -0700202 ${mib_state}= Get From Dictionary ${value} reason
ubuntu6b6e7d42020-03-02 12:35:42 -0800203 ${matched}= Set Variable If '${sn}' == '${id}' or '${devId}' == '${id}' True False
Andy Bavierb63f6d22020-03-12 15:34:37 -0700204 Exit For Loop If ${matched}
Zack Williamsec53a1b2019-09-16 15:50:52 -0700205 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700206 Should Be True ${matched} No match found for ${id} to validate device
Matteo Scandolo5e10b282019-11-25 10:54:32 -0700207 Log ${value}
ubuntu6b6e7d42020-03-02 12:35:42 -0800208 Should Be Equal '${astate}' '${admin_state}' Device ${sn} admin_state != ${admin_state}
Gilles Depatie675a2062019-10-22 12:44:42 -0400209 ... values=False
ubuntu6b6e7d42020-03-02 12:35:42 -0800210 Should Be Equal '${opstatus}' '${oper_status}' Device ${sn} oper_status != ${oper_status}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400211 ... values=False
ubuntu6b6e7d42020-03-02 12:35:42 -0800212 Should Be Equal '${cstatus}' '${connect_status}' Device ${sn} conn_status != ${connect_status}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400213 ... values=False
Matteo Scandolo74bd5c32020-12-08 09:52:19 -0800214 Run Keyword If '${onu}' == 'True' Should Contain '${onu_reason}' '${mib_state}'
ubuntu6b6e7d42020-03-02 12:35:42 -0800215 ... Device ${sn} mib_state incorrect (${mib_state}) values=False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400216
217Validate OLT Device
Hardik Windlass8b446492021-06-10 06:25:23 +0000218 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${id} ${by_dev_id}=False
ubuntu6b6e7d42020-03-02 12:35:42 -0800219 [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
Hardik Windlass8b446492021-06-10 06:25:23 +0000221 ... Note: Set "by_dev_id" to True if Device Id is passed for validation
222 ... otherwise look up will be based on Device Serial Number
223 Validate Device ${admin_state} ${oper_status} ${connect_status} ${id} by_dev_id=${by_dev_id}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400224
Suchitra Vemuria6879aa2020-11-03 11:03:11 -0800225Validate OLT Devices
226 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${ids}=${EMPTY}
227 [Documentation] Parses the output of "voltctl device list" and inspects device ${id}, specified
228 ... as either its serial numbner or device ID. Match on OLT Serial number or Device Id and inspect states
229 FOR ${I} IN RANGE 0 ${olt_count}
230 ${olt_serial_number}= Get From Dictionary ${olt_ids}[${I}] sn
231 ${olt_device_id}= Get OLTDeviceID From OLT List ${olt_serial_number}
Hardik Windlass8b446492021-06-10 06:25:23 +0000232 Validate Device ${admin_state} ${oper_status} ${connect_status} ${olt_device_id} by_dev_id=True
Suchitra Vemuria6879aa2020-11-03 11:03:11 -0800233 END
234
Gilles Depatieb5682f82019-10-31 10:39:45 -0400235Validate ONU Devices
236 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${List_ONU_Serial}
Andy Bavierf1f26ed2020-03-18 10:59:07 -0700237 ... ${onu_reason}=omci-flows-pushed
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700238 [Documentation] Parses the output of "voltctl device list" and inspects device ${List_ONU_Serial}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400239 ... Iteratively match on each Serial number contained in ${List_ONU_Serial} and inspect
240 ... states including MIB state
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700241 FOR ${serial_number} IN @{List_ONU_Serial}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400242 Validate Device ${admin_state} ${oper_status} ${connect_status} ${serial_number}
Andy Bavierf1f26ed2020-03-18 10:59:07 -0700243 ... onu_reason=${onu_reason} onu=True
Debasish28130d02020-03-16 11:05:26 +0000244 END
245
Gilles Depatieb5682f82019-10-31 10:39:45 -0400246Validate Device Port Types
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700247 [Documentation]
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800248 ... Parses the output of voltctl device port list <device_id> and matches the port types listed
Andy Bavier90eb1a12020-03-26 11:54:35 -0700249 [Arguments] ${device_id} ${pon_type} ${ethernet_type} ${all_active}=True
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700250 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800251 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${device_id} -m 8MB -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400252 Should Be Equal As Integers ${rc} 0
253 ${jsondata}= To Json ${output}
254 Log ${jsondata}
255 ${length}= Get Length ${jsondata}
256 FOR ${INDEX} IN RANGE 0 ${length}
257 ${value}= Get From List ${jsondata} ${INDEX}
Scott Baker780b65f2020-05-22 14:03:15 -0700258 ${jsonCamelCaseFieldnames}= Run Keyword And Return Status
259 ... Dictionary Should Contain Key ${value} adminState
260 ${astate}= Run Keyword If ${jsonCamelCaseFieldNames}
Hardik Windlass2b37e712020-06-12 02:13:17 +0530261 ... Get From Dictionary ${value} adminState
Scott Baker780b65f2020-05-22 14:03:15 -0700262 ... ELSE
Hardik Windlass2b37e712020-06-12 02:13:17 +0530263 ... Get From Dictionary ${value} adminstate
Scott Baker780b65f2020-05-22 14:03:15 -0700264 ${opstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
265 ... Get From Dictionary ${value} operStatus
266 ... ELSE
Hardik Windlass2b37e712020-06-12 02:13:17 +0530267 ... Get From Dictionary ${value} operstatus
Gilles Depatieb5682f82019-10-31 10:39:45 -0400268 ${type}= Get From Dictionary ${value} type
Hemaf64d34c2020-03-25 00:40:17 +0530269 Should Be Equal '${astate}' 'ENABLED' Device ${device_id} port admin_state != ENABLED values=False
Andy Bavier90eb1a12020-03-26 11:54:35 -0700270 Run Keyword If ${all_active} Should Be Equal '${opstatus}' 'ACTIVE'
271 ... Device ${device_id} port oper_status != ACTIVE values=False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400272 Should Be True '${type}' == '${pon_type}' or '${type}' == '${ethernet_type}'
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700273 ... Device ${device_id} port type is neither ${pon_type} or ${ethernet_type}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400274 END
275
276Validate OLT Port Types
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800277 [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 -0700278 [Arguments] ${pon_type} ${ethernet_type}
279 Validate Device Port Types ${olt_device_id} ${pon_type} ${ethernet_type}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400280
281Validate ONU Port Types
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700282 [Arguments] ${List_ONU_Serial} ${pon_type} ${ethernet_type}
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800283 [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 -0700284 ... and matches the port types listed
Gilles Depatieb5682f82019-10-31 10:39:45 -0400285 FOR ${serial_number} IN @{List_ONU_Serial}
286 ${onu_dev_id}= Get Device ID From SN ${serial_number}
Andy Bavier90eb1a12020-03-26 11:54:35 -0700287 # Only first UNI port is ACTIVE; the rest are in DISCOVERED operstatus
288 Validate Device Port Types ${onu_dev_id} ${pon_type} ${ethernet_type} all_active=False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400289 END
290
291Validate Device Flows
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000292 [Arguments] ${device_id} ${flow_count}=${EMPTY}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400293 [Documentation] Parses the output of voltctl device flows <device_id> and expects flow count > 0
Andrea Campanella80655eb2020-07-10 15:49:22 +0200294 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800295 ... voltctl -c ${VOLTCTL_CONFIG} device flows ${device_id} -m 8MB -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400296 Should Be Equal As Integers ${rc} 0
297 ${jsondata}= To Json ${output}
298 Log ${jsondata}
299 ${length}= Get Length ${jsondata}
300 Log 'Number of flows = ' ${length}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000301 Run Keyword If '${flow_count}' == '${EMPTY}' Should Be True ${length} > 0
Gilles Depatieb5682f82019-10-31 10:39:45 -0400302 ... Number of flows for ${device_id} was 0
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000303 ... ELSE Should Be True ${length} == ${flow_count}
304 ... Number of flows for ${device_id} was not ${flow_count}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400305
306Validate OLT Flows
Suchitra Vemuria6879aa2020-11-03 11:03:11 -0800307 [Arguments] ${flow_count}=${EMPTY} ${olt_device_id}=${EMPTY}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000308 [Documentation] Parses the output of voltctl device flows ${olt_device_id}
309 ... and expects flow count == ${flow_count}
310 Validate Device Flows ${olt_device_id} ${flow_count}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400311
312Validate ONU Flows
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000313 [Arguments] ${List_ONU_Serial} ${flow_count}=${EMPTY}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400314 [Documentation] Parses the output of voltctl device flows for each ONU SN listed in ${List_ONU_Serial}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000315 ... and expects flow count == ${flow_count}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700316 FOR ${serial_number} IN @{List_ONU_Serial}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400317 ${onu_dev_id}= Get Device ID From SN ${serial_number}
Hardik Windlassa3d04b92020-02-17 15:06:05 +0000318 Validate Device Flows ${onu_dev_id} ${flow_count}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400319 END
320
TorstenThieme401af432020-06-11 15:53:53 +0000321Validate ONU Devices With Duration
322 [Documentation]
323 ... Parses the output of "voltctl device list" and inspects all devices ${List_ONU_Serial},
324 ... Iteratively match on each Serial number contained in ${List_ONU_Serial} and inspect
325 ... states including MIB state.
326 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${onu_reason}
327 ... ${List_ONU_Serial} ${startTime} ${print2console}=False ${output_file}=${EMPTY}
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000328 ... ${alternate_reason}=${EMPTY}
TorstenThiemef78a9d82021-03-05 13:42:09 +0000329 ${cmd}= Catenate voltctl -c ${VOLTCTL_CONFIG} device list -m 8MB -f Type=brcm_openomci_onu
Matteo Scandolo6f24ea92021-04-29 11:55:50 -0700330 ... --format "{{.SerialNumber}}\t{{.AdminState}}\t{{.OperStatus}}\t{{.ConnectStatus}}\t{{.Reason}}" | grep -v SERIALNUMBER
TorstenThiemef78a9d82021-03-05 13:42:09 +0000331 ${rc} ${output}= Run and Return Rc and Output ${cmd}
TorstenThieme401af432020-06-11 15:53:53 +0000332 Should Be Equal As Integers ${rc} 0
333 ${timeCurrent} = Get Current Date
334 ${timeTotalMs} = Subtract Date From Date ${timeCurrent} ${startTime} result_format=number
TorstenThiemef78a9d82021-03-05 13:42:09 +0000335 @{Results}= Split String ${output} \n
336 FOR ${Line} IN @{Results}
TorstenThieme401af432020-06-11 15:53:53 +0000337 ${matched}= Set Variable False
TorstenThiemef78a9d82021-03-05 13:42:09 +0000338 @{words}= Split String ${Line} \t
339 ${sn}= Set Variable ${words[0]}
340 ${astate}= Set Variable ${words[1]}
341 ${opstatus}= Set Variable ${words[2]}
342 ${cstatus}= Set Variable ${words[3]}
343 ${mib_state}= Set Variable ${words[4]}
TorstenThieme401af432020-06-11 15:53:53 +0000344 ${onu_id}= Get Index From List ${List_ONU_Serial} ${sn}
345 ${matched}= Set Variable If -1 != ${onu_id} True False
346 ${matched}= Set Variable If '${astate}' == '${admin_state}' ${matched} False
347 ${matched}= Set Variable If '${opstatus}' == '${oper_status}' ${matched} False
348 ${matched}= Set Variable If '${cstatus}' == '${connect_status}' ${matched} False
TorstenThiemec3c23232021-01-13 13:06:31 +0000349 ${len}= Get Length ${alternate_reason}
TorstenThieme105c5982021-01-21 09:50:27 +0000350 ${matches}= Run Keyword If ${len} >= 1 Get Match Count ${alternate_reason} ${mib_state}
351 ... ELSE Set Variable 0
TorstenThiemec3c23232021-01-13 13:06:31 +0000352 ${matched}= Set Variable If '${mib_state}' == '${onu_reason}' or ${matches} >= 1
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000353 ... ${matched} False
TorstenThieme401af432020-06-11 15:53:53 +0000354 Run Keyword If ${matched} and ${print2console} Log
355 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec. console=yes
356 Run Keyword If ${matched} and ('${output_file}'!='${EMPTY}') Append To File ${output_file}
357 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec.
358 Run Keyword If ${matched} Remove Values From List ${List_ONU_Serial} ${sn}
359 END
360 Should Be Empty ${List_ONU_Serial} List ${List_ONU_Serial} not empty
361
TorstenThieme9949b172020-06-16 10:00:15 +0000362Validate ONU Devices MIB State With Duration
363 [Documentation]
364 ... Parses the output of "voltctl device list" and inspects all devices ${List_ONU_Serial},
365 ... Iteratively match on each Serial number contained in ${List_ONU_Serial} and inspect MIB state.
366 [Arguments] ${onu_reason}
367 ... ${List_ONU_Serial} ${startTime} ${print2console}=False ${output_file}=${EMPTY}
368 ${type} = Set Variable brcm_openomci_onu
Andrea Campanella80655eb2020-07-10 15:49:22 +0200369 ${voltctl_commad} = Catenate SEPARATOR=
370 ... voltctl device list -m 8MB -f Type=${type} -f Reason=${onu_reason} --format '{{.SerialNumber}}'
371 ${rc} ${output}= Run and Return Rc and Output ${voltctl_commad}
TorstenThieme9949b172020-06-16 10:00:15 +0000372 Should Be Equal As Integers ${rc} 0
373 ${timeCurrent} = Get Current Date
374 ${timeTotalMs} = Subtract Date From Date ${timeCurrent} ${startTime} result_format=number
375 @{outputdata} = Split String ${output}
376 ${outputlength} = Get Length ${outputdata}
377 ${onulength} = Get Length ${List_ONU_Serial}
378 ${Matches} = Run Keyword If ${outputlength}<=${onulength}
379 ... Compare Lists ${outputdata} ${List_ONU_Serial}
380 ... ELSE Compare Lists ${List_ONU_Serial} ${outputdata}
381 ${length} = Get Length ${Matches}
382 FOR ${INDEX} IN RANGE 0 ${length}
383 ${sn}= Get From List ${Matches} ${INDEX}
384 Run Keyword If ${print2console} Log
385 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec. console=yes
386 Run Keyword If ('${output_file}'!='${EMPTY}') Append To File ${output_file}
387 ... \r\nONU ${sn} reached the state ${onu_reason} after ${timeTotalMs} sec.
388 Remove Values From List ${List_ONU_Serial} ${sn}
389 END
390 Should Be Empty ${List_ONU_Serial} List ${List_ONU_Serial} not empty
391
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000392Validate ONU Device By Device Id
393 [Documentation]
394 ... Parses the output of "voltctl device list" filtered by device id and inspects states including reason.
395 [Arguments] ${admin_state} ${oper_status} ${connect_status} ${onu_reason} ${onu_id}
Matteo Scandolo5899be12020-11-11 15:38:07 -0800396 ${cmd} Catenate voltctl -c ${VOLTCTL_CONFIG} device list --filter=Id=${onu_id} -m 8MB -o json
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000397 ${rc} ${output}= Run and Return Rc and Output ${cmd}
398 Should Be Equal As Integers ${rc} 0
399 ${jsondata}= To Json ${output}
400 ${length}= Get Length ${jsondata}
401 Should Be Equal As Integers ${length} 1 No match found for ${onu_id} to validate device
402 ${value}= Get From List ${jsondata} 0
403 Log ${value}
404 ${jsonCamelCaseFieldnames}= Run Keyword And Return Status
405 ... Dictionary Should Contain Key ${value} adminState
406 ${astate}= Run Keyword If ${jsonCamelCaseFieldNames}
407 ... Get From Dictionary ${value} adminState
408 ... ELSE
409 ... Get From Dictionary ${value} adminstate
410 ${opstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
411 ... Get From Dictionary ${value} operStatus
412 ... ELSE
413 ... Get From Dictionary ${value} operstatus
414 ${cstatus}= Run Keyword If ${jsonCamelCaseFieldNames}
415 ... Get From Dictionary ${value} connectStatus
416 ... ELSE
417 ... Get From Dictionary ${value} connectstatus
418 ${sn}= Run Keyword If ${jsonCamelCaseFieldNames}
419 ... Get From Dictionary ${value} serialNumber
420 ... ELSE
421 ... Get From Dictionary ${value} serialnumber
422 ${devId}= Get From Dictionary ${value} id
423 ${mib_state}= Get From Dictionary ${value} reason
424 Should Be Equal '${devId}' '${onu_id}' No match found for ${onu_id} to validate device
425 ... values=False
426 Should Be Equal '${astate}' '${admin_state}' Device ${sn} admin_state != ${admin_state}
427 ... values=False
428 Should Be Equal '${opstatus}' '${oper_status}' Device ${sn} oper_status != ${oper_status}
429 ... values=False
430 Should Be Equal '${cstatus}' '${connect_status}' Device ${sn} conn_status != ${connect_status}
431 ... values=False
432 Should Be Equal '${mib_state}' '${onu_reason}'
433 ... Device ${sn} mib_state incorrect (${mib_state}) values=False
434
435
TorstenThieme9949b172020-06-16 10:00:15 +0000436Compare Lists
437 [Documentation]
438 ... Compares both lists and put all matches in the returned list
439 [Arguments] ${ListIterate} ${ListCompare}
440 @{list} = Create List
441 ${length} = Get Length ${ListIterate}
442 FOR ${INDEX} IN RANGE 0 ${length}
443 ${sn}= Get From List ${ListIterate} ${INDEX}
444 ${onu_id}= Get Index From List ${ListCompare} ${sn}
445 Run Keyword If -1 != ${onu_id} Append To List ${list} ${sn}
446 END
447 [Return] ${list}
448
Gilles Depatieb5682f82019-10-31 10:39:45 -0400449Validate Logical Device
450 [Documentation] Validate Logical Device is listed
Matteo Scandolo5899be12020-11-11 15:38:07 -0800451 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} logicaldevice list -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400452 Should Be Equal As Integers ${rc} 0
453 ${jsondata}= To Json ${output}
454 Log ${jsondata}
455 ${length}= Get Length ${jsondata}
456 FOR ${INDEX} IN RANGE 0 ${length}
457 ${value}= Get From List ${jsondata} ${INDEX}
458 ${devid}= Get From Dictionary ${value} id
Scott Baker2ab2a0c2020-06-05 12:51:47 -0700459 ${rootdev}= Get From Dictionary ${value} rootDeviceId
460 ${desc}= Get From Dictionary ${value} desc
461 ${sn}= Get From Dictionary ${desc} serialNum
Gilles Depatieb5682f82019-10-31 10:39:45 -0400462 Exit For Loop
463 END
464 Should Be Equal '${rootdev}' '${olt_device_id}' Root Device does not match ${olt_device_id} values=False
465 Should Be Equal '${sn}' '${BBSIM_OLT_SN}' Logical Device ${sn} does not match ${BBSIM_OLT_SN}
466 ... values=False
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700467 [Return] ${devid}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400468
469Validate Logical Device Ports
470 [Arguments] ${logical_device_id}
471 [Documentation] Validate Logical Device Ports are listed and are > 0
472 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800473 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice port list ${logical_device_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400474 Should Be Equal As Integers ${rc} 0
475 ${jsondata}= To Json ${output}
476 Log ${jsondata}
477 ${length}= Get Length ${jsondata}
478 Should Be True ${length} > 0 Number of ports for ${logical_device_id} was 0
479
480Validate Logical Device Flows
481 [Arguments] ${logical_device_id}
482 [Documentation] Validate Logical Device Flows are listed and are > 0
483 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800484 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice flows ${logical_device_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400485 Should Be Equal As Integers ${rc} 0
486 ${jsondata}= To Json ${output}
487 Log ${jsondata}
488 ${length}= Get Length ${jsondata}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700489 Should Be True ${length} > 0 Number of flows for ${logical_device_id} was 0
Gilles Depatieb5682f82019-10-31 10:39:45 -0400490
Hardik Windlass16cdf962020-04-29 15:26:50 +0530491Retrieve OLT PON Ports
492 [Arguments] ${olt_device_id}
493 [Documentation] Retrieves the list of PON ports from the OLT device
494 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800495 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Hardik Windlass16cdf962020-04-29 15:26:50 +0530496 Should Be Equal As Integers ${rc} 0
497 ${jsondata}= To Json ${output}
498 Log ${jsondata}
499 ${length}= Get Length ${jsondata}
500 ${olt_pon_list}= Create List
501 FOR ${INDEX} IN RANGE 0 ${length}
502 ${value}= Get From List ${jsondata} ${INDEX}
503 ${type}= Get From Dictionary ${value} type
504 ${portno}= Get From Dictionary ${value} portNo
505 ${peers}= Get From Dictionary ${value} peers
506 ${len_peers}= Get Length ${peers}
507 Run Keyword If '${type}' == 'PON_OLT' and ${len_peers} > 0
508 ... Append To List ${olt_pon_list} ${portno}
509 END
510 [Return] ${olt_pon_list}
511
512Retrieve Peer List From OLT PON Port
513 [Arguments] ${olt_device_id} ${pon_port}
514 [Documentation] Retrieves the list of peer device ids list from the OLT PON port
515 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800516 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Hardik Windlass16cdf962020-04-29 15:26:50 +0530517 Should Be Equal As Integers ${rc} 0
518 ${jsondata}= To Json ${output}
519 Log ${jsondata}
520 ${length}= Get Length ${jsondata}
521 ${matched}= Set Variable False
522 FOR ${INDEX} IN RANGE 0 ${length}
523 ${value}= Get From List ${jsondata} ${INDEX}
524 ${type}= Get From Dictionary ${value} type
525 ${portno}= Get From Dictionary ${value} portNo
526 ${peers}= Get From Dictionary ${value} peers
527 ${matched}= Set Variable If '${type}' == 'PON_OLT' and '${portno}' == '${pon_port}' True False
528 Exit For Loop If ${matched}
529 END
530 Should Be True ${matched} No PON port found for OLT ${olt_device_id}
531 ${length}= Get Length ${peers}
532 ${olt_peer_list}= Create List
533 FOR ${INDEX} IN RANGE 0 ${length}
534 ${value}= Get From List ${peers} ${INDEX}
535 ${peer_id}= Get From Dictionary ${value} deviceId
536 Append To List ${olt_peer_list} ${peer_id}
537 END
538 [Return] ${olt_peer_list}
539
540Validate OLT PON Port Status
541 [Arguments] ${olt_device_id} ${pon_port} ${admin_state} ${oper_status}
542 [Documentation] Verifies the state of the PON port of the OLT
543 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800544 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Hardik Windlass16cdf962020-04-29 15:26:50 +0530545 Should Be Equal As Integers ${rc} 0
546 ${jsondata}= To Json ${output}
547 Log ${jsondata}
548 ${length}= Get Length ${jsondata}
549 ${matched}= Set Variable False
550 FOR ${INDEX} IN RANGE 0 ${length}
551 ${value}= Get From List ${jsondata} ${INDEX}
552 ${type}= Get From Dictionary ${value} type
553 ${portno}= Get From Dictionary ${value} portNo
554 ${astate}= Get From Dictionary ${value} adminState
555 ${opstatus}= Get From Dictionary ${value} operStatus
556 ${matched}= Set Variable If '${type}' == 'PON_OLT' and '${portno}' == '${pon_port}' True False
557 Exit For Loop If ${matched}
558 END
559 Should Be True ${matched} No PON port found for OLT ${olt_device_id} ${pon_port}
560 Log ${value}
561 Should Be Equal '${astate}' '${admin_state}' OLT PON Port admin_state != ${admin_state}
562 ... values=False
563 Should Be Equal '${opstatus}' '${oper_status}' OLT PON Port oper_status != ${oper_status}
564 ... values=False
565
566DisableOrEnable OLT PON Port
567 [Arguments] ${operation} ${olt_device_id} ${portno}
568 [Documentation] Disables or Enables the PON port of the OLT
569 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800570 ... voltctl -c ${VOLTCTL_CONFIG} device port ${operation} ${olt_device_id} ${portno}
Hardik Windlass16cdf962020-04-29 15:26:50 +0530571 Should Be Equal As Integers ${rc} 0
572
Gilles Depatieb5682f82019-10-31 10:39:45 -0400573Retrieve Peer List From OLT
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700574 [Arguments] ${olt_peer_list}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400575 [Documentation] Retrieve the list of peer device id list from port list
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700576 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800577 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${olt_device_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400578 Should Be Equal As Integers ${rc} 0
579 ${jsondata}= To Json ${output}
580 Log ${jsondata}
581 ${length}= Get Length ${jsondata}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700582 ${matched}= Set Variable False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400583 FOR ${INDEX} IN RANGE 0 ${length}
584 ${value}= Get From List ${jsondata} ${INDEX}
585 ${type}= Get From Dictionary ${value} type
586 ${peers}= Get From Dictionary ${value} peers
Andy Bavierb63f6d22020-03-12 15:34:37 -0700587 ${matched}= Set Variable If '${type}' == 'PON_OLT' True False
588 Exit For Loop If ${matched}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400589 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700590 Should Be True ${matched} No PON port found for OLT ${olt_device_id}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400591 ${length}= Get Length ${peers}
592 FOR ${INDEX} IN RANGE 0 ${length}
593 ${value}= Get From List ${peers} ${INDEX}
Hardik Windlass16cdf962020-04-29 15:26:50 +0530594 ${peer_id}= Get From Dictionary ${value} deviceId
Gilles Depatieb5682f82019-10-31 10:39:45 -0400595 Append To List ${olt_peer_list} ${peer_id}
596 END
597
598Validate OLT Peer Id List
599 [Arguments] ${olt_peer_id_list}
600 [Documentation] Match each entry in the ${olt_peer_id_list} against ONU device ids.
601 FOR ${peer_id} IN @{olt_peer_id_list}
602 Match OLT Peer Id ${peer_id}
603 END
604
605Match OLT Peer Id
606 [Arguments] ${olt_peer_id}
607 [Documentation] Lookup the OLT Peer Id in against the list of ONU device Ids
Matteo Scandolo5899be12020-11-11 15:38:07 -0800608 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400609 Should Be Equal As Integers ${rc} 0
610 ${jsondata}= To Json ${output}
611 Log ${jsondata}
612 ${length}= Get Length ${jsondata}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700613 ${matched}= Set Variable False
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700614 FOR ${INDEX} IN RANGE 0 ${length}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400615 ${value}= Get From List ${jsondata} ${INDEX}
616 ${devid}= Get From Dictionary ${value} id
Andy Bavierb63f6d22020-03-12 15:34:37 -0700617 ${matched}= Set Variable If '${devid}' == '${olt_peer_id}' True False
618 Exit For Loop If ${matched}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400619 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700620 Should Be True ${matched} Peer id ${olt_peer_id} does not match any ONU device id
Gilles Depatieb5682f82019-10-31 10:39:45 -0400621
622Validate ONU Peer Id
623 [Arguments] ${olt_device_id} ${List_ONU_Serial}
624 [Documentation] Match each ONU peer to that of the OLT device id
625 FOR ${onu_serial} IN @{List_ONU_Serial}
626 ${onu_dev_id}= Get Device ID From SN ${onu_serial}
627 Match ONU Peer Id ${onu_dev_id}
628 END
629
630Match ONU Peer Id
631 [Arguments] ${onu_dev_id}
632 [Documentation] Match an ONU peer to that of the OLT device id
David K. Bainbridgebd5ebd22020-02-04 10:01:18 -0800633 ${rc} ${output}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800634 ... voltctl -c ${VOLTCTL_CONFIG} device port list ${onu_dev_id} -o json
Gilles Depatieb5682f82019-10-31 10:39:45 -0400635 Should Be Equal As Integers ${rc} 0
636 ${jsondata}= To Json ${output}
637 Log ${jsondata}
638 ${length}= Get Length ${jsondata}
Andy Bavierb63f6d22020-03-12 15:34:37 -0700639 ${matched}= Set Variable False
Gilles Depatieb5682f82019-10-31 10:39:45 -0400640 FOR ${INDEX} IN RANGE 0 ${length}
641 ${value}= Get From List ${jsondata} ${INDEX}
642 ${type}= Get From Dictionary ${value} type
643 ${peers}= Get From Dictionary ${value} peers
Andy Bavierb63f6d22020-03-12 15:34:37 -0700644 ${matched}= Set Variable If '${type}' == 'PON_ONU' True False
645 Exit For Loop If ${matched}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400646 END
Andy Bavierb63f6d22020-03-12 15:34:37 -0700647 Should Be True ${matched} No PON port found for ONU ${onu_dev_id}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400648 ${length}= Get Length ${peers}
649 FOR ${INDEX} IN RANGE 0 ${length}
650 ${value}= Get From List ${peers} ${INDEX}
Hardik Windlass16cdf962020-04-29 15:26:50 +0530651 ${peer_id}= Get From Dictionary ${value} deviceId
Gilles Depatieb5682f82019-10-31 10:39:45 -0400652 END
653 Should Be Equal '${peer_id}' '${olt_device_id}'
654 ... Mismatch between ONU peer ${peer_id} and OLT device id ${olt_device_id} values=False
Kailash6f5acb62019-08-28 14:38:45 -0700655
Kailash6f5acb62019-08-28 14:38:45 -0700656Get Device ID From SN
657 [Arguments] ${serial_number}
658 [Documentation] Gets the device id by matching for ${serial_number}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700659 ${rc} ${id}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800660 ... voltctl -c ${VOLTCTL_CONFIG} device list --filter=SerialNumber=${serial_number} --format='{{.Id}}'
Matteo Scandolo2769d2b2021-04-14 10:29:24 -0700661 Should Be Equal As Integers ${rc} 0 "Error while fetching device list from VOLTHA"
Andy Bavier8fca0452019-12-16 15:30:11 -0700662 Log ${id}
Kailash6f5acb62019-08-28 14:38:45 -0700663 [Return] ${id}
664
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700665Get Logical Device ID From SN
666 [Arguments] ${serial_number}
667 [Documentation] Gets the device id by matching for ${serial_number}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700668 ${rc} ${id}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800669 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice list --filter=Desc.SerialNum=${serial_number} --format='{{.Id}}'
Andy Bavier8fca0452019-12-16 15:30:11 -0700670 Should Be Equal As Integers ${rc} 0
671 Log ${id}
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700672 [Return] ${id}
673
Gilles Depatieb5682f82019-10-31 10:39:45 -0400674Build ONU SN List
Andrea Campanella6391f842020-11-16 10:01:18 +0100675 [Arguments] ${serial_numbers} ${olt_serial_number}=${EMPTY} ${num_onus}=${num_all_onus}
676 [Documentation] Appends all ONU SNs for the given OLT to the ${serial_numbers} list
Gilles Depatieb5682f82019-10-31 10:39:45 -0400677 FOR ${INDEX} IN RANGE 0 ${num_onus}
Andrea Campanella6391f842020-11-16 10:01:18 +0100678 Run Keyword IF "${olt_serial_number}"=="${hosts.src[${INDEX}].olt}" or "${olt_serial_number}"=="${EMPTY}"
679 ... Append To List ${serial_numbers} ${hosts.src[${INDEX}].onu}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400680 END
681
682Get SN From Device ID
683 [Arguments] ${device_id}
684 [Documentation] Gets the device id by matching for ${device_id}
Zack Williamsa8fe75a2020-01-10 14:25:27 -0700685 ${rc} ${sn}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800686 ... voltctl -c ${VOLTCTL_CONFIG} device list --filter=Id=${device_id} --format='{{.SerialNumber}}'
Gilles Depatieb5682f82019-10-31 10:39:45 -0400687 Should Be Equal As Integers ${rc} 0
Andy Bavier8fca0452019-12-16 15:30:11 -0700688 Log ${sn}
Gilles Depatieb5682f82019-10-31 10:39:45 -0400689 [Return] ${sn}
690
Scott Baker60e570d2020-02-02 22:10:13 -0800691Get Parent ID From Device ID
692 [Arguments] ${device_id}
693 [Documentation] Gets the device id by matching for ${device_id}
694 ${rc} ${pid}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800695 ... voltctl -c ${VOLTCTL_CONFIG} device list --filter=Id=${device_id} --format='{{.ParentId}}'
Scott Baker60e570d2020-02-02 22:10:13 -0800696 Should Be Equal As Integers ${rc} 0
697 Log ${pid}
698 [Return] ${pid}
699
Kailash6f5acb62019-08-28 14:38:45 -0700700Validate Device Removed
701 [Arguments] ${id}
702 [Documentation] Verifys that device, ${serial_number}, has been removed
Matteo Scandolo5899be12020-11-11 15:38:07 -0800703 ${rc} ${output}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device list -o json
Andy Bavier8fca0452019-12-16 15:30:11 -0700704 Should Be Equal As Integers ${rc} 0
Kailash6f5acb62019-08-28 14:38:45 -0700705 ${jsondata}= To Json ${output}
706 Log ${jsondata}
707 ${length}= Get Length ${jsondata}
708 @{ids}= Create List
Zack Williamsec53a1b2019-09-16 15:50:52 -0700709 FOR ${INDEX} IN RANGE 0 ${length}
710 ${value}= Get From List ${jsondata} ${INDEX}
711 ${device_id}= Get From Dictionary ${value} id
712 Append To List ${ids} ${device_id}
713 END
Suchitra Vemuri00d147d2019-09-13 13:07:32 -0700714 List Should Not Contain Value ${ids} ${id}
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800715
Andrea Campanella4e507882020-11-26 11:33:11 +0100716Validate all ONUS for OLT Removed
717 [Arguments] ${num_all_onus} ${hosts} ${olt_serial_number} ${timeout}
718 [Documentation] Verifys that all the ONUS for OLT ${serial_number}, has been removed
719 FOR ${J} IN RANGE 0 ${num_all_onus}
720 ${src}= Set Variable ${hosts.src[${J}]}
721 Continue For Loop If "${olt_serial_number}"!="${src['olt']}"
722 Run Keyword And Continue On Failure Wait Until Keyword Succeeds ${timeout} 5s
723 ... Validate Device Removed ${src['onu']}
724 END
725
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800726Reboot ONU
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000727 [Arguments] ${onu_id} ${validate_device}=True
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800728 [Documentation] Using voltctl command reboot ONU and verify that ONU comes up to running state
Matteo Scandolo5899be12020-11-11 15:38:07 -0800729 ${rc} ${devices}= Run and Return Rc and Output voltctl -c ${VOLTCTL_CONFIG} device reboot ${onu_id}
Suchitra Vemuricd2f64f2020-02-18 18:30:27 -0800730 Should Be Equal As Integers ${rc} 0
TorstenThiemefd7e7ba2020-11-06 13:57:57 +0000731 Run Keyword If ${validate_device} Run Keyword And Continue On Failure Wait Until Keyword Succeeds
732 ... 60s 1s Validate ONU Device By Device Id ENABLED DISCOVERED REACHABLE rebooting ${onu_id}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700733
734Assert ONUs in Voltha
735 [Arguments] ${count}
736 [Documentation] Check that a certain number of devices reached the ACTIVE/ENABLE state
737 ${rc1} ${devices}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800738 ... voltctl -c ${VOLTCTL_CONFIG} -m 8M device list | grep -v OLT | grep ACTIVE | wc -l
Matteo Scandolo142e6272020-04-29 17:36:59 -0700739 Should Be Equal As Integers ${rc1} 0
740 Should Be Equal As Integers ${devices} ${count}
741
742Wait for ONUs in VOLTHA
743 [Arguments] ${count}
744 [Documentation] Waits until a certain number of devices reached the ACTIVE/ENABLE state
745 Wait Until Keyword Succeeds 10m 5s Assert ONUs In Voltha ${count}
746
747Count Logical Devices flows
748 [Documentation] Count the flows across logical devices in VOLTHA
749 [Arguments] ${targetFlows}
750 ${output}= Get Logical Device List From Voltha
751 ${logical_devices}= To Json ${output}
752 ${total_flows}= Set Variable 0
753 FOR ${device} IN @{logical_devices}
754 ${rc} ${flows}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800755 ... voltctl -c ${VOLTCTL_CONFIG} logicaldevice flows ${device['id']} | grep -v ID | wc -l
Matteo Scandolo142e6272020-04-29 17:36:59 -0700756 Should Be Equal As Integers ${rc} 0
757 ${total_flows}= Evaluate ${total_flows} + ${flows}
758 END
Matteo Scandolo616daab2020-05-13 11:49:24 -0700759 ${msg}= Format String Found {total_flows} flows of {targetFlows} expected
760 ... total_flows=${total_flows} targetFlows=${targetFlows}
761 Log ${msg}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700762 Should Be Equal As Integers ${targetFlows} ${total_flows}
763
764Wait for Logical Devices flows
765 [Documentation] Waits until the flows have been provisioned in the logical device
766 [Arguments] ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200767 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700768 ${targetFlows}= Calculate flows by workflow ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200769 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo142e6272020-04-29 17:36:59 -0700770 Log ${targetFlows}
771 # TODO extend Validate Logical Device Flows to check the correct number of flows
772 Wait Until Keyword Succeeds 10m 5s Count Logical Devices flows ${targetFlows}
773
Matteo Scandolo616daab2020-05-13 11:49:24 -0700774Count OpenOLT Device Flows
775 [Documentation] Count the flows across openolt devices in VOLTHA
776 [Arguments] ${targetFlows}
777 ${output}= Get Device List from Voltha by type openolt
778 ${devices}= To Json ${output}
779 ${total_flows}= Set Variable 0
780 FOR ${device} IN @{devices}
781 ${rc} ${flows}= Run and Return Rc and Output
Matteo Scandolo5899be12020-11-11 15:38:07 -0800782 ... voltctl -c ${VOLTCTL_CONFIG} device flows ${device['id']} | grep -v ID | wc -l
Matteo Scandolo616daab2020-05-13 11:49:24 -0700783 Should Be Equal As Integers ${rc} 0
784 ${total_flows}= Evaluate ${total_flows} + ${flows}
785 END
786 ${msg}= Format String Found {total_flows} flows of {targetFlows} expected
787 ... total_flows=${total_flows} targetFlows=${targetFlows}
788 Log ${msg}
789 Should Be Equal As Integers ${targetFlows} ${total_flows}
790
791Wait for OpenOLT Devices flows
792 [Documentation] Waits until the flows have been provisioned in the openolt devices
793 [Arguments] ${workflow} ${uni_count} ${olt_count} ${provisioned}
Andrea Campanella70cf0a72020-05-27 10:55:15 +0200794 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700795 ${beforeFlows}= Calculate flows by workflow ${workflow} ${uni_count} ${olt_count} ${provisioned}
796 ... ${withEapol} ${withDhcp} ${withIgmp} ${withLldp}
Matteo Scandoloda854b02020-09-01 16:20:51 -0700797 # In the physical device we only have 2 data plane flows (on the PON) instead of 4
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700798 ${afterFlows}= Evaluate ${beforeFlows} - (${uni_count} * 2)
Matteo Scandoloda854b02020-09-01 16:20:51 -0700799 # In the TT workflow we have multiple service,
800 # so we need to remove 6 flows per each UNI that are only on the ONU device
801 ${ttFlows}= Evaluate ${beforeFlows} - (${uni_count} * 6)
802 ${afterFlows}= Set Variable If $workflow=='tt' ${ttFlows} ${afterFlows}
Matteo Scandolo96dbe432020-05-28 10:51:57 -0700803 ${targetFlows}= Set Variable If $provisioned=='true' ${afterFlows} ${beforeFlows}
Matteo Scandolo616daab2020-05-13 11:49:24 -0700804 Log ${targetFlows}
Hardik Windlass2b37e712020-06-12 02:13:17 +0530805 Wait Until Keyword Succeeds 10m 5s Count OpenOLT Device Flows ${targetFlows}
Hardik Windlass17bd1142021-03-12 08:15:25 +0000806
807Download ONU Device Image
808 [Documentation] Downloads the given ONU software image
809 [Arguments] ${id} ${image} ${url} ${ver} ${crc} ${local_dir}
810 ${rc}= Run and Return Rc
811 ... voltctl -c ${VOLTCTL_CONFIG} device image download ${id} ${image} ${url} ${ver} ${crc} ${local_dir}
812 Should Be Equal As Integers ${rc} 0
813
814Activate ONU Device Image
815 [Documentation] Activatess the given ONU software image
816 [Arguments] ${id} ${image} ${ver} ${crc} ${local_dir}
817 ${rc}= Run and Return Rc
818 ... voltctl -c ${VOLTCTL_CONFIG} device image activate ${id} ${image} ${ver} ${crc} ${local_dir}
819 Should Be Equal As Integers ${rc} 0
820
821Verify ONU Device Image
822 [Documentation] Verfies the ONU device image state
823 [Arguments] ${dev_id} ${download_state} ${image_state} ${expected_reason}
824 ${rc} ${output}= Run and Return Rc and Output
825 ... voltctl -c ${VOLTCTL_CONFIG} device image list ${dev_id} -o json
826 Should Be Equal As Integers ${rc} 0
827 ${jsondata}= To Json ${output}
828 Log ${jsondata}
829 ${length}= Get Length ${jsondata}
830 ${matched}= Set Variable False
831 FOR ${INDEX} IN RANGE 0 ${length}
832 ${value}= Get From List ${jsondata} ${INDEX}
833 ${id}= Get From Dictionary ${value} id
834 ${downloadstate}= Get From Dictionary ${value} downloadState
835 ${imagestate}= Get From Dictionary ${value} imageState
836 ${reason}= Get From Dictionary ${value} reason
837 ${matched}= Set Variable If '${id}' == '${dev_id}' True False
838 Exit For Loop If ${matched}
839 END
840 Should Be True ${matched} No ONU Device Image for Id: ${dev_id}
841 Should Be Equal '${downloadstate}' '${download_state}' ONU Device ${id} Image downloadState does not match
842 Should Be Equal '${imagestate}' '${image_state}' ONU Device ${id} Image imageState does not match
843 Should Be Equal '${reason}' '${expected_reason}' ONU Device ${id} Image reason does not match
TorstenThiemeff9c9142021-04-08 07:21:34 +0000844
845
846# pm-data relevant keywords
847Read Default Interval From Pmconfig
848 [Documentation] Reads default interval from pm config
849 [Arguments] ${device_id}
850 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig get ${device_id}
851 Should Be Equal As Integers ${rc} 0
852 log ${result}
853 @{words}= Split String ${result}
854 ${interval}= Get From List ${words} 3
855 log ${interval}
856 [return] ${interval}
857
858Read Group Interval From Pmconfig
859 [Documentation] Reads default interval from pm config
860 [Arguments] ${device_id} ${group}
861 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group list ${device_id} | grep ${group}
862 Should Be Equal As Integers ${rc} 0
863 log ${result}
864 @{words}= Split String ${result}
865 ${interval}= Get From List ${words} -1
866 log ${interval}
867 [return] ${interval}
868
869Set and Validate Default Interval
870 [Documentation] Sets and validates default interval of pm data
871 [Arguments] ${device_id} ${interval}
872 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig frequency set ${device_id} ${interval}
873 Should Be Equal As Integers ${rc} 0
874 log ${result}
875 # workaround until unit will be printed out in voltctl - remove unit
876 ${interval}= Get Substring ${interval} 0 -1
877 Should Contain ${result} ${interval}
878
879Set and Validate Group Interval
880 [Documentation] Sets and validates group interval of pm data
881 [Arguments] ${device_id} ${interval} ${group}
882 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group set ${device_id} ${group} ${interval}
883 Should Be Equal As Integers ${rc} 0
884 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group list ${device_id} | grep ${group}
885 Should Be Equal As Integers ${rc} 0
886 log ${result}
887 # workaround until unit will be printed out in voltctl - remove unit
888 ${interval}= Get Substring ${interval} 0 -1
889 Should Contain ${result} ${interval}
890
891Read Group List
892 [Documentation] Reads metric group list of given device
893 [Arguments] ${device_id}
894 ${rc} ${result}= Run and Return Rc and Output voltctl device pmconfig group list ${device_id} | grep -v GROUPNAME
895 Should Be Equal As Integers ${rc} 0
896 ${group_list} Create List
897 ${interval_dict} Create Dictionary
898 @{output}= Split String ${result} \n
899 FOR ${Line} IN @{output}
900 @{words}= Split String ${Line}
901 ${group}= Set Variable ${words[0]}
902 ${interval}= Set Variable ${words[2]}
903 Append To List ${group_list} ${group}
904 Set To Dictionary ${interval_dict} ${group}=${interval}
905 END
906 [return] ${group_list} ${interval_dict}
907
908Read Group Metric List
909 [Documentation] Reads group metric list of given device and group
910 [Arguments] ${device_id} ${group}
911 ${cmd}= Catenate voltctl device pmconfig groupmetric list ${device_id} ${group} | grep -v SAMPLEFREQ
912 ${rc} ${result}= Run and Return Rc and Output ${cmd}
913 Should Be Equal As Integers ${rc} 0
914 ${groupmetric_list} Create List
915 @{output}= Split String ${result} \n
916 FOR ${Line} IN @{output}
917 @{words}= Split String ${Line}
918 ${name}= Set Variable ${words[0]}
919 ${type}= Set Variable ${words[1]}
920 ${enabled}= Set Variable ${words[2]}
921 ${subdict}= Create Dictionary type=${type} enabled=${enabled}
922 ${dict}= Create Dictionary ${name}=${subdict}
923 Append To List ${groupmetric_list} ${dict}
924 END
925 [return] ${groupmetric_list}
926
927Read Group Metric Dict
928 [Documentation] Reads group metric list of given device and group
929 [Arguments] ${device_id} ${group}
930 ${cmd}= Catenate voltctl device pmconfig groupmetric list ${device_id} ${group} | grep -v SAMPLEFREQ
931 ${rc} ${result}= Run and Return Rc and Output ${cmd}
932 Should Be Equal As Integers ${rc} 0
933 ${groupmetric_dict} Create Dictionary
934 @{output}= Split String ${result} \n
935 FOR ${Line} IN @{output}
936 @{words}= Split String ${Line}
937 ${name}= Set Variable ${words[0]}
938 ${type}= Set Variable ${words[1]}
939 ${enabled}= Set Variable ${words[2]}
940 ${subdict}= Create Dictionary type=${type} enabled=${enabled}
941 Set To Dictionary ${groupmetric_dict} ${name}=${subdict}
942 END
943 [return] ${groupmetric_dict}