csit/suites/bgpcep/bgpuser/ebgp_peers_basic.robot

   1 *** Settings ***
   2 Documentation     Basic tests for eBGP application peers.
   3 ...
   4 ...               Copyright (c) 2015-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 ...               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
  13 ...               Reported bugs:
  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)
  16 ...
  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    Teardown_Everything
  21 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
  22 Test Teardown     FailFast.Start_Failing_Fast_If_This_Failed
  23 Library           OperatingSystem
  24 Library           RequestsLibrary
  25 Variables         ${CURDIR}/../../../variables/Variables.py
  26 Variables         ${CURDIR}/../../../variables/bgpuser/variables.py    ${TOOLS_SYSTEM_IP}    ${ODL_STREAM}
  27 Resource          ${CURDIR}/../../../libraries/BGPcliKeywords.robot
  28 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  29 Resource          ${CURDIR}/../../../libraries/ConfigViaRestconf.robot
  30 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  31 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  32 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  33 Resource          ${CURDIR}/../../../libraries/SSHKeywords.robot
  34 Resource          ${CURDIR}/../../../libraries/Utils.robot
  35 Resource          ${CURDIR}/../../../libraries/WaitForFailure.robot
  36
  37 *** Variables ***
  38 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  39 ${HOLDTIME}       180
  40 ${BGP_PEER_LOG_LEVEL}    debug
  41 ${CONTROLLER_LOG_LEVEL}    INFO
  42 ${CONTROLLER_BGP_LOG_LEVEL}    DEFAULT
  43 ${iBGP_PEER1_IP}    127.0.0.1
  44 ${eBGP_PEER1_IP}    127.0.0.3
  45 ${eBGP_PEER2_IP}    127.0.0.4
  46 ${iBGP_PEER1_FIRST_PREFIX_IP}    8.1.0.0
  47 ${eBGP_PEERS_FIRST_PREFIX_IP}    8.0.0.0
  48 ${eBGP_PEER1_FIRST_PREFIX_IP}    ${eBGP_PEERS_FIRST_PREFIX_IP}
  49 ${eBGP_PEER2_FIRST_PREFIX_IP}    ${eBGP_PEERS_FIRST_PREFIX_IP}
  50 ${eBGP_PEER1_NEXT_HOP}    1.1.1.1
  51 ${eBGP_PEER2_NEXT_HOP}    2.2.2.2
  52 ${PREFIX_LEN}     28
  53 ${iBGP_PEER1_PREFIX_LEN}    ${PREFIX_LEN}
  54 ${eBGP_PEER1_PREFIX_LEN}    ${PREFIX_LEN}
  55 ${eBGP_PEER2_PREFIX_LEN}    ${PREFIX_LEN}
  56 ${PREFIX_COUNT}    2
  57 ${iBGP_PEER1_PREFIX_COUNT}    0
  58 ${eBGP_PEER1_PREFIX_COUNT}    ${PREFIX_COUNT}
  59 ${eBGP_PEER2_PREFIX_COUNT}    ${PREFIX_COUNT}
  60 ${eBGP_PEERS_AS}    32768
  61 ${eBGP_PEER1_AS}    ${eBGP_PEERS_AS}
  62 ${eBGP_PEER2_AS}    ${eBGP_PEERS_AS}
  63 ${iBGP_PEER1_LOG_FILE}    bgp_peer1.log
  64 ${eBGP_PEER1_LOG_FILE}    ebgp_peer1.log
  65 ${eBGP_PEER2_LOG_FILE}    ebgp_peer2.log
  66 ${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}
  67 ${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}
  68 ${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}
  69 ${iBGP_PEER1_OPTIONS}    &>${iBGP_PEER1_LOG_FILE}
  70 ${eBGP_PEER1_OPTIONS}    &>${eBGP_PEER1_LOG_FILE}
  71 ${eBGP_PEER2_OPTIONS}    &>${eBGP_PEER2_LOG_FILE}
  72 ${DEFAULT_LOG_CHECK_TIMEOUT}    20s
  73 ${DEFAULT_LOG_CHECK_PERIOD}    1s
  74 ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT}    10s
  75 ${DEFAULT_TOPOLOGY_CHECK_PERIOD}    1s
  76
  77 *** Test Cases ***
  78 Configure_BGP_Peers
  79     [Documentation]    Configure an iBGP and two eBGP peers
  80     [Tags]    critical
  81     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ibgp-peer1', 'IP': '${iBGP_PEER1_IP}', 'HOLDTIME': '${HOLDTIME}', 'PEER_PORT': '${BGP_TOOL_PORT}','PEER_ROLE': 'ibgp', 'INITIATE': 'false'}
  82     ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ibgp_peers    ${template_as_string}
  83     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ebgp-peer1', 'IP': '${eBGP_PEER1_IP}', 'HOLDTIME': '${HOLDTIME}', 'PEER_PORT': '${BGP_TOOL_PORT}', 'PEER_ROLE': 'ebgp', 'AS_NUMBER': '${eBGP_PEER1_AS}', 'INITIATE': 'false'}
  84     ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ebgp_peers    ${template_as_string}
  85     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ebgp-peer2', 'IP': '${eBGP_PEER2_IP}', 'HOLDTIME': '${HOLDTIME}', 'PEER_PORT': '${BGP_TOOL_PORT}','PEER_ROLE': 'ebgp', 'AS_NUMBER': '${eBGP_PEER2_AS}', 'INITIATE': 'false'}
  86     ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ebgp_peers    ${template_as_string}
  87     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ibgp-peer1'}
  88     ${result}=    ConfigViaRestconf.Get_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ibgp_peers    ${template_as_string}
  89     BuiltIn.Log    ${result}
  90     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ebgp-peer1'}
  91     ${result}=    ConfigViaRestconf.Get_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ebgp_peers    ${template_as_string}
  92     BuiltIn.Log    ${result}
  93     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ebgp-peer2'}
  94     ${result}=    ConfigViaRestconf.Get_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ebgp_peers    ${template_as_string}
  95     BuiltIn.Log    ${result}
  96
  97 Connect_iBGP_Peer1
  98     [Documentation]    Connect BGP peer
  99     [Tags]    critical
 100     SSHLibrary.Switch Connection    ibgp_peer1_console
 101     Start_Console_Tool    ${iBGP_PEER1_COMMAND}    ${iBGP_PEER1_OPTIONS}
 102     Read_And_Fail_If_Prompt_Is_Seen
 103     Check_Example_IPv4_Topology_Does_Not_Contain    prefix
 104
 105 Connect_eBGP_Peer1
 106     [Documentation]    Connect BGP peer
 107     [Tags]    critical
 108     SSHLibrary.Switch Connection    ebgp_peer1_console
 109     Start_Console_Tool    ${eBGP_PEER1_COMMAND}    ${eBGP_PEER1_OPTIONS}
 110     Read_And_Fail_If_Prompt_Is_Seen
 111
 112 Check_IPv4_Topology_For_First_Path
 113     [Documentation]    The IPv4 topology shall contain the route announced by the first eBGP
 114     BuiltIn.Wait_Until_Keyword_Succeeds    ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT}    ${DEFAULT_TOPOLOGY_CHECK_PERIOD}    Check_Example_IPv4_Topology_Content    "node-id":"${eBGP_PEER1_NEXT_HOP}"
 115     Check_Example_IPv4_Topology_Content    "prefix":"${eBGP_PEER1_FIRST_PREFIX_IP}/${PREFIX_LEN}"
 116
 117 iBGP_Check_Log_For_Introduced_Prefixes
 118     [Documentation]    Check incomming updates for introduced routes
 119     [Tags]    critical
 120     SSHLibrary.Switch Connection    ibgp_peer1_console
 121     ${total_prefix_count}=    BuiltIn.Evaluate    ${eBGP_PEER1_PREFIX_COUNT}
 122     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}
 123     ${count}=    Count_Key_Value_Pairs    ${iBGP_PEER1_LOG_FILE}    Network Address of Next Hop    ${eBGP_PEER1_NEXT_HOP}
 124     BuiltIn.Should_Be_Equal_As_Integers    ${count}    ${eBGP_PEER1_PREFIX_COUNT}
 125     ${count}=    Count_Key_Value_Pairs    ${iBGP_PEER1_LOG_FILE}    Network Address of Next Hop    ${eBGP_PEER2_NEXT_HOP}
 126     BuiltIn.Should_Be_Equal_As_Integers    ${count}    0
 127
 128 Connect_eBGP_Peer2
 129     [Documentation]    Connect BGP peer and check empty topology
 130     [Tags]    critical
 131     SSHLibrary.Switch Connection    ebgp_peer2_console
 132     Start_Console_Tool    ${eBGP_PEER2_COMMAND}    ${eBGP_PEER2_OPTIONS}
 133     Read_And_Fail_If_Prompt_Is_Seen
 134
 135 Disconnect_eBGP_Peer1
 136     [Documentation]    Stop BGP peer, log topology and store logs
 137     [Tags]    critical
 138     SSHLibrary.Switch Connection    ebgp_peer1_console
 139     Stop_Console_Tool
 140     Store_File_To_Workspace    ${eBGP_PEER1_LOG_FILE}    ${eBGP_PEER1_LOG_FILE}
 141
 142 Check_IPv4_Topology_For_Second_Path
 143     [Documentation]    The IPv4 topology shall contain the route announced by the second eBGP now
 144     BuiltIn.Wait_Until_Keyword_Succeeds    ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT}    ${DEFAULT_TOPOLOGY_CHECK_PERIOD}    Check_Example_IPv4_Topology_Content    "node-id":"${eBGP_PEER2_NEXT_HOP}"
 145     Check_Example_IPv4_Topology_Content    "prefix":"${eBGP_PEER2_FIRST_PREFIX_IP}/${PREFIX_LEN}"
 146
 147 iBGP_Check_Log_For_Updated_Prefixes
 148     [Documentation]    Check incomming updates for updated routes
 149     [Tags]    critical
 150     SSHLibrary.Switch Connection    ibgp_peer1_console
 151     ${total_prefix_count}=    BuiltIn.Evaluate    ${eBGP_PEER1_PREFIX_COUNT} + ${eBGP_PEER2_PREFIX_COUNT}
 152     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}
 153     ${count}=    Count_Key_Value_Pairs    ${iBGP_PEER1_LOG_FILE}    Network Address of Next Hop    ${eBGP_PEER1_NEXT_HOP}
 154     BuiltIn.Should_Be_Equal_As_Integers    ${count}    ${eBGP_PEER1_PREFIX_COUNT}
 155     ${count}=    Count_Key_Value_Pairs    ${iBGP_PEER1_LOG_FILE}    Network Address of Next Hop    ${eBGP_PEER2_NEXT_HOP}
 156     BuiltIn.Should_Be_Equal_As_Integers    ${count}    ${eBGP_PEER2_PREFIX_COUNT}
 157     [Teardown]    Report_Failure_Due_To_Bug    4834
 158
 159 Disconnect_eBGP_Peer2
 160     [Documentation]    Stop BGP peer, store logs and wait for empty topology
 161     [Tags]    critical
 162     SSHLibrary.Switch Connection    ebgp_peer2_console
 163     Stop_Console_Tool
 164     Store_File_To_Workspace    ${eBGP_PEER2_LOG_FILE}    ${eBGP_PEER2_LOG_FILE}
 165
 166 Check_For_Empty_IPv4_Topology
 167     [Documentation]    The IPv4 topology shall be empty
 168     BuiltIn.Wait_Until_Keyword_Succeeds    ${DEFAULT_TOPOLOGY_CHECK_TIMEOUT}    ${DEFAULT_TOPOLOGY_CHECK_PERIOD}    Check_Example_IPv4_Topology_Does_Not_Contain    prefix
 169     [Teardown]    Report_Failure_Due_To_Bug    4835
 170
 171 iBGP_Check_Log_For_Withdrawn_Prefixes
 172     [Documentation]    Check incomming updates for withdrawn routes
 173     [Tags]    critical
 174     SSHLibrary.Switch Connection    ibgp_peer1_console
 175     ${prefixes_to_be_removed}=    BuiltIn.Evaluate    max(${eBGP_PEER1_PREFIX_COUNT}, ${eBGP_PEER2_PREFIX_COUNT})
 176     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}
 177     [Teardown]    Report_Failure_Due_To_Bug    4835
 178
 179 Disconnect_iBGP_Peer1
 180     [Documentation]    Stop BGP peer, log topology and store logs
 181     [Tags]    critical
 182     SSHLibrary.Switch Connection    ibgp_peer1_console
 183     Stop_Console_Tool
 184     Store_File_To_Workspace    ${iBGP_PEER1_LOG_FILE}    ${iBGP_PEER1_LOG_FILE}
 185
 186 Delete_BGP_Peers_Configuration
 187     [Documentation]    Delete all previously configured BGP peers.
 188     [Tags]    critical
 189     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ibgp-peer1'}
 190     ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ibgp_peers    ${template_as_string}
 191     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ebgp-peer1'}
 192     ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ebgp_peers    ${template_as_string}
 193     ${template_as_string}=    BuiltIn.Set_Variable    {'NAME': 'example-ebgp-peer2'}
 194     ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}ebgp_peers    ${template_as_string}
 195
 196 *** Keywords ***
 197 Setup_Everything
 198     [Documentation]    Initialize SetupUtils. SSH-login to mininet machine, create HTTP session,
 199     ...    prepare directories for responses, put Python tool to mininet machine, setup imported resources.
 200     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 201     SSHLibrary.Set_Default_Configuration    prompt=${ODL_SYSTEM_PROMPT}
 202     SSHLibrary.Open_Connection    ${ODL_SYSTEM_IP}    alias=ibgp_peer1_console
 203     Utils.Flexible_Controller_Login
 204     SSHLibrary.Open_Connection    ${ODL_SYSTEM_IP}    alias=ebgp_peer1_console
 205     Utils.Flexible_Controller_Login
 206     SSHLibrary.Open_Connection    ${ODL_SYSTEM_IP}    alias=ebgp_peer2_console
 207     Utils.Flexible_Controller_Login
 208     SSHKeywords.Require_Python
 209     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
 210     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 211     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_TOPO_API}    auth=${AUTH}
 212     ConfigViaRestconf.Setup_Config_Via_Restconf
 213     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_LOG_LEVEL}
 214     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.bgpcep
 215     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.protocol
 216
 217 Teardown_Everything
 218     [Documentation]    Create and Log the diff between expected and actual responses, make sure Python tool was killed.
 219     ...    Tear down imported Resources.
 220     KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 221     ConfigViaRestconf.Teardown_Config_Via_Restconf
 222     RequestsLibrary.Delete_All_Sessions
 223     SSHLibrary.Close_All_Connections
 224
 225 Read_Text_Before_Prompt
 226     [Documentation]    Log text gathered by SSHLibrary.Read_Until_Prompt.
 227     ...    This needs to be a separate keyword just because how Read_And_Fail_If_Prompt_Is_Seen is implemented.
 228     ${text}=    SSHLibrary.Read_Until_Prompt
 229     BuiltIn.Log    ${text}
 230
 231 Check_Example_IPv4_Topology_Content
 232     [Arguments]    ${string_to_check}=${EMPTY}
 233     [Documentation]    Check the example-ipv4-topology content for string
 234     ${response}=    RequestsLibrary.Get Request    operational    topology/example-ipv4-topology
 235     BuiltIn.Log    ${response.status_code}
 236     BuiltIn.Log    ${response.text}
 237     BuiltIn.Should_Contain    ${response.text}    ${string_to_check}
 238
 239 Check_Example_IPv4_Topology_Does_Not_Contain
 240     [Arguments]    ${string_to_check}
 241     [Documentation]    Check the example-ipv4-topology does not contain the string
 242     ${response}=    RequestsLibrary.Get Request    operational    topology/example-ipv4-topology
 243     BuiltIn.Log    ${response.status_code}
 244     BuiltIn.Log    ${response.text}
 245     BuiltIn.Should_Not_Contain    ${response.text}    ${string_to_check}
 246
 247 Store_File_To_Workspace
 248     [Arguments]    ${source_file_name}    ${target_file_name}
 249     [Documentation]    Store the ${source_file_name} to the workspace as ${target_file_name}.
 250     ${output_log}=    SSHLibrary.Execute_Command    cat ${source_file_name}
 251     BuiltIn.Log    ${output_log}
 252     Create File    ${target_file_name}    ${output_log}