2 Documentation BGP performance of ingesting from 1 BGP application peer
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
10 ... Test suite performs basic BGP performance test cases for
11 ... BGP application peer. BGP application peer introduces routes -
12 ... using restconf - in two steps:
13 ... 1. introduces the ${PREFILL} number of routes in one POST request
14 ... 2. POSTs the rest of routes (up to the ${COUNT} number) one by one
15 ... Test suite checks that the prefixes are propagated to
16 ... IPv4 topology and announced to BGP peer via updates. Test case
17 ... where the BGP peer is disconnected and reconnected and all routes
18 ... are deleted by BGP application peer are performed as well.
19 ... Brief description how to configure BGP application peer and
20 ... how to use restconf application peer interface:
21 ... https://wiki.opendaylight.org/view/BGP_LS_PCEP:User_Guide#BGP_Application_Peer
22 ... https://wiki.opendaylight.org/view/BGP_LS_PCEP:Programmer_Guide#BGP
25 ... Bug 4689 - Not a reasonable duration of 1M prefix introduction from BGP application peer via restconf
26 ... Bug 4791 - BGPSessionImpl: Failed to send message Update logged even all UPDATE mesages received by iBGP peer
27 Suite Setup Setup_Everything
28 Suite Teardown Teardown_Everything
29 Test Setup SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
30 Test Teardown SetupUtils.Teardown_Test_Show_Bugs_And_Start_Fast_Failing_If_Test_Failed
32 Library SSHLibrary timeout=10s
33 Library RequestsLibrary
34 Variables ${CURDIR}/../../../variables/Variables.py
35 Resource ${CURDIR}/../../../libraries/BGPcliKeywords.robot
36 Resource ${CURDIR}/../../../libraries/BGPSpeaker.robot
37 Resource ${CURDIR}/../../../libraries/ConfigViaRestconf.robot
38 Resource ${CURDIR}/../../../libraries/FailFast.robot
39 Resource ${CURDIR}/../../../libraries/KillPythonTool.robot
40 Resource ${CURDIR}/../../../libraries/PrefixCounting.robot
41 Resource ${CURDIR}/../../../libraries/SetupUtils.robot
42 Resource ${CURDIR}/../../../libraries/SSHKeywords.robot
45 ${BGP_VARIABLES_FOLDER} ${CURDIR}/../../../variables/bgpuser/
47 ${HOLDTIME_APP_PEER_PREFIX_COUNT} ${HOLDTIME}
50 ${COUNT_APP_PEER_PREFIX_COUNT} ${COUNT}
52 ${CHECK_PERIOD_APP_PEER_PREFIX_COUNT} ${CHECK_PERIOD}
53 ${REPETITIONS_APP_PEER_PREFIX_COUNT} 1
54 ${BGP_PEER_LOG_LEVEL} info
55 ${BGP_APP_PEER_LOG_LEVEL} info
56 ${CONTROLLER_LOG_LEVEL} INFO
57 ${CONTROLLER_BGP_LOG_LEVEL} DEFAULT
58 ${BGP_PEER_COMMAND} python play.py --amount 0 --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --${BGP_PEER_LOG_LEVEL}
59 ${BGP_PEER_OPTIONS} &>bgp_peer.log
60 ${BGP_APP_PEER_ID} 10.0.0.10
61 ${BGP_APP_PEER_INITIAL_COMMAND} python bgp_app_peer.py --host ${ODL_SYSTEM_IP} --port ${RESTCONFPORT} --command post --count ${PREFILL} --prefix 8.0.0.0 --prefixlen 28 --${BGP_APP_PEER_LOG_LEVEL} --stream=${ODL_STREAM}
62 ${BGP_APP_PEER_PUT_COMMAND} python bgp_app_peer.py --host ${ODL_SYSTEM_IP} --port ${RESTCONFPORT} --command put --count ${PREFILL} --prefix 8.0.0.0 --prefixlen 28 --${BGP_APP_PEER_LOG_LEVEL} --stream=${ODL_STREAM}
63 ${BGP_APP_PEER_DELETE_ALL_COMMAND} python bgp_app_peer.py --host ${ODL_SYSTEM_IP} --port ${RESTCONFPORT} --command delete-all --${BGP_APP_PEER_LOG_LEVEL} --stream=${ODL_STREAM}
64 ${BGP_APP_PEER_GET_COMMAND} python bgp_app_peer.py --host ${ODL_SYSTEM_IP} --port ${RESTCONFPORT} --command get --${BGP_APP_PEER_LOG_LEVEL} --stream=${ODL_STREAM}
65 ${BGP_APP_PEER_OPTIONS} &>bgp_app_peer.log
66 ${TEST_DURATION_MULTIPLIER} 30
67 ${last_prefix_count} -1
70 Check_For_Empty_Ipv4_Topology_Before_Starting
71 [Documentation] Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
72 BuiltIn.Wait_Until_Keyword_Succeeds 120s 1s PrefixCounting.Check_Ipv4_Topology_Is_Empty
74 Reconfigure_ODL_To_Accept_Connection
75 [Documentation] Configure BGP peer module with initiate-connection set to false.
76 ${template_as_string}= BuiltIn.Set_Variable {'NAME': 'example-bgp-peer', 'IP': '${TOOLS_SYSTEM_IP}', 'HOLDTIME': '${HOLDTIME_APP_PEER_PREFIX_COUNT}', 'PEER_PORT': '${BGP_TOOL_PORT}', 'INITIATE': 'false'}
77 ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${BGP_VARIABLES_FOLDER}${/}bgp_peer ${template_as_string}
79 Reconfigure_ODL_To_Accept_BGP_Application_Peer
80 [Documentation] Configure BGP application peer module.
81 ${template_as_string}= BuiltIn.Set_Variable {'NAME': 'example-bgp-peer-app', 'IP': '${BGP_APP_PEER_ID}'}
82 ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf ${BGP_VARIABLES_FOLDER}${/}bgp_application_peer ${template_as_string}
85 [Documentation] Start BGP peer tool
86 SSHLibrary.Switch Connection bgp_peer_console
87 Start_Console_Tool ${BGP_PEER_COMMAND} ${BGP_PEER_OPTIONS}
88 Read_And_Fail_If_Prompt_Is_Seen
90 BGP_Application_Peer_Prefill_Routes
91 [Documentation] Start BGP application peer tool and prefill routes.
92 SSHLibrary.Switch Connection bgp_app_peer_console
93 Start_Console_Tool ${BGP_APP_PEER_INITIAL_COMMAND} ${BGP_APP_PEER_OPTIONS}
94 Wait_Until_Console_Tool_Finish ${bgp_filling_timeout}
95 Store_File_To_Workspace bgp_app_peer.log bgp_app_peer_prefill.log
97 Wait_For_Ipv4_Topology_Is_Prefilled
98 [Documentation] Wait until example-ipv4-topology reaches the target prfix count.
99 BuiltIn.Wait Until Keyword Succeeds ${bgp_filling_timeout} 10s PrefixCounting.Check_Ipv4_Topology_Count ${PREFILL}
101 Check_Bgp_Peer_Updates_For_Prefilled_Routes
102 [Documentation] Count the routes introduced by updates.
103 [Setup] SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
104 BuiltIn.Wait Until Keyword Succeeds ${bgp_filling_timeout} 1s Check_File_For_Word_Count bgp_peer.log total_received_nlri_prefix_counter: ${PREFILL} 2
106 BGP_Application_Peer_Introduce_Single_Routes
107 [Documentation] Start BGP application peer tool and introduce routes.
108 SSHLibrary.Switch Connection bgp_app_peer_console
109 Start_Console_Tool python bgp_app_peer.py --host ${ODL_SYSTEM_IP} --port ${RESTCONFPORT} --command add --count ${remaining_prefixes} --prefix 12.0.0.0 --prefixlen 28 --${BGP_APP_PEER_LOG_LEVEL} --stream=${ODL_STREAM} ${BGP_APP_PEER_OPTIONS}
110 Wait_Until_Console_Tool_Finish ${bgp_filling_timeout}
111 Store_File_To_Workspace bgp_app_peer.log bgp_app_peer_singles.log
113 Wait_For_Ipv4_Topology_Is_Filled
114 [Documentation] Wait until example-ipv4-topology reaches the target prfix count.
115 BuiltIn.Wait Until Keyword Succeeds ${bgp_filling_timeout} 10s PrefixCounting.Check_Ipv4_Topology_Count ${COUNT_APP_PEER_PREFIX_COUNT}
117 Check_Bgp_Peer_Updates_For_All_Routes
118 [Documentation] Count the routes introduced by updates.
119 [Setup] SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
120 BuiltIn.Wait Until Keyword Succeeds ${bgp_filling_timeout} 1s Check_File_For_Word_Count bgp_peer.log total_received_nlri_prefix_counter: ${COUNT_APP_PEER_PREFIX_COUNT} 2
123 [Documentation] Stop BGP peer tool
124 SSHLibrary.Switch Connection bgp_peer_console
126 Store_File_To_Workspace bgp_peer.log bgp_peer_reconnect.log
129 [Documentation] Start BGP peer tool
130 SSHLibrary.Switch Connection bgp_peer_console
131 Start_Console_Tool ${BGP_PEER_COMMAND} ${BGP_PEER_OPTIONS}
132 Read_And_Fail_If_Prompt_Is_Seen
134 Check_Bgp_Peer_Updates_For_Reintroduced_Routes
135 [Documentation] Count the routes introduced by updates.
136 [Setup] SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
137 BuiltIn.Wait Until Keyword Succeeds ${bgp_filling_timeout} 1s Check_File_For_Word_Count bgp_peer.log total_received_nlri_prefix_counter: ${COUNT_APP_PEER_PREFIX_COUNT} 2
139 BGP_Application_Peer_Delete_All_Routes
140 [Documentation] Start BGP application peer tool and delete all routes.
141 SSHLibrary.Switch Connection bgp_app_peer_console
142 Start_Console_Tool ${BGP_APP_PEER_DELETE_ALL_COMMAND} ${BGP_APP_PEER_OPTIONS}
143 Wait_Until_Console_Tool_Finish ${bgp_emptying_timeout}
144 Store_File_To_Workspace bgp_app_peer.log bgp_app_peer_delete_all.log
146 Wait_For_Stable_Topology_After_Deletion
147 [Documentation] Wait until example-ipv4-topology becomes stable again.
148 PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable timeout=${bgp_emptying_timeout} period=${CHECK_PERIOD_APP_PEER_PREFIX_COUNT} repetitions=${REPETITIONS_APP_PEER_PREFIX_COUNT} excluded_count=${COUNT_APP_PEER_PREFIX_COUNT}
150 Check_For_Empty_Ipv4_Topology_After_Deleting
151 [Documentation] Example-ipv4-topology should be empty now.
152 PrefixCounting.Check_Ipv4_Topology_Is_Empty
154 Check_Bgp_Peer_Updates_For_Prefix_Withdrawals
155 [Documentation] Count the routes withdrawn by updates.
156 [Setup] SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
157 BuiltIn.Wait Until Keyword Succeeds ${bgp_emptying_timeout} 1s Check_File_For_Word_Count bgp_peer.log total_received_withdrawn_prefix_counter: ${COUNT_APP_PEER_PREFIX_COUNT} 2
160 [Documentation] Stop BGP peer tool
161 SSHLibrary.Switch Connection bgp_peer_console
163 Store_File_To_Workspace bgp_peer.log bgp_peer_reconnect.log
165 Delete_Bgp_Peer_Configuration
166 [Documentation] Revert the BGP configuration to the original state: without any configured peers.
167 ${template_as_string}= BuiltIn.Set_Variable {'NAME': 'example-bgp-peer'}
168 ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf ${BGP_VARIABLES_FOLDER}${/}bgp_peer ${template_as_string}
170 Delete_Bgp_Application_Peer_Configuration
171 [Documentation] Revert the BGP configuration to the original state: without any configured peers.
172 ${template_as_string}= BuiltIn.Set_Variable {'NAME': 'example-bgp-peer-app'}
173 ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf ${BGP_VARIABLES_FOLDER}${/}bgp_application_peer ${template_as_string}
176 [Documentation] Check controller's log for errors
177 Check Karaf Log File Does Not Have Messages ${ODL_SYSTEM_IP} Failed to send message Update
181 [Documentation] Setup imported resources, SSH-login to tools system,
182 ... create HTTP session, put Python tool to tools system.
183 SetupUtils.Setup_Utils_For_Setup_And_Teardown
184 ConfigViaRestconf.Setup_Config_Via_Restconf
185 PrefixCounting.PC_Setup
186 SSHLibrary.Set_Default_Configuration prompt=${TOOLS_SYSTEM_PROMPT}
187 RequestsLibrary.Create_Session operational http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_API} auth=${AUTH}
188 # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
189 # TODO: Alternatively, create variable in Variables which starts with http.
190 # Both TODOs would probably need to update every suite relying on current Variables.
191 Open_BGP_Peer_Console
192 Open_BGP_Aplicationp_Peer_Console
193 SSHKeywords.Require_Python
194 SSHKeywords.Assure_Library_Ipaddr target_dir=.
195 SSHLibrary.Put_File ${CURDIR}/../../../../tools/fastbgp/play.py
196 SSHLibrary.Put_File ${CURDIR}/../../../../tools/fastbgp/bgp_app_peer.py
197 SSHLibrary.Put_File ${CURDIR}/../../../../tools/fastbgp/ipv4-routes-template.xml*
198 # Calculate the timeout value based on how many routes are going to be pushed.
199 # The offset (20) is set for keeping reasonable timeout for low COUNT values.
200 ${timeout} = BuiltIn.Evaluate ${TEST_DURATION_MULTIPLIER} * ${COUNT_APP_PEER_PREFIX_COUNT} * 3.0 / 10000 + 20
201 Builtin.Set_Suite_Variable ${bgp_filling_timeout} ${timeout}
202 Builtin.Set_Suite_Variable ${bgp_emptying_timeout} ${bgp_filling_timeout*3.0/4}
203 ${result} = BuiltIn.Evaluate str(int(${COUNT_APP_PEER_PREFIX_COUNT}) - int(${PREFILL}))
204 Builtin.Set_Suite_Variable ${remaining_prefixes} ${result}
205 KarafKeywords.Execute_Controller_Karaf_Command_On_Background log:set ${CONTROLLER_LOG_LEVEL}
206 KarafKeywords.Execute_Controller_Karaf_Command_On_Background log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.bgpcep
207 KarafKeywords.Execute_Controller_Karaf_Command_On_Background log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.protocol
210 [Documentation] Make sure Python tool was killed and tear down imported Resources.
211 SSHLibrary.Switch Connection bgp_peer_console
212 KillPythonTool.Search_And_Kill_Remote_Python 'play\.py'
213 KillPythonTool.Search_And_Kill_Remote_Python 'bgp_app_peer\.py'
214 ConfigViaRestconf.Teardown_Config_Via_Restconf
215 RequestsLibrary.Delete_All_Sessions
216 SSHLibrary.Close_All_Connections
218 Open_BGP_Peer_Console
219 [Documentation] Create a session for BGP peer.
220 SSHLibrary.Open_Connection ${TOOLS_SYSTEM_IP} alias=bgp_peer_console
221 Utils.Flexible_Mininet_Login
223 Open_BGP_Aplicationp_Peer_Console
224 [Documentation] Create a session for BGP peer.
225 SSHLibrary.Open_Connection ${TOOLS_SYSTEM_IP} alias=bgp_app_peer_console
226 Utils.Flexible_Mininet_Login