csit/libraries/NetconfKeywords.robot

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