csit/suites/bgpcep/bgpingest/manypeers_changecount.robot

   1 *** Settings ***
   2 Documentation     BGP performance of ingesting from many iBGP peers, 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 processes as iBGP peers.
  12 ...               This is analogue of single peer performance suite, which uses many peers.
  13 ...               Each peer is of ibgp type, and they contribute to the same example-bgp-rib,
  14 ...               and thus to the same single example-ipv4-topology.
  15 ...               The suite only looks at example-ipv4-topology, so RIB is not examined.
  16 ...
  17 ...               This suite requires odl-bgpcep-data-change-counter to be installed so
  18 ...               make sure it is added to "install-features" of any jobs that are going to invoke it.
  19 ...               Use the other version of the suite (manypeers_prefixcount.robot) if the feature does not work.
  20 ...
  21 ...               The suite consists of two halves, differing on which side initiates BGP connection.
  22 ...               Data change counter is a lightweight way to detect "work is being done".
  23 ...               WaitUtils provide a nice Keyword to wait for stability, but it needs
  24 ...               initial value, that is why Store_Change_Count appears just before work-inducing action.
  25 ...               The time for Wait_For_Stable_* cases to finish is the main performance metric.
  26 ...               After waiting for stability is done, full check on number of prefixes present is performed.
  27 ...
  28 ...               TODO: Currently, if a bug causes zero increase of data changes,
  29 ...               affected test cases will wait for max time. Reconsider.
  30 ...               If zero increase is allowed as stable, higher number of repetitions should be required.
  31 ...
  32 ...               ODL distinguishes peers by their IP addresses.
  33 ...               Currently, this suite requires python utils to be started on ODL System,
  34 ...               to guarantee IP address block is available for them to bind to.
  35 ...               TODO: Figure out how to use Docker and docker IP pool available in RelEng.
  36 ...
  37 ...               Currently, 127.0.0.1 is hardcoded as the first peer address to use.
  38 ...               TODO: Figure out how to make it configurable.
  39 ...               As peer IP adresses are set incrementally, we need ipaddr to be used in Robot somehow.
  40 ...
  41 ...               Brief description how to configure BGP peer can be found here:
  42 ...               https://wiki.opendaylight.org/view/BGP_LS_PCEP:User_Guide#BGP_Peer
  43 ...               http://docs.opendaylight.org/en/stable-boron/user-guide/bgp-user-guide.html#bgp-peering
  44 ...
  45 ...               TODO: Is there a need for version of this suite where ODL connects to pers?
  46 ...               Note that configuring ODL is slow, which may affect measured performance singificantly.
  47 ...               Advanced TODO: Give manager ability to start pushing on trigger long after connections are established.
  48 Suite Setup       Setup_Everything
  49 Suite Teardown    Teardown_Everything
  50 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  51 Test Teardown     SetupUtils.Teardown_Test_Show_Bugs_And_Start_Fast_Failing_If_Test_Failed
  52 Library           DateTime
  53 Library           RequestsLibrary
  54 Library           SSHLibrary    timeout=10s
  55 Resource          ../../../libraries/BGPSpeaker.robot
  56 Resource          ../../../libraries/ChangeCounter.robot
  57 Resource          ../../../libraries/FailFast.robot
  58 Resource          ../../../libraries/KarafKeywords.robot
  59 Resource          ../../../libraries/KillPythonTool.robot
  60 Resource          ../../../libraries/PrefixCounting.robot
  61 Resource          ../../../libraries/SetupUtils.robot
  62 Resource          ../../../libraries/SSHKeywords.robot
  63 Resource          ../../../libraries/TemplatedRequests.robot
  64 Resource          ../../../libraries/Utils.robot
  65 Resource          ../../../variables/Variables.robot
  66
  67 *** Variables ***
  68 ${BGP_TOOL_LOG_LEVEL}    info
  69 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  70 ${CHECK_PERIOD}    60
  71 ${CHECK_PERIOD_CHANGE_COUNT}    ${CHECK_PERIOD}
  72 ${CHECK_PERIOD_CHANGE_COUNT_MANY}    ${CHECK_PERIOD_CHANGE_COUNT}
  73 ${COUNT}          600000
  74 ${COUNT_CHANGE_COUNT}    ${COUNT}
  75 ${COUNT_CHANGE_COUNT_MANY}    ${COUNT_CHANGE_COUNT}
  76 ${FIRST_PEER_IP}    127.0.0.1
  77 ${HOLDTIME}       180
  78 ${HOLDTIME_CHANGE_COUNT}    ${HOLDTIME}
  79 ${HOLDTIME_CHANGE_COUNT_MANY}    ${HOLDTIME_CHANGE_COUNT}
  80 ${KARAF_LOG_LEVEL}    INFO
  81 ${KARAF_BGPCEP_LOG_LEVEL}    ${KARAF_LOG_LEVEL}
  82 ${KARAF_PROTOCOL_LOG_LEVEL}    ${KARAF_BGPCEP_LOG_LEVEL}
  83 ${MULTIPLICITY}    2    # May be increased after Bug 4488 is fixed.
  84 ${MULTIPLICITY_CHANGE_COUNT}    ${MULTIPLICITY}
  85 ${MULTIPLICITY_CHANGE_COUNT_MANY}    ${MULTIPLICITY_CHANGE_COUNT}
  86 ${REPETITIONS}    1    # Should be increased depending on multiplicity.
  87 ${REPETITIONS_CHANGE_COUNT}    ${REPETITIONS}
  88 ${REPETITIONS_CHANGE_COUNT_MANY}    ${REPETITIONS_CHANGE_COUNT}
  89 ${TEST_DURATION_MULTIPLIER}    1
  90 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}    ${TEST_DURATION_MULTIPLIER}
  91 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_MANY}    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}
  92 ${RIB_INSTANCE}    example-bgp-rib
  93 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  94 ${DEVICE_NAME}    controller-config
  95 # TODO: Option names can be better.
  96 ${last_change_count_many}    1
  97
  98 *** Test Cases ***
  99 Check_For_Empty_Ipv4_Topology_Before_Talking
 100     [Documentation]    Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
 101     [Tags]    critical
 102     # TODO: Choose which tags to assign and make sure they are assigned correctly.
 103     BuiltIn.Wait_Until_Keyword_Succeeds    120s    1s    PrefixCounting.Check_Ipv4_Topology_Is_Empty
 104
 105 Reconfigure_ODL_To_Accept_Connections
 106     [Documentation]    Configure BGP peer modules with initiate-connection set to false.
 107     : FOR    ${index}    IN RANGE    1    ${MULTIPLICITY_CHANGE_COUNT_MANY}+1
 108     \    ${peer_name} =    BuiltIn.Set_Variable    example-bgp-peer-${index}
 109     \    ${peer_ip} =    BuiltIn.Evaluate    str(ipaddr.IPAddress('${FIRST_PEER_IP}') + ${index} - 1)    modules=ipaddr
 110     \    &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${peer_name}    IP=${peer_ip}    HOLDTIME=${HOLDTIME_CHANGE_COUNT_MANY}
 111     \    ...    PEER_PORT=${BGP_TOOL_PORT}    INITIATE=false    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=true    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 112     \    ...    RIB_INSTANCE_NAME=${RIB_INSTANCE}
 113     \    TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 114     # FIXME: Add testcase to change bgpcep and protocol log levels, when a Keyword that does it without messing with current connection is ready.
 115
 116 Reconfigure_Data_Change_Counter
 117     [Documentation]    Configure data change counter to count transactions in example-ipv4-topology instead of example-linkstate-topology.
 118     ChangeCounter.Reconfigure_Topology_Name    example-ipv4-topology
 119
 120 Verify_For_Data_Change_Counter_Ready
 121     [Documentation]    Data change counter might have been slower to start than ipv4 topology, wait for it.
 122     BuiltIn.Wait_Until_Keyword_Succeeds    5s    1s    ChangeCounter.Get_Change_Count
 123
 124 Change_Karaf_Logging_Levels
 125     [Documentation]    We may want to set more verbose logging here after configuration is done.
 126     KarafKeywords.Set_Bgpcep_Log_Levels    bgpcep_level=${KARAF_BGPCEP_LOG_LEVEL}    protocol_level=${KARAF_PROTOCOL_LOG_LEVEL}
 127
 128 Start_Talking_BGP_Manager
 129     [Documentation]    Start Python manager to connect speakers to ODL.
 130     Store_Change_Count
 131     # Myport value is needed for checking whether connection at precise port was established.
 132     BGPSpeaker.Start_BGP_Manager    --amount=${COUNT_CHANGE_COUNT_MANY} --multiplicity=${MULTIPLICITY_CHANGE_COUNT_MANY} --myip=${FIRST_PEER_IP} --myport=${BGP_TOOL_PORT} --peerip=${ODL_SYSTEM_IP} --peerport=${ODL_BGP_PORT}
 133
 134 Wait_For_Stable_Talking_Ipv4_Topology
 135     [Documentation]    Wait until example-ipv4-topology becomes stable. This is done by checking stability of the change counter.
 136     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT_MANY}    repetitions=${REPETITIONS_CHANGE_COUNT_MANY}    count_to_overcome=${last_change_count_many}
 137
 138 Check_Talking_Ipv4_Topology_Count
 139     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
 140     [Tags]    critical
 141     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 142     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_CHANGE_COUNT_MANY}
 143
 144 Kill_Talking_BGP_Speakers
 145     [Documentation]    Abort the Python speakers. Also, attempt to stop failing fast.
 146     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 147     Store_Change_Count
 148     BGPSpeaker.Kill_BGP_Speaker
 149     FailFast.Do_Not_Fail_Fast_From_Now_On
 150     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 151     [Teardown]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
 152
 153 Wait_For_Stable_Ipv4_Topology_After_Talking
 154     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 155     [Tags]    critical
 156     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT_MANY}    repetitions=${REPETITIONS_CHANGE_COUNT_MANY}    count_to_overcome=${last_change_count_many}
 157
 158 Check_For_Empty_Ipv4_Topology_After_Talking
 159     [Documentation]    Example-ipv4-topology should be empty now.
 160     [Tags]    critical
 161     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 162     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 163
 164 Restore_Karaf_Logging_Levels
 165     [Documentation]    Set logging on bgpcep and protocol to the global value.
 166     KarafKeywords.Set_Bgpcep_Log_Levels    bgpcep_level=${KARAF_LOG_LEVEL}    protocol_level=${KARAF_LOG_LEVEL}
 167
 168 Restore_Data_Change_Counter_Configuration
 169     [Documentation]    Configure data change counter back to count transactions affecting example-linkstate-topology.
 170     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 171     ChangeCounter.Reconfigure_Topology_Name    example-linkstate-topology
 172
 173 Delete_Bgp_Peer_Configuration
 174     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 175     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 176     # TODO: Is it useful to extract peer naming logic to separate Keyword?
 177     : FOR    ${index}    IN RANGE    1    ${MULTIPLICITY_CHANGE_COUNT_MANY}+1
 178     \    ${peer_name} =    BuiltIn.Set_Variable    example-bgp-peer-${index}
 179     \    ${peer_ip} =    BuiltIn.Evaluate    str(ipaddr.IPAddress('${FIRST_PEER_IP}') + ${index} - 1)    modules=ipaddr
 180     \    &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${peer_name}    IP=${peer_ip}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 181     \    TemplatedRequests.Delete_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 182
 183 *** Keywords ***
 184 Setup_Everything
 185     [Documentation]    Setup imported resources, SSH-login to ODL system,
 186     ...    create HTTP session, put Python tool to ODL system.
 187     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 188     TemplatedRequests.Create_Default_Session
 189     ChangeCounter.CC_Setup
 190     PrefixCounting.PC_Setup
 191     KarafKeywords.Open Controller Karaf Console On Background
 192     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}    timeout=125    max_retries=0
 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.Set_Default_Configuration    prompt=${ODL_SYSTEM_PROMPT}
 197     SSHLibrary.Open_Connection    ${ODL_SYSTEM_IP}
 198     SSHKeywords.Flexible_Controller_Login
 199     SSHKeywords.Require_Python
 200     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
 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     ${period} =    DateTime.Convert_Time    ${CHECK_PERIOD_CHANGE_COUNT_MANY}    result_format=number
 204     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_MANY} * (${COUNT_CHANGE_COUNT_MANY} * 3.0 / 10000 + ${period} * (${REPETITIONS_CHANGE_COUNT_MANY} + 1)) + 20
 205     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${timeout}
 206     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_MANY} * (${COUNT_CHANGE_COUNT_MANY} * 2.0 / 10000 + ${period} * (${REPETITIONS_CHANGE_COUNT_MANY} + 1)) + 20
 207     Builtin.Set_Suite_Variable    ${bgp_emptying_timeout}    ${timeout}
 208     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${KARAF_LOG_LEVEL}
 209
 210 Teardown_Everything
 211     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
 212     # Environment issue may have dropped the SSH connection, but we do not want Teardown to fail.
 213     BuiltIn.Run_Keyword_And_Ignore_Error    KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 214     BuiltIn.Run_Keyword_And_Ignore_Error    Utils.Get_Sysstat_Statistics
 215     RequestsLibrary.Delete_All_Sessions
 216     SSHLibrary.Close_All_Connections
 217
 218 Store_Change_Count
 219     [Documentation]    Get the count of changes from BGP change counter. Ignore error or store the value.
 220     ${status}    ${count} =    BuiltIn.Run_Keyword_And_Ignore_Error    ChangeCounter.Get_Change_Count
 221     BuiltIn.Run_Keyword_If    '${status}' == 'PASS'    BuiltIn.Set_Suite_Variable    ${last_change_count_many}    ${count}