2 Documentation Basic tests for eBGP application peers.
4 ... Copyright (c) 2015-2016 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 eBGP functional tests:
11 ... Two eBGP peers advertise the same group of prefixes (aka BGP HA)
12 ... https://wiki.opendaylight.org/view/BGP_LS_PCEP:BGP
14 ... Bug 4834 - ODL controller announces the same route twice (two eBGP scenario aka HA)
15 ... Bug 4835 - Routes not withdrawn when eBGP peers are disconnected (the same prefixes announced)
17 ... TODO: Extend testsuite by tests dedicated to path selection algorithm
18 ... TODO: Choose keywords used by more than one test suite to be placed in a common place.
19 Suite Setup Setup_Everything
20 Suite Teardown BgpOperations.Teardown_Everything
21 Test Setup SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
22 Test Teardown FailFast.Start_Failing_Fast_If_This_Failed
24 Library OperatingSystem
25 Library RequestsLibrary
26 Variables ${CURDIR}/../../../variables/Variables.py
27 Variables ${CURDIR}/../../../variables/bgpuser/variables.py ${TOOLS_SYSTEM_IP} ${ODL_STREAM}
28 Resource ${CURDIR}/../../../libraries/BGPcliKeywords.robot
29 Resource ${CURDIR}/../../../libraries/BgpOperations.robot
30 Resource ${CURDIR}/../../../libraries/BGPSpeaker.robot
31 Resource ${CURDIR}/../../../libraries/FailFast.robot
32 Resource ${CURDIR}/../../../libraries/KillPythonTool.robot
33 Resource ${CURDIR}/../../../libraries/SetupUtils.robot
34 Resource ${CURDIR}/../../../libraries/SSHKeywords.robot
35 Resource ${CURDIR}/../../../libraries/TemplatedRequests.robot
36 Resource ${CURDIR}/../../../libraries/Utils.robot
37 Resource ${CURDIR}/../../../libraries/WaitForFailure.robot
40 ${BGP_VARIABLES_FOLDER} ${CURDIR}/../../../variables/bgpuser/
42 ${BGP_PEER_LOG_LEVEL} debug
44 ${ODL_BGP_LOG_LEVEL} DEFAULT
45 ${iBGP_PEER1_IP} 127.0.0.1
46 ${eBGP_PEER1_IP} 127.0.0.3
47 ${eBGP_PEER2_IP} 127.0.0.4
48 ${iBGP_PEER1_FIRST_PREFIX_IP} 8.1.0.0
49 ${eBGP_PEERS_FIRST_PREFIX_IP} 8.0.0.0
50 ${eBGP_PEER1_FIRST_PREFIX_IP} ${eBGP_PEERS_FIRST_PREFIX_IP}
51 ${eBGP_PEER2_FIRST_PREFIX_IP} ${eBGP_PEERS_FIRST_PREFIX_IP}
52 ${eBGP_PEER1_NEXT_HOP} 1.1.1.1
53 ${eBGP_PEER2_NEXT_HOP} 2.2.2.2
55 ${iBGP_PEER1_PREFIX_LEN} ${PREFIX_LEN}
56 ${eBGP_PEER1_PREFIX_LEN} ${PREFIX_LEN}
57 ${eBGP_PEER2_PREFIX_LEN} ${PREFIX_LEN}
59 ${iBGP_PEER1_PREFIX_COUNT} 0
60 ${eBGP_PEER1_PREFIX_COUNT} ${PREFIX_COUNT}
61 ${eBGP_PEER2_PREFIX_COUNT} ${PREFIX_COUNT}
62 ${eBGP_PEERS_AS} 32768
63 ${eBGP_PEER1_AS} ${eBGP_PEERS_AS}
64 ${eBGP_PEER2_AS} ${eBGP_PEERS_AS}
65 ${iBGP_PEER1_LOG_FILE} bgp_peer1.log
66 ${eBGP_PEER1_LOG_FILE} ebgp_peer1.log
67 ${eBGP_PEER2_LOG_FILE} ebgp_peer2.log
68 ${iBGP_PEER1_COMMAND} python play.py --firstprefix ${iBGP_PEER1_FIRST_PREFIX_IP} --prefixlen ${iBGP_PEER1_PREFIX_LEN} --amount ${iBGP_PEER1_PREFIX_COUNT} --myip=${iBGP_PEER1_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --${BGP_PEER_LOG_LEVEL} --logfile ${iBGP_PEER1_LOG_FILE}
69 ${eBGP_PEER1_COMMAND} python play.py --firstprefix ${eBGP_PEER1_FIRST_PREFIX_IP} --prefixlen ${eBGP_PEER1_PREFIX_LEN} --amount ${eBGP_PEER1_PREFIX_COUNT} --myip=${eBGP_PEER1_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --nexthop ${eBGP_PEER1_NEXT_HOP} --asnumber ${eBGP_PEER1_AS} --${BGP_PEER_LOG_LEVEL} --logfile ${eBGP_PEER1_LOG_FILE}
70 ${eBGP_PEER2_COMMAND} python play.py --firstprefix ${eBGP_PEER2_FIRST_PREFIX_IP} --prefixlen ${eBGP_PEER2_PREFIX_LEN} --amount ${eBGP_PEER2_PREFIX_COUNT} --myip=${eBGP_PEER2_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --nexthop ${eBGP_PEER2_NEXT_HOP} --asnumber ${eBGP_PEER2_AS} --${BGP_PEER_LOG_LEVEL} --logfile ${eBGP_PEER2_LOG_FILE}
71 ${iBGP_PEER1_OPTIONS} &>${iBGP_PEER1_LOG_FILE}
72 ${eBGP_PEER1_OPTIONS} &>${eBGP_PEER1_LOG_FILE}
73 ${eBGP_PEER2_OPTIONS} &>${eBGP_PEER2_LOG_FILE}
74 ${DEFAULT_LOG_CHECK_TIMEOUT} 20s
75 ${DEFAULT_LOG_CHECK_PERIOD} 1s
76 ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT} 10s
77 ${DEFAULT_TOPOLOGY_CHECK_PERIOD} 1s
78 ${RIB_INSTANCE} example-bgp-rib
79 ${PROTOCOL_OPENCONFIG} ${RIB_INSTANCE}
80 ${DEVICE_NAME} controller-config
84 [Documentation] Configure an iBGP and two eBGP peers
86 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} NAME=example-ibgp-peer1 IP=${iBGP_PEER1_IP} HOLDTIME=${HOLDTIME} PEER_PORT=${BGP_TOOL_PORT}
87 ... PEER_ROLE=ibgp INITIATE=false BGP_RIB=${RIB_INSTANCE} PASSIVE_MODE=true BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG} RIB_INSTANCE_NAME=${RIB_INSTANCE}
89 TemplatedRequests.Put_As_Xml_Templated ${BGP_VARIABLES_FOLDER}${/}ibgp_peers mapping=${mapping}
90 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} NAME=example-ebgp-peer1 IP=${eBGP_PEER1_IP} HOLDTIME=${HOLDTIME} PEER_PORT=${BGP_TOOL_PORT}
91 ... PEER_ROLE=ebgp INITIATE=false BGP_RIB=${RIB_INSTANCE} PASSIVE_MODE=true BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG} RIB_INSTANCE_NAME=${RIB_INSTANCE}
92 ... RR_CLIENT=false AS_NUMBER=${eBGP_PEER1_AS}
93 TemplatedRequests.Put_As_Xml_Templated ${BGP_VARIABLES_FOLDER}${/}ebgp_peers mapping=${mapping}
94 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} NAME=example-ebgp-peer2 IP=${eBGP_PEER2_IP} HOLDTIME=${HOLDTIME} PEER_PORT=${BGP_TOOL_PORT}
95 ... PEER_ROLE=ebgp INITIATE=false BGP_RIB=${RIB_INSTANCE} PASSIVE_MODE=true BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG} RIB_INSTANCE_NAME=${RIB_INSTANCE}
96 ... RR_CLIENT=false AS_NUMBER=${eBGP_PEER2_AS}
97 TemplatedRequests.Put_As_Xml_Templated ${BGP_VARIABLES_FOLDER}${/}ebgp_peers mapping=${mapping}
100 [Documentation] Connect BGP peer
102 SSHLibrary.Switch Connection ibgp_peer1_console
103 Start_Console_Tool ${iBGP_PEER1_COMMAND} ${iBGP_PEER1_OPTIONS}
104 Read_And_Fail_If_Prompt_Is_Seen
105 BgpOperations.Check_Example_IPv4_Topology_Does_Not_Contain prefix
108 [Documentation] Connect BGP peer
110 SSHLibrary.Switch Connection ebgp_peer1_console
111 Start_Console_Tool ${eBGP_PEER1_COMMAND} ${eBGP_PEER1_OPTIONS}
112 Read_And_Fail_If_Prompt_Is_Seen
114 Check_IPv4_Topology_For_First_Path
115 [Documentation] The IPv4 topology shall contain the route announced by the first eBGP
116 BuiltIn.Wait_Until_Keyword_Succeeds ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT} ${DEFAULT_TOPOLOGY_CHECK_PERIOD} BgpOperations.Check_Example_IPv4_Topology_Content "node-id":"${eBGP_PEER1_NEXT_HOP}"
117 BgpOperations.Check_Example_IPv4_Topology_Content "prefix":"${eBGP_PEER1_FIRST_PREFIX_IP}/${PREFIX_LEN}"
119 iBGP_Check_Log_For_Introduced_Prefixes
120 [Documentation] Check incomming updates for introduced routes
122 SSHLibrary.Switch Connection ibgp_peer1_console
123 ${total_prefix_count}= BuiltIn.Evaluate ${eBGP_PEER1_PREFIX_COUNT}
124 BuiltIn.Wait_Until_Keyword_Succeeds ${DEFAULT_LOG_CHECK_TIMEOUT} ${DEFAULT_LOG_CHECK_PERIOD} Check_File_For_Word_Count ${iBGP_PEER1_LOG_FILE} nlri_prefix_received: ${total_prefix_count}
125 ${count}= Count_Key_Value_Pairs ${iBGP_PEER1_LOG_FILE} Network Address of Next Hop ${eBGP_PEER1_NEXT_HOP}
126 BuiltIn.Should_Be_Equal_As_Integers ${count} ${eBGP_PEER1_PREFIX_COUNT}
127 ${count}= Count_Key_Value_Pairs ${iBGP_PEER1_LOG_FILE} Network Address of Next Hop ${eBGP_PEER2_NEXT_HOP}
128 BuiltIn.Should_Be_Equal_As_Integers ${count} 0
131 [Documentation] Connect BGP peer and check empty topology
133 SSHLibrary.Switch Connection ebgp_peer2_console
134 Start_Console_Tool ${eBGP_PEER2_COMMAND} ${eBGP_PEER2_OPTIONS}
135 Read_And_Fail_If_Prompt_Is_Seen
137 Disconnect_eBGP_Peer1
138 [Documentation] Stop BGP peer, log topology and store logs
140 SSHLibrary.Switch Connection ebgp_peer1_console
142 Store_File_To_Workspace ${eBGP_PEER1_LOG_FILE} ${eBGP_PEER1_LOG_FILE}
144 Check_IPv4_Topology_For_Second_Path
145 [Documentation] The IPv4 topology shall contain the route announced by the second eBGP now
146 BuiltIn.Wait_Until_Keyword_Succeeds ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT} ${DEFAULT_TOPOLOGY_CHECK_PERIOD} BgpOperations.Check_Example_IPv4_Topology_Content "node-id":"${eBGP_PEER2_NEXT_HOP}"
147 BgpOperations.Check_Example_IPv4_Topology_Content "prefix":"${eBGP_PEER2_FIRST_PREFIX_IP}/${PREFIX_LEN}"
149 iBGP_Check_Log_For_Updated_Prefixes
150 [Documentation] Check incomming updates for updated routes
152 SSHLibrary.Switch Connection ibgp_peer1_console
153 ${total_prefix_count}= BuiltIn.Evaluate ${eBGP_PEER1_PREFIX_COUNT} + ${eBGP_PEER2_PREFIX_COUNT}
154 BuiltIn.Wait_Until_Keyword_Succeeds ${DEFAULT_LOG_CHECK_TIMEOUT} ${DEFAULT_LOG_CHECK_PERIOD} Check_File_For_Word_Count ${iBGP_PEER1_LOG_FILE} nlri_prefix_received: ${total_prefix_count}
155 ${count}= Count_Key_Value_Pairs ${iBGP_PEER1_LOG_FILE} Network Address of Next Hop ${eBGP_PEER1_NEXT_HOP}
156 BuiltIn.Should_Be_Equal_As_Integers ${count} ${eBGP_PEER1_PREFIX_COUNT}
157 ${count}= Count_Key_Value_Pairs ${iBGP_PEER1_LOG_FILE} Network Address of Next Hop ${eBGP_PEER2_NEXT_HOP}
158 BuiltIn.Should_Be_Equal_As_Integers ${count} ${eBGP_PEER2_PREFIX_COUNT}
159 [Teardown] Report_Failure_Due_To_Bug 4834
161 Disconnect_eBGP_Peer2
162 [Documentation] Stop BGP peer, store logs and wait for empty topology
164 SSHLibrary.Switch Connection ebgp_peer2_console
166 Store_File_To_Workspace ${eBGP_PEER2_LOG_FILE} ${eBGP_PEER2_LOG_FILE}
168 Check_For_Empty_IPv4_Topology
169 [Documentation] The IPv4 topology shall be empty
170 BuiltIn.Wait_Until_Keyword_Succeeds ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT} ${DEFAULT_TOPOLOGY_CHECK_PERIOD} BgpOperations.Check_Example_IPv4_Topology_Does_Not_Contain prefix
171 [Teardown] Report_Failure_Due_To_Bug 4835
173 iBGP_Check_Log_For_Withdrawn_Prefixes
174 [Documentation] Check incomming updates for withdrawn routes
176 SSHLibrary.Switch Connection ibgp_peer1_console
177 ${prefixes_to_be_removed}= BuiltIn.Evaluate max(${eBGP_PEER1_PREFIX_COUNT}, ${eBGP_PEER2_PREFIX_COUNT})
178 BuiltIn.Wait_Until_Keyword_Succeeds ${DEFAULT_LOG_CHECK_TIMEOUT} ${DEFAULT_LOG_CHECK_PERIOD} Check_File_For_Word_Count ${iBGP_PEER1_LOG_FILE} withdrawn_prefix_received: ${prefixes_to_be_removed}
179 [Teardown] Report_Failure_Due_To_Bug 4835
181 Disconnect_iBGP_Peer1
182 [Documentation] Stop BGP peer, log topology and store logs
184 SSHLibrary.Switch Connection ibgp_peer1_console
186 Store_File_To_Workspace ${iBGP_PEER1_LOG_FILE} ${iBGP_PEER1_LOG_FILE}
188 Delete_BGP_Peers_Configuration
189 [Documentation] Delete all previously configured BGP peers.
191 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} NAME=example-ibgp-peer1 IP=${iBGP_PEER1_IP} BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
192 TemplatedRequests.Delete_Templated ${BGP_VARIABLES_FOLDER}${/}ibgp_peers mapping=${mapping}
193 Collections.Set To Dictionary ${mapping} NAME=example-ebgp-peer1 IP=${eBGP_PEER1_IP}
194 TemplatedRequests.Delete_Templated ${BGP_VARIABLES_FOLDER}${/}ebgp_peers mapping=${mapping}
195 Collections.Set To Dictionary ${mapping} NAME=example-ebgp-peer2 IP=${eBGP_PEER2_IP}
196 TemplatedRequests.Delete_Templated ${BGP_VARIABLES_FOLDER}${/}ebgp_peers mapping=${mapping}
200 [Documentation] Initialize SetupUtils. SSH-login to mininet machine, create HTTP session,
201 ... prepare directories for responses, put Python tool to mininet machine, setup imported resources.
202 SetupUtils.Setup_Utils_For_Setup_And_Teardown
203 SSHLibrary.Set_Default_Configuration prompt=${ODL_SYSTEM_PROMPT}
204 SSHLibrary.Open_Connection ${ODL_SYSTEM_IP} alias=ibgp_peer1_console
205 Utils.Flexible_Controller_Login
206 SSHLibrary.Open_Connection ${ODL_SYSTEM_IP} alias=ebgp_peer1_console
207 Utils.Flexible_Controller_Login
208 SSHLibrary.Open_Connection ${ODL_SYSTEM_IP} alias=ebgp_peer2_console
209 Utils.Flexible_Controller_Login
210 SSHKeywords.Require_Python
211 SSHKeywords.Assure_Library_Ipaddr target_dir=.
212 SSHLibrary.Put_File ${CURDIR}/../../../../tools/fastbgp/play.py
213 RequestsLibrary.Create_Session operational http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_TOPO_API} auth=${AUTH}
214 TemplatedRequests.Create_Default_Session
215 KarafKeywords.Execute_Controller_Karaf_Command_On_Background log:set ${ODL_LOG_LEVEL}
216 KarafKeywords.Execute_Controller_Karaf_Command_On_Background log:set ${ODL_BGP_LOG_LEVEL} org.opendaylight.bgpcep
217 KarafKeywords.Execute_Controller_Karaf_Command_On_Background log:set ${ODL_BGP_LOG_LEVEL} org.opendaylight.protocol
219 Read_Text_Before_Prompt
220 [Documentation] Log text gathered by SSHLibrary.Read_Until_Prompt.
221 ... This needs to be a separate keyword just because how Read_And_Fail_If_Prompt_Is_Seen is implemented.
222 ${text}= SSHLibrary.Read_Until_Prompt
225 Store_File_To_Workspace
226 [Arguments] ${source_file_name} ${target_file_name}
227 [Documentation] Store the ${source_file_name} to the workspace as ${target_file_name}.
228 ${output_log}= SSHLibrary.Execute_Command cat ${source_file_name}
229 BuiltIn.Log ${output_log}
230 Create File ${target_file_name} ${output_log}