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