csit/suites/bgpcep/bgpfunct/010_bgp_functional_l3vpn.robot

   1 *** Settings ***
   2 Documentation     Functional test suite for bgp - l3vpn-ipv4
   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 advertising and receiveing routes with l3vpn content.
  11 ...               It uses odl and exabgp as bgp peers. Routes advertized from odl
  12 ...               are configured via application peer. Routes advertised from exabgp is
  13 ...               statically configured in exabgp config file.
  14 Suite Setup       Start_Suite
  15 Suite Teardown    Stop_Suite
  16 Library           RequestsLibrary
  17 Library           SSHLibrary
  18 Variables         ${CURDIR}/../../../variables/Variables.py
  19 Resource          ${CURDIR}/../../../libraries/Utils.robot
  20 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  21 Resource          ${CURDIR}/../../../libraries/TemplatedRequests.robot
  22 Resource          ${CURDIR}/../../../libraries/KarafKeywords.robot
  23 Resource          ${CURDIR}/../../../libraries/SSHKeywords.robot
  24 Library           ${CURDIR}/../../../libraries/norm_json.py
  25 Library           ${CURDIR}/../../../libraries/BgpRpcClient.py    ${TOOLS_SYSTEM_IP}
  26
  27 *** Variables ***
  28 ${HOLDTIME}       180
  29 ${DEVICE_NAME}    controller-config
  30 ${BGP_PEER_NAME}    example-bgp-peer
  31 ${RIB_INSTANCE}    example-bgp-rib
  32 ${APP_PEER_NAME}    example-bgp-peer-app
  33 ${CMD}            env exabgp.tcp.port=1790 exabgp --debug
  34 ${BGP_VAR_FOLDER}    ${CURDIR}/../../../variables/bgpfunctional
  35 ${BGP_L3VPN_DIR}    ${BGP_VAR_FOLDER}/l3vpn_ipv4
  36 ${DEFAUTL_EXA_CFG}    exa.cfg
  37 ${L3VPN_EXA_CFG}    bgp-l3vpn-ipv4.cfg
  38 ${L3VPN_RSPEMPTY}    ${BGP_L3VPN_DIR}/bgp-l3vpn-ipv4-empty.json
  39 ${L3VPN_RSP}      ${BGP_L3VPN_DIR}/bgp-l3vpn-ipv4.json
  40 ${L3VPN_URL}      /restconf/operational/bgp-rib:bgp-rib/rib/example-bgp-rib/loc-rib/tables/bgp-types:ipv4-address-family/bgp-types:mpls-labeled-vpn-subsequent-address-family/bgp-vpn-ipv4:vpn-ipv4-routes
  41 ${CONFIG_SESSION}    config-session
  42 ${EXARPCSCRIPT}    ${CURDIR}/../../../../tools/exabgp_files/exarpc.py
  43 ${PEER_CHECK_URL}    /restconf/operational/bgp-rib:bgp-rib/rib/example-bgp-rib/peer/bgp:%2F%2F
  44 ${DEFAULT_BGPCEP_LOG_LEVEL}    INFO
  45
  46 *** Test Cases ***
  47 Configure_App_Peer
  48     [Documentation]    Configures bgp application peer
  49     KarafKeywords.Log_Testcase_Start_To_Controller_Karaf
  50     &{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}
  51     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VAR_FOLDER}/app_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  52
  53 Reconfigure_ODL_To_Accept_Connection
  54     [Documentation]    Configures BGP peer module with initiate-connection set to false.
  55     KarafKeywords.Log_Testcase_Start_To_Controller_Karaf
  56     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME}    PEER_PORT=${BGP_TOOL_PORT}
  57     ...    INITIATE=false    RIB_INSTANCE_NAME=${RIB_INSTANCE}
  58     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VAR_FOLDER}/bgp_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  59
  60 L3vpn_Ipv4_To_Odl
  61     [Documentation]    Testing mpls vpn ipv4 routes reported to odl from exabgp
  62     [Setup]    Setup_Testcase    ${L3VPN_EXA_CFG}    ${L3VPN_URL}    ${L3VPN_RSPEMPTY}
  63     BuiltIn.Wait_Until_Keyword_Succeeds    15s    1s    Verify Reported Data    ${L3VPN_URL}    ${L3VPN_RSP}
  64     [Teardown]    Teardown_Testcase    ${L3VPN_URL}    ${L3VPN_RSPEMPTY}
  65
  66 L3vpn_Ipv4_From_Odl
  67     [Documentation]    Testing mpls vpn ipv4 routes reported from odl to exabgp
  68     [Setup]    Start_Tool_And_Verify_Connected    ${DEFAUTL_EXA_CFG}
  69     BgpRpcClient.exa_clean_update_message
  70     &{mapping}    BuiltIn.Create_Dictionary    BGP_PEER_IP=${TOOLS_SYSTEM_IP}
  71     TemplatedRequests.Post_As_Xml_Templated    ${BGP_L3VPN_DIR}/route    mapping=${mapping}    session=${CONFIG_SESSION}
  72     BuiltIn.Wait_Until_Keyword_Succeeds    5x    2s    Verify_Tool_Received_Update    ${BGP_L3VPN_DIR}/route/exa-expected.json
  73     [Teardown]    Remove_Route_And_Stop_Tool
  74
  75 Delete_Bgp_Peer_Configuration
  76     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
  77     KarafKeywords.Log_Testcase_Start_To_Controller_Karaf
  78     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}
  79     TemplatedRequests.Delete_Templated    ${BGP_VAR_FOLDER}/bgp_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  80
  81 Deconfigure_App_Peer
  82     [Documentation]    Revert the BGP configuration to the original state: without application peer
  83     KarafKeywords.Log_Testcase_Start_To_Controller_Karaf
  84     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    APP_PEER_NAME=${APP_PEER_NAME}
  85     TemplatedRequests.Delete_Templated    ${BGP_VAR_FOLDER}/app_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  86
  87 *** Keywords ***
  88 Start_Suite
  89     [Documentation]    Suite setup keyword
  90     SetupUtils.Setup_Utils_For_Setup_And_Teardown
  91     ${tools_system_conn_id}=    SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}    prompt=${DEFAULT_LINUX_PROMPT}    timeout=6s
  92     Builtin.Set_Suite_Variable    ${tools_system_conn_id}
  93     Utils.Flexible_Mininet_Login    ${TOOLS_SYSTEM_USER}
  94     SSHKeywords.Virtual_Env_Create
  95     SSHKeywords.Virtual_Env_Install_Package    exabgp==3.4.16
  96     RequestsLibrary.Create_Session    ${CONFIG_SESSION}    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}
  97     Upload_Config_Files
  98     KarafKeywords.Set_Bgpcep_Log_Levels    # ${DEFAULT_BGPCEP_LOG_LEVEL} is applied by default
  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 and needed scripts
 108     SSHLibrary.Put_File    ${BGP_VAR_FOLDER}/${DEFAUTL_EXA_CFG}    .
 109     SSHLibrary.Put_File    ${BGP_L3VPN_DIR}/${L3VPN_EXA_CFG}    .
 110     SSHLibrary.Put_File    ${EXARPCSCRIPT}    .
 111     @{cfgfiles}=    SSHLibrary.List_Files_In_Directory    .    *.cfg
 112     : FOR    ${cfgfile}    IN    @{cfgfiles}
 113     \    SSHLibrary.Execute_Command    sed -i -e 's/EXABGPIP/${TOOLS_SYSTEM_IP}/g' ${cfgfile}
 114     \    SSHLibrary.Execute_Command    sed -i -e 's/ODLIP/${ODL_SYSTEM_IP}/g' ${cfgfile}
 115     \    SSHLibrary.Execute_Command    sed -i -e 's/ROUTEREFRESH/disable/g' ${cfgfile}
 116     \    SSHLibrary.Execute_Command    sed -i -e 's/ADDPATH/disable/g' ${cfgfile}
 117     \    ${stdout}=    SSHLibrary.Execute_Command    cat ${cfgfile}
 118     \    Log    ${stdout}
 119
 120 Setup_Testcase
 121     [Arguments]    ${cfg_file}    ${url}    ${empty_response}
 122     [Documentation]    Verifies initial test condition and starts the tool
 123     Verify_Reported_Data    ${url}    ${empty_response}
 124     Start_Tool_And_Verify_Connected    ${cfg_file}
 125
 126 Start_Tool
 127     [Arguments]    ${cfg_file}    ${mapping}={}
 128     [Documentation]    Start the tool ${cmd} ${cfg_file}
 129     ${start_cmd}    BuiltIn.Set_Variable    ${cmd} ${cfg_file}
 130     BuiltIn.Log    ${start_cmd}
 131     SSHKeywords.Virtual_Env_Activate_On_Current_Session    log_output=${True}
 132     ${output}=    SSHLibrary.Write    ${start_cmd}
 133     BuiltIn.Log    ${output}
 134
 135 Verify_Tools_Connection
 136     [Arguments]    ${connected}=${True}
 137     [Documentation]    Checks peer presence in operational datastore
 138     ${exp_status_code}=    BuiltIn.Set_Variable_If    ${connected}    ${200}    ${404}
 139     ${rsp}=    RequestsLibrary.Get Request    ${CONFIG_SESSION}    ${PEER_CHECK_URL}${TOOLS_SYSTEM_IP}
 140     BuiltIn.Log    ${rsp.content}
 141     BuiltIn.Should_Be_Equal_As_Numbers    ${exp_status_code}    ${rsp.status_code}
 142
 143 Start_Tool_And_Verify_Connected
 144     [Arguments]    ${cfg_file}
 145     [Documentation]    Start the tool and verify its connection
 146     KarafKeywords.Log_Testcase_Start_To_Controller_Karaf
 147     Start_Tool    ${cfg_file}
 148     BuiltIn.Wait_Until_Keyword_Succeeds    3x    3s    Verify_Tools_Connection    connected=${True}
 149
 150 Stop_Tool
 151     [Documentation]    Stop the tool by sending ctrl+c
 152     ${output}=    SSHLibrary.Read
 153     BuiltIn.Log    ${output}
 154     Utils.Write_Bare_Ctrl_C
 155     ${output}=    SSHLibrary.Read_Until_Prompt
 156     BuiltIn.Log    ${output}
 157     SSHKeywords.Virtual_Env_Deactivate_On_Current_Session    log_output=${True}
 158
 159 Remove_Route_And_Stop_Tool
 160     [Documentation]    Removes configured route from application peer and stops the tool
 161     &{mapping}    BuiltIn.Create_Dictionary
 162     TemplatedRequests.Delete_Templated    ${BGP_L3VPN_DIR}/route    mapping=${mapping}    session=${CONFIG_SESSION}
 163     Stop_Tool
 164
 165 Teardown_Testcase
 166     [Arguments]    ${url}    ${empty_response}
 167     [Documentation]    Testcse teardown with data verification
 168     Stop_Tool
 169     BuiltIn.Wait_Until_Keyword_Succeeds    3x    1s    Verify_Reported_Data    ${url}    ${empty_response}
 170
 171 Verify_Tool_Received_Update
 172     [Arguments]    ${exp_update_fn}
 173     [Documentation]    Verification of receiving particular update message
 174     ${exp_update}=    Get_Expected_Response_From_File    ${exp_update_fn}
 175     ${rcv_update_dict}=    BgpRpcClient.exa_get_update_message    msg_only=${True}
 176     ${rcv_update}=    BuiltIn.Evaluate    json.dumps(${rcv_update_dict})    modules=json
 177     ${received_json}=    norm_json.Normalize_Json_Text    ${rcv_update}
 178     ${expected_json}=    norm_json.Normalize_Json_Text    ${exp_update}
 179     BuiltIn.Log    ${received_json}
 180     BuiltIn.Log    ${expected_json}
 181     BuiltIn.Should_Be_Equal    ${received_json}    ${expected_json}
 182
 183 Verify_Reported_Data
 184     [Arguments]    ${url}    ${exprspfile}
 185     [Documentation]    Verifies expected response
 186     ${expected_rsp}=    Get_Expected_Response_From_File    ${exprspfile}
 187     ${expected_json}=    norm_json.Normalize_Json_Text    ${expected_rsp}
 188     ${rsp}=    RequestsLibrary.Get_Request    ${CONFIG_SESSION}    ${url}
 189     BuiltIn.Log    ${rsp.content}
 190     ${received_json}=    norm_json.Normalize_Json_Text    ${rsp.content}
 191     BuiltIn.Log    ${received_json}
 192     BuiltIn.Log    ${expected_json}
 193     BuiltIn.Should_Be_Equal    ${received_json}    ${expected_json}
 194
 195 Get_Expected_Response_From_File
 196     [Arguments]    ${exprspfile}
 197     [Documentation]    Looks for release specific response first, then take default.
 198     ${status}    ${expresponse}=    BuiltIn.Run_Keyword_And_Ignore_Error    OperatingSystem.Get File    ${exprspfile}.${ODL_STREAM}
 199     Return From Keyword If    '${status}' == 'PASS'    ${expresponse}
 200     ${expresponse}=    OperatingSystem.Get File    ${exprspfile}
 201     [Return]    ${expresponse}