csit/suites/bgpcep/bgpuser/cases.robot

   1 *** Settings ***
   2 Documentation     Basic tests for odl-bgpcep-bgp-all feature.
   3 ...
   4 ...               Copyright (c) 2015 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 ...               TODO: Rename this file after Beryllium is out, for example to basic.robot
  11 ...
  12 ...               Test suite performs basic BGP functional test cases:
  13 ...               BGP peer initiated coonection
  14 ...               - introduce and check 3 prefixes in one update message
  15 ...               ODL controller initiated coonection:
  16 ...               - introduce and check 3 prefixes in one update message
  17 ...               - introduce 2 prefixes in first update message and then additional 2 prefixes
  18 ...               in another update while the very first prefix is withdrawn
  19 ...               - introduce 3 prefixes and try to withdraw the first one
  20 ...               (to be ignored by controller) in a single update message
  21 ...
  22 ...               Brief description how to perform BGP functional test:
  23 ...               https://wiki.opendaylight.org/view/BGP_LS_PCEP:Lithium_Feature_Tests#How_to_test_2
  24 ...
  25 ...               Reported bugs:
  26 ...               https://bugs.opendaylight.org/show_bug.cgi?id=4409
  27 ...               https://bugs.opendaylight.org/show_bug.cgi?id=4634
  28 Suite Setup       Setup_Everything
  29 Suite Teardown    Teardown_Everything
  30 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  31 Test Teardown     FailFast.Start_Failing_Fast_If_This_Failed
  32 Library           OperatingSystem
  33 Library           SSHLibrary    timeout=10s
  34 Library           RequestsLibrary
  35 Library           ${CURDIR}/../../../libraries/norm_json.py
  36 Variables         ${CURDIR}/../../../variables/Variables.py
  37 Variables         ${CURDIR}/../../../variables/bgpuser/variables.py    ${TOOLS_SYSTEM_IP}    ${ODL_STREAM}
  38 Resource          ${CURDIR}/../../../libraries/BGPcliKeywords.robot
  39 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  40 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  41 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  42 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  43 Resource          ${CURDIR}/../../../libraries/SSHKeywords.robot
  44 Resource          ${CURDIR}/../../../libraries/TemplatedRequests.robot
  45 Resource          ${CURDIR}/../../../libraries/Utils.robot
  46 Resource          ${CURDIR}/../../../libraries/WaitForFailure.robot
  47
  48 *** Variables ***
  49 ${ACTUAL_RESPONSES_FOLDER}    ${TEMPDIR}/actual
  50 ${EXPECTED_RESPONSES_FOLDER}    ${TEMPDIR}/expected
  51 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  52 ${TOOLS_SYSTEM_PROMPT}    ${DEFAULT_LINUX_PROMPT}
  53 ${HOLDTIME}       180
  54 ${BGP_TOOL_LOG_LEVEL}    info
  55 ${CONTROLLER_LOG_LEVEL}    INFO
  56 ${CONTROLLER_BGP_LOG_LEVEL}    DEFAULT
  57 ${CONFIG_SESSION}    session
  58 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  59 ${DEVICE_NAME}    controller-config
  60 ${BGP_PEER_NAME}    example-bgp-peer
  61 ${RIB_INSTANCE}    example-bgp-rib
  62
  63 *** Test Cases ***
  64 Check_For_Empty_Topology_Before_Talking
  65     [Documentation]    Sanity check example-ipv4-topology is up but empty.
  66     [Tags]    critical
  67     Wait_For_Topology_To_Change_To    ${empty_json}    010_Empty.json    timeout=120s
  68     # TODO: Verify that 120 seconds is not too short if this suite is run immediatelly after ODL is started.
  69
  70 Reconfigure_ODL_To_Accept_Connection
  71     [Documentation]    Configure BGP peer module with initiate-connection set to false.
  72     &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME}    PEER_PORT=${BGP_TOOL_PORT}
  73     ...    INITIATE=false    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=true    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}    RIB_INSTANCE_NAME=${RIB_INSTANCE}
  74     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}    session=${CONFIG_SESSION}
  75     [Teardown]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
  76
  77 Start_Talking_BGP_speaker
  78     [Documentation]    Start Python speaker to connect to ODL, verify that the tool does not promptly exit.
  79     # Myport value is needed for checking whether connection at precise port was established.
  80     BGPSpeaker.Start_BGP_Speaker    --amount 3 --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --${BGP_TOOL_LOG_LEVEL}
  81     Read_And_Fail_If_Prompt_Is_Seen
  82
  83 Check_Talking_Connection_Is_Established
  84     [Documentation]    See TCP (BGP) connection in established state.
  85     # This case is separate from the previous one, to resemble structure of the second half of this suite more closely.
  86     Check_Speaker_Is_Connected
  87     [Teardown]    Utils.Report_Failure_Due_To_Bug    5171
  88
  89 Check_Talking_Topology_Is_Filled
  90     [Documentation]    See new routes in example-ipv4-topology as a proof that synchronization was correct.
  91     [Tags]    critical
  92     Wait_For_Topology_To_Change_To    ${filled_json}    020_Filled.json
  93
  94 Kill_Talking_BGP_Speaker
  95     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
  96     [Tags]    critical
  97     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
  98     BGPSpeaker.Kill_BGP_Speaker
  99     FailFast.Do_Not_Fail_Fast_From_Now_On
 100     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 101     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
 102
 103 Check_For_Empty_Topology_After_Talking
 104     [Documentation]    See example-ipv4-topology empty again.
 105     [Tags]    critical
 106     Wait_For_Topology_To_Change_To    ${empty_json}    030_Empty.json
 107
 108 Start_Listening_BGP_Speaker
 109     [Documentation]    Start Python speaker in listening mode, verify that the tool does not exit quickly.
 110     BGPSpeaker.Start_BGP_Speaker    --amount 3 --listen --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --${BGP_TOOL_LOG_LEVEL}
 111     Read_And_Fail_If_Prompt_Is_Seen
 112
 113 Check_Listening_Connection_Is_Not_Established_Yet
 114     [Documentation]    See no TCP connection, as both ODL and tool are in listening mode.
 115     Check_Speaker_Is_Not_Connected
 116
 117 Check_For_Empty_Topology_Before_Listening
 118     [Documentation]    Sanity check example-ipv4-topology is still empty.
 119     [Tags]    critical
 120     Verify_That_Topology_Does_Not_Change_From    ${empty_json}    040_Empty.json
 121
 122 Reconfigure_ODL_To_Initiate_Connection
 123     [Documentation]    Replace BGP peer config module, now with initiate-connection set to true.
 124     &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME}    PEER_PORT=${BGP_TOOL_PORT}
 125     ...    INITIATE=true    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=false    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}    RIB_INSTANCE_NAME=${RIB_INSTANCE}
 126     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}    session=${CONFIG_SESSION}
 127
 128 Check_Listening_Connection_Is_Established
 129     [Documentation]    See TCP (BGP) connection in established state.
 130     Check_Speaker_Is_Connected
 131
 132 Check_Listening_Topology_Is_Filled
 133     [Documentation]    See new routes in example-ipv4-topology as a proof that synchronization was correct.
 134     [Tags]    critical
 135     Wait_For_Topology_To_Change_To    ${filled_json}    050_Filled.json
 136
 137 Kill_Listening_BGP_Speaker
 138     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 139     [Tags]    critical
 140     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 141     BGPSpeaker.Kill_BGP_Speaker
 142     FailFast.Do_Not_Fail_Fast_From_Now_On
 143     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 144     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
 145
 146 Check_For_Empty_Topology_After_Listening
 147     [Documentation]    Post-condition: Check example-ipv4-topology is empty again.
 148     [Tags]    critical
 149     Wait_For_Topology_To_Change_To    ${empty_json}    060_Empty.json
 150
 151 Start_Listening_BGP_Speaker_Case_2
 152     [Documentation]    BGP Speaker introduces 2 prefixes in the first update & another 2 prefixes while the very first is withdrawn in 2nd update
 153     BGPSpeaker.Start_BGP_Speaker    --amount 3 --listen --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --prefill=2 --insert=2 --withdraw=1 --updates=single --firstprefix=8.0.0.240 --${BGP_TOOL_LOG_LEVEL}
 154     Read_And_Fail_If_Prompt_Is_Seen
 155
 156 Check_Listening_Connection_Is_Established_Case_2
 157     [Documentation]    See TCP (BGP) connection in established state.
 158     Check_Speaker_Is_Connected
 159
 160 Check_Listening_Topology_Is_Filled_Case_2
 161     [Documentation]    See new routes in example-ipv4-topology as a proof that synchronization was correct.
 162     [Tags]    critical
 163     Wait_For_Topology_To_Change_To    ${filled_json}    050_Filled.json
 164     [Teardown]    Report_Failure_Due_To_Bug    4409
 165
 166 Kill_Listening_BGP_Speaker_Case_2
 167     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 168     [Tags]    critical
 169     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 170     BGPSpeaker.Kill_BGP_Speaker
 171     FailFast.Do_Not_Fail_Fast_From_Now_On
 172     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 173     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
 174
 175 Check_For_Empty_Topology_After_Listening_Case_2
 176     [Documentation]    Post-condition: Check example-ipv4-topology is empty again.
 177     [Tags]    critical
 178     Wait_For_Topology_To_Change_To    ${empty_json}    060_Empty.json
 179
 180 Start_Listening_BGP_Speaker_Case_3
 181     [Documentation]    BGP Speaker introduces 3 prefixes while the first one occures again in the withdrawn list (to be ignored bu controller)
 182     BGPSpeaker.Start_BGP_Speaker    --amount 2 --listen --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --prefill=0 --insert=3 --withdraw=1 --updates=single --${BGP_TOOL_LOG_LEVEL}
 183     Read_And_Fail_If_Prompt_Is_Seen
 184
 185 Check_Listening_Connection_Is_Established_Case_3
 186     [Documentation]    See TCP (BGP) connection in established state.
 187     Check_Speaker_Is_Connected
 188
 189 Check_Listening_Topology_Is_Filled_Case_3
 190     [Documentation]    See new routes in example-ipv4-topology as a proof that synchronization was correct.
 191     [Tags]    critical
 192     Wait_For_Topology_To_Change_To    ${filled_json}    050_Filled.json
 193     [Teardown]    Report_Failure_Due_To_Bug    4634
 194
 195 Kill_Listening_BGP_Speaker_Case_3
 196     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 197     [Tags]    critical
 198     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 199     BGPSpeaker.Kill_BGP_Speaker
 200     FailFast.Do_Not_Fail_Fast_From_Now_On
 201     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 202     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
 203
 204 Check_For_Empty_Topology_After_Listening_Case_3
 205     [Documentation]    Post-condition: Check example-ipv4-topology is empty again.
 206     [Tags]    critical
 207     Wait_For_Topology_To_Change_To    ${empty_json}    060_Empty.json
 208
 209 Delete_Bgp_Peer_Configuration
 210     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 211     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 212     TemplatedRequests.Delete_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}    session=${CONFIG_SESSION}
 213     # TODO: Do we need to check something else?
 214
 215 *** Keywords ***
 216 Setup_Everything
 217     [Documentation]    Initialize SetupUtils. SSH-login to mininet machine, create HTTP session,
 218     ...    prepare directories for responses, put Python tool to mininet machine, setup imported resources.
 219     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 220     SSHLibrary.Set_Default_Configuration    prompt=${TOOLS_SYSTEM_PROMPT}
 221     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_TOPO_API}    auth=${AUTH}
 222     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
 223     # TODO: Alternatively, create variable in Variables which starts with http.
 224     # Both TODOs would probably need to update every suite relying on current Variables.
 225     OperatingSystem.Remove_Directory    ${EXPECTED_RESPONSES_FOLDER}    recursive=True
 226     OperatingSystem.Remove_Directory    ${ACTUAL_RESPONSES_FOLDER}    recursive=True
 227     # The previous suite may have been using the same directories.
 228     OperatingSystem.Create_Directory    ${EXPECTED_RESPONSES_FOLDER}
 229     OperatingSystem.Create_Directory    ${ACTUAL_RESPONSES_FOLDER}
 230     SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}
 231     Utils.Flexible_Mininet_Login
 232     SSHKeywords.Require_Python
 233     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
 234     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 235     RequestsLibrary.Create_Session    ${CONFIG_SESSION}    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}
 236     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_LOG_LEVEL}
 237     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.bgpcep
 238     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.protocol
 239
 240 Teardown_Everything
 241     [Documentation]    Create and Log the diff between expected and actual responses, make sure Python tool was killed.
 242     ...    Tear down imported Resources.
 243     ${diff}=    OperatingSystem.Run    diff -dur ${EXPECTED_RESPONSES_FOLDER} ${ACTUAL_RESPONSES_FOLDER}
 244     BuiltIn.Log    ${diff}
 245     KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 246     RequestsLibrary.Delete_All_Sessions
 247     SSHLibrary.Close_All_Connections
 248
 249 Wait_For_Topology_To_Change_To
 250     [Arguments]    ${json_topology}    ${filename}    ${timeout}=10s    ${refresh}=1s
 251     [Documentation]    Normalize the expected json topology and save it to ${EXPECTED_RESPONSES_FOLDER}.
 252     ...    Wait until Compare_Topology matches. ${ACTUAL_RESPONSES_FOLDER} will hold its last result.
 253     ${topology_normalized}=    Normalize_And_Save_Expected_Json    ${json_topology}    ${filename}    ${EXPECTED_RESPONSES_FOLDER}
 254     BuiltIn.Wait_Until_Keyword_Succeeds    ${timeout}    ${refresh}    Compare_Topology    ${topology_normalized}    ${filename}
 255
 256 Verify_That_Topology_Does_Not_Change_From
 257     [Arguments]    ${json_topology}    ${filename}    ${timeout}=10s    ${refresh}=1s
 258     [Documentation]    Normalize the expected json topology and save it to ${EXPECTED_RESPONSES_FOLDER}.
 259     ...    Verify that Compare_Topology keeps passing. ${ACTUAL_RESPONSES_FOLDER} will hold its last result.
 260     ${topology_normalized}=    Normalize_And_Save_Expected_Json    ${json_topology}    ${filename}    ${EXPECTED_RESPONSES_FOLDER}
 261     WaitForFailure.Verify_Keyword_Does_Not_Fail_Within_Timeout    ${timeout}    ${refresh}    Compare_Topology    ${topology_normalized}    ${filename}
 262
 263 Compare_Topology
 264     [Arguments]    ${expected_normalized}    ${filename}
 265     [Documentation]    Get current example-ipv4-topology as json, normalize it, save to ${ACTUAL_RESPONSES_FOLDER}.
 266     ...    Check that status code is 200, check that normalized jsons match exactly.
 267     ${response}=    RequestsLibrary.Get Request    operational    topology/example-ipv4-topology
 268     BuiltIn.Log    ${response.status_code}
 269     BuiltIn.Log    ${response.text}
 270     ${actual_normalized}=    Normalize_And_Save_Expected_Json    ${response.text}    ${filename}    ${ACTUAL_RESPONSES_FOLDER}
 271     BuiltIn.Should_Be_Equal_As_Strings    ${response.status_code}    200
 272     BuiltIn.Should_Be_Equal    ${actual_normalized}    ${expected_normalized}
 273
 274 Normalize_And_Save_Expected_Json
 275     [Arguments]    ${json_text}    ${filename}    ${directory}
 276     [Documentation]    Normalize given json using norm_json library. Log and save the result to given filename under given directory.
 277     ${json_normalized}=    norm_json.normalize_json_text    ${json_text}
 278     BuiltIn.Log    ${json_normalized}
 279     OperatingSystem.Create_File    ${directory}${/}${filename}    ${json_normalized}
 280     # TODO: Should we prepend .json to the filename? When we detect it is not already prepended?
 281     [Return]    ${json_normalized}
 282
 283 Check_Speaker_Is_Not_Connected
 284     [Documentation]    Give it a few tries to see zero established connections.
 285     BuiltIn.Wait_Until_Keyword_Succeeds    3s    1s    Check_Number_Of_Speaker_Connections    0
 286
 287 Check_Speaker_Is_Connected
 288     [Documentation]    Give it several tries to see exactly one established connection.
 289     BuiltIn.Wait_Until_Keyword_Succeeds    5s    1s    Check_Number_Of_Speaker_Connections    1
 290
 291 Check_Number_Of_Speaker_Connections
 292     [Arguments]    ${howmany}
 293     [Documentation]    Run netstat in mininet machine and parse it for number of established connections. Check it is ${howmany}.
 294     ${output}=    SSHKeywords.Count_Port_Occurences    17900    ESTABLISHED    python
 295     BuiltIn.Should_Be_Equal_As_Strings    ${output}    ${howmany}