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 ...               Brief description how to configure BGP peer can be found here:
  26 ...               https://wiki.opendaylight.org/view/BGP_LS_PCEP:User_Guide#BGP_Peer
  27 ...               http://docs.opendaylight.org/en/stable-boron/user-guide/bgp-user-guide.html#bgp-peering
  28 ...               The peer configuration depends on the ${ODL_STREAM}. For "boron" and older streams it uses netconf connector and
  29 ...               for carbon and further it configures peer via openconfig.
  30 ...
  31 ...               TODO: Currently, if a bug causes zero increase of data changes,
  32 ...               affected test cases will wait for max time. Reconsider.
  33 ...               If zero increase is allowed as stable, higher number of repetitions should be required.
  34 ...
  35 ...               Additionally this test suite is not compatible with Helium and Hydrogen
  36 ...               releases as they don't include data change counter feature.
  37 ...               Use the other version of the suite (singlepeer_prefixcount.robot) to test them.
  38 Suite Setup       Setup_Everything
  39 Suite Teardown    Teardown_Everything
  40 Test Setup        SetupUtils.Setup_Test_With_Logging_And_Fast_Failing
  41 Test Teardown     SetupUtils.Teardown_Test_Show_Bugs_And_Start_Fast_Failing_If_Test_Failed
  42 Library           SSHLibrary    timeout=10s
  43 Library           RequestsLibrary
  44 Variables         ${CURDIR}/../../../variables/Variables.py
  45 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  46 Resource          ${CURDIR}/../../../libraries/ChangeCounter.robot
  47 Resource          ${CURDIR}/../../../libraries/CompareStream.robot
  48 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  49 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  50 Resource          ${CURDIR}/../../../libraries/PrefixCounting.robot
  51 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  52 Resource          ${CURDIR}/../../../libraries/SSHKeywords.robot
  53 Resource          ${CURDIR}/../../../libraries/TemplatedRequests.robot
  54
  55 *** Variables ***
  56 ${BGP_TOOL_LOG_LEVEL}    info
  57 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpuser/
  58 ${CHECK_PERIOD}    1
  59 ${CHECK_PERIOD_CHANGE_COUNT}    ${CHECK_PERIOD}
  60 ${CHECK_PERIOD_CHANGE_COUNT_SINGLE}    ${CHECK_PERIOD_CHANGE_COUNT}
  61 ${COUNT}          1000000
  62 ${COUNT_CHANGE_COUNT}    ${COUNT}
  63 ${COUNT_CHANGE_COUNT_SINGLE}    ${COUNT_CHANGE_COUNT}
  64 ${HOLDTIME}       180
  65 ${HOLDTIME_CHANGE_COUNT}    ${HOLDTIME}
  66 ${HOLDTIME_CHANGE_COUNT_SINGLE}    ${HOLDTIME_CHANGE_COUNT}
  67 ${INSERT}         1
  68 ${KARAF_LOG_LEVEL}    INFO
  69 ${KARAF_BGPCEP_LOG_LEVEL}    ${KARAF_LOG_LEVEL}
  70 ${KARAF_PROTOCOL_LOG_LEVEL}    ${KARAF_BGPCEP_LOG_LEVEL}
  71 ${PREFILL}        0
  72 ${REPETITIONS}    1
  73 ${REPETITIONS_CHANGE_COUNT}    ${REPETITIONS}
  74 ${REPETITIONS_CHANGE_COUNT_SINGLE}    ${REPETITIONS_CHANGE_COUNT}
  75 ${RESULTS_FILE_NAME}    bgp.csv
  76 ${TEST_DURATION_MULTIPLIER}    1
  77 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}    ${TEST_DURATION_MULTIPLIER}
  78 ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_SINGLE}    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT}
  79 ${UPDATE}         single
  80 ${WITHDRAW}       0
  81 ${RIB_INSTANCE}    example-bgp-rib
  82 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  83 ${DEVICE_NAME}    controller-config
  84 ${BGP_PEER_NAME}    example-bgp-peer
  85 # TODO: Option names can be better.
  86 ${last_change_count_single}    -1
  87 ${NETCONF_DEV_FOLDER}    ${CURDIR}/../../../variables/netconf/device/full-uri-device
  88 ${NETCONF_MOUNT_FOLDER}    ${CURDIR}/../../../variables/netconf/device/full-uri-mount
  89
  90 *** Test Cases ***
  91 Check_For_Empty_Ipv4_Topology_Before_Talking
  92     [Documentation]    Wait for example-ipv4-topology to come up and empty. Give large timeout for case when BGP boots slower than restconf.
  93     [Tags]    critical
  94     # TODO: Choose which tags to assign and make sure they are assigned correctly.
  95     BuiltIn.Wait_Until_Keyword_Succeeds    120s    1s    PrefixCounting.Check_Ipv4_Topology_Is_Empty
  96
  97 Configure_Netconf_Device
  98     [Documentation]    Configures netconf device if ${USE_NETCONF_CONNECTOR} is False.
  99     BuiltIn.Run_Keyword_If    """${USE_NETCONF_CONNECTOR}""" == """True"""    BuiltIn.Pass_Execution    No need to configure netconf device because netconf connector is present.
 100     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.
 101     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    DEVICE_PORT=1830    DEVICE_IP=${ODL_SYSTEM_IP}    DEVICE_USER=admin    DEVICE_PASSWORD=admin
 102     TemplatedRequests.Put_As_Xml_Templated    ${NETCONF_DEV_FOLDER}    mapping=${mapping}
 103     BuiltIn.Wait_Until_Keyword_Succeeds    10x    3s    TemplatedRequests.Get_As_Xml_Templated    ${NETCONF_MOUNT_FOLDER}    mapping=${mapping}
 104
 105 Reconfigure_ODL_To_Accept_Connection
 106     [Documentation]    Configure BGP peer module with initiate-connection set to false.
 107     &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME_CHANGE_COUNT_SINGLE}    PEER_PORT=${BGP_TOOL_PORT}
 108     ...    INITIATE=false    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=true    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}    RIB_INSTANCE_NAME=${RIB_INSTANCE}
 109     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 110
 111 Wait_For_Data_Change_Counter_Ready
 112     [Documentation]    Data change counter might have been slower to start than ipv4 topology, wait for it.
 113     CompareStream.Run_Keyword_If_At_Least_Carbon    BuiltIn.Pass_Execution    No data change counter is present yet.
 114     BuiltIn.Wait_Until_Keyword_Succeeds    180s    1s    ChangeCounter.Get_Change_Count
 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_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_Speaker
 129     [Documentation]    Start Python speaker to connect to ODL.
 130     Store_Change_Count
 131     # Myport value is needed for checking whether connection at precise port was established.
 132     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_CHANGE_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}
 133
 134 Wait_For_Stable_Talking_Ipv4_Topology
 135     [Documentation]    Wait until example-ipv4-topology becomes stable. This is done by checking the change counter.
 136     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE}    repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE}    count_to_overcome=${last_change_count_single}
 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_SINGLE}
 143
 144 Kill_Talking_BGP_Speaker
 145     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 146     [Tags]    critical
 147     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 148     Store_Change_Count
 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]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
 153
 154 Store_Results_For_Talking_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}    changecount-talking-totals-${RESULTS_FILE_NAME}
 160     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    changecount-talking-performance-${RESULTS_FILE_NAME}
 161
 162 Wait_For_Stable_Ipv4_Topology_After_Talking
 163     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 164     [Tags]    critical
 165     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_emptying_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE}    repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE}    count_to_overcome=${last_change_count_single}
 166
 167 Check_For_Empty_Ipv4_Topology_After_Talking
 168     [Documentation]    Example-ipv4-topology should be empty now.
 169     [Tags]    critical
 170     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 171     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 172
 173 Start_Listening_BGP_Speaker
 174     [Documentation]    Start Python speaker in listening mode.
 175     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT_CHANGE_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}
 176
 177 Reconfigure_ODL_To_Initiate_Connection
 178     [Documentation]    Replace BGP peer config module, now with initiate-connection set to true.
 179     Store_Change_Count
 180     &{mapping}    Create Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    HOLDTIME=${HOLDTIME_CHANGE_COUNT_SINGLE}    PEER_PORT=${BGP_TOOL_PORT}
 181     ...    INITIATE=true    BGP_RIB=${RIB_INSTANCE}    PASSIVE_MODE=false    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}    RIB_INSTANCE_NAME=${RIB_INSTANCE}
 182     TemplatedRequests.Put_As_Xml_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 183
 184 Wait_For_Stable_Listening_Ipv4_Topology
 185     [Documentation]    Wait until example-ipv4-topology becomes stable.
 186     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_filling_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE}    repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE}    count_to_overcome=${last_change_count_single}
 187
 188 Check_Listening_Ipv4_Topology_Count
 189     [Documentation]    Count the routes in example-ipv4-topology and fail if the count is not correct.
 190     [Tags]    critical
 191     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 192     PrefixCounting.Check_Ipv4_Topology_Count    ${COUNT_CHANGE_COUNT_SINGLE}
 193
 194 Kill_Listening_BGP_Speaker
 195     [Documentation]    Abort the Python speaker. Also, attempt to stop failing fast.
 196     [Tags]    critical
 197     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 198     Store_Change_Count
 199     BGPSpeaker.Kill_BGP_Speaker
 200     FailFast.Do_Not_Fail_Fast_From_Now_On
 201     # NOTE: It is still possible to remain failing fast, if both previous and this test have failed.
 202     [Teardown]    SetupUtils.Teardown_Test_Show_Bugs_If_Test_Failed
 203
 204 Store_Results_For_Listening_BGP_Speaker
 205     [Documentation]    Store results for plotting
 206     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 207     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    totals-${RESULTS_FILE_NAME}
 208     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    performance-${RESULTS_FILE_NAME}
 209     Store_File_To_Workspace    totals-${RESULTS_FILE_NAME}    changecount-listening-totals-${RESULTS_FILE_NAME}
 210     Store_File_To_Workspace    performance-${RESULTS_FILE_NAME}    changecount-listening-performance-${RESULTS_FILE_NAME}
 211
 212 Wait_For_Stable_Ipv4_Topology_After_Listening
 213     [Documentation]    Wait until example-ipv4-topology becomes stable again.
 214     [Tags]    critical
 215     ChangeCounter.Wait_For_Change_Count_To_Become_Stable    timeout=${bgp_emptying_timeout}    period=${CHECK_PERIOD_CHANGE_COUNT_SINGLE}    repetitions=${REPETITIONS_CHANGE_COUNT_SINGLE}    count_to_overcome=${last_change_count_single}
 216
 217 Check_For_Empty_Ipv4_Topology_After_Listening
 218     [Documentation]    Example-ipv4-topology should be empty now.
 219     [Tags]    critical
 220     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 221     PrefixCounting.Check_Ipv4_Topology_Is_Empty
 222
 223 Restore_Karaf_Logging_Levels
 224     [Documentation]    Set logging on bgpcep and protocol to the global value.
 225     KarafKeywords.Set_Bgpcep_Log_Levels    bgpcep_level=${KARAF_LOG_LEVEL}    protocol_level=${KARAF_LOG_LEVEL}
 226
 227 Restore_Data_Change_Counter_Configuration
 228     [Documentation]    Configure data change counter back to count transactions affecting example-linkstate-topology.
 229     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 230     ChangeCounter.Reconfigure_Topology_Name    example-linkstate-topology
 231
 232 Delete_Bgp_Peer_Configuration
 233     [Documentation]    Revert the BGP configuration to the original state: without any configured peers.
 234     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 235     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    BGP_NAME=${BGP_PEER_NAME}    IP=${TOOLS_SYSTEM_IP}    BGP_RIB_OPENCONFIG=${PROTOCOL_OPENCONFIG}
 236     TemplatedRequests.Delete_Templated    ${BGP_VARIABLES_FOLDER}${/}bgp_peer    mapping=${mapping}
 237
 238 Remove_Netconf_Device
 239     [Documentation]    Removes netconf device if ${USE_NETCONF_CONNECTOR} is False.
 240     [Setup]    SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
 241     BuiltIn.Run_Keyword_If    """${USE_NETCONF_CONNECTOR}""" == """True"""    BuiltIn.Pass_Execution    No need to remove netconf device because netconf connector is present.
 242     CompareStream.Run_Keyword_If_At_Least_Carbon    BuiltIn.Pass_Execution    No need to remove netconf device because none was used.
 243     &{mapping}    BuiltIn.Create_Dictionary    DEVICE_NAME=${DEVICE_NAME}    DEVICE_PORT=1830    DEVICE_IP=${ODL_SYSTEM_IP}    DEVICE_USER=admin    DEVICE_PASSWORD=admin
 244     TemplatedRequests.Delete_Templated    ${NETCONF_DEV_FOLDER}    mapping=${mapping}
 245
 246 *** Keywords ***
 247 Setup_Everything
 248     [Documentation]    Setup imported resources, SSH-login to tools system,
 249     ...    create HTTP session, put Python tool to tools system.
 250     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 251     TemplatedRequests.Create_Default_Session
 252     ChangeCounter.CC_Setup
 253     PrefixCounting.PC_Setup
 254     RequestsLibrary.Create_Session    operational    http://${ODL_SYSTEM_IP}:${RESTCONFPORT}    auth=${AUTH}    timeout=125    max_retries=0
 255     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
 256     # TODO: Alternatively, create variable in Variables which starts with http.
 257     # Both TODOs would probably need to update every suite relying on current Variables.
 258     SSHLibrary.Set_Default_Configuration    prompt=${TOOLS_SYSTEM_PROMPT}
 259     SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}
 260     SSHKeywords.Flexible_Mininet_Login
 261     SSHKeywords.Require_Python
 262     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
 263     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
 264     # Calculate the timeout value based on how many routes are going to be pushed
 265     # TODO: Unify formulas with other suites in this directory.
 266     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER_CHANGE_COUNT_SINGLE} * (${COUNT_CHANGE_COUNT_SINGLE} * 9.0 / 10000 + 20)
 267     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${timeout}
 268     Builtin.Set_Suite_Variable    ${bgp_emptying_timeout}    ${bgp_filling_timeout*3.0/4}
 269     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${KARAF_LOG_LEVEL}
 270
 271 Teardown_Everything
 272     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
 273     # Environment issue may have dropped the SSH connection, but we do not want Teardown to fail.
 274     BuiltIn.Run_Keyword_And_Ignore_Error    KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
 275     RequestsLibrary.Delete_All_Sessions
 276     SSHLibrary.Close_All_Connections
 277
 278 Store_Change_Count
 279     [Documentation]    Get the count of changes from BGP change counter. Ignore error or store the value.
 280     ${status}    ${count} =    BuiltIn.Run_Keyword_And_Ignore_Error    ChangeCounter.Get_Change_Count
 281     BuiltIn.Run_Keyword_If    '${status}' == 'PASS'    BuiltIn.Set_Suite_Variable    ${last_change_count_single}    ${count}
 282
 283 Store_File_To_Workspace
 284     [Arguments]    ${src_file_name}    ${dst_file_name}
 285     [Documentation]    Store the provided file from the SSH client to workspace.
 286     ${files}=    SSHLibrary.List Files In Directory    .
 287     ${output_log}=    SSHLibrary.Execute_Command    cat ${src_file_name}
 288     BuiltIn.Log    ${output_log}
 289     Create File    ${dst_file_name}    ${output_log}