csit/libraries/NetconfKeywords.robot

   1 *** Settings ***
   2 Documentation     Perform complex operations on netconf.
   3 ...
   4 ...               Copyright (c) 2015,2017 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 library encapsulates a bunch of somewhat complex and commonly used
  12 ...               netconf operations into reusable keywords to make writing netconf
  13 ...               test suites easier.
  14 ...
  15 ...               TODO: RemoteBash.robot contains logic which could be reused here.
  16 Library           Collections
  17 Library           DateTime
  18 Library           RequestsLibrary
  19 Library           SSHLibrary
  20 Resource          NexusKeywords.robot
  21 Resource          SSHKeywords.robot
  22 Resource          TemplatedRequests.robot
  23 Resource          Utils.robot
  24 Resource          RemoteBash.robot
  25
  26 *** Variables ***
  27 ${MAX_HEAP}       1G
  28 ${TESTTOOL_DEFAULT_JAVA_OPTIONS}    -Xmx${MAX_HEAP}
  29 ${DIRECTORY_WITH_DEVICE_TEMPLATES}    ${CURDIR}/../variables/netconf/device
  30 ${FIRST_TESTTOOL_PORT}    17830
  31 ${BASE_NETCONF_DEVICE_PORT}    17830
  32 ${DEVICE_NAME_BASE}    netconf-scaling-device
  33 ${TESTTOOL_BOOT_TIMEOUT}    60s
  34 ${ENABLE_NETCONF_TEST_TIMEOUT}    ${ENABLE_GLOBAL_TEST_DEADLINES}
  35
  36 *** Keywords ***
  37 Setup_NetconfKeywords
  38     [Arguments]    ${create_session_for_templated_requests}=True
  39     [Documentation]    Setup the environment for the other keywords of this Resource to work properly.
  40     ${tmp}=    BuiltIn.Create_Dictionary
  41     BuiltIn.Set_Suite_Variable    ${NetconfKeywords__mounted_device_types}    ${tmp}
  42     BuiltIn.Run_Keyword_If    ${create_session_for_templated_requests}    TemplatedRequests.Create_Default_Session    timeout=2
  43     NexusKeywords.Initialize_Artifact_Deployment_And_Usage
  44
  45 Configure_Device_In_Netconf
  46     [Arguments]    ${device_name}    ${device_type}=default    ${device_port}=${FIRST_TESTTOOL_PORT}    ${device_address}=${TOOLS_SYSTEM_IP}    ${device_user}=admin    ${device_password}=topsecret
  47     ...    ${device_key}=device-key    ${session}=default    ${schema_directory}=/tmp/schema    ${http_timeout}=${EMPTY}    ${http_method}=put
  48     [Documentation]    Tell Netconf about the specified device so it can add it into its configuration.
  49     ${mapping}=    BuiltIn.Create_dictionary    DEVICE_IP=${device_address}    DEVICE_NAME=${device_name}    DEVICE_PORT=${device_port}    DEVICE_USER=${device_user}    DEVICE_PASSWORD=${device_password}
  50     ...    DEVICE_KEY=${device_key}    SCHEMA_DIRECTORY=${schema_directory}
  51     # TODO: Is it possible to use &{kwargs} as a mapping directly?
  52     Run Keyword if    '${http_method}'=='post'    TemplatedRequests.Post_As_Xml_Templated    folder=${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type}    mapping=${mapping}    session=${session}    http_timeout=${http_timeout}
  53     ...    ELSE    TemplatedRequests.Put_As_Xml_Templated    folder=${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type}    mapping=${mapping}    session=${session}    http_timeout=${http_timeout}
  54     Collections.Set_To_Dictionary    ${NetconfKeywords__mounted_device_types}    ${device_name}    ${device_type}
  55
  56 Count_Netconf_Connectors_For_Device
  57     [Arguments]    ${device_name}    ${session}=default
  58     [Documentation]    Count all instances of the specified device in the Netconf topology (usually 0 or 1).
  59     # FIXME: This no longer counts netconf connectors, it counts "device instances in Netconf topology".
  60     # This keyword should be renamed but without an automatic keyword naming standards checker this is
  61     # potentially destabilizing change so right now it is as FIXME. Proposed new name:
  62     # Count_Device_Instances_In_Netconf_Topology
  63     ${mounts}=    TemplatedRequests.Get_As_Json_From_Uri    ${OPERATIONAL_API}/network-topology:network-topology/topology/topology-netconf    session=${session}
  64     Builtin.Log    ${mounts}
  65     ${actual_count}=    Builtin.Evaluate    len('''${mounts}'''.split('"node-id": "${device_name}"'))-1
  66     Builtin.Return_From_Keyword    ${actual_count}
  67
  68 Check_Device_Has_No_Netconf_Connector
  69     [Arguments]    ${device_name}    ${session}=default
  70     [Documentation]    Check that there are no instances of the specified device in the Netconf topology.
  71     # FIXME: Similarlt to "Count_Netconf_Connectors_For_Device", this does not check whether the device has
  72     # no netconf connector but whether the device is present in the netconf topology or not. Rename, proposed
  73     # new name: Check_Device_Not_Present_In_Netconf_Topology
  74     ${count}    Count_Netconf_Connectors_For_Device    ${device_name}    session=${session}
  75     Builtin.Should_Be_Equal_As_Strings    ${count}    0
  76
  77 Check_Device_Completely_Gone
  78     [Arguments]    ${device_name}    ${session}=default
  79     [Documentation]    Check that the specified device has no Netconf connectors nor associated data.
  80     Check_Device_Has_No_Netconf_Connector    ${device_name}    session=${session}
  81     ${uri}=    Builtin.Set_Variable    ${CONFIG_API}/network-topology:network-topology/topology/topology-netconf/node/${device_name}
  82     ${status}    ${response}=    BuiltIn.Run_Keyword_And_Ignore_Error    TemplatedRequests.Get_As_Xml_From_Uri    ${uri}    session=${session}
  83     BuiltIn.Should_Be_Equal_As_Strings    ${status}    FAIL
  84     BuiltIn.Should_Contain    ${response}    404
  85
  86 Check_Device_Connected
  87     [Arguments]    ${device_name}    ${session}=default
  88     [Documentation]    Check that the specified device is accessible from Netconf.
  89     ${device_status}=    TemplatedRequests.Get_As_Json_From_Uri    ${OPERATIONAL_API}/network-topology:network-topology/topology/topology-netconf/node/${device_name}    session=${session}
  90     Builtin.Should_Contain    ${device_status}    "netconf-node-topology:connection-status": "connected"
  91
  92 Wait_Device_Connected
  93     [Arguments]    ${device_name}    ${timeout}=20s    ${period}=1s    ${session}=default
  94     [Documentation]    Wait for the device to become connected.
  95     ...    It is more readable to use this keyword in a test case than to put the whole WUKS below into it.
  96     BuiltIn.Wait_Until_Keyword_Succeeds    ${timeout}    ${period}    Check_Device_Connected    ${device_name}    session=${session}
  97
  98 Remove_Device_From_Netconf
  99     [Arguments]    ${device_name}    ${session}=default    ${location}=location
 100     [Documentation]    Tell Netconf to deconfigure the specified device
 101     ${device_type}=    Collections.Pop_From_Dictionary    ${NetconfKeywords__mounted_device_types}    ${device_name}
 102     ${template_as_string}=    BuiltIn.Set_Variable    {'DEVICE_NAME': '${device_name}'}
 103     TemplatedRequests.Delete_Templated    ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type}    ${template_as_string}    session=${session}    location=${location}
 104
 105 Wait_Device_Fully_Removed
 106     [Arguments]    ${device_name}    ${timeout}=10s    ${period}=1s    ${session}=default
 107     [Documentation]    Wait until all netconf connectors for the device with the given name disappear.
 108     ...    Call of Remove_Device_From_Netconf returns before netconf gets
 109     ...    around deleting the device's connector. To ensure the device is
 110     ...    really gone from netconf, use this keyword to make sure all
 111     ...    connectors disappear. If a call to Remove_Device_From_Netconf
 112     ...    is not made before using this keyword, the wait will fail.
 113     ...    Using this keyword is more readable than putting the WUKS below
 114     ...    into a test case.
 115     BuiltIn.Wait_Until_Keyword_Succeeds    ${timeout}    ${period}    Check_Device_Completely_Gone    ${device_name}    session=${session}
 116
 117 NetconfKeywords__Deploy_Additional_Schemas
 118     [Arguments]    ${schemas}
 119     [Documentation]    Internal keyword for Install_And_Start_TestTool
 120     ...    This deploys the additional schemas if any and returns a
 121     ...    command line argument to be added to the testtool commandline
 122     ...    to tell it to load them. While this code could be integrated
 123     ...    into its only user, I considered the resulting code to be too
 124     ...    unreadable as the actions are quite different in the two
 125     ...    possibilities (additional schemas present versus no additional
 126     ...    schemas present), therefore a separate keyword is used.
 127     # Make sure there is no schemas directory on the remote machine. A
 128     # previous test suite might have left some debris there and that might
 129     # lead to spurious failures, so it is better to make sure we start with a
 130     # clean slate. Additionally when the caller did not specify any
 131     # additional schemas for testtool, we want to make extra sure none are
 132     # used.
 133     ${response}=    SSHLibrary.Execute_Command    rm -rf schemas 2>&1
 134     BuiltIn.Log    ${response}
 135     # Drop out of the keyword, returning no command line argument when there
 136     # are no additional schemas to deploy.
 137     BuiltIn.Return_From_Keyword_If    '${schemas}' == 'none'    ${EMPTY}
 138     # Deploy the additional schemas into a standard directory on the remote
 139     # machine and construct a command line argument pointing to that
 140     # directory from the point of view of the process running on that
 141     # machine.
 142     SSHLibrary.Put_Directory    ${schemas}    destination=./schemas
 143     SSHLibrary.List_Directory    ./schemas
 144     [Return]    --schemas-dir ./schemas
 145
 146 NetconfKeywords__Deploy_Custom_RPC
 147     [Arguments]    ${rpc_config}
 148     [Documentation]    Internal keyword for Install_And_Start_TestTool
 149     ...    This deploys the optional custom rpc file.
 150     ...    Drop out of the keyword, returning no command line argument when there
 151     ...    is no rpc file to deploy.
 152     BuiltIn.Return_From_Keyword_If    '${rpc_config}' == 'none'    ${EMPTY}
 153     SSHKeywords.Copy_File_To_Tools_System    ${TOOLS_SYSTEM_1_IP}    ${rpc_config}    /tmp
 154     [Return]    --rpc-config /tmp/customaction.xml
 155
 156 NetconfKeywords__Check_Device_Is_Up
 157     [Arguments]    ${last-port}
 158     ${count}=    SSHKeywords.Count_Port_Occurences    ${last-port}    LISTEN    java
 159     BuiltIn.Should_Be_Equal_As_Integers    ${count}    1
 160
 161 NetconfKeywords__Wait_Device_Is_Up_And_Running
 162     [Arguments]    ${device_name}
 163     ${number}=    BuiltIn.Evaluate    '${device_name}'.split('-').pop()
 164     BuiltIn.Wait_Until_Keyword_Succeeds    ${TESTTOOL_BOOT_TIMEOUT}    1s    Check_Device_Up_And_Running    ${number}
 165
 166 Install_And_Start_Testtool
 167     [Arguments]    ${device-count}=10    ${debug}=true    ${schemas}=none    ${rpc_config}=none    ${tool_options}=${EMPTY}    ${java_options}=${TESTTOOL_DEFAULT_JAVA_OPTIONS}
 168     ...    ${mdsal}=true
 169     [Documentation]    Install and run testtool.
 170     ${filename}=    NexusKeywords.Deploy_Test_Tool    netconf    netconf-testtool
 171     Start_Testtool    ${filename}    ${device-count}    ${debug}    ${schemas}    ${rpc_config}    ${tool_options}
 172     ...    ${java_options}    ${mdsal}
 173
 174 Start_Testtool
 175     [Arguments]    ${filename}    ${device-count}=10    ${debug}=true    ${schemas}=none    ${rpc_config}=none    ${tool_options}=${EMPTY}
 176     ...    ${java_options}=${TESTTOOL_DEFAULT_JAVA_OPTIONS}    ${mdsal}=true
 177     [Documentation]    Arrange to collect tool's output into a log file.
 178     ...    Will use specific ${schemas} unless argument resolves to 'none',
 179     ...    which signifies that there are no additional schemas to be deployed.
 180     ...    If so the directory for the additional schemas is deleted on the
 181     ...    remote machine and the additional schemas argument is left out.
 182     ${schemas_option}=    NetconfKeywords__Deploy_Additional_Schemas    ${schemas}
 183     ${rpc_config_option}=    NetconfKeywords__Deploy_Custom_RPC    ${rpc_config}
 184     ${command}=    NexusKeywords.Compose_Full_Java_Command    ${java_options} -jar ${filename} ${tool_options} --device-count ${device-count} --debug ${debug} ${schemas_option} ${rpc_config_option} --md-sal ${mdsal}
 185     BuiltIn.Log    Running testtool: ${command}
 186     ${logfile}=    Utils.Get_Log_File_Name    testtool
 187     BuiltIn.Set_Suite_Variable    ${testtool_log}    ${logfile}
 188     SSHLibrary.Write    ${command} >${logfile} 2>&1
 189     # Store information needed by other keywords.
 190     BuiltIn.Set_Suite_Variable    ${NetconfKeywords__testtool_device_count}    ${device-count}
 191     # Wait for the testtool to boot up.
 192     Perform_Operation_On_Each_Device    NetconfKeywords__Wait_Device_Is_Up_And_Running
 193
 194 Check_Device_Up_And_Running
 195     [Arguments]    ${device-number}
 196     [Documentation]    Query netstat on remote machine whether testtool device with the specified number has its port open and fail if not.
 197     ${device-port}=    BuiltIn.Evaluate    ${FIRST_TESTTOOL_PORT}+${device-number}-1
 198     NetconfKeywords__Check_Device_Is_Up    ${device-port}
 199
 200 Stop_Testtool
 201     [Documentation]    Stop testtool and download its log.
 202     RemoteBash.Write_Bare_Ctrl_C
 203     SSHLibrary.Read_Until_Prompt
 204     # TODO: Unify with play.py and pcc-mock handling.
 205     # TODO: Maybe this keyword's content shall be moved into SSHUtils and named somewhat like
 206     # "Interrupt_Program_And_Download_Its_Log" which will get an argument stating the name of
 207     # the log file to get.
 208     SSHLibrary.Get_File    ${testtool_log}
 209
 210 NetconfKeywords__Check_Netconf_Test_Timeout_Not_Expired
 211     [Arguments]    ${deadline_Date}
 212     BuiltIn.Return_From_Keyword_If    not ${ENABLE_NETCONF_TEST_TIMEOUT}
 213     ${current_Date}=    DateTime.Get_Current_Date
 214     ${ellapsed_seconds}=    DateTime.Subtract_Date_From_Date    ${deadline_Date}    ${current_Date}
 215     BuiltIn.Run_Keyword_If    ${ellapsed_seconds}<0    Fail    The global time out period expired
 216
 217 NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device
 218     [Arguments]    ${operation}    ${deadline_Date}
 219     NetconfKeywords__Check_Netconf_Test_Timeout_Not_Expired    ${deadline_Date}
 220     ${number}=    BuiltIn.Evaluate    ${current_port}-${BASE_NETCONF_DEVICE_PORT}+1
 221     BuiltIn.Run_Keyword    ${operation}    ${DEVICE_NAME_BASE}-${number}
 222     ${next}=    BuiltIn.Evaluate    ${current_port}+1
 223     BuiltIn.Set_Suite_Variable    ${current_port}    ${next}
 224
 225 Perform_Operation_On_Each_Device
 226     [Arguments]    ${operation}    ${count}=${NetconfKeywords__testtool_device_count}    ${timeout}=30m
 227     ${current_Date}=    DateTime.Get_Current_Date
 228     ${deadline_Date}=    DateTime.Add_Time_To_Date    ${current_Date}    ${timeout}
 229     BuiltIn.Set_Suite_Variable    ${current_port}    ${BASE_NETCONF_DEVICE_PORT}
 230     BuiltIn.Repeat_Keyword    ${count} times    NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device    ${operation}    ${deadline_Date}