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 ...               The peer configuration depends on the ${ODL_STREAM}. For "boron" and older streams it uses netconf connector and
  45 ...               for carbon and further it configures peer via openconfig.
  46 ...
  47 ...               TODO: Is there a need for version of this suite where ODL connects to pers?
  48 ...               Note that configuring ODL is slow, which may affect measured performance singificantly.
  49 ...               Advanced TODO: Give manager ability to start pushing on trigger long after connections are established.
  50 Suite Setup       Setup_Everything
  51 Suite Teardown    Teardown_Everything
  52 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  53 Test Teardown     SetupUtils.Teardown_Test_Show_Bugs_And_Start_Fast_Failing_If_Test_Failed
  54 Library           DateTime
  55 Library           RequestsLibrary
  56 Library           SSHLibrary    timeout=10s
  57 Variables         ${CURDIR}/../../../variables/Variables.py
  58 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  59 Resource          ${CURDIR}/../../../libraries/ChangeCounter.robot
  60 Resource          ${CURDIR}/../../../libraries/CompareStream.robot
  61 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  62 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  63 Resource          ${CURDIR}/../../../libraries/PrefixCounting.robot
  64 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  65 Resource          ${CURDIR}/../../../libraries/SSHKeywords.robot
  66 Resource          ${CURDIR}/../../../libraries/TemplatedRequests.robot
  67
  68 *** Variables ***
  69 ${BGP_TOOL_LOG_LEVEL}    info
  70 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  71 ${CHECK_PERIOD}    1
  72 ${CHECK_PERIOD_CHANGE_COUNT}    ${CHECK_PERIOD}
  73 ${CHECK_PERIOD_CHANGE_COUNT_MANY}    ${CHECK_PERIOD_CHANGE_COUNT}
  74 ${COUNT}          1000000
  75 ${COUNT_CHANGE_COUNT}    ${COUNT}
  76 ${COUNT_CHANGE_COUNT_MANY}    ${COUNT_CHANGE_COUNT}
  77 ${FIRST_PEER_IP}    127.0.0.1
  78 ${HOLDTIME}       180
  79 ${HOLDTIME_CHANGE_COUNT}    ${HOLDTIME}
  80 ${HOLDTIME_CHANGE_COUNT_MANY}    ${HOLDTIME_CHANGE_COUNT}
  81 ${KARAF_LOG_LEVEL}    INFO
  82 ${KARAF_BGPCEP_LOG_LEVEL}    ${KARAF_LOG_LEVEL}
  83 ${KARAF_PROTOCOL_LOG_LEVEL}    ${KARAF_BGPCEP_LOG_LEVEL}
  84 ${MULTIPLICITY}    2    # May be increased after Bug 4488 is fixed.
  85 ${MULTIPLICITY_CHANGE_COUNT}    ${MULTIPLICITY}
  86 ${MULTIPLICITY_CHANGE_COUNT_MANY}    ${MULTIPLICITY_CHANGE_COUNT}
  87 ${NETCONF_DEV_FOLDER}    ${CURDIR}/../../../variables/netconf/device/full-uri-device
  88 ${NETCONF_MOUNT_FOLDER}    ${CURDIR}/../../../variables/netconf/device/full-uri-mount
  89 ${REPETITIONS}    1    # Should be increased depending on multiplicity.
  90 ${REPETITIONS_CHANGE_COUNT}    ${REPETITIONS}
  91 ${REPETITIONS_CHANGE_COUNT_MANY}    ${REPETITIONS_CHANGE_COUNT}
  92 ${TEST_DURATION_MULTIPLIER}    1
  93 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}    ${TEST_DURATION_MULTIPLIER}
  94 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_MANY}    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}
  95 ${RIB_INSTANCE}    example-bgp-rib
  96 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  97 ${DEVICE_NAME}    controller-config
  98 # TODO: Option names can be better.
  99 ${last_change_count_many}    -1
 100
 101 *** Test Cases ***
 102 Check_For_Empty_Ipv4_Topology_Before_Talking
 103     [Documentation]    Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
 104     [Tags]    critical
 105     # TODO: Choose which tags to assign and make sure they are assigned correctly.
 106     BuiltIn.Wait_Until_Keyword_Succeeds    120s    1s    PrefixCounting.Check_Ipv4_Topology_Is_Empty
 107
 108 Configure_Netconf_Device
 109     [Documentation]    Configures netconf device if ${USE_NETCONF_CONNECTOR} is False.
 110     BuiltIn.Run_Keyword_If    """${USE_NETCONF_CONNECTOR}""" == """True"""    BuiltIn.Pass_Execution    No need to configure netconf device because netconf connector is present.
 111     CompareStream.Run_Keyword_If_At_Least_Carbon    BuiltIn.Pass_Execution    No need to configure netconf device because data change counter is not configured via it.
 112     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    DEVICE_PORT=1830    DEVICE_IP=${ODL_SYSTEM_IP}    DEVICE_USER=admin    DEVICE_PASSWORD=admin
 113     TemplatedRequests.Put_As_Xml_Templated    ${NETCONF_DEV_FOLDER}    mapping=${mapping}
 114     BuiltIn.Wait_Until_Keyword_Succeeds    10x    3s    TemplatedRequests.Get_As_Xml_Templated    ${NETCONF_MOUNT_FOLDER}    mapping=${mapping}
 115
 116 Reconfigure_ODL_To_Accept_Connections
 117     [Documentation]    Configure BGP peer modules with initiate-connection set to false.
 118     : FOR    ${index}    IN RANGE    1    ${MULTIPLICITY_CHANGE_COUNT_MANY}+1
 119     \    ${peer_name} =    BuiltIn.Set_Variable    example-bgp-peer-${index}
 120     \    ${peer_ip} =    BuiltIn.Evaluate    str(ipaddr.IPAddress('${FIRST_PEER_IP}') + ${index} - 1)    modules=ipaddr
 121     \    &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${peer_name}    IP=${peer_ip}    HOLDTIME=${HOLDTIME_CHANGE_COUNT_MANY}
 122     \    ...    PEER_PORT=${BGP_TOOL_PORT}    INITIATE=false    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=true    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 123     \    ...    RIB_INSTANCE_NAME=${RIB_INSTANCE}
 124     \    TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 125     # FIXME: Add testcase to change bgpcep and protocol log levels, when a Keyword that does it without messing with current connection is ready.
 126
 127 Wait_For_Data_Change_Counter_Ready
 128     [Documentation]    Data change counter might have been slower to start than ipv4 topology, wait for it.
 129     CompareStream.Run_Keyword_If_At_Least_Carbon    BuiltIn.Pass_Execution    No data change counter is present yet.
 130     BuiltIn.Wait_Until_Keyword_Succeeds    180s    1s    ChangeCounter.Get_Change_Count
 131
 132 Reconfigure_Data_Change_Counter
 133     [Documentation]    Configure data change counter to count transactions in example-ipv4-topology instead of example-linkstate-topology.
 134     ChangeCounter.Reconfigure_Topology_Name    example-ipv4-topology
 135
 136 Verify_For_Data_Change_Counter_Ready
 137     [Documentation]    Data change counter might have been slower to start than ipv4 topology, wait for it.
 138     BuiltIn.Wait_Until_Keyword_Succeeds    5s    1s    ChangeCounter.Get_Change_Count
 139
 140 Change_Karaf_Logging_Levels
 141     [Documentation]    We may want to set more verbose logging here after configuration is done.
 142     KarafKeywords.Set_Bgpcep_Log_Levels    bgpcep_level=${KARAF_BGPCEP_LOG_LEVEL}    protocol_level=${KARAF_PROTOCOL_LOG_LEVEL}
 143
 144 Start_Talking_BGP_Manager
 145     [Documentation]    Start Python manager to connect speakers to ODL.
 146     Store_Change_Count
 147     # Myport value is needed for checking whether connection at precise port was established.
 148     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}
 149
 150 Wait_For_Stable_Talking_Ipv4_Topology
 151     [Documentation]    Wait until example-ipv4-topology becomes stable. This is done by checking stability of the change counter.
 152     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}
 153
 154 Check_Talking_Ipv4_Topology_Count
 155     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
 156     [Tags]    critical
 157     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 158     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_CHANGE_COUNT_MANY}
 159
 160 Kill_Talking_BGP_Speakers
 161     [Documentation]    Abort the Python speakers. Also, attempt to stop failing fast.
 162     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 163     Store_Change_Count
 164     BGPSpeaker.Kill_BGP_Speaker
 165     FailFast.Do_Not_Fail_Fast_From_Now_On
 166     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 167     [Teardown]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
 168
 169 Wait_For_Stable_Ipv4_Topology_After_Talking
 170     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 171     [Tags]    critical
 172     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}
 173
 174 Check_For_Empty_Ipv4_Topology_After_Talking
 175     [Documentation]    Example-ipv4-topology should be empty now.
 176     [Tags]    critical
 177     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 178     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 179
 180 Restore_Karaf_Logging_Levels
 181     [Documentation]    Set logging on bgpcep and protocol to the global value.
 182     KarafKeywords.Set_Bgpcep_Log_Levels    bgpcep_level=${KARAF_LOG_LEVEL}    protocol_level=${KARAF_LOG_LEVEL}
 183
 184 Restore_Data_Change_Counter_Configuration
 185     [Documentation]    Configure data change counter back to count transactions affecting example-linkstate-topology.
 186     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 187     ChangeCounter.Reconfigure_Topology_Name    example-linkstate-topology
 188
 189 Delete_Bgp_Peer_Configuration
 190     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 191     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 192     # TODO: Is it useful to extract peer naming logic to separate Keyword?
 193     : FOR    ${index}    IN RANGE    1    ${MULTIPLICITY_CHANGE_COUNT_MANY}+1
 194     \    ${peer_name} =    BuiltIn.Set_Variable    example-bgp-peer-${index}
 195     \    ${peer_ip} =    BuiltIn.Evaluate    str(ipaddr.IPAddress('${FIRST_PEER_IP}') + ${index} - 1)    modules=ipaddr
 196     \    &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${peer_name}    IP=${peer_ip}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 197     \    TemplatedRequests.Delete_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 198
 199 Remove_Netconf_Device
 200     [Documentation]    Removes netconf device if ${USE_NETCONF_CONNECTOR} is False.
 201     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 202     BuiltIn.Run_Keyword_If    """${USE_NETCONF_CONNECTOR}""" == """True"""    BuiltIn.Pass_Execution    No need to remove netconf device because netconf connector is present.
 203     CompareStream.Run_Keyword_If_At_Least_Carbon    BuiltIn.Pass_Execution    No need to remove netconf device because none was used.
 204     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    DEVICE_PORT=1830    DEVICE_IP=${ODL_SYSTEM_IP}    DEVICE_USER=admin    DEVICE_PASSWORD=admin
 205     TemplatedRequests.Delete_Templated    ${NETCONF_DEV_FOLDER}    mapping=${mapping}
 206
 207 *** Keywords ***
 208 Setup_Everything
 209     [Documentation]    Setup imported resources, SSH-login to ODL system,
 210     ...    create HTTP session, put Python tool to ODL system.
 211     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 212     TemplatedRequests.Create_Default_Session
 213     ChangeCounter.CC_Setup
 214     PrefixCounting.PC_Setup
 215     KarafKeywords.Open Controller Karaf Console On Background
 216     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}    timeout=125    max_retries=0
 217     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
 218     # TODO: Alternatively, create variable in Variables which starts with http.
 219     # Both TODOs would probably need to update every suite relying on current Variables.
 220     SSHLibrary.Set_Default_Configuration    prompt=${ODL_SYSTEM_PROMPT}
 221     SSHLibrary.Open_Connection    ${ODL_SYSTEM_IP}
 222     SSHKeywords.Flexible_Controller_Login
 223     SSHKeywords.Require_Python
 224     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
 225     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 226     # Calculate the timeout value based on how many routes are going to be pushed
 227     ${period} =    DateTime.Convert_Time    ${CHECK_PERIOD_CHANGE_COUNT_MANY}    result_format=number
 228     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_MANY} * (${COUNT_CHANGE_COUNT_MANY} * 3.0 / 10000 + ${period} * (${REPETITIONS_CHANGE_COUNT_MANY} + 1)) + 20
 229     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${timeout}
 230     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_MANY} * (${COUNT_CHANGE_COUNT_MANY} * 2.0 / 10000 + ${period} * (${REPETITIONS_CHANGE_COUNT_MANY} + 1)) + 20
 231     Builtin.Set_Suite_Variable    ${bgp_emptying_timeout}    ${timeout}
 232     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${KARAF_LOG_LEVEL}
 233
 234 Teardown_Everything
 235     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
 236     # Environment issue may have dropped the SSH connection, but we do not want Teardown to fail.
 237     BuiltIn.Run_Keyword_And_Ignore_Error    KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 238     RequestsLibrary.Delete_All_Sessions
 239     SSHLibrary.Close_All_Connections
 240
 241 Store_Change_Count
 242     [Documentation]    Get the count of changes from BGP change counter. Ignore error or store the value.
 243     ${status}    ${count} =    BuiltIn.Run_Keyword_And_Ignore_Error    ChangeCounter.Get_Change_Count
 244     BuiltIn.Run_Keyword_If    '${status}' == 'PASS'    BuiltIn.Set_Suite_Variable    ${last_change_count_many}    ${count}