csit/suites/bgpcep/bgpingest/singlepeer_prefixcount.robot

   1 *** Settings ***
   2 Documentation     BGP performance of ingesting from 1 iBGP peer, data change counter is NOT used.
   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 ...
  11 ...               This suite uses play.py as single iBGP peer.
  12 ...               The suite only looks at example-ipv4-topology, so RIB is not examined.
  13 ...
  14 ...               The suite consists of two halves, differing on which side initiates BGP connection.
  15 ...               State of "work is being done" is detected by increasing value of prefixes in topology.
  16 ...               The time for Wait_For_Stable_* cases to finish is the main performance metric.
  17 ...               After waiting for stability is done, full check on number of prefixes present is performed.
  18 ...
  19 ...               Brief description how to configure BGP peer can be found here:
  20 ...               https://wiki.opendaylight.org/view/BGP_LS_PCEP:User_Guide#BGP_Peer
  21 ...               http://docs.opendaylight.org/en/stable-boron/user-guide/bgp-user-guide.html#bgp-peering
  22 ...
  23 ...               TODO: Currently, if a bug causes prefix count to remain at zero,
  24 ...               affected test cases will wait for max time. Reconsider.
  25 ...               If zero is allowed as stable, higher period or repetitions would be required.
  26 ...
  27 ...               The prefix counting is quite heavyweight and may induce large variation in time.
  28 ...               Try the other version of the suite (singlepeer_changecount.robot) to get better precision.
  29 Suite Setup       Setup_Everything
  30 Suite Teardown    Teardown_Everything
  31 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  32 Test Teardown     SetupUtils.Teardown_Test_Show_Bugs_And_Start_Fast_Failing_If_Test_Failed
  33 Library           SSHLibrary    timeout=10s
  34 Library           RequestsLibrary
  35 Resource          ../../../libraries/BGPSpeaker.robot
  36 Resource          ../../../libraries/FailFast.robot
  37 Resource          ../../../libraries/KillPythonTool.robot
  38 Resource          ../../../libraries/PrefixCounting.robot
  39 Resource          ../../../libraries/SetupUtils.robot
  40 Resource          ../../../libraries/SSHKeywords.robot
  41 Resource          ../../../libraries/TemplatedRequests.robot
  42 Resource          ../../../libraries/Utils.robot
  43 Resource          ../../../variables/Variables.robot
  44
  45 *** Variables ***
  46 ${BGP_TOOL_LOG_LEVEL}    info
  47 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  48 ${CHECK_PERIOD}    60
  49 ${CHECK_PERIOD_PREFIX_COUNT}    ${CHECK_PERIOD}
  50 ${CHECK_PERIOD_PREFIX_COUNT_SINGLE}    ${CHECK_PERIOD_PREFIX_COUNT}
  51 ${COUNT}          600000
  52 ${COUNT_PREFIX_COUNT}    ${COUNT}
  53 ${COUNT_PREFIX_COUNT_SINGLE}    ${COUNT_PREFIX_COUNT}
  54 ${HOLDTIME}       180
  55 ${HOLDTIME_PREFIX_COUNT}    ${HOLDTIME}
  56 ${HOLDTIME_PREFIX_COUNT_SINGLE}    ${HOLDTIME_PREFIX_COUNT}
  57 ${INSERT}         1
  58 ${PREFILL}        0
  59 ${REPETITIONS}    1
  60 ${REPETITIONS_PREFIX_COUNT}    ${REPETITIONS}
  61 ${REPETITIONS_PREFIX_COUNT_SINGLE}    ${REPETITIONS_PREFIX_COUNT}
  62 ${RESULTS_FILE_NAME}    bgp.csv
  63 ${TEST_DURATION_MULTIPLIER}    1
  64 ${TEST_DURATION_MULTIPLIER_PREFIX_COUNT}    ${TEST_DURATION_MULTIPLIER}
  65 ${TEST_DURATION_MULTIPLIER_PREFIX_COUNT_SINGLE}    ${TEST_DURATION_MULTIPLIER_PREFIX_COUNT}
  66 ${UPDATE}         single
  67 ${WITHDRAW}       0
  68 ${RIB_INSTANCE}    example-bgp-rib
  69 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  70 ${DEVICE_NAME}    controller-config
  71 ${BGP_PEER_NAME}    example-bgp-peer
  72 # TODO: Option names can be better.
  73
  74 *** Test Cases ***
  75 Check_For_Empty_Ipv4_Topology_Before_Talking
  76     [Documentation]    Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
  77     [Tags]    critical
  78     # TODO: Choose which tags to assign and make sure they are assigned correctly.
  79     BuiltIn.Wait_Until_Keyword_Succeeds    120s    1s    PrefixCounting.Check_Ipv4_Topology_Is_Empty
  80
  81 Reconfigure_ODL_To_Accept_Connection
  82     [Documentation]    Configure BGP peer module with initiate-connection set to false.
  83     &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME_PREFIX_COUNT_SINGLE}    PEER_PORT=${BGP_TOOL_PORT}
  84     ...    INITIATE=false    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=true    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}    RIB_INSTANCE_NAME=${RIB_INSTANCE}
  85     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
  86
  87 Start_Talking_BGP_Speaker
  88     [Documentation]    Start Python speaker to connect to ODL.
  89     # Myport value is needed for checking whether connection at precise port was established.
  90     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_PREFIX_COUNT_SINGLE} --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT} --insert=${INSERT} --withdraw=${WITHDRAW} --prefill ${PREFILL} --update ${UPDATE} --${BGP_TOOL_LOG_LEVEL} --results ${RESULTS_FILE_NAME}
  91
  92 Wait_For_Stable_Talking_Ipv4_Topology
  93     [Documentation]    Wait until example-ipv4-topology becomes stable. This is done by checking stability of prefix count.
  94     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT_SINGLE}    repetitions=${REPETITIONS_PREFIX_COUNT_SINGLE}    excluded_count=0
  95
  96 Check_Talking_Ipv4_Topology_Count
  97     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
  98     [Tags]    critical
  99     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 100     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_PREFIX_COUNT_SINGLE}
 101
 102 Kill_Talking_BGP_Speaker
 103     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 104     [Tags]    critical
 105     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 106     BGPSpeaker.Kill_BGP_Speaker
 107     FailFast.Do_Not_Fail_Fast_From_Now_On
 108     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 109     [Teardown]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
 110
 111 Store_Results_For_Talking_BGP_Speaker
 112     [Documentation]    Store results for plotting
 113     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 114     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    totals-${RESULTS_FILE_NAME}
 115     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    performance-${RESULTS_FILE_NAME}
 116     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    prefixcount-talking-totals-${RESULTS_FILE_NAME}
 117     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    prefixcount-talking-performance-${RESULTS_FILE_NAME}
 118
 119 Wait_For_Stable_Ipv4_Topology_After_Talking
 120     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 121     [Tags]    critical
 122     # TODO: Is is possible to have failed at Check_Talking_Ipv4_Topology_Count and still have initial period of constant count?
 123     # FIXME: If yes, do count here to get the initial value and use it (if nonzero).
 124     # TODO: If yes, decide whether access to the FailFast state should have keyword or just variable name.
 125     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT_SINGLE}    repetitions=${REPETITIONS_PREFIX_COUNT_SINGLE}    excluded_count=${COUNT_PREFIX_COUNT_SINGLE}
 126
 127 Check_For_Empty_Ipv4_Topology_After_Talking
 128     [Documentation]    Example-ipv4-topology should be empty now.
 129     [Tags]    critical
 130     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 131     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 132
 133 Start_Listening_BGP_Speaker
 134     [Documentation]    Start Python speaker in listening mode.
 135     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_PREFIX_COUNT_SINGLE} --listen --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --insert=${INSERT} --withdraw=${WITHDRAW} --prefill ${PREFILL} --update ${UPDATE} --${BGP_TOOL_LOG_LEVEL} --results ${RESULTS_FILE_NAME}
 136
 137 Reconfigure_ODL_To_Initiate_Connection
 138     [Documentation]    Replace BGP peer config module, now with initiate-connection set to true.
 139     &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME_PREFIX_COUNT_SINGLE}    PEER_PORT=${BGP_TOOL_PORT}
 140     ...    INITIATE=true    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=false    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}    RIB_INSTANCE_NAME=${RIB_INSTANCE}
 141     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 142
 143 Wait_For_Stable_Listening_Ipv4_Topology
 144     [Documentation]    Wait until example-ipv4-topology becomes stable.
 145     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT_SINGLE}    repetitions=${REPETITIONS_PREFIX_COUNT_SINGLE}    excluded_count=0
 146
 147 Check_Listening_Ipv4_Topology_Count
 148     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
 149     [Tags]    critical
 150     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 151     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_PREFIX_COUNT_SINGLE}
 152
 153 Kill_Listening_BGP_Speaker
 154     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 155     [Tags]    critical
 156     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 157     BGPSpeaker.Kill_BGP_Speaker
 158     FailFast.Do_Not_Fail_Fast_From_Now_On
 159     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 160     [Teardown]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
 161
 162 Store_Results_For_Listening_BGP_Speaker
 163     [Documentation]    Store results for plotting
 164     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 165     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    totals-${RESULTS_FILE_NAME}
 166     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    performance-${RESULTS_FILE_NAME}
 167     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    prefixcount-listening-totals-${RESULTS_FILE_NAME}
 168     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    prefixcount-listening-performance-${RESULTS_FILE_NAME}
 169
 170 Wait_For_Stable_Ipv4_Topology_After_Listening
 171     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 172     [Tags]    critical
 173     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT_SINGLE}    repetitions=${REPETITIONS_PREFIX_COUNT_SINGLE}    excluded_count=${COUNT_PREFIX_COUNT_SINGLE}
 174
 175 Check_For_Empty_Ipv4_Topology_After_Listening
 176     [Documentation]    Example-ipv4-topology should be empty now.
 177     [Tags]    critical
 178     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 179     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 180
 181 Delete_Bgp_Peer_Configuration
 182     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 183     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 184     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 185     TemplatedRequests.Delete_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 186
 187 *** Keywords ***
 188 Setup_Everything
 189     [Documentation]    Setup imported resources, SSH-login to tools system,
 190     ...    create HTTP session, put Python tool to tools system.
 191     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 192     TemplatedRequests.Create_Default_Session
 193     PrefixCounting.PC_Setup
 194     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}    timeout=125    max_retries=0
 195     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
 196     # TODO: Alternatively, create variable in Variables which starts with http.
 197     # Both TODOs would probably need to update every suite relying on current Variables.
 198     SSHLibrary.Set_Default_Configuration    prompt=${TOOLS_SYSTEM_PROMPT}
 199     SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}
 200     SSHKeywords.Flexible_Mininet_Login
 201     SSHKeywords.Require_Python
 202     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
 203     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 204     # Calculate the timeout value based on how many routes are going to be pushed
 205     # TODO: Replace 20 with some formula from period and repetitions.
 206     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER_PREFIX_COUNT_SINGLE} * (${COUNT_PREFIX_COUNT_SINGLE} * 9.0 / 10000 + 20)
 207     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${timeout}
 208
 209 Teardown_Everything
 210     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
 211     # Environment issue may have dropped the SSH connection, but we do not want Teardown to fail.
 212     BuiltIn.Run_Keyword_And_Ignore_Error    KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 213     BuiltIn.Run_Keyword_And_Ignore_Error    Utils.Get_Sysstat_Statistics
 214     RequestsLibrary.Delete_All_Sessions
 215     SSHLibrary.Close_All_Connections
 216
 217 Store_File_To_Workspace
 218     [Arguments]    ${src_file_name}    ${dst_file_name}
 219     [Documentation]    Store the provided file from the SSH client to workspace.
 220     ${files}=    SSHLibrary.List Files In Directory    .
 221     ${output_log}=    SSHLibrary.Execute_Command    cat ${src_file_name}
 222     BuiltIn.Log    ${output_log}
 223     Create File    ${dst_file_name}    ${output_log}