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 ...               TODO: Currently, if a bug causes prefix count to remain at zero,
  20 ...               affected test cases will wait for max time. Reconsider.
  21 ...               If zero is allowed as stable, higher period or repetitions would be required.
  22 ...
  23 ...               The prefix counting is quite heavyweight and may induce large variation in time.
  24 ...               Try the other version of the suite (singlepeer_changecount.robot) to get better precision.
  25 Suite Setup       Setup_Everything
  26 Suite Teardown    Teardown_Everything
  27 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  28 Test Teardown     FailFast.Start_Failing_Fast_If_This_Failed
  29 Library           SSHLibrary    timeout=10s
  30 Library           RequestsLibrary
  31 Variables         ${CURDIR}/../../../variables/Variables.py
  32 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  33 Resource          ${CURDIR}/../../../libraries/ConfigViaRestconf.robot
  34 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  35 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  36 Resource          ${CURDIR}/../../../libraries/PrefixCounting.robot
  37 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  38
  39 *** Variables ***
  40 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  41 ${HOLDTIME}       180
  42 ${HOLDTIME_PREFIX_COUNT}    ${HOLDTIME}
  43 ${COUNT}          1000000
  44 ${COUNT_PREFIX_COUNT}    ${COUNT}
  45 ${CHECK_PERIOD}    1
  46 ${CHECK_PERIOD_PREFIX_COUNT}    ${CHECK_PERIOD}
  47 ${REPETITIONS_PREFIX_COUNT}    1
  48 ${INSERT}         1
  49 ${WITHDRAW}       0
  50 ${PREFILL}        0
  51 ${UPDATE}         single
  52 ${BGP_TOOL_LOG_LEVEL}    info
  53 ${CONTROLLER_LOG_LEVEL}    INFO
  54 ${CONTROLLER_BGP_LOG_LEVEL}    DEFAULT
  55 ${RESULTS_FILE_NAME}    bgp.csv
  56 ${TEST_DURATION_MULTIPLIER}    1
  57 # TODO: Option names can be better.
  58 ${last_prefix_count}    -1
  59
  60 *** Test Cases ***
  61 Check_For_Empty_Ipv4_Topology_Before_Talking
  62     [Documentation]    Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
  63     [Tags]    critical
  64     # TODO: Choose which tags to assign and make sure they are assigned correctly.
  65     BuiltIn.Wait_Until_Keyword_Succeeds    120s    1s    PrefixCounting.Check_Ipv4_Topology_Is_Empty
  66
  67 Reconfigure_ODL_To_Accept_Connection
  68     [Documentation]    Configure BGP peer module with initiate-connection set to false.
  69     ${template_as_string} =    BuiltIn.Set_Variable    {'NAME': 'example-bgp-peer', 'IP': '${TOOLS_SYSTEM_IP}', 'HOLDTIME': '${HOLDTIME_PREFIX_COUNT}', 'PEER_PORT': '${BGP_TOOL_PORT}', 'INITIATE': 'false'}
  70     ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    ${template_as_string}
  71
  72 Start_Talking_BGP_Speaker
  73     [Documentation]    Start Python speaker to connect to ODL.
  74     # Myport value is needed for checking whether connection at precise port was established.
  75     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_PREFIX_COUNT} --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}
  76
  77 Wait_For_Stable_Talking_Ipv4_Topology
  78     [Documentation]    Wait until example-ipv4-topology becomes stable. This is done by checking stability of prefix count.
  79     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT}    repetitions=${REPETITIONS_PREFIX_COUNT}    excluded_count=0
  80
  81 Check_Talking_Ipv4_Topology_Count
  82     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
  83     [Tags]    critical
  84     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_PREFIX_COUNT}
  85
  86 Kill_Talking_BGP_Speaker
  87     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
  88     [Tags]    critical
  89     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
  90     BGPSpeaker.Kill_BGP_Speaker
  91     FailFast.Do_Not_Fail_Fast_From_Now_On
  92     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
  93     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
  94
  95 Store_Results_For_Talking_BGP_Speaker
  96     [Documentation]    Store results for plotting
  97     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
  98     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    totals-${RESULTS_FILE_NAME}
  99     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    performance-${RESULTS_FILE_NAME}
 100     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    prefixcount-talking-totals-${RESULTS_FILE_NAME}
 101     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    prefixcount-talking-performance-${RESULTS_FILE_NAME}
 102
 103 Wait_For_Stable_Ipv4_Topology_After_Talking
 104     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 105     [Tags]    critical
 106     # TODO: Is is possible to have failed at Check_Talking_Ipv4_Topology_Count and still have initial period of constant count?
 107     # FIXME: If yes, do count here to get the initial value and use it (if nonzero).
 108     # TODO: If yes, decide whether access to the FailFast state should have keyword or just variable name.
 109     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT}    repetitions=${REPETITIONS_PREFIX_COUNT}    excluded_count=${COUNT_PREFIX_COUNT}
 110
 111 Check_For_Empty_Ipv4_Topology_After_Talking
 112     [Documentation]    Example-ipv4-topology should be empty now.
 113     [Tags]    critical
 114     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 115
 116 Start_Listening_BGP_Speaker
 117     [Documentation]    Start Python speaker in listening mode.
 118     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_PREFIX_COUNT} --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}
 119
 120 Reconfigure_ODL_To_Initiate_Connection
 121     [Documentation]    Replace BGP peer config module, now with initiate-connection set to true.
 122     ${template_as_string} =    BuiltIn.Set_Variable    {'NAME': 'example-bgp-peer', 'IP': '${TOOLS_SYSTEM_IP}', 'HOLDTIME': '${HOLDTIME_PREFIX_COUNT}', 'PEER_PORT': '${BGP_TOOL_PORT}', 'INITIATE': 'true'}
 123     ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    ${template_as_string}
 124
 125 Wait_For_Stable_Listening_Ipv4_Topology
 126     [Documentation]    Wait until example-ipv4-topology becomes stable.
 127     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT}    repetitions=${REPETITIONS_PREFIX_COUNT}    excluded_count=0
 128
 129 Check_Listening_Ipv4_Topology_Count
 130     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
 131     [Tags]    critical
 132     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_PREFIX_COUNT}
 133
 134 Kill_Listening_BGP_Speaker
 135     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 136     [Tags]    critical
 137     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 138     BGPSpeaker.Kill_BGP_Speaker
 139     FailFast.Do_Not_Fail_Fast_From_Now_On
 140     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 141     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
 142
 143 Store_Results_For_Listening_BGP_Speaker
 144     [Documentation]    Store results for plotting
 145     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 146     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    totals-${RESULTS_FILE_NAME}
 147     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    performance-${RESULTS_FILE_NAME}
 148     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    prefixcount-listening-totals-${RESULTS_FILE_NAME}
 149     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    prefixcount-listening-performance-${RESULTS_FILE_NAME}
 150
 151 Wait_For_Stable_Ipv4_Topology_After_Listening
 152     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 153     [Tags]    critical
 154     PrefixCounting.Wait_For_Ipv4_Topology_Prefixes_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_PREFIX_COUNT}    repetitions=${REPETITIONS_PREFIX_COUNT}    excluded_count=${COUNT_PREFIX_COUNT}
 155
 156 Check_For_Empty_Ipv4_Topology_After_Listening
 157     [Documentation]    Example-ipv4-topology should be empty now.
 158     [Tags]    critical
 159     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 160
 161 Delete_Bgp_Peer_Configuration
 162     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 163     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 164     ${template_as_string} =    BuiltIn.Set_Variable    {'NAME': 'example-bgp-peer'}
 165     ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    ${template_as_string}
 166
 167 *** Keywords ***
 168 Setup_Everything
 169     [Documentation]    Setup imported resources, SSH-login to tools system,
 170     ...    create HTTP session, put Python tool to tools system.
 171     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 172     ConfigViaRestconf.Setup_Config_Via_Restconf
 173     PrefixCounting.PC_Setup
 174     SSHLibrary.Set_Default_Configuration    prompt=${TOOLS_SYSTEM_PROMPT}
 175     SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}
 176     Utils.Flexible_Mininet_Login
 177     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_API}    auth=${AUTH}
 178     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
 179     # TODO: Alternatively, create variable in Variables which starts with http.
 180     # Both TODOs would probably need to update every suite relying on current Variables.
 181     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 182     # Calculate the timeout value based on how many routes are going to be pushed
 183     # TODO: Replace 20 with some formula from period and repetitions.
 184     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER} * ${COUNT_PREFIX_COUNT} * 3.0 / 10000 + 20
 185     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${timeout}
 186     Builtin.Set_Suite_Variable    ${bgp_emptying_timeout}    ${bgp_filling_timeout*3.0/4}
 187     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_LOG_LEVEL}
 188     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.bgpcep
 189     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.protocol
 190
 191 Teardown_Everything
 192     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
 193     KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 194     ConfigViaRestconf.Teardown_Config_Via_Restconf
 195     RequestsLibrary.Delete_All_Sessions
 196     SSHLibrary.Close_All_Connections
 197
 198 Store_File_To_Workspace
 199     [Arguments]    ${src_file_name}    ${dst_file_name}
 200     [Documentation]    Store the provided file from the SSH client to workspace.
 201     ${files}=    SSHLibrary.List Files In Directory    .
 202     ${output_log}=    SSHLibrary.Execute_Command    cat ${src_file_name}
 203     BuiltIn.Log    ${output_log}
 204     Create File    ${dst_file_name}    ${output_log}