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