2 Documentation Functional test for bgp - route refresh
4 ... Copyright (c) 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 ... This suite tests sending and receiveing route request message.
11 ... It uses odl and exabgp as bgp peers.
12 ... Sending route refresh message from odl is initiated via restconf.
13 ... If route refresh received by odl also correct advertising of routes
14 ... is verified. Receiving of route refresh by odl is verified by
15 ... checking appropriate message counter via ${JOLOKURL}. Feature
16 ... odl-jolokia is required by this test suite.
17 Suite Setup Start_Suite
18 Suite Teardown Stop_Suite
19 Test Setup SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
20 Library RequestsLibrary
22 Variables ${CURDIR}/../../../variables/Variables.py
23 Resource ${CURDIR}/../../../libraries/ExaBgpLib.robot
24 Resource ${CURDIR}/../../../libraries/Utils.robot
25 Resource ${CURDIR}/../../../libraries/SetupUtils.robot
26 Resource ${CURDIR}/../../../libraries/TemplatedRequests.robot
27 Resource ${CURDIR}/../../../libraries/SSHKeywords.robot
28 Library ${CURDIR}/../../../libraries/BgpRpcClient.py ${TOOLS_SYSTEM_IP}
32 ${DEVICE_NAME} controller-config
33 ${BGP_PEER_NAME} example-bgp-peer
34 ${RIB_INSTANCE} example-bgp-rib
35 ${PROTOCOL_OPENCONFIG} ${RIB_INSTANCE}
36 ${APP_PEER_NAME} example-bgp-peer-app
37 ${BGP_VAR_FOLDER} ${CURDIR}/../../../variables/bgpfunctional
38 ${BGP_RR_VAR_FOLDER} ${BGP_VAR_FOLDER}/route_refresh
39 ${BGP_CFG_NAME} exa.cfg
40 ${CONFIG_SESSION} config-session
41 ${EXARPCSCRIPT} ${CURDIR}/../../../../tools/exabgp_files/exarpc.py
42 ${JOLOKURL} /jolokia/read/org.opendaylight.controller:instanceName=${BGP_PEER_NAME},type=RuntimeBean,moduleFactoryName=bgp-peer
46 [Documentation] Configures bgp application peer. Openconfig is used for carbon and above.
47 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} APP_PEER_NAME=${APP_PEER_NAME} RIB_INSTANCE_NAME=${RIB_INSTANCE} APP_PEER_ID=${ODL_SYSTEM_IP} BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
48 ... IP=${ODL_SYSTEM_IP}
49 TemplatedRequests.Put_As_Xml_Templated ${BGP_VAR_FOLDER}/app_peer mapping=${mapping} session=${CONFIG_SESSION}
51 Reconfigure_ODL_To_Accept_Connection
52 [Documentation] Configures BGP peer module with initiate-connection set to false.
53 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} BGP_NAME=${BGP_PEER_NAME} IP=${TOOLS_SYSTEM_IP} HOLDTIME=${HOLDTIME} PEER_PORT=${BGP_TOOL_PORT}
54 ... INITIATE=false RIB_INSTANCE_NAME=${RIB_INSTANCE} BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG} PASSIVE_MODE=true
55 TemplatedRequests.Put_As_Xml_Templated ${BGP_VAR_FOLDER}/bgp_peer mapping=${mapping} session=${CONFIG_SESSION}
57 Exa_To_Send_Route_Request
58 [Documentation] Exabgp sends route refresh and count received updates
59 [Setup] Configure_Routes_And_Start_ExaBgp ${BGP_CFG_NAME}
60 Verify_Odl_Received_Route_Request 0
61 BgpRpcClient.exa_clean_received_update_count
62 BgpRpcClient.exa_announce announce route-refresh ipv4 unicast
63 BuiltIn.Wait_Until_Keyword_Succeeds 5x 2s Verify_Odl_Received_Route_Request 1
64 BuiltIn.Wait_Until_Keyword_Succeeds 5x 2s Verify_ExaBgp_Received_Updates ${nr_configured_routes}
65 [Teardown] Deconfigure_Routes_And_Stop_ExaBgp
67 Odl_To_Send_Route_Request
68 [Documentation] Sends route requests and checks if exabgp receives it
69 [Setup] ExaBgpLib.Start_ExaBgp_And_Verify_Connected ${BGP_CFG_NAME} ${CONFIG_SESSION} ${TOOLS_SYSTEM_IP}
70 BgpRpcClient.exa_clean_received_route_refresh_count
71 &{mapping} BuiltIn.Create_Dictionary BGP_PEER_IP=${TOOLS_SYSTEM_IP}
72 TemplatedRequests.Post_As_Xml_Templated ${BGP_VAR_FOLDER}/route_refresh mapping=${mapping} session=${CONFIG_SESSION}
73 BuiltIn.Wait_Until_Keyword_Succeeds 5x 2s Verify_Odl_Sent_Route_Request 1
74 [Teardown] ExaBgpLib.Stop_ExaBgp
76 Delete_Bgp_Peer_Configuration
77 [Documentation] Revert the BGP configuration to the original state: without any configured peers.
78 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} BGP_NAME=${BGP_PEER_NAME} IP=${TOOLS_SYSTEM_IP} BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
79 TemplatedRequests.Delete_Templated ${BGP_VAR_FOLDER}/bgp_peer mapping=${mapping} session=${CONFIG_SESSION}
82 [Documentation] Revert the BGP configuration to the original state: without application peer
83 &{mapping} BuiltIn.Create_Dictionary DEVICE_NAME=${DEVICE_NAME} APP_PEER_NAME=${APP_PEER_NAME} IP=${ODL_SYSTEM_IP} BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
84 TemplatedRequests.Delete_Templated ${BGP_VAR_FOLDER}/app_peer mapping=${mapping} session=${CONFIG_SESSION}
88 [Documentation] Suite setup keyword.
89 SetupUtils.Setup_Utils_For_Setup_And_Teardown
90 ${mininet_conn_id}= SSHLibrary.Open Connection ${TOOLS_SYSTEM_IP} prompt=${DEFAULT_LINUX_PROMPT} timeout=6s
91 Builtin.Set_Suite_Variable ${mininet_conn_id}
92 Utils.Flexible_Mininet_Login ${TOOLS_SYSTEM_USER}
93 SSHKeywords.Virtual_Env_Create
94 SSHKeywords.Virtual_Env_Install_Package exabgp==3.4.16
95 RequestsLibrary.Create_Session ${CONFIG_SESSION} http://${ODL_SYSTEM_IP}:${RESTCONFPORT} auth=${AUTH}
99 [Documentation] Suite teardown keyword
100 SSHKeywords.Virtual_Env_Delete
101 SSHLibrary.Close_All_Connections
102 RequestsLibrary.Delete_All_Sessions
105 [Documentation] Uploads exabgp config files
106 SSHLibrary.Put_File ${BGP_VAR_FOLDER}/${BGP_CFG_NAME} .
107 SSHLibrary.Put_File ${EXARPCSCRIPT} .
108 @{cfgfiles}= SSHLibrary.List_Files_In_Directory . *.cfg
109 : FOR ${cfgfile} IN @{cfgfiles}
110 \ SSHLibrary.Execute_Command sed -i -e 's/EXABGPIP/${TOOLS_SYSTEM_IP}/g' ${cfgfile}
111 \ SSHLibrary.Execute_Command sed -i -e 's/ODLIP/${ODL_SYSTEM_IP}/g' ${cfgfile}
112 \ SSHLibrary.Execute_Command sed -i -e 's/ROUTEREFRESH/enable/g' ${cfgfile}
113 \ SSHLibrary.Execute_Command sed -i -e 's/ADDPATH/disable/g' ${cfgfile}
114 \ ${stdout}= SSHLibrary.Execute_Command cat ${cfgfile}
117 Configure_Routes_And_Start_ExaBgp
118 [Arguments] ${cfg_file}
119 [Documentation] Setup keyword for exa to odl test case
120 ${app_rib} CompareStream.Set_Variable_If_At_Most_Boron example-app-rib ${ODL_SYSTEM_IP}
121 : FOR ${prefix} IN 1.1.1.1/32 2.2.2.2/32
122 \ &{mapping} BuiltIn.Create_Dictionary PREFIX=${prefix} APP_RIB=${app_rib}
123 \ TemplatedRequests.Post_As_Xml_Templated ${BGP_RR_VAR_FOLDER}/route mapping=${mapping} session=${CONFIG_SESSION}
124 BuiltIn.Set_Suite_Variable ${nr_configured_routes} 2
125 ExaBgpLib.Start_ExaBgp_And_Verify_Connected ${cfg_file} ${CONFIG_SESSION} ${TOOLS_SYSTEM_IP}
126 BuiltIn.Wait_Until_Keyword_Succeeds 3x 3s Verify_ExaBgp_Received_Updates ${nr_configured_routes}
128 Deconfigure_Routes_And_Stop_ExaBgp
129 [Documentation] Teardown keyword for exa to odl test case
130 ExaBgpLib.Stop_ExaBgp
131 ${app_rib} CompareStream.Set_Variable_If_At_Most_Boron example-app-rib ${ODL_SYSTEM_IP}
132 &{mapping} BuiltIn.Create_Dictionary PREFIX=${prefix} APP_RIB=${app_rib}
133 TemplatedRequests.Delete_Templated ${BGP_RR_VAR_FOLDER}/route mapping=${mapping} session=${CONFIG_SESSION}
135 Verify_Odl_Sent_Route_Request
136 [Arguments] ${expcount}
137 [Documentation] Compares expected count of route request messages on exabgp side
138 ${count}= BgpRpcClient.exa_get_received_route_refresh_count
139 BuiltIn.Should Be Equal As Numbers ${count} ${expcount}
141 Verify_Odl_Received_Route_Request
142 [Arguments] ${expcount}
143 [Documentation] Gets numebr of received route requests and compares with given expected count
144 ${rsp}= RequestsLibrary.Get_Request ${CONFIG_SESSION} ${JOLOKURL}
145 BuiltIn.Log ${rsp.content}
146 BuiltIn.Should_Be_Equal_As_Numbers ${rsp.status_code} 200
147 BuiltIn.Should_Be_Equal_As_Numbers ${rsp.json()['status']} 200
148 BuiltIn.Should_Be_Equal_As_Numbers ${rsp.json()['value']['BgpSessionState']['messagesStats']['routeRefreshMsgs']['received']['count']['value']} ${expcount}
150 Verify_ExaBgp_Received_Updates
151 [Arguments] ${expcount}
152 [Documentation] Gets numebr of received update requests and compares with given expected count
153 ${count_recv}= BgpRpcClient.exa_get_received_update_count
154 BuiltIn.Should Be Equal As Numbers ${count_recv} ${expcount}