*** Settings ***
Documentation Perform complex operations on netconf.
...
-... Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+... Copyright (c) 2015,2017 Cisco Systems, Inc. and others. All rights reserved.
...
... This program and the accompanying materials are made available under the
... terms of the Eclipse Public License v1.0 which accompanies this distribution,
... This library encapsulates a bunch of somewhat complex and commonly used
... netconf operations into reusable keywords to make writing netconf
... test suites easier.
+...
+... TODO: RemoteBash.robot contains logic which could be reused here.
Library Collections
Library DateTime
Library RequestsLibrary
-Resource NetconfViaRestconf.robot
+Library SSHLibrary
Resource NexusKeywords.robot
+Resource Restconf.robot
Resource SSHKeywords.robot
+Resource TemplatedRequests.robot
+Resource Utils.robot
+Resource RemoteBash.robot
*** Variables ***
-${TESTTOOL_DEFAULT_JAVA_OPTIONS} -Xmx1G -XX:MaxPermSize=256M -Dorg.apache.sshd.registerBouncyCastle=false
+${MAX_HEAP} 1G
+${TESTTOOL_DEFAULT_JAVA_OPTIONS} -Xmx${MAX_HEAP} -Djava.security.egd=file:/dev/./urandom
${DIRECTORY_WITH_DEVICE_TEMPLATES} ${CURDIR}/../variables/netconf/device
${FIRST_TESTTOOL_PORT} 17830
${BASE_NETCONF_DEVICE_PORT} 17830
${DEVICE_NAME_BASE} netconf-scaling-device
-${TESTTOOL_DEVICE_TIMEOUT} 60s
+${TESTTOOL_BOOT_TIMEOUT} 60s
${ENABLE_NETCONF_TEST_TIMEOUT} ${ENABLE_GLOBAL_TEST_DEADLINES}
+${SSE_CFG_FILE} ${WORKSPACE}/${BUNDLEFOLDER}/etc/org.opendaylight.restconf.nb.rfc8040.cfg
*** Keywords ***
Setup_NetconfKeywords
+ [Arguments] ${create_session_for_templated_requests}=True
[Documentation] Setup the environment for the other keywords of this Resource to work properly.
${tmp}= BuiltIn.Create_Dictionary
BuiltIn.Set_Suite_Variable ${NetconfKeywords__mounted_device_types} ${tmp}
- NetconfViaRestconf.Setup_Netconf_Via_Restconf
+ BuiltIn.Run_Keyword_If ${create_session_for_templated_requests} TemplatedRequests.Create_Default_Session timeout=2
+ NexusKeywords.Initialize_Artifact_Deployment_And_Usage
Configure_Device_In_Netconf
- [Arguments] ${device_name} ${device_type}=default ${device_port}=${FIRST_TESTTOOL_PORT}
+ [Arguments] ${device_name} ${device_type}=default ${device_port}=${FIRST_TESTTOOL_PORT} ${device_address}=${TOOLS_SYSTEM_IP} ${device_user}=admin ${device_password}=topsecret
+ ... ${device_key}=device-key ${session}=default ${schema_directory}=/tmp/schema ${http_timeout}=${EMPTY} ${http_method}=put
[Documentation] Tell Netconf about the specified device so it can add it into its configuration.
- ${template_as_string}= BuiltIn.Set_Variable {'DEVICE_IP': '${TOOLS_SYSTEM_IP}', 'DEVICE_NAME': '${device_name}', 'DEVICE_PORT': '${device_port}'}
- NetconfViaRestconf.Put_Xml_Template_Folder_Via_Restconf ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string}
+ ${mapping}= BuiltIn.Create_dictionary DEVICE_IP=${device_address} DEVICE_NAME=${device_name} DEVICE_PORT=${device_port} DEVICE_USER=${device_user} DEVICE_PASSWORD=${device_password}
+ ... DEVICE_KEY=${device_key} SCHEMA_DIRECTORY=${schema_directory}
+ # TODO: Is it possible to use &{kwargs} as a mapping directly?
+ 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}
+ ... ELSE TemplatedRequests.Put_As_Xml_Templated folder=${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} mapping=${mapping} session=${session} http_timeout=${http_timeout}
Collections.Set_To_Dictionary ${NetconfKeywords__mounted_device_types} ${device_name} ${device_type}
+Configure_Device
+ [Arguments] ${current_name} ${log_response}=True
+ [Documentation] Operation for configuring the device.
+ KarafKeywords.Log_Message_To_Controller_Karaf Configuring device ${current_name} to Netconf
+ Configure_Device_In_Netconf ${current_name} device_type=${device_type} device_port=${current_port}
+ KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} configured
+
+Configure_Device_And_Verify
+ [Arguments] ${current_name} ${log_response}=True
+ [Documentation] Operation for configuring the device in the Netconf subsystem and connecting to it.
+ Configure_Device ${current_name} ${log_response}
+ KarafKeywords.Log_Message_To_Controller_Karaf Waiting for device ${current_name} to connect
+ Wait_Device_Connected ${current_name} period=0.5s log_response=${log_response}
+ KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} connected
+
Count_Netconf_Connectors_For_Device
- [Arguments] ${device_name}
+ [Arguments] ${device_name} ${session}=default
[Documentation] Count all instances of the specified device in the Netconf topology (usually 0 or 1).
# FIXME: This no longer counts netconf connectors, it counts "device instances in Netconf topology".
# This keyword should be renamed but without an automatic keyword naming standards checker this is
# potentially destabilizing change so right now it is as FIXME. Proposed new name:
# Count_Device_Instances_In_Netconf_Topology
- ${mounts}= NetconfViaRestconf.Get_Operational_Data_From_URI network-topology:network-topology/topology/topology-netconf
+ ${uri} = Restconf.Generate URI network-topology:network-topology operational
+ ${mounts}= TemplatedRequests.Get_As_Json_From_Uri ${uri} session=${session}
Builtin.Log ${mounts}
- ${actual_count}= Builtin.Evaluate len('''${mounts}'''.split('"node-id":"${device_name}"'))-1
+ ${actual_count}= Builtin.Evaluate len('''${mounts}'''.split('"node-id": "${device_name}"'))-1
Builtin.Return_From_Keyword ${actual_count}
+Wait_Connected
+ [Arguments] ${current_name} ${log_response}=True
+ [Documentation] Operation for waiting until the device is connected.
+ KarafKeywords.Log_Message_To_Controller_Karaf Waiting for device ${current_name} to connect
+ Wait_Device_Connected ${current_name} period=0.5s timeout=300s log_response=${log_response}
+ KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} connected
+
Check_Device_Has_No_Netconf_Connector
- [Arguments] ${device_name}
+ [Arguments] ${device_name} ${session}=default
[Documentation] Check that there are no instances of the specified device in the Netconf topology.
# FIXME: Similarlt to "Count_Netconf_Connectors_For_Device", this does not check whether the device has
# no netconf connector but whether the device is present in the netconf topology or not. Rename, proposed
# new name: Check_Device_Not_Present_In_Netconf_Topology
- ${count} Count_Netconf_Connectors_For_Device ${device_name}
+ ${count} Count_Netconf_Connectors_For_Device ${device_name} session=${session}
Builtin.Should_Be_Equal_As_Strings ${count} 0
Check_Device_Completely_Gone
- [Arguments] ${device_name}
+ [Arguments] ${device_name} ${session}=default ${log_response}=True
[Documentation] Check that the specified device has no Netconf connectors nor associated data.
- Check_Device_Has_No_Netconf_Connector ${device_name}
- ${uri}= Builtin.Set_Variable network-topology:network-topology/topology/topology-netconf/node/${device_name}
- ${response}= RequestsLibrary.Get Request nvr_session ${uri} ${ACCEPT_XML}
- BuiltIn.Should_Be_Equal_As_Integers ${response.status_code} 404
+ Check_Device_Has_No_Netconf_Connector ${device_name} session=${session}
+ ${uri} = Restconf.Generate URI network-topology:network-topology config topology=topology-netconf node=${device_name}
+ Utils.No Content From URI ${session} ${uri}
Check_Device_Connected
- [Arguments] ${device_name}
+ [Arguments] ${device_name} ${session}=default ${log_response}=True
[Documentation] Check that the specified device is accessible from Netconf.
- ${device_status}= NetconfViaRestconf.Get_Operational_Data_From_URI network-topology:network-topology/topology/topology-netconf/node/${device_name}
- Builtin.Should_Contain ${device_status} "netconf-node-topology:connection-status":"connected"
+ ${uri} = Restconf.Generate URI network-topology:network-topology operational topology=topology-netconf node=${device_name}
+ ${device_status}= TemplatedRequests.Get_As_Json_From_Uri ${uri} session=${session} log_response=${log_response}
+ Builtin.Should_Contain ${device_status} "netconf-node-topology:connection-status": "connected"
Wait_Device_Connected
- [Arguments] ${device_name} ${timeout}=10s ${period}=1s
+ [Arguments] ${device_name} ${timeout}=20s ${period}=1s ${session}=default ${log_response}=True
[Documentation] Wait for the device to become connected.
... It is more readable to use this keyword in a test case than to put the whole WUKS below into it.
- BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} ${period} Check_Device_Connected ${device_name}
+ BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} ${period} Check_Device_Connected ${device_name} session=${session} log_response=${log_response}
Remove_Device_From_Netconf
- [Arguments] ${device_name}
+ [Arguments] ${device_name} ${session}=default ${location}=location
[Documentation] Tell Netconf to deconfigure the specified device
${device_type}= Collections.Pop_From_Dictionary ${NetconfKeywords__mounted_device_types} ${device_name}
- ${template_as_string}= BuiltIn.Set_Variable {'DEVICE_NAME': '${device_name}'}
- NetconfViaRestconf.Delete_Xml_Template_Folder_Via_Restconf ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string}
+ ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
+ TemplatedRequests.Delete_Templated ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string} session=${session} location=${location}
+
+Deconfigure_Device
+ [Arguments] ${current_name} ${log_response}=True
+ [Documentation] Operation for deconfiguring the device.
+ KarafKeywords.Log_Message_To_Controller_Karaf Deconfiguring device ${current_name}
+ Remove_Device_From_Netconf ${current_name}
+ KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} deconfigured
+
+Deconfigure_Device_And_Verify
+ [Arguments] ${current_name} ${log_response}=True
+ [Documentation] Operation for deconfiguring the device from Netconf.
+ Deconfigure_Device ${current_name} ${log_response}
+ Check_Device_Deconfigured ${current_name}
+
+Check_Device_Deconfigured
+ [Arguments] ${current_name} ${log_response}=True
+ [Documentation] Operation for making sure the device is really deconfigured.
+ KarafKeywords.Log_Message_To_Controller_Karaf Waiting for device ${current_name} to disappear
+ Wait_Device_Fully_Removed ${current_name} period=0.5s timeout=120s
+ KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} removed
Wait_Device_Fully_Removed
- [Arguments] ${device_name} ${timeout}=10s ${period}=1s
+ [Arguments] ${device_name} ${timeout}=10s ${period}=1s ${session}=default ${log_response}=True
[Documentation] Wait until all netconf connectors for the device with the given name disappear.
... Call of Remove_Device_From_Netconf returns before netconf gets
... around deleting the device's connector. To ensure the device is
... is not made before using this keyword, the wait will fail.
... Using this keyword is more readable than putting the WUKS below
... into a test case.
- BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} ${period} Check_Device_Completely_Gone ${device_name}
+ BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} ${period} Check_Device_Completely_Gone ${device_name} session=${session} log_response=${log_response}
NetconfKeywords__Deploy_Additional_Schemas
[Arguments] ${schemas}
# directory from the point of view of the process running on that
# machine.
SSHLibrary.Put_Directory ${schemas} destination=./schemas
+ SSHLibrary.List_Directory ./schemas
[Return] --schemas-dir ./schemas
+NetconfKeywords__Deploy_Custom_RPC
+ [Arguments] ${rpc_config}
+ [Documentation] Internal keyword for Install_And_Start_TestTool
+ ... This deploys the optional custom rpc file.
+ ... Drop out of the keyword, returning no command line argument when there
+ ... is no rpc file to deploy.
+ BuiltIn.Return_From_Keyword_If '${rpc_config}' == 'none' ${EMPTY}
+ SSHKeywords.Copy_File_To_Tools_System ${TOOLS_SYSTEM_1_IP} ${rpc_config} /tmp
+ [Return] --rpc-config /tmp/customaction.xml
+
NetconfKeywords__Check_Device_Is_Up
[Arguments] ${last-port}
${count}= SSHKeywords.Count_Port_Occurences ${last-port} LISTEN java
BuiltIn.Should_Be_Equal_As_Integers ${count} 1
NetconfKeywords__Wait_Device_Is_Up_And_Running
- [Arguments] ${device_name}
+ [Arguments] ${device_name} ${log_response}=True
${number}= BuiltIn.Evaluate '${device_name}'.split('-').pop()
- BuiltIn.Wait_Until_Keyword_Succeeds ${TESTTOOL_DEVICE_TIMEOUT} 1s Check_Device_Up_And_Running ${number}
+ BuiltIn.Wait_Until_Keyword_Succeeds ${TESTTOOL_BOOT_TIMEOUT} 1s Check_Device_Up_And_Running ${number}
Install_And_Start_Testtool
- [Arguments] ${device-count}=10 ${debug}=true ${schemas}=none ${tool_options}=${EMPTY} ${java_options}=${TESTTOOL_DEFAULT_JAVA_OPTIONS} ${mdsal}=true
- [Documentation] Install and run testtool. Also arrange to collect its output into a log file.
- ... When the ${schemas} argument is set to 'none', it signifies that
- ... there are no additional schemas to be deployed, so the directory
- ... for the additional schemas is deleted on the remote machine and
- ... the additional schemas argument is left out.
- # Install test tool on the machine.
- ${filename}= NexusKeywords.Deploy_Test_Tool netconf/netconf-testtool
+ [Arguments] ${device-count}=10 ${debug}=true ${schemas}=none ${rpc_config}=none ${tool_options}=${EMPTY} ${java_options}=${TESTTOOL_DEFAULT_JAVA_OPTIONS}
+ ... ${mdsal}=true ${log_response}=True
+ [Documentation] Install and run testtool.
+ ${filename}= NexusKeywords.Deploy_Test_Tool netconf netconf-testtool
+ Start_Testtool ${filename} ${device-count} ${debug} ${schemas} ${rpc_config} ${tool_options}
+ ... ${java_options} ${mdsal} log_response=${log_response}
+
+Start_Testtool
+ [Arguments] ${filename} ${device-count}=10 ${debug}=true ${schemas}=none ${rpc_config}=none ${tool_options}=${EMPTY}
+ ... ${java_options}=${TESTTOOL_DEFAULT_JAVA_OPTIONS} ${mdsal}=true ${log_response}=True
+ [Documentation] Arrange to collect tool's output into a log file.
+ ... Will use specific ${schemas} unless argument resolves to 'none',
+ ... which signifies that there are no additional schemas to be deployed.
+ ... If so the directory for the additional schemas is deleted on the
+ ... remote machine and the additional schemas argument is left out.
${schemas_option}= NetconfKeywords__Deploy_Additional_Schemas ${schemas}
- # Start the testtool
- ${command} BuiltIn.Set_Variable java ${java_options} -jar ${filename} ${tool_options} --device-count ${device-count} --debug ${debug} ${schemas_option} --md-sal ${mdsal}
+ ${rpc_config_option}= NetconfKeywords__Deploy_Custom_RPC ${rpc_config}
+ ${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}
BuiltIn.Log Running testtool: ${command}
- SSHLibrary.Write ${command} >testtool.log 2>&1
+ ${logfile}= Utils.Get_Log_File_Name testtool
+ BuiltIn.Set_Suite_Variable ${testtool_log} ${logfile}
+ SSHLibrary.Write ${command} >${logfile} 2>&1
# Store information needed by other keywords.
BuiltIn.Set_Suite_Variable ${NetconfKeywords__testtool_device_count} ${device-count}
# Wait for the testtool to boot up.
- Perform_Operation_On_Each_Device NetconfKeywords__Wait_Device_Is_Up_And_Running
+ Perform_Operation_On_Each_Device NetconfKeywords__Wait_Device_Is_Up_And_Running log_response=${log_response}
Check_Device_Up_And_Running
[Arguments] ${device-number}
Stop_Testtool
[Documentation] Stop testtool and download its log.
- Utils.Write_Bare_Ctrl_C
+ RemoteBash.Write_Bare_Ctrl_C
SSHLibrary.Read_Until_Prompt
# TODO: Unify with play.py and pcc-mock handling.
# TODO: Maybe this keyword's content shall be moved into SSHUtils and named somewhat like
# "Interrupt_Program_And_Download_Its_Log" which will get an argument stating the name of
# the log file to get.
- SSHLibrary.Get_File testtool.log
+ SSHLibrary.Get_File ${testtool_log}
NetconfKeywords__Check_Netconf_Test_Timeout_Not_Expired
[Arguments] ${deadline_Date}
BuiltIn.Run_Keyword_If ${ellapsed_seconds}<0 Fail The global time out period expired
NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device
- [Arguments] ${operation} ${deadline_Date}
+ [Arguments] ${operation} ${deadline_Date} ${log_response}=True
NetconfKeywords__Check_Netconf_Test_Timeout_Not_Expired ${deadline_Date}
${number}= BuiltIn.Evaluate ${current_port}-${BASE_NETCONF_DEVICE_PORT}+1
- BuiltIn.Run_Keyword ${operation} ${DEVICE_NAME_BASE}-${number}
+ BuiltIn.Run_Keyword ${operation} ${DEVICE_NAME_BASE}-${number} log_response=${log_response}
${next}= BuiltIn.Evaluate ${current_port}+1
BuiltIn.Set_Suite_Variable ${current_port} ${next}
Perform_Operation_On_Each_Device
- [Arguments] ${operation} ${count}=${NetconfKeywords__testtool_device_count} ${timeout}=30m
+ [Arguments] ${operation} ${count}=${NetconfKeywords__testtool_device_count} ${timeout}=45m ${log_response}=True
${current_Date}= DateTime.Get_Current_Date
${deadline_Date}= DateTime.Add_Time_To_Date ${current_Date} ${timeout}
BuiltIn.Set_Suite_Variable ${current_port} ${BASE_NETCONF_DEVICE_PORT}
- BuiltIn.Repeat_Keyword ${count} times NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device ${operation} ${deadline_Date}
+ BuiltIn.Repeat_Keyword ${count} times NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device ${operation} ${deadline_Date} log_response=${log_response}
+
+Disable SSE On Controller
+ [Arguments] ${controller_ip}
+ [Documentation] Sets the config for using SSE (Server Side Events) to false. Note that
+ ... this keyword only changes the config. A controller restart is needed for the config to
+ ... to take effect.
+ SSHLibrary.Open Connection ${controller_ip}
+ Login With Public Key ${ODL_SYSTEM_USER} ${USER_HOME}/.ssh/${SSH_KEY} any
+ ${cmd}= Set Variable echo "use-sse=false" > ${SSE_CFG_FILE}
+ SSHLibrary.Execute Command ${cmd}
+ SSHLibrary.Close Connection
+
+Enable SSE On Controller
+ [Arguments] ${controller_ip}
+ [Documentation] Sets the config for using SSE (Server Side Events) to true. Note that
+ ... this keyword only changes the config. A controller restart is needed for the config to
+ ... to take effect.
+ SSHLibrary.Open Connection ${controller_ip}
+ Login With Public Key ${ODL_SYSTEM_USER} ${USER_HOME}/.ssh/${SSH_KEY} any
+ ${cmd}= Set Variable echo "use-sse=true" > ${SSE_CFG_FILE}
+ SSHLibrary.Execute Command ${cmd}
+ SSHLibrary.Close Connection
Code Review / integration / test.git / blobdiff