csit/suites/bgpcep/bgpingest/singlepeer_changecount.robot

   1 *** Settings ***
   2 Documentation     BGP performance of ingesting from 1 iBGP peer, data change counter is 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 ...               This suite requires odl-bgpcep-data-change-counter to be installed so
  15 ...               make sure it is added to "install-features" of any jobs that are going
  16 ...               to invoke it.
  17 ...
  18 ...               The suite consists of two halves, differing on which side initiates BGP connection.
  19 ...               Data change counter is a lightweight way to detect "work is being done".
  20 ...               WaitUtils provide a nice Keyword to wait for stability, but it needs
  21 ...               initial value, that is why Store_Change_Count appears just before work-inducing action.
  22 ...               The time for Wait_For_Stable_* cases to finish is the main performance metric.
  23 ...               After waiting for stability is done, full check on number of prefixes present is performed.
  24 ...
  25 ...               TODO: Currently, if a bug causes zero increase of data changes,
  26 ...               affected test cases will wait for max time. Reconsider.
  27 ...               If zero increase is allowed as stable, higher number of repetitions should be required.
  28 ...
  29 ...               Additionally this test suite is not compatible with Helium and Hydrogen
  30 ...               releases as they don't include data change counter feature.
  31 ...               Use the other version of the suite (singlepeer_prefixcount.robot) to test them.
  32 Suite Setup       Setup_Everything
  33 Suite Teardown    Teardown_Everything
  34 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  35 Test Teardown     FailFast.Start_Failing_Fast_If_This_Failed
  36 Library           SSHLibrary    timeout=10s
  37 Library           RequestsLibrary
  38 Variables         ${CURDIR}/../../../variables/Variables.py
  39 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  40 Resource          ${CURDIR}/../../../libraries/ChangeCounter.robot
  41 Resource          ${CURDIR}/../../../libraries/ConfigViaRestconf.robot
  42 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  43 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  44 Resource          ${CURDIR}/../../../libraries/PrefixCounting.robot
  45 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  46
  47 *** Variables ***
  48 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  49 ${HOLDTIME}       180
  50 ${HOLDTIME_CHANGE_COUNT}    ${HOLDTIME}
  51 ${COUNT}          1000000
  52 ${COUNT_CHANGE_COUNT}    ${COUNT}
  53 ${CHECK_PERIOD}    1
  54 ${CHECK_PERIOD_CHANGE_COUNT}    ${CHECK_PERIOD}
  55 ${REPETITIONS_CHANGE_COUNT}    1
  56 ${INSERT}         1
  57 ${WITHDRAW}       0
  58 ${PREFILL}        0
  59 ${UPDATE}         single
  60 ${BGP_TOOL_LOG_LEVEL}    info
  61 ${CONTROLLER_LOG_LEVEL}    INFO
  62 ${CONTROLLER_BGP_LOG_LEVEL}    DEFAULT
  63 ${RESULTS_FILE_NAME}    bgp.csv
  64 # TODO: Option names can be better.
  65 ${last_change_count}    -1
  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_CHANGE_COUNT}', '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 Wait_For_Data_Change_Counter_Ready
  80     [Documentation]    Data change counter might have been slower to start than ipv4 topology, wait for it.
  81     BuiltIn.Wait_Until_Keyword_Succeeds    60s    1s    ChangeCounter.Get_Change_Count
  82
  83 Reconfigure_Data_Change_Counter
  84     [Documentation]    Configure data change counter to count transactions in example-ipv4-topology instead of example-linkstate-topology.
  85     ChangeCounter.Reconfigure_Topology_Name    example-ipv4-topology
  86
  87 Start_Talking_BGP_Speaker
  88     [Documentation]    Start Python speaker to connect to ODL.
  89     Store_Change_Count
  90     # Myport value is needed for checking whether connection at precise port was established.
  91     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_CHANGE_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}
  92
  93 Wait_For_Stable_Talking_Ipv4_Topology
  94     [Documentation]    Wait until example-ipv4-topology becomes stable. This is done by checking the change counter.
  95     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT}    repetitions=${REPETITIONS_CHANGE_COUNT}    count_to_overcome=${last_change_count}
  96
  97 Check_Talking_Ipv4_Topology_Count
  98     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
  99     [Tags]    critical
 100     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_CHANGE_COUNT}
 101
 102 Kill_Talking_BGP_Speaker
 103     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 104     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 105     Store_Change_Count
 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]    FailFast.Do_Not_Start_Failing_If_This_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}    changecount-talking-totals-${RESULTS_FILE_NAME}
 117     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    changecount-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     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_emptying_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT}    repetitions=${REPETITIONS_CHANGE_COUNT}    count_to_overcome=${last_change_count}
 123
 124 Check_For_Empty_Ipv4_Topology_After_Talking
 125     [Documentation]    Example-ipv4-topology should be empty now.
 126     [Tags]    critical
 127     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 128
 129 Start_Listening_BGP_Speaker
 130     [Documentation]    Start Python speaker in listening mode.
 131     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_CHANGE_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}
 132
 133 Reconfigure_ODL_To_Initiate_Connection
 134     [Documentation]    Replace BGP peer config module, now with initiate-connection set to true.
 135     Store_Change_Count
 136     ${template_as_string} =    BuiltIn.Set_Variable    {'NAME': 'example-bgp-peer', 'IP': '${TOOLS_SYSTEM_IP}', 'HOLDTIME': '${HOLDTIME_CHANGE_COUNT}', 'PEER_PORT': '${BGP_TOOL_PORT}', 'INITIATE': 'true'}
 137     ConfigViaRestconf.Put_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    ${template_as_string}
 138
 139 Wait_For_Stable_Listening_Ipv4_Topology
 140     [Documentation]    Wait until example-ipv4-topology becomes stable.
 141     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT}    repetitions=${REPETITIONS_CHANGE_COUNT}    count_to_overcome=${last_change_count}
 142
 143 Check_Listening_Ipv4_Topology_Count
 144     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
 145     [Tags]    critical
 146     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_CHANGE_COUNT}
 147
 148 Kill_Listening_BGP_Speaker
 149     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 150     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 151     Store_Change_Count
 152     BGPSpeaker.Kill_BGP_Speaker
 153     FailFast.Do_Not_Fail_Fast_From_Now_On
 154     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 155     [Teardown]    FailFast.Do_Not_Start_Failing_If_This_Failed
 156
 157 Store_Results_For_Listening_BGP_Speaker
 158     [Documentation]    Store results for plotting
 159     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 160     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    totals-${RESULTS_FILE_NAME}
 161     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    performance-${RESULTS_FILE_NAME}
 162     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    changecount-listening-totals-${RESULTS_FILE_NAME}
 163     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    changecount-listening-performance-${RESULTS_FILE_NAME}
 164
 165 Wait_For_Stable_Ipv4_Topology_After_Listening
 166     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 167     [Tags]    critical
 168     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_emptying_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT}    repetitions=${REPETITIONS_CHANGE_COUNT}    count_to_overcome=${last_change_count}
 169
 170 Check_For_Empty_Ipv4_Topology_After_Listening
 171     [Documentation]    Example-ipv4-topology should be empty now.
 172     [Tags]    critical
 173     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 174
 175 Restore_Data_Change_Counter_Configuration
 176     [Documentation]    Configure data change counter back to count transactions affecting example-linkstate-topology.
 177     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 178     ChangeCounter.Reconfigure_Topology_Name    example-linkstate-topology
 179
 180 Delete_Bgp_Peer_Configuration
 181     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 182     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 183     ${template_as_string} =    BuiltIn.Set_Variable    {'NAME': 'example-bgp-peer'}
 184     ConfigViaRestconf.Delete_Xml_Template_Folder_Config_Via_Restconf    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    ${template_as_string}
 185
 186 *** Keywords ***
 187 Setup_Everything
 188     [Documentation]    Setup imported resources, SSH-login to tools system,
 189     ...    create HTTP session, put Python tool to tools system.
 190     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 191     ConfigViaRestconf.Setup_Config_Via_Restconf
 192     ChangeCounter.CC_Setup
 193     PrefixCounting.PC_Setup
 194     SSHLibrary.Set_Default_Configuration    prompt=${TOOLS_SYSTEM_PROMPT}
 195     SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}
 196     Utils.Flexible_Mininet_Login
 197     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${OPERATIONAL_API}    auth=${AUTH}
 198     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
 199     # TODO: Alternatively, create variable in Variables which starts with http.
 200     # Both TODOs would probably need to update every suite relying on current Variables.
 201     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 202     # Calculate the timeout value based on how many routes are going to be pushed
 203     ${count} =    Builtin.Convert_To_Integer    ${COUNT_CHANGE_COUNT}
 204     # TODO: Replace 20 with some formula from period and repetitions.
 205     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${count*3/10000+20}
 206     Builtin.Set_Suite_Variable    ${bgp_emptying_timeout}    ${bgp_filling_timeout*3/4}
 207     # Timeout in case of doubled number of updates per iteration (per prefix count increase in the simplest mixed scenario)
 208     Builtin.Run_Keyword_If    '${UPDATE}' == 'mixed'    Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${count*6/10000+20}
 209     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_LOG_LEVEL}
 210     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.bgpcep
 211     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${CONTROLLER_BGP_LOG_LEVEL} org.opendaylight.protocol
 212
 213 Teardown_Everything
 214     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
 215     KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 216     ConfigViaRestconf.Teardown_Config_Via_Restconf
 217     RequestsLibrary.Delete_All_Sessions
 218     SSHLibrary.Close_All_Connections
 219
 220 Store_Change_Count
 221     [Documentation]    Get the count of changes from BGP change counter. Ignore error or store the value.
 222     ${status}    ${count} =    BuiltIn.Run_Keyword_And_Ignore_Error    ChangeCounter.Get_Change_Count
 223     BuiltIn.Run_Keyword_If    '${status}' == 'PASS'    BuiltIn.Set_Suite_Variable    ${last_change_count}    ${count}
 224
 225 Store_File_To_Workspace
 226     [Arguments]    ${src_file_name}    ${dst_file_name}
 227     [Documentation]    Store the provided file from the SSH client to workspace.
 228     ${files}=    SSHLibrary.List Files In Directory    .
 229     ${output_log}=    SSHLibrary.Execute_Command    cat ${src_file_name}
 230     BuiltIn.Log    ${output_log}
 231     Create File    ${dst_file_name}    ${output_log}