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