-Documentation Perform complex operations on netconf.
-...
-... 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,
-... and is available at http://www.eclipse.org/legal/epl-v10.html
-...
-...
-... 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
-Library SSHLibrary
-Resource NexusKeywords.robot
-Resource Restconf.robot
-Resource SSHKeywords.robot
-Resource TemplatedRequests.robot
-Resource Utils.robot
-Resource RemoteBash.robot
+Documentation Perform complex operations on netconf.
+...
+... 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,
+... and is available at http://www.eclipse.org/legal/epl-v10.html
+...
+...
+... 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
+Library SSHLibrary
+Resource NexusKeywords.robot
+Resource Restconf.robot
+Resource SSHKeywords.robot
+Resource TemplatedRequests.robot
+Resource Utils.robot
+Resource RemoteBash.robot
+
-${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
-${DEVICE_NAME_BASE} netconf-scaling-device
-${TESTTOOL_BOOT_TIMEOUT} 60s
-${ENABLE_NETCONF_TEST_TIMEOUT} ${ENABLE_GLOBAL_TEST_DEADLINES}
-${SSE_CFG_FILE} ${WORKSPACE}/${BUNDLEFOLDER}/etc/org.opendaylight.restconf.nb.rfc8040.cfg
+${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_BOOT_TIMEOUT} 60s
+${ENABLE_NETCONF_TEST_TIMEOUT} ${ENABLE_GLOBAL_TEST_DEADLINES}
+${SSE_CFG_FILE} ${WORKSPACE}/${BUNDLEFOLDER}/etc/org.opendaylight.restconf.nb.rfc8040.cfg
+
${tmp}= BuiltIn.Create_Dictionary
BuiltIn.Set_Suite_Variable ${NetconfKeywords__mounted_device_types} ${tmp}
${tmp}= BuiltIn.Create_Dictionary
BuiltIn.Set_Suite_Variable ${NetconfKeywords__mounted_device_types} ${tmp}
[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
[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.
- ${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}
+ ${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}
- 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}
+ 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}
+ END
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
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
Configure_Device ${current_name} ${log_response}
KarafKeywords.Log_Message_To_Controller_Karaf Waiting for device ${current_name} to connect
Configure_Device ${current_name} ${log_response}
KarafKeywords.Log_Message_To_Controller_Karaf Waiting for device ${current_name} to connect
KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} connected
Count_Netconf_Connectors_For_Device
KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} connected
Count_Netconf_Connectors_For_Device
# 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
# 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}= TemplatedRequests.Get_As_Json_From_Uri ${uri} session=${session}
Builtin.Log ${mounts}
${actual_count}= Builtin.Evaluate len('''${mounts}'''.split('"node-id": "${device_name}"'))-1
${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
KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} connected
Check_Device_Has_No_Netconf_Connector
KarafKeywords.Log_Message_To_Controller_Karaf Device ${current_name} connected
Check_Device_Has_No_Netconf_Connector
# 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
# 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
- ${uri} = Restconf.Generate URI network-topology:network-topology config topology=topology-netconf node=${device_name}
+ ${uri}= Restconf.Generate URI
+ ... network-topology:network-topology
+ ... config
+ ... topology=topology-netconf
+ ... node=${device_name}
- ${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}
+ [Arguments] ${device_name} ${session}=default ${log_response}=True
+ ${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}
[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.
[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} log_response=${log_response}
+ [Arguments] ${device_name} ${timeout}=20s ${period}=1s ${session}=default ${log_response}=True
+ BuiltIn.Wait_Until_Keyword_Succeeds
+ ... ${timeout}
+ ... ${period}
+ ... Check_Device_Connected
+ ... ${device_name}
+ ... session=${session}
+ ... log_response=${log_response}
- ${template_as_string}= BuiltIn.Set_Variable {'DEVICE_NAME': '${device_name}'}
- TemplatedRequests.Delete_Templated ${DIRECTORY_WITH_DEVICE_TEMPLATES}${/}${device_type} ${template_as_string} session=${session} location=${location}
+ ${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}
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
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
Deconfigure_Device ${current_name} ${log_response}
Check_Device_Deconfigured ${current_name}
Check_Device_Deconfigured
Deconfigure_Device ${current_name} ${log_response}
Check_Device_Deconfigured ${current_name}
Check_Device_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
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
[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
[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.
... 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} log_response=${log_response}
+ [Arguments] ${device_name} ${timeout}=10s ${period}=1s ${session}=default ${log_response}=True
+ BuiltIn.Wait_Until_Keyword_Succeeds
+ ... ${timeout}
+ ... ${period}
+ ... Check_Device_Completely_Gone
+ ... ${device_name}
+ ... session=${session}
+ ... log_response=${log_response}
[Documentation] Internal keyword for Install_And_Start_TestTool
... This deploys the additional schemas if any and returns a
... command line argument to be added to the testtool commandline
[Documentation] Internal keyword for Install_And_Start_TestTool
... This deploys the additional schemas if any and returns a
... command line argument to be added to the testtool commandline
... unreadable as the actions are quite different in the two
... possibilities (additional schemas present versus no additional
... schemas present), therefore a separate keyword is used.
... unreadable as the actions are quite different in the two
... possibilities (additional schemas present versus no additional
... schemas present), therefore a separate keyword is used.
# Make sure there is no schemas directory on the remote machine. A
# previous test suite might have left some debris there and that might
# lead to spurious failures, so it is better to make sure we start with a
# Make sure there is no schemas directory on the remote machine. A
# previous test suite might have left some debris there and that might
# lead to spurious failures, so it is better to make sure we start with a
BuiltIn.Log ${response}
# Drop out of the keyword, returning no command line argument when there
# are no additional schemas to deploy.
BuiltIn.Log ${response}
# Drop out of the keyword, returning no command line argument when there
# are no additional schemas to deploy.
# Deploy the additional schemas into a standard directory on the remote
# machine and construct a command line argument pointing to that
# directory from the point of view of the process running on that
# machine.
SSHLibrary.Put_Directory ${schemas} destination=./schemas
SSHLibrary.List_Directory ./schemas
# Deploy the additional schemas into a standard directory on the remote
# machine and construct a command line argument pointing to that
# directory from the point of view of the process running on that
# machine.
SSHLibrary.Put_Directory ${schemas} destination=./schemas
SSHLibrary.List_Directory ./schemas
[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.
[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.Wait_Until_Keyword_Succeeds ${TESTTOOL_BOOT_TIMEOUT} 1s Check_Device_Up_And_Running ${number}
Install_And_Start_Testtool
BuiltIn.Wait_Until_Keyword_Succeeds ${TESTTOOL_BOOT_TIMEOUT} 1s Check_Device_Up_And_Running ${number}
Install_And_Start_Testtool
${filename}= NexusKeywords.Deploy_Test_Tool netconf netconf-testtool
Start_Testtool ${filename} ${device-count} ${debug} ${schemas} ${rpc_config} ${tool_options}
${filename}= NexusKeywords.Deploy_Test_Tool netconf netconf-testtool
Start_Testtool ${filename} ${device-count} ${debug} ${schemas} ${rpc_config} ${tool_options}
[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.
[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}
${rpc_config_option}= NetconfKeywords__Deploy_Custom_RPC ${rpc_config}
${schemas_option}= NetconfKeywords__Deploy_Additional_Schemas ${schemas}
${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}
+ ${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}
BuiltIn.Log Running testtool: ${command}
${logfile}= Utils.Get_Log_File_Name testtool
BuiltIn.Set_Suite_Variable ${testtool_log} ${logfile}
# Store information needed by other keywords.
BuiltIn.Set_Suite_Variable ${NetconfKeywords__testtool_device_count} ${device-count}
# Wait for the testtool to boot up.
# Store information needed by other keywords.
BuiltIn.Set_Suite_Variable ${NetconfKeywords__testtool_device_count} ${device-count}
# Wait for the testtool to boot up.
${device-port}= BuiltIn.Evaluate ${FIRST_TESTTOOL_PORT}+${device-number}-1
NetconfKeywords__Check_Device_Is_Up ${device-port}
${device-port}= BuiltIn.Evaluate ${FIRST_TESTTOOL_PORT}+${device-number}-1
NetconfKeywords__Check_Device_Is_Up ${device-port}
${current_Date}= DateTime.Get_Current_Date
${ellapsed_seconds}= DateTime.Subtract_Date_From_Date ${deadline_Date} ${current_Date}
${current_Date}= DateTime.Get_Current_Date
${ellapsed_seconds}= DateTime.Subtract_Date_From_Date ${deadline_Date} ${current_Date}
NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device
[Arguments] ${operation} ${deadline_Date} ${log_response}=True
NetconfKeywords__Perform_Operation_With_Checking_On_Next_Device
[Arguments] ${operation} ${deadline_Date} ${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}
${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}
[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.
[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.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}
[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.
[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.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}
Code Review / integration / test.git / blobdiff