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.w3c.dom.Document;
79 import org.w3c.dom.Element;
80 import org.w3c.dom.NodeList;
82 public class RestGetOperationTest extends JerseyTest {
84 static class NodeData {
86 Object data; // List for a CompositeNode, value Object for a SimpleNode
88 NodeData(final Object key, final Object data) {
94 private static BrokerFacade brokerFacade;
95 private static RestconfImpl restconfImpl;
96 private static SchemaContext schemaContextYangsIetf;
97 private static SchemaContext schemaContextTestModule;
98 @SuppressWarnings("rawtypes")
99 private static NormalizedNode answerFromGet;
101 private static SchemaContext schemaContextModules;
102 private static SchemaContext schemaContextBehindMountPoint;
104 private static final String RESTCONF_NS = "urn:ietf:params:xml:ns:yang:ietf-restconf";
107 public static void init() throws FileNotFoundException, ParseException {
108 schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs");
109 schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module");
110 brokerFacade = mock(BrokerFacade.class);
111 restconfImpl = RestconfImpl.getInstance();
112 restconfImpl.setBroker(brokerFacade);
113 answerFromGet = TestUtils.prepareNormalizedNodeWithIetfInterfacesInterfacesData();
115 schemaContextModules = TestUtils.loadSchemaContext("/modules");
116 schemaContextBehindMountPoint = TestUtils.loadSchemaContext("/modules/modules-behind-mount-point");
120 protected Application configure() {
121 /* enable/disable Jersey logs to console */
122 // enable(TestProperties.LOG_TRAFFIC);
123 // enable(TestProperties.DUMP_ENTITY);
124 // enable(TestProperties.RECORD_LOG_LEVEL);
125 // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue());
126 ResourceConfig resourceConfig = new ResourceConfig();
127 resourceConfig = resourceConfig.registerInstances(restconfImpl, new NormalizedNodeJsonBodyWriter(),
128 new NormalizedNodeXmlBodyWriter(), new XmlNormalizedNodeBodyReader(), new JsonNormalizedNodeBodyReader());
129 resourceConfig.registerClasses(RestconfDocumentedExceptionMapper.class);
130 resourceConfig.registerClasses(new RestconfApplication().getClasses());
131 return resourceConfig;
134 private void setControllerContext(final SchemaContext schemaContext) {
135 final ControllerContext controllerContext = ControllerContext.getInstance();
136 controllerContext.setSchemas(schemaContext);
137 restconfImpl.setControllerContext(controllerContext);
141 * Tests of status codes for "/operational/{identifier}".
144 public void getOperationalStatusCodes() throws UnsupportedEncodingException {
145 setControllerContext(schemaContextYangsIetf);
146 mockReadOperationalDataMethod();
147 String uri = "/operational/ietf-interfaces:interfaces/interface/eth0";
148 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
150 uri = "/operational/wrong-module:interfaces/interface/eth0";
151 assertEquals(400, get(uri, MediaType.APPLICATION_XML));
155 * Tests of status codes for "/config/{identifier}".
158 public void getConfigStatusCodes() throws UnsupportedEncodingException {
159 setControllerContext(schemaContextYangsIetf);
160 mockReadConfigurationDataMethod();
161 String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
162 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
164 uri = "/config/wrong-module:interfaces/interface/eth0";
165 assertEquals(400, get(uri, MediaType.APPLICATION_XML));
169 * MountPoint test. URI represents mount point.
171 @SuppressWarnings("unchecked")
173 public void getDataWithUrlMountPoint() throws UnsupportedEncodingException, URISyntaxException, ParseException {
174 when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class))).thenReturn(
175 prepareCnDataForMountPointTest(false));
176 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
177 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
178 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
179 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
181 ControllerContext.getInstance().setMountService(mockMountService);
183 String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/cont1";
184 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
186 uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont/cont1";
187 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
191 * MountPoint test. URI represents mount point.
193 * Slashes in URI behind mount point. lst1 element with key GigabitEthernet0%2F0%2F0%2F0 (GigabitEthernet0/0/0/0) is
194 * requested via GET HTTP operation. It is tested whether %2F character is replaced with simple / in
195 * InstanceIdentifier parameter in method
196 * {@link BrokerFacade#readConfigurationData(DOMMountPoint, YangInstanceIdentifier)} which is called in
197 * method {@link RestconfImpl#readConfigurationData}
199 * @throws ParseException
202 public void getDataWithSlashesBehindMountPoint() throws Exception {
203 final YangInstanceIdentifier awaitedInstanceIdentifier = prepareInstanceIdentifierForList();
204 when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), eq(awaitedInstanceIdentifier))).thenReturn(
205 prepareCnDataForSlashesBehindMountPointTest());
206 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
207 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
208 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
209 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
211 ControllerContext.getInstance().setMountService(mockMountService);
213 final String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/lst1/GigabitEthernet0%2F0%2F0%2F0";
214 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
217 private YangInstanceIdentifier prepareInstanceIdentifierForList() throws Exception {
218 final List<PathArgument> parameters = new ArrayList<>();
220 final QName qNameCont = newTestModuleQName("cont");
221 final QName qNameList = newTestModuleQName("lst1");
222 final QName qNameKeyList = newTestModuleQName("lf11");
224 parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameCont));
225 parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameList));
226 parameters.add(new YangInstanceIdentifier.NodeIdentifierWithPredicates(qNameList, qNameKeyList,
227 "GigabitEthernet0/0/0/0"));
228 return YangInstanceIdentifier.create(parameters);
231 private QName newTestModuleQName(String localPart) throws Exception {
232 final Date revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-01-09");
233 final URI uri = new URI("test:module");
234 return QName.create(uri, revision, localPart);
238 public void getDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException,
240 when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class))).thenReturn(
241 prepareCnDataForMountPointTest(true));
242 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
243 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
244 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
245 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
247 ControllerContext.getInstance().setMountService(mockMountService);
249 final String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont";
250 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
253 @SuppressWarnings("unchecked")
255 public void getDataWithIdentityrefInURL() throws Exception {
256 setControllerContext(schemaContextTestModule);
258 QName moduleQN = newTestModuleQName("module");
259 ImmutableMap<QName, Object> keyMap = ImmutableMap.<QName, Object>builder()
260 .put(newTestModuleQName("type"), newTestModuleQName("test-identity"))
261 .put(newTestModuleQName("name"), "foo").build();
262 YangInstanceIdentifier iid = YangInstanceIdentifier.builder().node(newTestModuleQName("modules"))
263 .node(moduleQN).nodeWithKey(moduleQN, keyMap).build();
264 @SuppressWarnings("rawtypes")
265 NormalizedNode data = ImmutableMapNodeBuilder.create().withNodeIdentifier(
266 new NodeIdentifier(moduleQN)).withChild(ImmutableNodes.mapEntryBuilder()
267 .withNodeIdentifier(new NodeIdentifierWithPredicates(moduleQN, keyMap))
268 .withChild(ImmutableNodes.leafNode(newTestModuleQName("type"), newTestModuleQName("test-identity")))
269 .withChild(ImmutableNodes.leafNode(newTestModuleQName("name"), "foo"))
270 .withChild(ImmutableNodes.leafNode(newTestModuleQName("data"), "bar")).build()).build();
271 when(brokerFacade.readConfigurationData(iid)).thenReturn(data);
273 String uri = "/config/test-module:modules/module/test-module:test-identity/foo";
274 assertEquals(200, get(uri, MediaType.APPLICATION_XML));
279 public void getModulesTest() throws UnsupportedEncodingException, FileNotFoundException {
280 final ControllerContext controllerContext = ControllerContext.getInstance();
281 controllerContext.setGlobalSchema(schemaContextModules);
282 restconfImpl.setControllerContext(controllerContext);
284 final String uri = "/modules";
286 Response response = target(uri).request("application/yang.api+json").get();
287 validateModulesResponseJson(response);
289 response = target(uri).request("application/yang.api+xml").get();
290 validateModulesResponseXml(response,schemaContextModules);
295 @Ignore // FIXME : find why it is fail by in gerrit build
296 public void getStreamsTest() throws UnsupportedEncodingException, FileNotFoundException {
297 setControllerContext(schemaContextModules);
299 final String uri = "/streams";
301 Response response = target(uri).request("application/yang.api+json").get();
302 final String responseBody = response.readEntity(String.class);
303 assertEquals(200, response.getStatus());
304 assertNotNull(responseBody);
305 assertTrue(responseBody.contains("streams"));
307 response = target(uri).request("application/yang.api+xml").get();
308 assertEquals(200, response.getStatus());
309 final Document responseXmlBody = response.readEntity(Document.class);
310 assertNotNull(responseXmlBody);
311 final Element rootNode = responseXmlBody.getDocumentElement();
313 assertEquals("streams", rootNode.getLocalName());
314 assertEquals(RESTCONF_NS, rootNode.getNamespaceURI());
319 public void getModuleTest() throws FileNotFoundException, UnsupportedEncodingException {
320 setControllerContext(schemaContextModules);
322 final String uri = "/modules/module/module2/2014-01-02";
324 Response response = target(uri).request("application/yang.api+xml").get();
325 assertEquals(200, response.getStatus());
326 final Document responseXml = response.readEntity(Document.class);
328 final QName qname = assertedModuleXmlToModuleQName(responseXml.getDocumentElement());
329 assertNotNull(qname);
331 assertEquals("module2", qname.getLocalName());
332 assertEquals("module:2", qname.getNamespace().toString());
333 assertEquals("2014-01-02", qname.getFormattedRevision());
335 response = target(uri).request("application/yang.api+json").get();
336 assertEquals(200, response.getStatus());
337 final String responseBody = response.readEntity(String.class);
338 assertTrue("Module2 in json wasn't found", prepareJsonRegex("module2", "2014-01-02", "module:2", responseBody)
340 final String[] split = responseBody.split("\"module\"");
341 assertEquals("\"module\" element is returned more then once", 2, split.length);
347 public void getOperationsTest() throws FileNotFoundException, UnsupportedEncodingException {
348 setControllerContext(schemaContextModules);
350 final String uri = "/operations";
352 Response response = target(uri).request("application/yang.api+xml").get();
353 assertEquals(200, response.getStatus());
354 final Document responseDoc = response.readEntity(Document.class);
355 validateOperationsResponseXml(responseDoc, schemaContextModules);
357 response = target(uri).request("application/yang.api+json").get();
358 assertEquals(200, response.getStatus());
359 final String responseBody = response.readEntity(String.class);
360 assertTrue("Json response for /operations dummy-rpc1-module1 is incorrect",
361 validateOperationsResponseJson(responseBody, "dummy-rpc1-module1", "module1").find());
362 assertTrue("Json response for /operations dummy-rpc2-module1 is incorrect",
363 validateOperationsResponseJson(responseBody, "dummy-rpc2-module1", "module1").find());
364 assertTrue("Json response for /operations dummy-rpc1-module2 is incorrect",
365 validateOperationsResponseJson(responseBody, "dummy-rpc1-module2", "module2").find());
366 assertTrue("Json response for /operations dummy-rpc2-module2 is incorrect",
367 validateOperationsResponseJson(responseBody, "dummy-rpc2-module2", "module2").find());
371 private void validateOperationsResponseXml(final Document responseDoc, final SchemaContext schemaContext) {
373 final Element operationsElem = responseDoc.getDocumentElement();
374 assertEquals(RESTCONF_NS, operationsElem.getNamespaceURI());
375 assertEquals("operations", operationsElem.getLocalName());
377 final NodeList operationsList = operationsElem.getChildNodes();
378 final HashSet<String> foundOperations = new HashSet<>();
380 for (int i = 0; i < operationsList.getLength(); i++) {
381 final org.w3c.dom.Node operation = operationsList.item(i);
382 foundOperations.add(operation.getLocalName());
385 for (final RpcDefinition schemaOp : schemaContext.getOperations()) {
386 assertTrue(foundOperations.contains(schemaOp.getQName().getLocalName()));
390 // /operations/pathToMountPoint/yang-ext:mount
392 public void getOperationsBehindMountPointTest() throws FileNotFoundException, UnsupportedEncodingException {
393 setControllerContext(schemaContextModules);
395 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
396 when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
397 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
398 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
400 ControllerContext.getInstance().setMountService(mockMountService);
402 final String uri = "/operations/ietf-interfaces:interfaces/interface/0/yang-ext:mount/";
404 Response response = target(uri).request("application/yang.api+xml").get();
405 assertEquals(200, response.getStatus());
407 final Document responseDoc = response.readEntity(Document.class);
408 validateOperationsResponseXml(responseDoc, schemaContextBehindMountPoint);
410 response = target(uri).request("application/yang.api+json").get();
411 assertEquals(200, response.getStatus());
412 final String responseBody = response.readEntity(String.class);
413 assertTrue("Json response for /operations/mount_point rpc-behind-module1 is incorrect",
414 validateOperationsResponseJson(responseBody, "rpc-behind-module1", "module1-behind-mount-point").find());
415 assertTrue("Json response for /operations/mount_point rpc-behind-module2 is incorrect",
416 validateOperationsResponseJson(responseBody, "rpc-behind-module2", "module2-behind-mount-point").find());
420 private Matcher validateOperationsResponseJson(final String searchIn, final String rpcName, final String moduleName) {
421 final StringBuilder regex = new StringBuilder();
422 regex.append(".*\"" + rpcName + "\"");
423 final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
424 return ptrn.matcher(searchIn);
428 private Matcher validateOperationsResponseXml(final String searchIn, final String rpcName, final String namespace) {
429 final StringBuilder regex = new StringBuilder();
433 regex.append(".*<operations");
434 regex.append(".*xmlns=\"urn:ietf:params:xml:ns:yang:ietf-restconf\"");
438 regex.append(".*" + rpcName);
439 regex.append(".*" + namespace);
443 regex.append(".*</operations.*");
448 final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
449 return ptrn.matcher(searchIn);
452 // /restconf/modules/pathToMountPoint/yang-ext:mount
454 public void getModulesBehindMountPoint() throws FileNotFoundException, UnsupportedEncodingException {
455 setControllerContext(schemaContextModules);
457 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
458 when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
459 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
460 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
462 ControllerContext.getInstance().setMountService(mockMountService);
464 final String uri = "/modules/ietf-interfaces:interfaces/interface/0/yang-ext:mount/";
466 Response response = target(uri).request("application/yang.api+json").get();
467 assertEquals(200, response.getStatus());
468 final String responseBody = response.readEntity(String.class);
471 "module1-behind-mount-point in json wasn't found",
472 prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point",
473 responseBody).find());
475 "module2-behind-mount-point in json wasn't found",
476 prepareJsonRegex("module2-behind-mount-point", "2014-02-04", "module:2:behind:mount:point",
477 responseBody).find());
479 response = target(uri).request("application/yang.api+xml").get();
480 assertEquals(200, response.getStatus());
481 validateModulesResponseXml(response, schemaContextBehindMountPoint);
485 // /restconf/modules/module/pathToMountPoint/yang-ext:mount/moduleName/revision
487 public void getModuleBehindMountPoint() throws FileNotFoundException, UnsupportedEncodingException {
488 setControllerContext(schemaContextModules);
490 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
491 when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
492 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
493 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
495 ControllerContext.getInstance().setMountService(mockMountService);
497 final String uri = "/modules/module/ietf-interfaces:interfaces/interface/0/yang-ext:mount/module1-behind-mount-point/2014-02-03";
499 Response response = target(uri).request("application/yang.api+json").get();
500 assertEquals(200, response.getStatus());
501 final String responseBody = response.readEntity(String.class);
504 "module1-behind-mount-point in json wasn't found",
505 prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point",
506 responseBody).find());
507 final String[] split = responseBody.split("\"module\"");
508 assertEquals("\"module\" element is returned more then once", 2, split.length);
510 response = target(uri).request("application/yang.api+xml").get();
511 assertEquals(200, response.getStatus());
512 final Document responseXml = response.readEntity(Document.class);
514 final QName module = assertedModuleXmlToModuleQName(responseXml.getDocumentElement());
516 assertEquals("module1-behind-mount-point", module.getLocalName());
517 assertEquals("2014-02-03", module.getFormattedRevision());
518 assertEquals("module:1:behind:mount:point", module.getNamespace().toString());
523 private void validateModulesResponseXml(final Response response, final SchemaContext schemaContext) {
524 assertEquals(200, response.getStatus());
525 final Document responseBody = response.readEntity(Document.class);
526 final NodeList moduleNodes = responseBody.getDocumentElement().getElementsByTagNameNS(RESTCONF_NS, "module");
528 assertTrue(moduleNodes.getLength() > 0);
530 final HashSet<QName> foundModules = new HashSet<>();
532 for(int i=0;i < moduleNodes.getLength();i++) {
533 final org.w3c.dom.Node module = moduleNodes.item(i);
535 final QName name = assertedModuleXmlToModuleQName(module);
536 foundModules.add(name);
539 assertAllModules(foundModules,schemaContext);
542 private void assertAllModules(final Set<QName> foundModules, final SchemaContext schemaContext) {
543 for(final Module module : schemaContext.getModules()) {
544 final QName current = QName.create(module.getQNameModule(),module.getName());
545 assertTrue("Module not found in response.",foundModules.contains(current));
550 private QName assertedModuleXmlToModuleQName(final org.w3c.dom.Node module) {
551 assertEquals("module", module.getLocalName());
552 assertEquals(RESTCONF_NS, module.getNamespaceURI());
553 String revision = null;
554 String namespace = null;
558 final NodeList childNodes = module.getChildNodes();
560 for(int i =0;i < childNodes.getLength(); i++) {
561 final org.w3c.dom.Node child = childNodes.item(i);
562 assertEquals(RESTCONF_NS, child.getNamespaceURI());
564 switch(child.getLocalName()) {
566 assertNull("Name element appeared multiple times",name);
567 name = child.getTextContent().trim();
570 assertNull("Revision element appeared multiple times",revision);
571 revision = child.getTextContent().trim();
575 assertNull("Namespace element appeared multiple times",namespace);
576 namespace = child.getTextContent().trim();
581 assertNotNull("Revision was not part of xml",revision);
582 assertNotNull("Module namespace was not part of xml",namespace);
583 assertNotNull("Module identiffier was not part of xml",name);
586 // TODO Auto-generated method stub
588 return QName.create(namespace,revision,name);
591 private void validateModulesResponseJson(final Response response) {
592 assertEquals(200, response.getStatus());
593 final String responseBody = response.readEntity(String.class);
595 assertTrue("Module1 in json wasn't found", prepareJsonRegex("module1", "2014-01-01", "module:1", responseBody)
597 assertTrue("Module2 in json wasn't found", prepareJsonRegex("module2", "2014-01-02", "module:2", responseBody)
599 assertTrue("Module3 in json wasn't found", prepareJsonRegex("module3", "2014-01-03", "module:3", responseBody)
603 private Matcher prepareJsonRegex(final String module, final String revision, final String namespace,
604 final String searchIn) {
605 final StringBuilder regex = new StringBuilder();
608 regex.append(".*\\{");
609 regex.append(".*\"name\"");
611 regex.append(".*\"" + module + "\",");
613 regex.append(".*\"revision\"");
615 regex.append(".*\"" + revision + "\",");
617 regex.append(".*\"namespace\"");
619 regex.append(".*\"" + namespace + "\"");
621 regex.append(".*\\}");
625 final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
626 return ptrn.matcher(searchIn);
631 private int get(final String uri, final String mediaType) {
632 return target(uri).request(mediaType).get().getStatus();
642 @SuppressWarnings("rawtypes")
643 private NormalizedNode prepareCnDataForMountPointTest(final boolean wrapToCont) throws URISyntaxException, ParseException {
644 final String testModuleDate = "2014-01-09";
645 final ContainerNode contChild = Builders
647 .withNodeIdentifier(TestUtils.getNodeIdentifier("cont1", "test:module", testModuleDate))
649 Builders.leafBuilder()
650 .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", testModuleDate))
651 .withValue("lf11 value").build()).build();
654 return Builders.containerBuilder()
655 .withNodeIdentifier(TestUtils.getNodeIdentifier("cont", "test:module", testModuleDate))
656 .withChild(contChild).build();
662 @SuppressWarnings("unchecked")
663 private void mockReadOperationalDataMethod() {
664 when(brokerFacade.readOperationalData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet);
667 @SuppressWarnings("unchecked")
668 private void mockReadConfigurationDataMethod() {
669 when(brokerFacade.readConfigurationData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet);
672 @SuppressWarnings("rawtypes")
673 private NormalizedNode prepareCnDataForSlashesBehindMountPointTest() throws ParseException {
674 return ImmutableMapEntryNodeBuilder
677 TestUtils.getNodeIdentifierPredicate("lst1", "test:module", "2014-01-09", "lf11",
678 "GigabitEthernet0/0/0/0"))
680 ImmutableLeafNodeBuilder.create()
681 .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", "2014-01-09"))
682 .withValue("GigabitEthernet0/0/0/0").build()).build();
687 * If includeWhiteChars URI parameter is set to false then no white characters can be included in returned output
689 * @throws UnsupportedEncodingException
692 public void getDataWithUriIncludeWhiteCharsParameterTest() throws UnsupportedEncodingException {
693 getDataWithUriIncludeWhiteCharsParameter("config");
694 getDataWithUriIncludeWhiteCharsParameter("operational");
697 private void getDataWithUriIncludeWhiteCharsParameter(final String target) throws UnsupportedEncodingException {
698 mockReadConfigurationDataMethod();
699 mockReadOperationalDataMethod();
700 final String uri = "/" + target + "/ietf-interfaces:interfaces/interface/eth0";
701 Response response = target(uri).queryParam("prettyPrint", "false").request("application/xml").get();
702 final String xmlData = response.readEntity(String.class);
704 Pattern pattern = Pattern.compile(".*(>\\s+|\\s+<).*", Pattern.DOTALL);
705 Matcher matcher = pattern.matcher(xmlData);
706 // XML element can't surrounded with white character (e.g "> " or
708 assertFalse(matcher.matches());
710 response = target(uri).queryParam("prettyPrint", "false").request("application/json").get();
711 final String jsonData = response.readEntity(String.class);
712 pattern = Pattern.compile(".*(\\}\\s+|\\s+\\{|\\]\\s+|\\s+\\[|\\s+:|:\\s+).*", Pattern.DOTALL);
713 matcher = pattern.matcher(jsonData);
714 // JSON element can't surrounded with white character (e.g "} ", " {",
715 // "] ", " [", " :" or ": ")
716 assertFalse(matcher.matches());
720 * Tests behavior when invalid value of depth URI parameter
724 public void getDataWithInvalidDepthParameterTest() {
725 setControllerContext(schemaContextModules);
727 final MultivaluedMap<String, String> paramMap = new MultivaluedHashMap<>();
728 paramMap.putSingle("depth", "1o");
729 final UriInfo mockInfo = mock(UriInfo.class);
730 when(mockInfo.getQueryParameters(false)).thenAnswer(new Answer<MultivaluedMap<String, String>>() {
732 public MultivaluedMap<String, String> answer(final InvocationOnMock invocation) {
737 getDataWithInvalidDepthParameterTest(mockInfo);
739 paramMap.putSingle("depth", "0");
740 getDataWithInvalidDepthParameterTest(mockInfo);
742 paramMap.putSingle("depth", "-1");
743 getDataWithInvalidDepthParameterTest(mockInfo);
746 @SuppressWarnings({"rawtypes", "unchecked"})
747 private void getDataWithInvalidDepthParameterTest(final UriInfo uriInfo) {
749 final QName qNameDepth1Cont = QName.create("urn:nested:module", "2014-06-3", "depth1-cont");
750 final YangInstanceIdentifier ii = YangInstanceIdentifier.builder().node(qNameDepth1Cont).build();
751 final NormalizedNode value = (Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(qNameDepth1Cont)).build());
752 when(brokerFacade.readConfigurationData(eq(ii))).thenReturn(value);
753 restconfImpl.readConfigurationData("nested-module:depth1-cont", uriInfo);
754 fail("Expected RestconfDocumentedException");
755 } catch (final RestconfDocumentedException e) {
756 assertTrue("Unexpected error message: " + e.getErrors().get(0).getErrorMessage(), e.getErrors().get(0)
757 .getErrorMessage().contains("depth"));
761 @SuppressWarnings("unused")
762 private void verifyXMLResponse(final Response response, final NodeData nodeData) {
763 final Document doc = response.readEntity(Document.class);
764 // Document doc = TestUtils.loadDocumentFrom((InputStream) response.getEntity());
765 // System.out.println();
766 assertNotNull("Could not parse XML document", doc);
768 // System.out.println(TestUtils.getDocumentInPrintableForm( doc ));
770 verifyContainerElement(doc.getDocumentElement(), nodeData);
773 @SuppressWarnings("unchecked")
774 private void verifyContainerElement(final Element element, final NodeData nodeData) {
776 assertEquals("Element local name", nodeData.key, element.getLocalName());
778 final NodeList childNodes = element.getChildNodes();
779 if (nodeData.data == null) { // empty container
780 assertTrue("Expected no child elements for \"" + element.getLocalName() + "\"", childNodes.getLength() == 0);
784 final Map<String, NodeData> expChildMap = Maps.newHashMap();
785 for (final NodeData expChild : (List<NodeData>) nodeData.data) {
786 expChildMap.put(expChild.key.toString(), expChild);
789 for (int i = 0; i < childNodes.getLength(); i++) {
790 final org.w3c.dom.Node actualChild = childNodes.item(i);
791 if (!(actualChild instanceof Element)) {
795 final Element actualElement = (Element) actualChild;
796 final NodeData expChild = expChildMap.remove(actualElement.getLocalName());
798 "Unexpected child element for parent \"" + element.getLocalName() + "\": "
799 + actualElement.getLocalName(), expChild);
801 if (expChild.data == null || expChild.data instanceof List) {
802 verifyContainerElement(actualElement, expChild);
804 assertEquals("Text content for element: " + actualElement.getLocalName(), expChild.data,
805 actualElement.getTextContent());
809 if (!expChildMap.isEmpty()) {
810 fail("Missing elements for parent \"" + element.getLocalName() + "\": " + expChildMap.keySet());