2 Documentation BGP performance of ingesting from 1 iBGP peer, data change counter is used.
4 ... Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
6 ... This program and the accompanying materials are made available under the
7 ... terms of the Eclipse Public License v1.0 which accompanies this distribution,
8 ... and is available at http://www.eclipse.org/legal/epl-v10.html
11 ... This suite uses play.py as single iBGP peer.
12 ... The suite only looks at example-ipv4-topology, so RIB is not examined.
14 ... This suite requires odl-bgpcep-data-change-counter to be installed so
15 ... make sure it is added to "install-features" of any jobs that are going
18 ... The suite consists of two halves, differing on which side initiates BGP connection.
19 ... Data change counter is a lightweight way to detect "work is being done".
20 ... WaitUtils provide a nice Keyword to wait for stability, but it needs
21 ... initial value, that is why Store_Change_Count appears just before work-inducing action.
22 ... The time for Wait_For_Stable_* cases to finish is the main performance metric.
23 ... After waiting for stability is done, full check on number of prefixes present is performed.
25 ... Brief description how to configure BGP peer can be found here:
26 ... https://wiki.opendaylight.org/view/BGP_LS_PCEP:User_Guide#BGP_Peer
27 ... http://docs.opendaylight.org/en/stable-boron/user-guide/bgp-user-guide.html#bgp-peering
29 ... TODO: Currently, if a bug causes zero increase of data changes,
30 ... affected test cases will wait for max time. Reconsider.
31 ... If zero increase is allowed as stable, higher number of repetitions should be required.
33 ... Additionally this test suite is not compatible with Helium and Hydrogen
34 ... releases as they don't include data change counter feature.
35 ... Use the other version of the suite (singlepeer_prefixcount.robot) to test them.
36 Suite Setup Setup_Everything
37 Suite Teardown Teardown_Everything
38 Test Setup SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
39 Test Teardown SetupUtils.Teardown_Test_Show_Bugs_And_Start_Fast_Failing_If_Test_Failed
40 Library SSHLibrary timeout=10s
41 Library RequestsLibrary
42 Resource ../../../libraries/BGPSpeaker.robot
43 Resource ../../../libraries/ChangeCounter.robot
44 Resource ../../../libraries/FailFast.robot
45 Resource ../../../libraries/KillPythonTool.robot
46 Resource ../../../libraries/PrefixCounting.robot
47 Resource ../../../libraries/SetupUtils.robot
48 Resource ../../../libraries/SSHKeywords.robot
49 Resource ../../../libraries/TemplatedRequests.robot
50 Resource ../../../libraries/Utils.robot
51 Resource ../../../variables/Variables.robot
54 ${BGP_TOOL_LOG_LEVEL} info
55 ${BGP_VARIABLES_FOLDER} ${CURDIR}/../../../variables/bgpuser/
57 ${CHECK_PERIOD_CHANGE_COUNT} ${CHECK_PERIOD}
58 ${CHECK_PERIOD_CHANGE_COUNT_SINGLE} ${CHECK_PERIOD_CHANGE_COUNT}
60 ${COUNT_CHANGE_COUNT} ${COUNT}
61 ${COUNT_CHANGE_COUNT_SINGLE} ${COUNT_CHANGE_COUNT}
63 ${HOLDTIME_CHANGE_COUNT} ${HOLDTIME}
64 ${HOLDTIME_CHANGE_COUNT_SINGLE} ${HOLDTIME_CHANGE_COUNT}
68 ${REPETITIONS_CHANGE_COUNT} ${REPETITIONS}
69 ${REPETITIONS_CHANGE_COUNT_SINGLE} ${REPETITIONS_CHANGE_COUNT}
70 ${RESULTS_FILE_NAME} bgp.csv
71 ${TEST_DURATION_MULTIPLIER} 1
72 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT} ${TEST_DURATION_MULTIPLIER}
73 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_SINGLE} ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}
76 ${RIB_INSTANCE} example-bgp-rib
77 ${PROTOCOL_OPENCONFIG} ${RIB_INSTANCE}
78 ${DEVICE_NAME} controller-config
79 ${BGP_PEER_NAME} example-bgp-peer
80 # TODO: Option names can be better.
81 ${last_change_count_single} 1
84 Check_For_Empty_Ipv4_Topology_Before_Talking
85 [Documentation] Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
87 # TODO: Choose which tags to assign and make sure they are assigned correctly.
88 BuiltIn.Wait_Until_Keyword_Succeeds 120s 1s PrefixCounting.Check_Ipv4_Topology_Is_Empty
90 Reconfigure_ODL_To_Accept_Connection
91 [Documentation] Configure BGP peer module with initiate-connection set to false.
92 &{mapping} Create Dictionary DEVICE_NAME=${DEVICE_NAME} BGP_NAME=${BGP_PEER_NAME} IP=${TOOLS_SYSTEM_IP} HOLDTIME=${HOLDTIME_CHANGE_COUNT_SINGLE} PEER_PORT=${BGP_TOOL_PORT}
93 ... INITIATE=false BGP_RIB=${RIB_INSTANCE} PASSIVE_MODE=true BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG} RIB_INSTANCE_NAME=${RIB_INSTANCE}
94 TemplatedRequests.Put_As_Xml_Templated ${BGP_VARIABLES_FOLDER}${/}bgp_peer mapping=${mapping}
96 Reconfigure_Data_Change_Counter
97 [Documentation] Configure data change counter to count transactions in example-ipv4-topology instead of example-linkstate-topology.
98 ChangeCounter.Reconfigure_Topology_Name example-ipv4-topology
100 Verify_Data_Change_Counter_Ready
101 [Documentation] Data change counter might have been slower to start than ipv4 topology, wait for it.
102 BuiltIn.Wait_Until_Keyword_Succeeds 5x 1s ChangeCounter.Get_Change_Count
104 Start_Talking_BGP_Speaker
105 [Documentation] Start Python speaker to connect to ODL.
107 # Myport value is needed for checking whether connection at precise port was established.
108 BGPSpeaker.Start_BGP_Speaker --amount ${COUNT_CHANGE_COUNT_SINGLE} --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --insert=${INSERT} --withdraw=${WITHDRAW} --prefill ${PREFILL} --update ${UPDATE} --${BGP_TOOL_LOG_LEVEL} --results ${RESULTS_FILE_NAME}
110 Wait_For_Stable_Talking_Ipv4_Topology
111 [Documentation] Wait until example-ipv4-topology becomes stable. This is done by checking the change counter.
112 ChangeCounter.Wait_For_Change_Count_To_Become_Stable timeout=${bgp_filling_timeout} period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE} repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE} count_to_overcome=${last_change_count_single}
114 Check_Talking_Ipv4_Topology_Count
115 [Documentation] Count the routes in example-ipv4-topology and fail if the count is not correct.
117 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
118 PrefixCounting.Check_Ipv4_Topology_Count ${COUNT_CHANGE_COUNT_SINGLE}
120 Kill_Talking_BGP_Speaker
121 [Documentation] Abort the Python speaker. Also, attempt to stop failing fast.
123 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
125 BGPSpeaker.Kill_BGP_Speaker
126 FailFast.Do_Not_Fail_Fast_From_Now_On
127 # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
128 [Teardown] SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
130 Store_Results_For_Talking_BGP_Speaker
131 [Documentation] Store results for plotting
132 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
133 Store_File_To_Workspace totals-${RESULTS_FILE_NAME} totals-${RESULTS_FILE_NAME}
134 Store_File_To_Workspace performance-${RESULTS_FILE_NAME} performance-${RESULTS_FILE_NAME}
135 Store_File_To_Workspace totals-${RESULTS_FILE_NAME} changecount-talking-totals-${RESULTS_FILE_NAME}
136 Store_File_To_Workspace performance-${RESULTS_FILE_NAME} changecount-talking-performance-${RESULTS_FILE_NAME}
138 Wait_For_Stable_Ipv4_Topology_After_Talking
139 [Documentation] Wait until example-ipv4-topology becomes stable again.
141 ChangeCounter.Wait_For_Change_Count_To_Become_Stable timeout=${bgp_emptying_timeout} period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE} repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE} count_to_overcome=${last_change_count_single}
143 Check_For_Empty_Ipv4_Topology_After_Talking
144 [Documentation] Example-ipv4-topology should be empty now.
146 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
147 PrefixCounting.Check_Ipv4_Topology_Is_Empty
149 Start_Listening_BGP_Speaker
150 [Documentation] Start Python speaker in listening mode.
151 BGPSpeaker.Start_BGP_Speaker --amount ${COUNT_CHANGE_COUNT_SINGLE} --listen --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --insert=${INSERT} --withdraw=${WITHDRAW} --prefill ${PREFILL} --update ${UPDATE} --${BGP_TOOL_LOG_LEVEL} --results ${RESULTS_FILE_NAME}
153 Reconfigure_ODL_To_Initiate_Connection
154 [Documentation] Replace BGP peer config module, now with initiate-connection set to true.
156 &{mapping} Create Dictionary DEVICE_NAME=${DEVICE_NAME} BGP_NAME=${BGP_PEER_NAME} IP=${TOOLS_SYSTEM_IP} HOLDTIME=${HOLDTIME_CHANGE_COUNT_SINGLE} PEER_PORT=${BGP_TOOL_PORT}
157 ... INITIATE=true BGP_RIB=${RIB_INSTANCE} PASSIVE_MODE=false BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG} RIB_INSTANCE_NAME=${RIB_INSTANCE}
158 TemplatedRequests.Put_As_Xml_Templated ${BGP_VARIABLES_FOLDER}${/}bgp_peer mapping=${mapping}
160 Wait_For_Stable_Listening_Ipv4_Topology
161 [Documentation] Wait until example-ipv4-topology becomes stable.
162 ChangeCounter.Wait_For_Change_Count_To_Become_Stable timeout=${bgp_filling_timeout} period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE} repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE} count_to_overcome=${last_change_count_single}
164 Check_Listening_Ipv4_Topology_Count
165 [Documentation] Count the routes in example-ipv4-topology and fail if the count is not correct.
167 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
168 PrefixCounting.Check_Ipv4_Topology_Count ${COUNT_CHANGE_COUNT_SINGLE}
170 Kill_Listening_BGP_Speaker
171 [Documentation] Abort the Python speaker. Also, attempt to stop failing fast.
173 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
175 BGPSpeaker.Kill_BGP_Speaker
176 FailFast.Do_Not_Fail_Fast_From_Now_On
177 # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
178 [Teardown] SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
180 Store_Results_For_Listening_BGP_Speaker
181 [Documentation] Store results for plotting
182 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
183 Store_File_To_Workspace totals-${RESULTS_FILE_NAME} totals-${RESULTS_FILE_NAME}
184 Store_File_To_Workspace performance-${RESULTS_FILE_NAME} performance-${RESULTS_FILE_NAME}
185 Store_File_To_Workspace totals-${RESULTS_FILE_NAME} changecount-listening-totals-${RESULTS_FILE_NAME}
186 Store_File_To_Workspace performance-${RESULTS_FILE_NAME} changecount-listening-performance-${RESULTS_FILE_NAME}
188 Wait_For_Stable_Ipv4_Topology_After_Listening
189 [Documentation] Wait until example-ipv4-topology becomes stable again.
191 ChangeCounter.Wait_For_Change_Count_To_Become_Stable timeout=${bgp_emptying_timeout} period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE} repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE} count_to_overcome=${last_change_count_single}
193 Check_For_Empty_Ipv4_Topology_After_Listening
194 [Documentation] Example-ipv4-topology should be empty now.
196 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
197 PrefixCounting.Check_Ipv4_Topology_Is_Empty
199 Restore_Data_Change_Counter_Configuration
200 [Documentation] Configure data change counter back to count transactions affecting example-linkstate-topology.
201 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
202 ChangeCounter.Reconfigure_Topology_Name example-linkstate-topology
204 Delete_Bgp_Peer_Configuration
205 [Documentation] Revert the BGP configuration to the original state: without any configured peers.
206 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
207 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} BGP_NAME=${BGP_PEER_NAME} IP=${TOOLS_SYSTEM_IP} BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
208 TemplatedRequests.Delete_Templated ${BGP_VARIABLES_FOLDER}${/}bgp_peer mapping=${mapping}
212 [Documentation] Setup imported resources, SSH-login to tools system,
213 ... create HTTP session, put Python tool to tools system.
214 SetupUtils.Setup_Utils_For_Setup_And_Teardown
215 TemplatedRequests.Create_Default_Session
216 ChangeCounter.CC_Setup
217 PrefixCounting.PC_Setup
218 RequestsLibrary.Create_Session operational http://${ODL_SYSTEM_IP}:${RESTCONFPORT} auth=${AUTH} timeout=125 max_retries=0
219 # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
220 # TODO: Alternatively, create variable in Variables which starts with http.
221 # Both TODOs would probably need to update every suite relying on current Variables.
222 SSHLibrary.Set_Default_Configuration prompt=${TOOLS_SYSTEM_PROMPT}
223 SSHLibrary.Open_Connection ${TOOLS_SYSTEM_IP}
224 SSHKeywords.Flexible_Mininet_Login
225 SSHKeywords.Require_Python
226 SSHKeywords.Assure_Library_Ipaddr target_dir=.
227 SSHLibrary.Put_File ${CURDIR}/../../../../tools/fastbgp/play.py
228 # Calculate the timeout value based on how many routes are going to be pushed
229 # TODO: Unify formulas with other suites in this directory.
230 ${timeout} = BuiltIn.Evaluate ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_SINGLE} * (${COUNT_CHANGE_COUNT_SINGLE} * 9.0 / 10000 + 20)
231 Builtin.Set_Suite_Variable ${bgp_filling_timeout} ${timeout}
232 Builtin.Set_Suite_Variable ${bgp_emptying_timeout} ${bgp_filling_timeout*3.0/4}
235 [Documentation] Make sure Python tool was killed and tear down imported Resources.
236 # Environment issue may have dropped the SSH connection, but we do not want Teardown to fail.
237 BuiltIn.Run_Keyword_And_Ignore_Error KillPythonTool.Search_And_Kill_Remote_Python 'play\.py'
238 BuiltIn.Run_Keyword_And_Ignore_Error Utils.Get_Sysstat_Statistics
239 RequestsLibrary.Delete_All_Sessions
240 SSHLibrary.Close_All_Connections
243 [Documentation] Get the count of changes from BGP change counter. Ignore error or store the value.
244 ${status} ${count} = BuiltIn.Run_Keyword_And_Ignore_Error ChangeCounter.Get_Change_Count
245 BuiltIn.Run_Keyword_If '${status}' == 'PASS' BuiltIn.Set_Suite_Variable ${last_change_count_single} ${count}
247 Store_File_To_Workspace
248 [Arguments] ${src_file_name} ${dst_file_name}
249 [Documentation] Store the provided file from the SSH client to workspace.
250 ${files}= SSHLibrary.List Files In Directory .
251 ${output_log}= SSHLibrary.Execute_Command cat ${src_file_name}
252 BuiltIn.Log ${output_log}
253 Create File ${dst_file_name} ${output_log}