csit/suites/bgpcep/bgpclustering/PrefixcountKeywords.robot

   1 *** Settings ***
   2 Documentation     BGP performance of ingesting from 1 iBGP peer, data change counter is NOT used.
   3 ...
   4 ...               Copyright (c) 2016 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 ...               For propper usage of this resource ${config_session} varaible has to be set.
  11 ...               It should point to http://<ip-addr>:${RESTCONFPORT}.
  12 Library           SSHLibrary    timeout=10s
  13 Library           RequestsLibrary
  14 Variables         ${CURDIR}/../../../variables/Variables.py
  15 Resource          ${CURDIR}/../../../libraries/BGPSpeaker.robot
  16 Resource          ${CURDIR}/../../../libraries/BGPcliKeywords.robot
  17 Resource          ${CURDIR}/../../../libraries/FailFast.robot
  18 Resource          ${CURDIR}/../../../libraries/KillPythonTool.robot
  19 Resource          ${CURDIR}/../../../libraries/PrefixCounting.robot
  20 Resource          ${CURDIR}/../../../libraries/SetupUtils.robot
  21 Resource          ${CURDIR}/../../../libraries/ClusterManagement.robot
  22 Resource          ${CURDIR}/../../../libraries/ShardStability.robot
  23 Resource          ${CURDIR}/../../../libraries/SSHKeywords.robot
  24 Resource          ${CURDIR}/../../../libraries/TemplatedRequests.robot
  25 Resource          ${CURDIR}/../../../libraries/ClusterAdmin.robot
  26
  27 *** Variables ***
  28 ${BGP_TOOL_LOG_LEVEL}    info
  29 ${BGP_PEER_FOLDER}    ${CURDIR}/../../../variables/bgpclustering/bgp_peer_openconf    # used for configuration of bgp peer via openconfig
  30 ${BGP_VARIABLES_FOLDER}    ${CURDIR}/../../../variables/bgpclustering/bgp_peer    # used for configuration of bgp peer vie netconf connector
  31 ${BGP_VARIABLES_FOLDER_OP}    ${CURDIR}/../../../variables/bgpclustering/bgp_peer_operational
  32 ${NETCONF_DEV_FOLDER}    ${CURDIR}/../../../variables/netconf/device/full-uri-device
  33 ${NETCONF_MOUNT_FOLDER}    ${CURDIR}/../../../variables/netconf/device/full-uri-mount
  34 ${CHECK_PERIOD}    10
  35 ${HOLDTIME}       180
  36 ${INSERT}         1
  37 ${KARAF_LOG_LEVEL}    INFO
  38 ${KARAF_BGPCEP_LOG_LEVEL}    ${KARAF_LOG_LEVEL}
  39 ${KARAF_PROTOCOL_LOG_LEVEL}    ${KARAF_BGPCEP_LOG_LEVEL}
  40 ${PREFILL}        0
  41 ${REPETITIONS}    1
  42 ${RESULTS_FILE_NAME}    bgp.csv
  43 ${TEST_DURATION_MULTIPLIER}    1
  44 ${UPDATE}         single
  45 ${WITHDRAW}       0
  46 ${INITIAL_RESTCONF_TIMEOUT}    30s
  47 ${KARAF_HOME}     ${WORKSPACE}/${BUNDLEFOLDER}
  48 ${SHARD_DEFAULT_CONFIG}    shard-default-config
  49 ${SHARD_DEFAULT_OPERATIONAL}    shard-default-operational
  50 ${EXAMPLE_IPV4_TOPOLOGY}    example-ipv4-topology
  51 ${DEVICE_NAME}    peer-controller-config
  52 ${DEVICE_CHECK_TIMEOUT}    60s
  53 ${RIB_INSTANCE}    example-bgp-rib
  54 ${PROTOCOL_OPENCONFIG}    ${RIB_INSTANCE}
  55 ${BGP_PEER_NAME}    example-bgp-peer
  56 ${PEER_CHECK_URL}    /restconf/operational/bgp-rib:bgp-rib/rib/example-bgp-rib/peer/bgp:%2F%2F
  57 @{SHARD_MONITOR_LIST}    default:config    default:operational    topology:config    topology:operational    inventory:config    inventory:operational
  58
  59 *** Keywords ***
  60 Setup_Everything
  61     [Documentation]    Setup imported resources, SSH-login to tools system,
  62     ...    create HTTP session, put Python tool to tools system.
  63     SetupUtils.Setup_Utils_For_Setup_And_Teardown    http_timeout=125
  64     PrefixCounting.PC_Setup
  65     ${indices} =    ClusterManagement.List_All_Indices
  66     : FOR    ${member_index}    IN    @{indices}
  67     \    ${session} =    ClusterManagement.Resolve_Http_Session_For_Member    ${member_index}
  68     \    BuiltIn.Set_Suite_Variable    ${operational_${member_index}}    ${session}
  69     BuiltIn.Set_Suite_Variable    ${pc_all_indices}    ${indices}
  70     SSHLibrary.Set_Default_Configuration    prompt=${TOOLS_SYSTEM_PROMPT}
  71     SSHLibrary.Open_Connection    ${TOOLS_SYSTEM_IP}
  72     Utils.Flexible_Mininet_Login
  73     # TODO: Do not include slash in ${OPERATIONAL_TOPO_API}, having it typed here is more readable.
  74     # TODO: Alternatively, create variable in Variables which starts with http.
  75     # Both TODOs would probably need to update every suite relying on current Variables.
  76     SSHLibrary.Put_File    ${CURDIR}/../../../../tools/fastbgp/play.py
  77     SSHKeywords.Require_Python
  78     SSHKeywords.Assure_Library_Ipaddr    target_dir=.
  79     # Calculate the timeout value based on how many routes are going to be pushed
  80     # TODO: Replace 35 with some formula from period and repetitions.
  81     ${timeout} =    BuiltIn.Evaluate    ${TEST_DURATION_MULTIPLIER} * (${COUNT} * 6.0 / 10000 + 35)
  82     Builtin.Set_Suite_Variable    ${bgp_filling_timeout}    ${timeout}
  83     Builtin.Set_Suite_Variable    ${bgp_emptying_timeout}    ${bgp_filling_timeout*3.0/4}
  84     KarafKeywords.Execute_Controller_Karaf_Command_On_Background    log:set ${KARAF_LOG_LEVEL}
  85     ${init_shard_details} =    ShardStability.Shards_Stability_Get_Details    ${SHARD_MONITOR_LIST}
  86     BuiltIn.Set_Suite_Variable    ${init_shard_details}
  87
  88 Teardown_Everything
  89     [Documentation]    Make sure Python tool was killed and tear down imported Resources.
  90     # TODO:    This keyword is not specific to prefix counting. Find a better place for it.
  91     # Environment issue may have dropped the SSH connection, but we do not want Teardown to fail.
  92     BuiltIn.Run_Keyword_And_Ignore_Error    KillPythonTool.Search_And_Kill_Remote_Python    'play\.py'
  93     RequestsLibrary.Delete_All_Sessions
  94     SSHLibrary.Close_All_Connections
  95
  96 Configure_Netconf_Device_And_Check_Mounted
  97     [Arguments]    ${mapping}
  98     [Documentation]    Configures netconf device
  99     # TODO:    This keyword is not specific to prefix counting. Find a better place for it.
 100     TemplatedRequests.Put_As_Xml_Templated    ${NETCONF_DEV_FOLDER}    mapping=${mapping}    session=${config_session}
 101     BuiltIn.Wait_Until_Keyword_Succeeds    10x    3s    TemplatedRequests.Get_As_Xml_Templated    ${NETCONF_MOUNT_FOLDER}    mapping=${mapping}    session=${config_session}
 102
 103 Start_Bgp_Peer
 104     [Arguments]    ${peerip}=${rib_owner_node_id}
 105     [Documentation]    Starts bgp peer and verifies that the peer runs.
 106     # TODO:    This keyword is not specific to prefix counting. Find a better place for it.
 107     BGPSpeaker.Start_BGP_Speaker    --amount ${COUNT} --myip=${TOOLS_SYSTEM_IP} --myport=${BGP_TOOL_PORT} --peerip=${peerip} --peerport=${ODL_BGP_PORT} --insert=${INSERT} --withdraw=${WITHDRAW} --prefill ${PREFILL} --update ${UPDATE} --${BGP_TOOL_LOG_LEVEL} --results ${RESULTS_FILE_NAME}
 108
 109 Start_Bgp_Peer_And_Verify_Connected
 110     [Arguments]    ${connection_retries}=${1}    ${peerip}=${rib_owner_node_id}
 111     [Documentation]    Starts the peer and verifies its connection. The verification is done by checking the presence
 112     ...    of the peer in the bgp rib.
 113     # TODO:    This keyword is not specific to prefix counting. Find a better place for it.
 114     : FOR    ${idx}    IN RANGE    ${connection_retries}
 115     \    Start_Bgp_Peer    peerip=${peerip}
 116     \    ${status}    ${value}=    BuiltIn.Run_Keyword_And_Ignore_Error    BuiltIn.Wait_Until_Keyword_Succeeds    3x    3s
 117     \    ...    Verify_Bgp_Peer_Connection    ${config_session}    ${TOOLS_SYSTEM_IP}    connected=${True}
 118     \    BuiltIn.Run_Keyword_Unless    "${status}" == "PASS"    BGPSpeaker.Kill_BGP_Speaker
 119     \    BuiltIn.Return_From_Keyword_If    "${status}" == "PASS"
 120     BuiltIn.Fail    Unable to connect bgp peer to ODL
 121
 122 Verify_Bgp_Peer_Connection
 123     [Arguments]    ${session}    ${peer_ip}    ${connected}=${True}
 124     [Documentation]    Checks peer presence in operational datastore
 125     # TODO:    This keyword is not specific to prefix counting. Find a better place for it.
 126     ${exp_status_code}=    BuiltIn.Set_Variable_If    ${connected}    ${200}    ${404}
 127     ${rsp}=    RequestsLibrary.Get Request    ${session}    ${PEER_CHECK_URL}${peer_ip}
 128     BuiltIn.Log    ${rsp.content}
 129     BuiltIn.Should_Be_Equal_As_Numbers    ${exp_status_code}    ${rsp.status_code}
 130
 131 Set_Shard_Leaders_Location_And_Verify
 132     [Arguments]    ${requested_shard_localtion_idx}
 133     [Documentation]    Move default/topology config/operational shard location to local or remote node as requested
 134     ...    towards the given rib singleton instance location.
 135     ShardStability.Set_Shard_Location    ${requested_shard_localtion_idx}
 136     BuiltIn.Wait_Until_Keyword_Succeeds    30s    5s    ShardStability.Verify_Shard_Leader_Located_As_Expected    ${requested_shard_localtion_idx}    http_timeout=125
 137     ${init_shard_details} =    ShardStability.Shards_Stability_Get_Details    ${SHARD_MONITOR_LIST}
 138     BuiltIn.Set_Suite_Variable    ${init_shard_details}