2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.sal.restconf.impl.test;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertFalse;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertNull;
15 import static org.junit.Assert.assertTrue;
16 import static org.junit.Assert.fail;
17 import static org.mockito.Matchers.any;
18 import static org.mockito.Matchers.eq;
19 import static org.mockito.Mockito.mock;
20 import static org.mockito.Mockito.when;
21 import com.google.common.base.Optional;
22 import com.google.common.collect.ImmutableMap;
23 import com.google.common.collect.Maps;
24 import java.io.FileNotFoundException;
25 import java.io.UnsupportedEncodingException;
27 import java.net.URISyntaxException;
28 import java.text.ParseException;
29 import java.text.SimpleDateFormat;
30 import java.util.ArrayList;
31 import java.util.Date;
32 import java.util.HashSet;
33 import java.util.List;
36 import java.util.regex.Matcher;
37 import java.util.regex.Pattern;
38 import javax.ws.rs.core.Application;
39 import javax.ws.rs.core.MediaType;
40 import javax.ws.rs.core.MultivaluedHashMap;
41 import javax.ws.rs.core.MultivaluedMap;
42 import javax.ws.rs.core.Response;
43 import javax.ws.rs.core.UriInfo;
44 import org.glassfish.jersey.server.ResourceConfig;
45 import org.glassfish.jersey.test.JerseyTest;
46 import org.junit.BeforeClass;
47 import org.junit.Ignore;
48 import org.junit.Test;
49 import org.mockito.invocation.InvocationOnMock;
50 import org.mockito.stubbing.Answer;
51 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
52 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
53 import org.opendaylight.netconf.sal.rest.impl.JsonNormalizedNodeBodyReader;
54 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeJsonBodyWriter;
55 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeXmlBodyWriter;
56 import org.opendaylight.netconf.sal.rest.impl.RestconfApplication;
57 import org.opendaylight.netconf.sal.rest.impl.RestconfDocumentedExceptionMapper;
58 import org.opendaylight.netconf.sal.rest.impl.XmlNormalizedNodeBodyReader;
59 import org.opendaylight.netconf.sal.restconf.impl.BrokerFacade;
60 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
61 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
62 import org.opendaylight.netconf.sal.restconf.impl.RestconfImpl;
63 import org.opendaylight.yangtools.yang.common.QName;
64 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
65 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
66 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
68 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
69 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
70 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
71 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
72 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
73 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
74 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
75 import org.opendaylight.yangtools.yang.model.api.Module;
76 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
77 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
78 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
79 import org.w3c.dom.Document;
80 import org.w3c.dom.Element;
81 import org.w3c.dom.NodeList;
83 public class RestGetOperationTest extends JerseyTest {
85 static class NodeData {
87 Object data; // List for a CompositeNode, value Object for a SimpleNode
89 NodeData(final Object key, final Object data) {
95 private static BrokerFacade brokerFacade;
96 private static RestconfImpl restconfImpl;
97 private static SchemaContext schemaContextYangsIetf;
98 private static SchemaContext schemaContextTestModule;
99 @SuppressWarnings("rawtypes")
100 private static NormalizedNode answerFromGet;
102 private static SchemaContext schemaContextModules;
103 private static SchemaContext schemaContextBehindMountPoint;
105 private static final String RESTCONF_NS = "urn:ietf:params:xml:ns:yang:ietf-restconf";
108 public static void init() throws FileNotFoundException, ParseException, ReactorException {
109 schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs");
110 schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module");
111 brokerFacade = mock(BrokerFacade.class);
112 restconfImpl = RestconfImpl.getInstance();
113 restconfImpl.setBroker(brokerFacade);
114 answerFromGet = TestUtils.prepareNormalizedNodeWithIetfInterfacesInterfacesData();
116 schemaContextModules = TestUtils.loadSchemaContext("/modules");
117 schemaContextBehindMountPoint = TestUtils.loadSchemaContext("/modules/modules-behind-mount-point");
121 protected Application configure() {
122 /* enable/disable Jersey logs to console */
123 // enable(TestProperties.LOG_TRAFFIC);
124 // enable(TestProperties.DUMP_ENTITY);
125 // enable(TestProperties.RECORD_LOG_LEVEL);
126 // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue());
127 ResourceConfig resourceConfig = new ResourceConfig();
128 resourceConfig = resourceConfig.registerInstances(restconfImpl, new NormalizedNodeJsonBodyWriter(),
129 new NormalizedNodeXmlBodyWriter(), new XmlNormalizedNodeBodyReader(), new JsonNormalizedNodeBodyReader());
130 resourceConfig.registerClasses(RestconfDocumentedExceptionMapper.class);
131 resourceConfig.registerClasses(new RestconfApplication().getClasses());
132 return resourceConfig;
135 private void setControllerContext(final SchemaContext schemaContext) {
136 final ControllerContext controllerContext = ControllerContext.getInstance();
137 controllerContext.setSchemas(schemaContext);
138 restconfImpl.setControllerContext(controllerContext);
142 * Tests of status codes for "/operational/{identifier}".
145 public void getOperationalStatusCodes() throws UnsupportedEncodingException {
146 setControllerContext(schemaContextYangsIetf);
147 mockReadOperationalDataMethod();
148 String uri = "/operational/ietf-interfaces:interfaces/interface/eth0";
149 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
151 uri = "/operational/wrong-module:interfaces/interface/eth0";
152 assertEquals(400, get(uri, MediaType.APPLICATION_XML));
156 * Tests of status codes for "/config/{identifier}".
159 public void getConfigStatusCodes() throws UnsupportedEncodingException {
160 setControllerContext(schemaContextYangsIetf);
161 mockReadConfigurationDataMethod();
162 String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
163 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
165 uri = "/config/wrong-module:interfaces/interface/eth0";
166 assertEquals(400, get(uri, MediaType.APPLICATION_XML));
170 * MountPoint test. URI represents mount point.
172 @SuppressWarnings("unchecked")
174 public void getDataWithUrlMountPoint() throws UnsupportedEncodingException, URISyntaxException, ParseException {
175 when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class))).thenReturn(
176 prepareCnDataForMountPointTest(false));
177 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
178 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
179 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
180 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
182 ControllerContext.getInstance().setMountService(mockMountService);
184 String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/cont1";
185 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
187 uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont/cont1";
188 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
192 * MountPoint test. URI represents mount point.
194 * Slashes in URI behind mount point. lst1 element with key GigabitEthernet0%2F0%2F0%2F0 (GigabitEthernet0/0/0/0) is
195 * requested via GET HTTP operation. It is tested whether %2F character is replaced with simple / in
196 * InstanceIdentifier parameter in method
197 * {@link BrokerFacade#readConfigurationData(DOMMountPoint, YangInstanceIdentifier)} which is called in
198 * method {@link RestconfImpl#readConfigurationData}
200 * @throws ParseException
203 public void getDataWithSlashesBehindMountPoint() throws Exception {
204 final YangInstanceIdentifier awaitedInstanceIdentifier = prepareInstanceIdentifierForList();
205 when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), eq(awaitedInstanceIdentifier))).thenReturn(
206 prepareCnDataForSlashesBehindMountPointTest());
207 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
208 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
209 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
210 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
212 ControllerContext.getInstance().setMountService(mockMountService);
214 final String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/lst1/GigabitEthernet0%2F0%2F0%2F0";
215 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
218 private YangInstanceIdentifier prepareInstanceIdentifierForList() throws Exception {
219 final List<PathArgument> parameters = new ArrayList<>();
221 final QName qNameCont = newTestModuleQName("cont");
222 final QName qNameList = newTestModuleQName("lst1");
223 final QName qNameKeyList = newTestModuleQName("lf11");
225 parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameCont));
226 parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameList));
227 parameters.add(new YangInstanceIdentifier.NodeIdentifierWithPredicates(qNameList, qNameKeyList,
228 "GigabitEthernet0/0/0/0"));
229 return YangInstanceIdentifier.create(parameters);
232 private QName newTestModuleQName(final String localPart) throws Exception {
233 final Date revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-01-09");
234 final URI uri = new URI("test:module");
235 return QName.create(uri, revision, localPart);
239 public void getDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException,
241 when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class))).thenReturn(
242 prepareCnDataForMountPointTest(true));
243 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
244 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
245 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
246 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
248 ControllerContext.getInstance().setMountService(mockMountService);
250 final String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont";
251 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
254 @SuppressWarnings("unchecked")
256 public void getDataWithIdentityrefInURL() throws Exception {
257 setControllerContext(schemaContextTestModule);
259 final QName moduleQN = newTestModuleQName("module");
260 final ImmutableMap<QName, Object> keyMap = ImmutableMap.<QName, Object>builder()
261 .put(newTestModuleQName("type"), newTestModuleQName("test-identity"))
262 .put(newTestModuleQName("name"), "foo").build();
263 final YangInstanceIdentifier iid = YangInstanceIdentifier.builder().node(newTestModuleQName("modules"))
264 .node(moduleQN).nodeWithKey(moduleQN, keyMap).build();
265 @SuppressWarnings("rawtypes")
267 NormalizedNode data = ImmutableMapNodeBuilder.create().withNodeIdentifier(
268 new NodeIdentifier(moduleQN)).withChild(ImmutableNodes.mapEntryBuilder()
269 .withNodeIdentifier(new NodeIdentifierWithPredicates(moduleQN, keyMap))
270 .withChild(ImmutableNodes.leafNode(newTestModuleQName("type"), newTestModuleQName("test-identity")))
271 .withChild(ImmutableNodes.leafNode(newTestModuleQName("name"), "foo"))
272 .withChild(ImmutableNodes.leafNode(newTestModuleQName("data"), "bar")).build()).build();
273 when(brokerFacade.readConfigurationData(iid)).thenReturn(data);
275 final String uri = "/config/test-module:modules/module/test-module:test-identity/foo";
276 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
281 public void getModulesTest() throws UnsupportedEncodingException, FileNotFoundException {
282 final ControllerContext controllerContext = ControllerContext.getInstance();
283 controllerContext.setGlobalSchema(schemaContextModules);
284 restconfImpl.setControllerContext(controllerContext);
286 final String uri = "/modules";
288 Response response = target(uri).request("application/yang.api+json").get();
289 validateModulesResponseJson(response);
291 response = target(uri).request("application/yang.api+xml").get();
292 validateModulesResponseXml(response,schemaContextModules);
297 @Ignore // FIXME : find why it is fail by in gerrit build
298 public void getStreamsTest() throws UnsupportedEncodingException, FileNotFoundException {
299 setControllerContext(schemaContextModules);
301 final String uri = "/streams";
303 Response response = target(uri).request("application/yang.api+json").get();
304 final String responseBody = response.readEntity(String.class);
305 assertEquals(200, response.getStatus());
306 assertNotNull(responseBody);
307 assertTrue(responseBody.contains("streams"));
309 response = target(uri).request("application/yang.api+xml").get();
310 assertEquals(200, response.getStatus());
311 final Document responseXmlBody = response.readEntity(Document.class);
312 assertNotNull(responseXmlBody);
313 final Element rootNode = responseXmlBody.getDocumentElement();
315 assertEquals("streams", rootNode.getLocalName());
316 assertEquals(RESTCONF_NS, rootNode.getNamespaceURI());
321 public void getModuleTest() throws FileNotFoundException, UnsupportedEncodingException {
322 setControllerContext(schemaContextModules);
324 final String uri = "/modules/module/module2/2014-01-02";
326 Response response = target(uri).request("application/yang.api+xml").get();
327 assertEquals(200, response.getStatus());
328 final Document responseXml = response.readEntity(Document.class);
330 final QName qname = assertedModuleXmlToModuleQName(responseXml.getDocumentElement());
331 assertNotNull(qname);
333 assertEquals("module2", qname.getLocalName());
334 assertEquals("module:2", qname.getNamespace().toString());
335 assertEquals("2014-01-02", qname.getFormattedRevision());
337 response = target(uri).request("application/yang.api+json").get();
338 assertEquals(200, response.getStatus());
339 final String responseBody = response.readEntity(String.class);
340 assertTrue("Module2 in json wasn't found", prepareJsonRegex("module2", "2014-01-02", "module:2", responseBody)
342 final String[] split = responseBody.split("\"module\"");
343 assertEquals("\"module\" element is returned more then once", 2, split.length);
350 public void getOperationsTest() throws FileNotFoundException, UnsupportedEncodingException {
351 setControllerContext(schemaContextModules);
353 final String uri = "/operations";
355 Response response = target(uri).request("application/yang.api+xml").get();
356 assertEquals(500, response.getStatus());
357 final Document responseDoc = response.readEntity(Document.class);
358 validateOperationsResponseXml(responseDoc, schemaContextModules);
360 response = target(uri).request("application/yang.api+json").get();
361 assertEquals(200, response.getStatus());
362 final String responseBody = response.readEntity(String.class);
363 assertTrue("Json response for /operations dummy-rpc1-module1 is incorrect",
364 validateOperationsResponseJson(responseBody, "dummy-rpc1-module1", "module1").find());
365 assertTrue("Json response for /operations dummy-rpc2-module1 is incorrect",
366 validateOperationsResponseJson(responseBody, "dummy-rpc2-module1", "module1").find());
367 assertTrue("Json response for /operations dummy-rpc1-module2 is incorrect",
368 validateOperationsResponseJson(responseBody, "dummy-rpc1-module2", "module2").find());
369 assertTrue("Json response for /operations dummy-rpc2-module2 is incorrect",
370 validateOperationsResponseJson(responseBody, "dummy-rpc2-module2", "module2").find());
374 private void validateOperationsResponseXml(final Document responseDoc, final SchemaContext schemaContext) {
376 final Element operationsElem = responseDoc.getDocumentElement();
377 assertEquals(RESTCONF_NS, operationsElem.getNamespaceURI());
378 assertEquals("operations", operationsElem.getLocalName());
380 final NodeList operationsList = operationsElem.getChildNodes();
381 final HashSet<String> foundOperations = new HashSet<>();
383 for (int i = 0; i < operationsList.getLength(); i++) {
384 final org.w3c.dom.Node operation = operationsList.item(i);
385 foundOperations.add(operation.getLocalName());
388 for (final RpcDefinition schemaOp : schemaContext.getOperations()) {
389 assertTrue(foundOperations.contains(schemaOp.getQName().getLocalName()));
393 // /operations/pathToMountPoint/yang-ext:mount
396 public void getOperationsBehindMountPointTest() throws FileNotFoundException, UnsupportedEncodingException {
397 setControllerContext(schemaContextModules);
399 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
400 when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
401 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
402 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
404 ControllerContext.getInstance().setMountService(mockMountService);
406 final String uri = "/operations/ietf-interfaces:interfaces/interface/0/yang-ext:mount/";
408 Response response = target(uri).request("application/yang.api+xml").get();
409 assertEquals(500, response.getStatus());
411 final Document responseDoc = response.readEntity(Document.class);
412 validateOperationsResponseXml(responseDoc, schemaContextBehindMountPoint);
414 response = target(uri).request("application/yang.api+json").get();
415 assertEquals(200, response.getStatus());
416 final String responseBody = response.readEntity(String.class);
417 assertTrue("Json response for /operations/mount_point rpc-behind-module1 is incorrect",
418 validateOperationsResponseJson(responseBody, "rpc-behind-module1", "module1-behind-mount-point").find());
419 assertTrue("Json response for /operations/mount_point rpc-behind-module2 is incorrect",
420 validateOperationsResponseJson(responseBody, "rpc-behind-module2", "module2-behind-mount-point").find());
424 private Matcher validateOperationsResponseJson(final String searchIn, final String rpcName, final String moduleName) {
425 final StringBuilder regex = new StringBuilder();
426 regex.append(".*\"" + rpcName + "\"");
427 final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
428 return ptrn.matcher(searchIn);
432 private Matcher validateOperationsResponseXml(final String searchIn, final String rpcName, final String namespace) {
433 final StringBuilder regex = new StringBuilder();
437 regex.append(".*<operations");
438 regex.append(".*xmlns=\"urn:ietf:params:xml:ns:yang:ietf-restconf\"");
442 regex.append(".*" + rpcName);
443 regex.append(".*" + namespace);
447 regex.append(".*</operations.*");
452 final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
453 return ptrn.matcher(searchIn);
456 // /restconf/modules/pathToMountPoint/yang-ext:mount
458 public void getModulesBehindMountPoint() throws FileNotFoundException, UnsupportedEncodingException {
459 setControllerContext(schemaContextModules);
461 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
462 when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
463 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
464 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
466 ControllerContext.getInstance().setMountService(mockMountService);
468 final String uri = "/modules/ietf-interfaces:interfaces/interface/0/yang-ext:mount/";
470 Response response = target(uri).request("application/yang.api+json").get();
471 assertEquals(200, response.getStatus());
472 final String responseBody = response.readEntity(String.class);
475 "module1-behind-mount-point in json wasn't found",
476 prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point",
477 responseBody).find());
479 "module2-behind-mount-point in json wasn't found",
480 prepareJsonRegex("module2-behind-mount-point", "2014-02-04", "module:2:behind:mount:point",
481 responseBody).find());
483 response = target(uri).request("application/yang.api+xml").get();
484 assertEquals(200, response.getStatus());
485 validateModulesResponseXml(response, schemaContextBehindMountPoint);
489 // /restconf/modules/module/pathToMountPoint/yang-ext:mount/moduleName/revision
491 public void getModuleBehindMountPoint() throws FileNotFoundException, UnsupportedEncodingException {
492 setControllerContext(schemaContextModules);
494 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
495 when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
496 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
497 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
499 ControllerContext.getInstance().setMountService(mockMountService);
501 final String uri = "/modules/module/ietf-interfaces:interfaces/interface/0/yang-ext:mount/module1-behind-mount-point/2014-02-03";
503 Response response = target(uri).request("application/yang.api+json").get();
504 assertEquals(200, response.getStatus());
505 final String responseBody = response.readEntity(String.class);
508 "module1-behind-mount-point in json wasn't found",
509 prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point",
510 responseBody).find());
511 final String[] split = responseBody.split("\"module\"");
512 assertEquals("\"module\" element is returned more then once", 2, split.length);
514 response = target(uri).request("application/yang.api+xml").get();
515 assertEquals(200, response.getStatus());
516 final Document responseXml = response.readEntity(Document.class);
518 final QName module = assertedModuleXmlToModuleQName(responseXml.getDocumentElement());
520 assertEquals("module1-behind-mount-point", module.getLocalName());
521 assertEquals("2014-02-03", module.getFormattedRevision());
522 assertEquals("module:1:behind:mount:point", module.getNamespace().toString());
527 private void validateModulesResponseXml(final Response response, final SchemaContext schemaContext) {
528 assertEquals(200, response.getStatus());
529 final Document responseBody = response.readEntity(Document.class);
530 final NodeList moduleNodes = responseBody.getDocumentElement().getElementsByTagNameNS(RESTCONF_NS, "module");
532 assertTrue(moduleNodes.getLength() > 0);
534 final HashSet<QName> foundModules = new HashSet<>();
536 for(int i=0;i < moduleNodes.getLength();i++) {
537 final org.w3c.dom.Node module = moduleNodes.item(i);
539 final QName name = assertedModuleXmlToModuleQName(module);
540 foundModules.add(name);
543 assertAllModules(foundModules,schemaContext);
546 private void assertAllModules(final Set<QName> foundModules, final SchemaContext schemaContext) {
547 for(final Module module : schemaContext.getModules()) {
548 final QName current = QName.create(module.getQNameModule(),module.getName());
549 assertTrue("Module not found in response.",foundModules.contains(current));
554 private QName assertedModuleXmlToModuleQName(final org.w3c.dom.Node module) {
555 assertEquals("module", module.getLocalName());
556 assertEquals(RESTCONF_NS, module.getNamespaceURI());
557 String revision = null;
558 String namespace = null;
562 final NodeList childNodes = module.getChildNodes();
564 for(int i =0;i < childNodes.getLength(); i++) {
565 final org.w3c.dom.Node child = childNodes.item(i);
566 assertEquals(RESTCONF_NS, child.getNamespaceURI());
568 switch(child.getLocalName()) {
570 assertNull("Name element appeared multiple times",name);
571 name = child.getTextContent().trim();
574 assertNull("Revision element appeared multiple times",revision);
575 revision = child.getTextContent().trim();
579 assertNull("Namespace element appeared multiple times",namespace);
580 namespace = child.getTextContent().trim();
585 assertNotNull("Revision was not part of xml",revision);
586 assertNotNull("Module namespace was not part of xml",namespace);
587 assertNotNull("Module identiffier was not part of xml",name);
590 // TODO Auto-generated method stub
592 return QName.create(namespace,revision,name);
595 private void validateModulesResponseJson(final Response response) {
596 assertEquals(200, response.getStatus());
597 final String responseBody = response.readEntity(String.class);
599 assertTrue("Module1 in json wasn't found", prepareJsonRegex("module1", "2014-01-01", "module:1", responseBody)
601 assertTrue("Module2 in json wasn't found", prepareJsonRegex("module2", "2014-01-02", "module:2", responseBody)
603 assertTrue("Module3 in json wasn't found", prepareJsonRegex("module3", "2014-01-03", "module:3", responseBody)
607 private Matcher prepareJsonRegex(final String module, final String revision, final String namespace,
608 final String searchIn) {
609 final StringBuilder regex = new StringBuilder();
612 regex.append(".*\\{");
613 regex.append(".*\"name\"");
615 regex.append(".*\"" + module + "\",");
617 regex.append(".*\"revision\"");
619 regex.append(".*\"" + revision + "\",");
621 regex.append(".*\"namespace\"");
623 regex.append(".*\"" + namespace + "\"");
625 regex.append(".*\\}");
629 final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
630 return ptrn.matcher(searchIn);
635 private int get(final String uri, final String mediaType) {
636 return target(uri).request(mediaType).get().getStatus();
646 @SuppressWarnings("rawtypes")
647 private NormalizedNode prepareCnDataForMountPointTest(final boolean wrapToCont) throws URISyntaxException, ParseException {
648 final String testModuleDate = "2014-01-09";
649 final ContainerNode contChild = Builders
651 .withNodeIdentifier(TestUtils.getNodeIdentifier("cont1", "test:module", testModuleDate))
653 Builders.leafBuilder()
654 .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", testModuleDate))
655 .withValue("lf11 value").build()).build();
658 return Builders.containerBuilder()
659 .withNodeIdentifier(TestUtils.getNodeIdentifier("cont", "test:module", testModuleDate))
660 .withChild(contChild).build();
666 @SuppressWarnings("unchecked")
667 private void mockReadOperationalDataMethod() {
668 when(brokerFacade.readOperationalData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet);
671 @SuppressWarnings("unchecked")
672 private void mockReadConfigurationDataMethod() {
673 when(brokerFacade.readConfigurationData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet);
676 @SuppressWarnings("rawtypes")
677 private NormalizedNode prepareCnDataForSlashesBehindMountPointTest() throws ParseException {
678 return ImmutableMapEntryNodeBuilder
681 TestUtils.getNodeIdentifierPredicate("lst1", "test:module", "2014-01-09", "lf11",
682 "GigabitEthernet0/0/0/0"))
684 ImmutableLeafNodeBuilder.create()
685 .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", "2014-01-09"))
686 .withValue("GigabitEthernet0/0/0/0").build()).build();
691 * If includeWhiteChars URI parameter is set to false then no white characters can be included in returned output
693 * @throws UnsupportedEncodingException
696 public void getDataWithUriIncludeWhiteCharsParameterTest() throws UnsupportedEncodingException {
697 getDataWithUriIncludeWhiteCharsParameter("config");
698 getDataWithUriIncludeWhiteCharsParameter("operational");
701 private void getDataWithUriIncludeWhiteCharsParameter(final String target) throws UnsupportedEncodingException {
702 mockReadConfigurationDataMethod();
703 mockReadOperationalDataMethod();
704 final String uri = "/" + target + "/ietf-interfaces:interfaces/interface/eth0";
705 Response response = target(uri).queryParam("prettyPrint", "false").request("application/xml").get();
706 final String xmlData = response.readEntity(String.class);
708 Pattern pattern = Pattern.compile(".*(>\\s+|\\s+<).*", Pattern.DOTALL);
709 Matcher matcher = pattern.matcher(xmlData);
710 // XML element can't surrounded with white character (e.g "> " or
712 assertFalse(matcher.matches());
714 response = target(uri).queryParam("prettyPrint", "false").request("application/json").get();
715 final String jsonData = response.readEntity(String.class);
716 pattern = Pattern.compile(".*(\\}\\s+|\\s+\\{|\\]\\s+|\\s+\\[|\\s+:|:\\s+).*", Pattern.DOTALL);
717 matcher = pattern.matcher(jsonData);
718 // JSON element can't surrounded with white character (e.g "} ", " {",
719 // "] ", " [", " :" or ": ")
720 assertFalse(matcher.matches());
724 * Tests behavior when invalid value of depth URI parameter
728 public void getDataWithInvalidDepthParameterTest() {
729 setControllerContext(schemaContextModules);
731 final MultivaluedMap<String, String> paramMap = new MultivaluedHashMap<>();
732 paramMap.putSingle("depth", "1o");
733 final UriInfo mockInfo = mock(UriInfo.class);
734 when(mockInfo.getQueryParameters(false)).thenAnswer(new Answer<MultivaluedMap<String, String>>() {
736 public MultivaluedMap<String, String> answer(final InvocationOnMock invocation) {
741 getDataWithInvalidDepthParameterTest(mockInfo);
743 paramMap.putSingle("depth", "0");
744 getDataWithInvalidDepthParameterTest(mockInfo);
746 paramMap.putSingle("depth", "-1");
747 getDataWithInvalidDepthParameterTest(mockInfo);
750 @SuppressWarnings({"rawtypes", "unchecked"})
751 private void getDataWithInvalidDepthParameterTest(final UriInfo uriInfo) {
753 final QName qNameDepth1Cont = QName.create("urn:nested:module", "2014-06-3", "depth1-cont");
754 final YangInstanceIdentifier ii = YangInstanceIdentifier.builder().node(qNameDepth1Cont).build();
755 final NormalizedNode value = (Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(qNameDepth1Cont)).build());
756 when(brokerFacade.readConfigurationData(eq(ii))).thenReturn(value);
757 restconfImpl.readConfigurationData("nested-module:depth1-cont", uriInfo);
758 fail("Expected RestconfDocumentedException");
759 } catch (final RestconfDocumentedException e) {
760 assertTrue("Unexpected error message: " + e.getErrors().get(0).getErrorMessage(), e.getErrors().get(0)
761 .getErrorMessage().contains("depth"));
765 @SuppressWarnings("unused")
766 private void verifyXMLResponse(final Response response, final NodeData nodeData) {
767 final Document doc = response.readEntity(Document.class);
768 // Document doc = TestUtils.loadDocumentFrom((InputStream) response.getEntity());
769 // System.out.println();
770 assertNotNull("Could not parse XML document", doc);
772 // System.out.println(TestUtils.getDocumentInPrintableForm( doc ));
774 verifyContainerElement(doc.getDocumentElement(), nodeData);
777 @SuppressWarnings("unchecked")
778 private void verifyContainerElement(final Element element, final NodeData nodeData) {
780 assertEquals("Element local name", nodeData.key, element.getLocalName());
782 final NodeList childNodes = element.getChildNodes();
783 if (nodeData.data == null) { // empty container
784 assertTrue("Expected no child elements for \"" + element.getLocalName() + "\"", childNodes.getLength() == 0);
788 final Map<String, NodeData> expChildMap = Maps.newHashMap();
789 for (final NodeData expChild : (List<NodeData>) nodeData.data) {
790 expChildMap.put(expChild.key.toString(), expChild);
793 for (int i = 0; i < childNodes.getLength(); i++) {
794 final org.w3c.dom.Node actualChild = childNodes.item(i);
795 if (!(actualChild instanceof Element)) {
799 final Element actualElement = (Element) actualChild;
800 final NodeData expChild = expChildMap.remove(actualElement.getLocalName());
802 "Unexpected child element for parent \"" + element.getLocalName() + "\": "
803 + actualElement.getLocalName(), expChild);
805 if ((expChild.data == null) || (expChild.data instanceof List)) {
806 verifyContainerElement(actualElement, expChild);
808 assertEquals("Text content for element: " + actualElement.getLocalName(), expChild.data,
809 actualElement.getTextContent());
813 if (!expChildMap.isEmpty()) {
814 fail("Missing elements for parent \"" + element.getLocalName() + "\": " + expChildMap.keySet());