Library RequestsLibrary
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}
${DIRECTORY_WITH_DEVICE_TEMPLATES} ${CURDIR}/../variables/netconf/device
${FIRST_TESTTOOL_PORT} 17830
${BASE_NETCONF_DEVICE_PORT} 17830
[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}
- BuiltIn.Run_Keyword_If ${create_session_for_templated_requests} TemplatedRequests.Create_Default_Session
+ 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} ${device_address}=${TOOLS_SYSTEM_IP} ${device_user}=admin ${device_password}=topsecret
- ... ${session}=default
+ ... ${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': '${device_address}', 'DEVICE_NAME': '${device_name}', 'DEVICE_PORT': '${device_port}', 'DEVICE_USER': '${device_user}', 'DEVICE_PASSWORD': '${device_password}'}
- TemplatedRequests.Put_As_Xml_Templated ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string} session=${session}
+ ${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}
Count_Netconf_Connectors_For_Device
# 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}= TemplatedRequests.Get_As_Json_From_Uri ${OPERATIONAL_API}/network-topology:network-topology/topology/topology-netconf session=${session}
+ ${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
Builtin.Return_From_Keyword ${actual_count}
Builtin.Should_Be_Equal_As_Strings ${count} 0
Check_Device_Completely_Gone
- [Arguments] ${device_name} ${session}=default
+ [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} session=${session}
- ${uri}= Builtin.Set_Variable ${CONFIG_API}/network-topology:network-topology/topology/topology-netconf/node/${device_name}
- ${status} ${response}= BuiltIn.Run_Keyword_And_Ignore_Error TemplatedRequests.Get_As_Xml_From_Uri ${uri} session=${session}
+ ${uri} = Restconf.Generate URI network-topology:network-topology config topology=topology-netconf node=${device_name}
+ ${status} ${response}= BuiltIn.Run_Keyword_And_Ignore_Error TemplatedRequests.Get_As_Xml_From_Uri ${uri} session=${session} log_response=${log_response}
BuiltIn.Should_Be_Equal_As_Strings ${status} FAIL
BuiltIn.Should_Contain ${response} 404
Check_Device_Connected
- [Arguments] ${device_name} ${session}=default
+ [Arguments] ${device_name} ${session}=default ${log_response}=True
[Documentation] Check that the specified device is accessible from Netconf.
- ${device_status}= TemplatedRequests.Get_As_Json_From_Uri ${OPERATIONAL_API}/network-topology:network-topology/topology/topology-netconf/node/${device_name} session=${session}
+ ${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 ${session}=default
+ [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} session=${session}
+ 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} ${session}=default
+ [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}'}
- TemplatedRequests.Delete_Templated ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string} session=${session}
+ TemplatedRequests.Delete_Templated ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string} session=${session} location=${location}
Wait_Device_Fully_Removed
- [Arguments] ${device_name} ${timeout}=10s ${period}=1s ${session}=default
+ [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} session=${session}
+ 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_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.
+ [Arguments] ${device-count}=10 ${debug}=true ${schemas}=none ${rpc_config}=none ${tool_options}=${EMPTY} ${java_options}=${TESTTOOL_DEFAULT_JAVA_OPTIONS}
+ ... ${mdsal}=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}
+
+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
+ [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}= NexusKeywords.Compose_Full_Java_Command ${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}
${logfile}= Utils.Get_Log_File_Name testtool
BuiltIn.Set_Suite_Variable ${testtool_log} ${logfile}
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
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}=30m ${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}