csit/suites/bgpcep/bgpfunct/040_bgp_functional_route_ref.robot

   1 *** Settings ***
   2 Documentation     Functional test for bgp - route refresh
   3 ...
   4 ...               Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
   5 ...
   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
   9 ...
  10 ...               This suite tests sending and receiveing route refresh 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 is received by odl, correct advertising of routes
  14 ...               is verified. Receiving of route refresh by odl is verified by
  15 ...               checking appropriate message counter via odl-bgpcep-bgp-cli and
  16 ...               restconf using BGP neighbor operational state
  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
  21 Library           SSHLibrary
  22 Library           ../../../libraries/BgpRpcClient.py    ${TOOLS_SYSTEM_IP}
  23 Resource          ../../../libraries/CompareStream.robot
  24 Resource          ../../../libraries/ExaBgpLib.robot
  25 Resource          ../../../libraries/KarafKeywords.robot
  26 Resource          ../../../libraries/SetupUtils.robot
  27 Resource          ../../../libraries/SSHKeywords.robot
  28 Resource          ../../../libraries/TemplatedRequests.robot
  29 Resource          ../../../variables/Variables.robot
  30
  31 *** Variables ***
  32 ${APP_PEER_NAME}    example-bgp-peer-app
  33 ${BGP_CFG_NAME}    exa.cfg
  34 ${BGP_PEER_NAME}    example-bgp-peer
  35 ${BGP_RR_VAR_FOLDER}    ${BGP_VAR_FOLDER}/route_refresh
  36 ${BGP_VAR_FOLDER}    ${CURDIR}/../../../variables/bgpfunctional
  37 ${CONFIG_SESSION}    config-session
  38 ${DEVICE_NAME}    controller-config
  39 ${EXARPCSCRIPT}    ${CURDIR}/../../../../tools/exabgp_files/exarpc.py
  40 ${HOLDTIME}       180
  41 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  42 ${RIB_INSTANCE}    example-bgp-rib
  43
  44 *** Test Cases ***
  45 Configure_App_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}
  50
  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}
  56
  57 Exa_To_Send_Route_Refresh
  58     [Documentation]    Exabgp sends route refresh and count received updates
  59     [Tags]    critical
  60     [Setup]    Configure_Routes_And_Start_ExaBgp    ${BGP_CFG_NAME}
  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_ExaBgp_Received_Updates    ${nr_configured_routes}
  64     BuiltIn.Wait_Until_Keyword_Succeeds    3x    5s    Verify_Odl_Operational_State_Count    notification_count=0    update_count=${nr_configured_routes}
  65     [Teardown]    Deconfigure_Routes_And_Stop_ExaBgp
  66
  67 Odl_To_Send_Route_Refresh
  68     [Documentation]    Sends route refresh request and checks if exabgp receives it
  69     [Tags]    critical
  70     [Setup]    ExaBgpLib.Start_ExaBgp_And_Verify_Connected    ${BGP_CFG_NAME}    ${CONFIG_SESSION}    ${TOOLS_SYSTEM_IP}
  71     BgpRpcClient.exa_clean_received_route_refresh_count
  72     &{mapping}    BuiltIn.Create_Dictionary    BGP_PEER_IP=${TOOLS_SYSTEM_IP}
  73     TemplatedRequests.Post_As_Xml_Templated    ${BGP_VAR_FOLDER}/route_refresh    mapping=${mapping}    session=${CONFIG_SESSION}
  74     BuiltIn.Wait_Until_Keyword_Succeeds    5x    2s    Verify_ExaBgp_Received_Route_Refresh    1
  75     BuiltIn.Wait_Until_Keyword_Succeeds    3x    5s    Verify_Odl_Operational_State_Count    notification_count=1    update_count=4
  76     [Teardown]    ExaBgpLib.Stop_ExaBgp
  77
  78 Delete_Bgp_Peer_Configuration
  79     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
  80     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
  81     TemplatedRequests.Delete_Templated    ${BGP_VAR_FOLDER}/bgp_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  82
  83 Deconfigure_App_Peer
  84     [Documentation]    Revert the BGP configuration to the original state: without application peer
  85     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    APP_PEER_NAME=${APP_PEER_NAME}    IP=${ODL_SYSTEM_IP}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
  86     TemplatedRequests.Delete_Templated    ${BGP_VAR_FOLDER}/app_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  87
  88 *** Keywords ***
  89 Start_Suite
  90     [Documentation]    Suite setup keyword.
  91     SetupUtils.Setup_Utils_For_Setup_And_Teardown
  92     ${mininet_conn_id}=    SSHLibrary.Open Connection    ${TOOLS_SYSTEM_IP}    prompt=${DEFAULT_LINUX_PROMPT}    timeout=6s
  93     Builtin.Set_Suite_Variable    ${mininet_conn_id}
  94     SSHKeywords.Flexible_Mininet_Login    ${TOOLS_SYSTEM_USER}
  95     SSHKeywords.Virtual_Env_Create
  96     SSHKeywords.Virtual_Env_Install_Package    exabgp==3.4.16
  97     RequestsLibrary.Create_Session    ${CONFIG_SESSION}    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}
  98     Upload_Config_Files
  99
 100 Stop_Suite
 101     [Documentation]    Suite teardown keyword
 102     SSHKeywords.Virtual_Env_Delete
 103     SSHLibrary.Close_All_Connections
 104     RequestsLibrary.Delete_All_Sessions
 105
 106 Upload_Config_Files
 107     [Documentation]    Uploads exabgp config files
 108     SSHLibrary.Put_File    ${BGP_VAR_FOLDER}/${BGP_CFG_NAME}    .
 109     SSHLibrary.Put_File    ${EXARPCSCRIPT}    .
 110     @{cfgfiles}=    SSHLibrary.List_Files_In_Directory    .    *.cfg
 111     : FOR    ${cfgfile}    IN    @{cfgfiles}
 112     \    SSHLibrary.Execute_Command    sed -i -e 's/EXABGPIP/${TOOLS_SYSTEM_IP}/g' ${cfgfile}
 113     \    SSHLibrary.Execute_Command    sed -i -e 's/ODLIP/${ODL_SYSTEM_IP}/g' ${cfgfile}
 114     \    SSHLibrary.Execute_Command    sed -i -e 's/ROUTEREFRESH/enable/g' ${cfgfile}
 115     \    SSHLibrary.Execute_Command    sed -i -e 's/ADDPATH/disable/g' ${cfgfile}
 116     \    ${stdout}=    SSHLibrary.Execute_Command    cat ${cfgfile}
 117     \    Log    ${stdout}
 118
 119 Configure_Routes_And_Start_ExaBgp
 120     [Arguments]    ${cfg_file}
 121     [Documentation]    Setup keyword for exa to odl test case
 122     ${app_rib}    Set Variable    ${ODL_SYSTEM_IP}
 123     : FOR    ${prefix}    IN    1.1.1.1/32    2.2.2.2/32
 124     \    &{mapping}    BuiltIn.Create_Dictionary    PREFIX=${prefix}    APP_RIB=${app_rib}
 125     \    TemplatedRequests.Post_As_Xml_Templated    ${BGP_RR_VAR_FOLDER}/route    mapping=${mapping}    session=${CONFIG_SESSION}
 126     BuiltIn.Set_Suite_Variable    ${nr_configured_routes}    2
 127     ExaBgpLib.Start_ExaBgp_And_Verify_Connected    ${cfg_file}    ${CONFIG_SESSION}    ${TOOLS_SYSTEM_IP}
 128     BuiltIn.Wait_Until_Keyword_Succeeds    3x    3s    Verify_ExaBgp_Received_Updates    ${nr_configured_routes}
 129
 130 Deconfigure_Routes_And_Stop_ExaBgp
 131     [Documentation]    Teardown keyword for exa to odl test case
 132     ExaBgpLib.Stop_ExaBgp
 133     ${app_rib}    Set Variable    ${ODL_SYSTEM_IP}
 134     &{mapping}    BuiltIn.Create_Dictionary    PREFIX=${prefix}    APP_RIB=${app_rib}
 135     TemplatedRequests.Delete_Templated    ${BGP_RR_VAR_FOLDER}/route    mapping=${mapping}    session=${CONFIG_SESSION}
 136
 137 Verify_ExaBgp_Received_Updates
 138     [Arguments]    ${expcount}
 139     [Documentation]    Gets number of received update requests and compares with given expected count
 140     ${count_recv}=    BgpRpcClient.exa_get_received_update_count
 141     BuiltIn.Should Be Equal As Numbers    ${count_recv}    ${expcount}
 142
 143 Verify_ExaBgp_Received_Route_Refresh
 144     [Arguments]    ${expcount}
 145     [Documentation]    Compares expected count of route request messages on exabgp side
 146     ${count}=    BgpRpcClient.exa_get_received_route_refresh_count
 147     BuiltIn.Should Be Equal As Numbers    ${count}    ${expcount}
 148
 149 Verify_Odl_Operational_State_Count
 150     [Arguments]    ${notification_count}    ${update_count}
 151     [Documentation]    Check notification and update count gained from operatial neighbor state
 152     ...    On versions oxygen and above, it verifies these counts also against cli output.
 153     &{mapping}    BuiltIn.Create_Dictionary    IP=${TOOLS_SYSTEM_IP}    RIB_INSTANCE_NAME=${RIB_INSTANCE}    NOT_COUNT=${notification_count}    UPD_COUNT=${update_count}
 154     ${ret}=    BuiltIn.Wait_Until_Keyword_Succeeds    3x    5s    TemplatedRequests.Get_As_Json_Templated    folder=${BGP_RR_VAR_FOLDER}/operational_state    mapping=${mapping}
 155     ...    session=${CONFIG_SESSION}    verify=True
 156     BuiltIn.Log    ${ret}
 157     CompareStream.Run_Keyword_If_At_Least_Oxygen    BuiltIn.Wait_Until_Keyword_Succeeds    3x    5s    Verify_Cli_Output_Count    ${notification_count}    ${update_count}
 158
 159 Verify_Cli_Output_Count
 160     [Arguments]    ${notification_count}    ${update_count}
 161     [Documentation]    Checks notification and update count from odl-bgpcep-bgp-cli.
 162     ...    odl-bgpcep-bgp-cli is only avaiable on versions oxygen and above.
 163     ${output}    KarafKeywords.Safe_Issue_Command_On_Karaf_Console    bgp:operational-state -rib example-bgp-rib -neighbor ${TOOLS_SYSTEM_IP}
 164     BuiltIn.Log    ${output}
 165     &{mapping}    BuiltIn.Create_Dictionary    IP=${TOOLS_SYSTEM_IP}    NOT_COUNT=${notification_count}    UPD_COUNT=${update_count}    DIVIDER=│
 166     ${expstate}    TemplatedRequests.Resolve_Text_From_Template_File    folder=${BGP_RR_VAR_FOLDER}/operational_cli    file_name=update.txt    mapping=${mapping}
 167     BuiltIn.Should_Contain    ${output}    ${expstate}