2 Documentation netconf-connector CRUD test suite.
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 ... Perform basic operations (Create, Read, Update and Delete or CRUD) on device
12 ... data mounted onto a netconf connector and see if they work.
14 ... FIXME: Replace the BuiltIn.Should_[Not_]Contain instances in the test cases
15 ... that check the car list related data with calls to keywords of a Resource
16 ... aimed at getting interesting pieces of data from the XML files and checking
17 ... them against expected data sets. See MDSAL/northbound.robot suite for
18 ... additional information.
19 Suite Setup Setup_Everything
20 Suite Teardown Teardown_Everything
21 Test Setup SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
23 Library RequestsLibrary
24 Library OperatingSystem
26 Library SSHLibrary timeout=10s
27 Resource ${CURDIR}/../../../libraries/CompareStream.robot
28 Resource ${CURDIR}/../../../libraries/FailFast.robot
29 Resource ${CURDIR}/../../../libraries/NetconfKeywords.robot
30 Resource ${CURDIR}/../../../libraries/SetupUtils.robot
31 Resource ${CURDIR}/../../../libraries/TemplatedRequests.robot
32 Variables ${CURDIR}/../../../variables/Variables.py
35 ${directory_with_template_folders} ${CURDIR}/../../../variables/netconf/CRUD
36 ${device_name} netconf-test-device
37 ${device_type} full-uri-device
38 ${USE_NETCONF_CONNECTOR} ${False}
43 [Documentation] Deploy and start test tool, then wait for all its devices to become online.
44 NetconfKeywords.Install_And_Start_Testtool device-count=1 schemas=${CURDIR}/../../../variables/netconf/CRUD/schemas mdsal=false
46 Check_Device_Is_Not_Configured_At_Beginning
47 [Documentation] Sanity check making sure our device is not there. Fail if found.
49 NetconfKeywords.Check_Device_Has_No_Netconf_Connector ${device_name}
51 Configure_Device_On_Netconf
52 [Documentation] Make request to configure a testtool device on Netconf connector.
54 NetconfKeywords.Configure_Device_In_Netconf ${device_name} device_type=${device_type} http_timeout=2
56 Check_ODL_Has_Netconf_Connector_For_Device
57 [Documentation] Get the list of configured devices and search for our device there. Fail if not found.
59 BuiltIn.Wait_Until_Keyword_Succeeds 5 sec 1 sec Count_Netconf_Connectors
61 Wait_For_Device_To_Become_Connected
62 [Documentation] Wait until the device becomes available through Netconf.
63 NetconfKeywords.Wait_Device_Connected ${device_name}
65 Check_Device_Data_Is_Empty
66 [Documentation] Get the device data and make sure it is empty.
67 Run_Keyword_If_Less_Than_Neon Check_Config_Data <data xmlns\="${ODL_NETCONF_NAMESPACE}"></data>
68 Run_Keyword_If_At_Least_Neon Check_Config_Data <data xmlns\="${ODL_NETCONF_NAMESPACE}"/>
70 Create_Device_Data_Label_Via_Xml
71 [Documentation] Send a sample test data label into the device and check that the request went OK.
72 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
73 TemplatedRequests.Post_As_Xml_Templated ${directory_with_template_folders}${/}dataorig ${template_as_string}
75 Check_Device_Data_Label_Is_Created
76 [Documentation] Get the device data label and make sure it contains the created content.
77 Check_Config_Data <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Content</l></cont></data>
79 Modify_Device_Data_Label_Via_Xml
80 [Documentation] Send a request to change the sample test data label and check that the request went OK.
81 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
82 TemplatedRequests.Put_As_Xml_Templated ${directory_with_template_folders}${/}datamod1 ${template_as_string}
84 Check_Device_Data_Label_Is_Modified
85 [Documentation] Get the device data label and make sure it contains the modified content.
86 Check_Config_Data <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Modified Content</l></cont></data>
88 Deconfigure_Device_From_Netconf_Temporarily
89 [Documentation] Make request to deconfigure the testtool device on Netconf connector.
90 ... This is the first part of the "configure/deconfigure" cycle of the device
91 ... The purpose of cycling the device like this is to see that the configuration
92 ... data was really stored in the device.
94 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
95 NetconfKeywords.Remove_Device_From_Netconf ${device_name}
97 Wait_For_Device_To_Be_Gone
98 [Documentation] Wait for the device to completely disappear.
99 NetconfKeywords.Wait_Device_Fully_Removed ${device_name}
101 Configure_The_Device_Back
102 [Documentation] Configure the device again.
103 ... This is the second step of the device configuration.
105 NetconfKeywords.Configure_Device_In_Netconf ${device_name} device_type=${device_type}
107 Wait_For_Device_To_Reconnect
108 [Documentation] Wait until the device becomes available through Netconf.
109 NetconfKeywords.Wait_Device_Connected ${device_name}
111 Check_Modified_Device_Data_Is_Still_There
112 [Documentation] Get the device data and make sure it contains the created content.
113 BuiltIn.Wait_Until_Keyword_Succeeds 60s 1s Check_Config_Data <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Modified Content</l></cont></data>
115 Modify_Device_Data_Again
116 [Documentation] Send a request to change the sample test data and check that the request went OK.
117 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
118 TemplatedRequests.Put_As_Xml_Templated ${DIRECTORY_WITH_TEMPLATE_FOLDERS}${/}datamod2 ${template_as_string}
120 Check_Device_Data_Is_Modified_Again
121 [Documentation] Get the device data and make sure it contains the created content.
122 Check_Config_Data <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Another Modified Content</l></cont></data>
124 Modify_Device_Data_Label_Via_Json
125 [Documentation] Send a JSON request to change the sample test data label and check that the request went OK.
126 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
127 TemplatedRequests.Put_As_Json_Templated ${directory_with_template_folders}${/}datamodjson ${template_as_string}
129 Check_Device_Data_Label_Is_Modified_Via_Json
130 [Documentation] Get the device data label as XML and make sure it matches the content posted as JSON in the previous case.
131 Check_Config_Data <data xmlns="${ODL_NETCONF_NAMESPACE}"><cont xmlns="urn:opendaylight:test:netconf:crud"><l>Content Modified via JSON</l></cont></data>
134 [Documentation] Send a request to create a list of cars in the sample test data label and check that the request went OK.
135 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
136 TemplatedRequests.Post_As_Xml_Templated ${directory_with_template_folders}${/}cars ${template_as_string}
138 Check_Car_List_Created
139 [Documentation] Get the device data label as XML and make sure it matches the content posted as JSON in the previous case.
140 ${data}= Get_Config_Data
141 BuiltIn.Should_Contain ${data} <id>KEEP</id>
142 BuiltIn.Should_Not_Contain ${data} <id>SMALL</id>
143 BuiltIn.Should_Not_Contain ${data} <model>Isetta</model>
144 BuiltIn.Should_Not_Contain ${data} <manufacturer>BMW</manufacturer>
145 BuiltIn.Should_Not_Contain ${data} <year>1953</year>
146 BuiltIn.Should_Not_Contain ${data} <category>microcar</category>
147 BuiltIn.Should_Not_Contain ${data} <id>TOYOTA</id>
148 BuiltIn.Should_Not_Contain ${data} <model>Camry</model>
149 BuiltIn.Should_Not_Contain ${data} <manufacturer>Toyota</manufacturer>
150 BuiltIn.Should_Not_Contain ${data} <year>1982</year>
151 BuiltIn.Should_Not_Contain ${data} <category>sedan</category>
153 Add_Device_Data_Item_1_Via_XML_Post
154 [Documentation] Send a request to create a data item in the test list and check that the request went OK.
155 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
156 TemplatedRequests.Post_As_Xml_Templated ${directory_with_template_folders}${/}item1 ${template_as_string}
158 Check_Item1_Is_Created
159 [Documentation] Get the device data as XML and make sure it matches the content posted as JSON in the previous case.
160 ${data}= Get_Config_Data
161 BuiltIn.Should_Contain ${data} <id>SMALL</id>
162 BuiltIn.Should_Contain ${data} <model>Isetta</model>
163 BuiltIn.Should_Contain ${data} <manufacturer>BMW</manufacturer>
164 BuiltIn.Should_Contain ${data} <year>1953</year>
165 BuiltIn.Should_Contain ${data} <category>microcar</category>
166 BuiltIn.Should_Not_Contain ${data} <id>TOYOTA</id>
167 BuiltIn.Should_Not_Contain ${data} <model>Camry</model>
168 BuiltIn.Should_Not_Contain ${data} <manufacturer>Toyota</manufacturer>
169 BuiltIn.Should_Not_Contain ${data} <year>1982</year>
170 BuiltIn.Should_Not_Contain ${data} <category>sedan</category>
172 Add_Device_Data_Item_2_Via_JSON_Post
173 [Documentation] Send a JSON request to change the sample test data and check that the request went OK.
174 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
175 TemplatedRequests.Post_As_Json_Templated ${directory_with_template_folders}${/}item2 ${template_as_string}
177 Check_Item2_Is_Created
178 [Documentation] Get the device data as XML and make sure it matches the content posted as JSON in the previous case.
179 ${data}= Get_Config_Data
180 BuiltIn.Should_Contain ${data} <id>SMALL</id>
181 BuiltIn.Should_Contain ${data} <model>Isetta</model>
182 BuiltIn.Should_Contain ${data} <manufacturer>BMW</manufacturer>
183 BuiltIn.Should_Contain ${data} <year>1953</year>
184 BuiltIn.Should_Contain ${data} <category>microcar</category>
185 BuiltIn.Should_Contain ${data} <id>TOYOTA</id>
186 BuiltIn.Should_Contain ${data} <model>Camry</model>
187 BuiltIn.Should_Contain ${data} <manufacturer>Toyota</manufacturer>
188 BuiltIn.Should_Contain ${data} <year>1982</year>
189 BuiltIn.Should_Contain ${data} <category>sedan</category>
192 [Documentation] Send a request to delete the sample test data on the device and check that the request went OK.
193 ${template_as_string}= BuiltIn.Create_Dictionary DEVICE_NAME=${device_name}
194 TemplatedRequests.Delete_Templated ${directory_with_template_folders}${/}datamod1 ${template_as_string}
195 TemplatedRequests.Delete_Templated ${directory_with_template_folders}${/}item1 ${template_as_string}
197 Check_Device_Data_Is_Deleted
198 [Documentation] Get the device data and make sure it is empty again.
199 Run_Keyword_If_Less_Than_Neon Check_Config_Data <data xmlns\="${ODL_NETCONF_NAMESPACE}"></data>
200 Run_Keyword_If_At_Least_Neon Check_Config_Data <data xmlns\="${ODL_NETCONF_NAMESPACE}"/>
202 Deconfigure_Device_From_Netconf
203 [Documentation] Make request to deconfigure the testtool device on Netconf connector.
205 [Setup] SetupUtils.Setup_Test_With_Logging_And_Without_Fast_Failing
206 NetconfKeywords.Remove_Device_From_Netconf ${device_name}
208 Check_Device_Going_To_Be_Gone_After_Deconfiguring
209 [Documentation] Check that the device is really going to be gone. Fail
210 ... if found after one minute. This is an expected behavior as the
211 ... delete request is sent to the config subsystem which then triggers
212 ... asynchronous destruction of the netconf connector referring to the
213 ... device and the device's data. This test makes sure this
214 ... asynchronous operation does not take unreasonable amount of time
215 ... by making sure that both the netconf connector and the device's
216 ... data is gone before reporting success.
218 NetconfKeywords.Wait_Device_Fully_Removed ${device_name}
222 [Documentation] Initialize SetupUtils. Setup everything needed for the test cases.
223 # Setup resources used by the suite.
224 SetupUtils.Setup_Utils_For_Setup_And_Teardown
225 RequestsLibrary.Create_Session operational http://${ODL_SYSTEM_IP}:${RESTCONFPORT}${REST_API} auth=${AUTH}
226 NetconfKeywords.Setup_Netconf_Keywords
227 ${device_type}= BuiltIn.Set_Variable_If """${USE_NETCONF_CONNECTOR}""" == """True""" default ${device_type}
228 BuiltIn.Set_Suite_Variable ${device_type}
231 [Documentation] Teardown the test infrastructure, perform cleanup and release all resources.
232 RequestsLibrary.Delete_All_Sessions
233 BuiltIn.Run_Keyword_And_Ignore_Error NetconfKeywords.Stop_Testtool
236 [Documentation] Get and return the config data from the device.
237 ${url}= Builtin.Set_Variable ${REST_API}/network-topology:network-topology/topology=topology-netconf/node=${device_name}/yang-ext:mount?content=config
238 ${data}= TemplatedRequests.Get_As_Xml_From_Uri ${url}
242 [Arguments] ${expected} ${contains}=False
243 ${data}= Get_Config_Data
244 BuiltIn.Run_Keyword_If not ${contains} BuiltIn.Should_Be_Equal_As_Strings ${data} ${expected}
245 BuiltIn.Run_Keyword_If ${contains} BuiltIn.Should_Contain ${data} ${expected}
247 Count_Netconf_Connectors
248 ${count} NetconfKeywords.Count_Netconf_Connectors_For_Device ${device_name}
249 Builtin.Should_Be_Equal_As_Strings ${count} 1