restconf/restconf-nb-bierman02/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestGetOperationTest.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.sal.restconf.impl.test;
  10
  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
  22 import com.google.common.base.Optional;
  23 import com.google.common.collect.ImmutableMap;
  24 import com.google.common.collect.Maps;
  25 import java.net.URI;
  26 import java.util.ArrayList;
  27 import java.util.Date;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Set;
  32 import java.util.regex.Matcher;
  33 import java.util.regex.Pattern;
  34 import javax.ws.rs.core.Application;
  35 import javax.ws.rs.core.MediaType;
  36 import javax.ws.rs.core.MultivaluedHashMap;
  37 import javax.ws.rs.core.MultivaluedMap;
  38 import javax.ws.rs.core.Response;
  39 import javax.ws.rs.core.UriInfo;
  40 import org.glassfish.jersey.server.ResourceConfig;
  41 import org.glassfish.jersey.test.JerseyTest;
  42 import org.junit.BeforeClass;
  43 import org.junit.Ignore;
  44 import org.junit.Test;
  45 import org.mockito.Mockito;
  46 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  47 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  48 import org.opendaylight.netconf.sal.rest.impl.JsonNormalizedNodeBodyReader;
  49 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeJsonBodyWriter;
  50 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeXmlBodyWriter;
  51 import org.opendaylight.netconf.sal.rest.impl.RestconfApplication;
  52 import org.opendaylight.netconf.sal.rest.impl.RestconfDocumentedExceptionMapper;
  53 import org.opendaylight.netconf.sal.rest.impl.XmlNormalizedNodeBodyReader;
  54 import org.opendaylight.netconf.sal.restconf.impl.BrokerFacade;
  55 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  56 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
  57 import org.opendaylight.netconf.sal.restconf.impl.RestconfImpl;
  58 import org.opendaylight.yangtools.yang.common.QName;
  59 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  64 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  65 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  66 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  67 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  68 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  69 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  70 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  71 import org.opendaylight.yangtools.yang.model.api.Module;
  72 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  73 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  74 import org.w3c.dom.Document;
  75 import org.w3c.dom.Element;
  76 import org.w3c.dom.NodeList;
  77
  78 public class RestGetOperationTest extends JerseyTest {
  79
  80     static class NodeData {
  81         Object key;
  82         Object data; // List for a CompositeNode, value Object for a SimpleNode
  83
  84         NodeData(final Object key, final Object data) {
  85             this.key = key;
  86             this.data = data;
  87         }
  88     }
  89
  90     private static BrokerFacade brokerFacade;
  91     private static RestconfImpl restconfImpl;
  92     private static SchemaContext schemaContextYangsIetf;
  93     private static SchemaContext schemaContextTestModule;
  94     @SuppressWarnings("rawtypes")
  95     private static NormalizedNode answerFromGet;
  96
  97     private static SchemaContext schemaContextModules;
  98     private static SchemaContext schemaContextBehindMountPoint;
  99
 100     private static final String RESTCONF_NS = "urn:ietf:params:xml:ns:yang:ietf-restconf";
 101
 102     @BeforeClass
 103     public static void init() throws Exception {
 104         schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs");
 105         schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module");
 106         brokerFacade = mock(BrokerFacade.class);
 107         restconfImpl = RestconfImpl.getInstance();
 108         restconfImpl.setBroker(brokerFacade);
 109         answerFromGet = TestUtils.prepareNormalizedNodeWithIetfInterfacesInterfacesData();
 110
 111         schemaContextModules = TestUtils.loadSchemaContext("/modules");
 112         schemaContextBehindMountPoint = TestUtils.loadSchemaContext("/modules/modules-behind-mount-point");
 113     }
 114
 115     @Override
 116     protected Application configure() {
 117         /* enable/disable Jersey logs to console */
 118         // enable(TestProperties.LOG_TRAFFIC);
 119         // enable(TestProperties.DUMP_ENTITY);
 120         // enable(TestProperties.RECORD_LOG_LEVEL);
 121         // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue());
 122         ResourceConfig resourceConfig = new ResourceConfig();
 123         resourceConfig = resourceConfig.registerInstances(restconfImpl, new NormalizedNodeJsonBodyWriter(),
 124             new NormalizedNodeXmlBodyWriter(), new XmlNormalizedNodeBodyReader(), new JsonNormalizedNodeBodyReader());
 125         resourceConfig.registerClasses(RestconfDocumentedExceptionMapper.class);
 126         resourceConfig.registerClasses(new RestconfApplication().getClasses());
 127         return resourceConfig;
 128     }
 129
 130     private static void setControllerContext(final SchemaContext schemaContext) {
 131         final ControllerContext controllerContext = ControllerContext.getInstance();
 132         controllerContext.setSchemas(schemaContext);
 133         restconfImpl.setControllerContext(controllerContext);
 134     }
 135
 136     /**
 137      * Tests of status codes for "/operational/{identifier}".
 138      */
 139     @Test
 140     public void getOperationalStatusCodes() throws Exception {
 141         setControllerContext(schemaContextYangsIetf);
 142         mockReadOperationalDataMethod();
 143         String uri = "/operational/ietf-interfaces:interfaces/interface/eth0";
 144         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 145
 146         uri = "/operational/wrong-module:interfaces/interface/eth0";
 147         assertEquals(400, get(uri, MediaType.APPLICATION_XML));
 148     }
 149
 150     /**
 151      * Tests of status codes for "/config/{identifier}".
 152      */
 153     @Test
 154     public void getConfigStatusCodes() throws Exception {
 155         setControllerContext(schemaContextYangsIetf);
 156         mockReadConfigurationDataMethod();
 157         String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 158         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 159
 160         uri = "/config/wrong-module:interfaces/interface/eth0";
 161         assertEquals(400, get(uri, MediaType.APPLICATION_XML));
 162     }
 163
 164     /**
 165      * MountPoint test. URI represents mount point.
 166      */
 167     @SuppressWarnings("unchecked")
 168     @Test
 169     public void getDataWithUrlMountPoint() throws Exception {
 170         when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class),
 171                 Mockito.anyString())).thenReturn(
 172                 prepareCnDataForMountPointTest(false));
 173         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 174         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 175         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 176         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 177
 178         ControllerContext.getInstance().setMountService(mockMountService);
 179
 180         String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/cont1";
 181         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 182
 183         uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont/cont1";
 184         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 185     }
 186
 187     /**
 188      * MountPoint test. URI represents mount point.
 189      * Slashes in URI behind mount point. lst1 element with key GigabitEthernet0%2F0%2F0%2F0 (GigabitEthernet0/0/0/0) is
 190      * requested via GET HTTP operation. It is tested whether %2F character is replaced with simple / in
 191      * InstanceIdentifier parameter in method
 192      * {@link BrokerFacade#readConfigurationData(DOMMountPoint, YangInstanceIdentifier)} which is called in
 193      * method {@link RestconfImpl#readConfigurationData}
 194      */
 195     @Test
 196     public void getDataWithSlashesBehindMountPoint() throws Exception {
 197         final YangInstanceIdentifier awaitedInstanceIdentifier = prepareInstanceIdentifierForList();
 198         when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), eq(awaitedInstanceIdentifier),
 199                 Mockito.anyString())).thenReturn(prepareCnDataForSlashesBehindMountPointTest());
 200         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 201         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 202         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 203         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 204
 205         ControllerContext.getInstance().setMountService(mockMountService);
 206
 207         final String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/"
 208                 + "test-module:cont/lst1/GigabitEthernet0%2F0%2F0%2F0";
 209         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 210     }
 211
 212     private static YangInstanceIdentifier prepareInstanceIdentifierForList() throws Exception {
 213         final List<PathArgument> parameters = new ArrayList<>();
 214
 215         final QName qNameCont = newTestModuleQName("cont");
 216         final QName qNameList = newTestModuleQName("lst1");
 217         final QName qNameKeyList = newTestModuleQName("lf11");
 218
 219         parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameCont));
 220         parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameList));
 221         parameters.add(new YangInstanceIdentifier.NodeIdentifierWithPredicates(qNameList, qNameKeyList,
 222                 "GigabitEthernet0/0/0/0"));
 223         return YangInstanceIdentifier.create(parameters);
 224     }
 225
 226     private static QName newTestModuleQName(final String localPart) throws Exception {
 227         final Date revision = SimpleDateFormatUtil.getRevisionFormat().parse("2014-01-09");
 228         final URI uri = URI.create("test:module");
 229         return QName.create(uri, revision, localPart);
 230     }
 231
 232     @Test
 233     public void getDataMountPointIntoHighestElement() throws Exception {
 234         when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class),
 235                 Mockito.anyString())).thenReturn(
 236                 prepareCnDataForMountPointTest(true));
 237         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 238         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 239         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 240         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 241
 242         ControllerContext.getInstance().setMountService(mockMountService);
 243
 244         final String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont";
 245         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 246     }
 247
 248     @SuppressWarnings("unchecked")
 249     @Test
 250     public void getDataWithIdentityrefInURL() throws Exception {
 251         setControllerContext(schemaContextTestModule);
 252
 253         final QName moduleQN = newTestModuleQName("module");
 254         final ImmutableMap<QName, Object> keyMap = ImmutableMap.<QName, Object>builder()
 255                 .put(newTestModuleQName("type"), newTestModuleQName("test-identity"))
 256                 .put(newTestModuleQName("name"), "foo").build();
 257         final YangInstanceIdentifier iid = YangInstanceIdentifier.builder().node(newTestModuleQName("modules"))
 258                 .node(moduleQN).nodeWithKey(moduleQN, keyMap).build();
 259         @SuppressWarnings("rawtypes")
 260         final NormalizedNode data = ImmutableMapNodeBuilder.create().withNodeIdentifier(
 261                 new NodeIdentifier(moduleQN)).withChild(ImmutableNodes.mapEntryBuilder()
 262                     .withNodeIdentifier(new NodeIdentifierWithPredicates(moduleQN, keyMap))
 263                     .withChild(ImmutableNodes.leafNode(newTestModuleQName("type"), newTestModuleQName("test-identity")))
 264                     .withChild(ImmutableNodes.leafNode(newTestModuleQName("name"), "foo"))
 265                     .withChild(ImmutableNodes.leafNode(newTestModuleQName("data"), "bar")).build()).build();
 266         when(brokerFacade.readConfigurationData(iid, null)).thenReturn(data);
 267
 268         final String uri = "/config/test-module:modules/module/test-module:test-identity/foo";
 269         assertEquals(200, get(uri, MediaType.APPLICATION_XML));
 270     }
 271
 272     // /modules
 273     @Test
 274     public void getModulesTest() throws Exception {
 275         final ControllerContext controllerContext = ControllerContext.getInstance();
 276         controllerContext.setGlobalSchema(schemaContextModules);
 277         restconfImpl.setControllerContext(controllerContext);
 278
 279         final String uri = "/modules";
 280
 281         Response response = target(uri).request("application/yang.api+json").get();
 282         validateModulesResponseJson(response);
 283
 284         response = target(uri).request("application/yang.api+xml").get();
 285         validateModulesResponseXml(response,schemaContextModules);
 286     }
 287
 288     // /streams/
 289     @Test
 290     @Ignore // FIXME : find why it is fail by in gerrit build
 291     public void getStreamsTest() throws Exception {
 292         setControllerContext(schemaContextModules);
 293
 294         final String uri = "/streams";
 295
 296         Response response = target(uri).request("application/yang.api+json").get();
 297         final String responseBody = response.readEntity(String.class);
 298         assertEquals(200, response.getStatus());
 299         assertNotNull(responseBody);
 300         assertTrue(responseBody.contains("streams"));
 301
 302         response = target(uri).request("application/yang.api+xml").get();
 303         assertEquals(200, response.getStatus());
 304         final Document responseXmlBody = response.readEntity(Document.class);
 305         assertNotNull(responseXmlBody);
 306         final Element rootNode = responseXmlBody.getDocumentElement();
 307
 308         assertEquals("streams", rootNode.getLocalName());
 309         assertEquals(RESTCONF_NS, rootNode.getNamespaceURI());
 310     }
 311
 312     // /modules/module
 313     @Test
 314     public void getModuleTest() throws Exception {
 315         setControllerContext(schemaContextModules);
 316
 317         final String uri = "/modules/module/module2/2014-01-02";
 318
 319         Response response = target(uri).request("application/yang.api+xml").get();
 320         assertEquals(200, response.getStatus());
 321         final Document responseXml = response.readEntity(Document.class);
 322
 323         final QName qname = assertedModuleXmlToModuleQName(responseXml.getDocumentElement());
 324         assertNotNull(qname);
 325
 326         assertEquals("module2", qname.getLocalName());
 327         assertEquals("module:2", qname.getNamespace().toString());
 328         assertEquals("2014-01-02", qname.getFormattedRevision());
 329
 330         response = target(uri).request("application/yang.api+json").get();
 331         assertEquals(200, response.getStatus());
 332         final String responseBody = response.readEntity(String.class);
 333         assertTrue("Module2 in json wasn't found", prepareJsonRegex("module2", "2014-01-02", "module:2", responseBody)
 334                 .find());
 335         final String[] split = responseBody.split("\"module\"");
 336         assertEquals("\"module\" element is returned more then once", 2, split.length);
 337
 338     }
 339
 340     // /operations
 341     @Ignore
 342     @Test
 343     public void getOperationsTest() throws Exception {
 344         setControllerContext(schemaContextModules);
 345
 346         final String uri = "/operations";
 347
 348         Response response = target(uri).request("application/yang.api+xml").get();
 349         assertEquals(500, response.getStatus());
 350         final Document responseDoc = response.readEntity(Document.class);
 351         validateOperationsResponseXml(responseDoc, schemaContextModules);
 352
 353         response = target(uri).request("application/yang.api+json").get();
 354         assertEquals(200, response.getStatus());
 355         final String responseBody = response.readEntity(String.class);
 356         assertTrue("Json response for /operations dummy-rpc1-module1 is incorrect",
 357                 validateOperationsResponseJson(responseBody, "dummy-rpc1-module1", "module1").find());
 358         assertTrue("Json response for /operations dummy-rpc2-module1 is incorrect",
 359                 validateOperationsResponseJson(responseBody, "dummy-rpc2-module1", "module1").find());
 360         assertTrue("Json response for /operations dummy-rpc1-module2 is incorrect",
 361                 validateOperationsResponseJson(responseBody, "dummy-rpc1-module2", "module2").find());
 362         assertTrue("Json response for /operations dummy-rpc2-module2 is incorrect",
 363                 validateOperationsResponseJson(responseBody, "dummy-rpc2-module2", "module2").find());
 364     }
 365
 366     private static void validateOperationsResponseXml(final Document responseDoc, final SchemaContext schemaContext) {
 367
 368         final Element operationsElem = responseDoc.getDocumentElement();
 369         assertEquals(RESTCONF_NS, operationsElem.getNamespaceURI());
 370         assertEquals("operations", operationsElem.getLocalName());
 371
 372         final NodeList operationsList = operationsElem.getChildNodes();
 373         final HashSet<String> foundOperations = new HashSet<>();
 374
 375         for (int i = 0; i < operationsList.getLength(); i++) {
 376             final org.w3c.dom.Node operation = operationsList.item(i);
 377             foundOperations.add(operation.getLocalName());
 378         }
 379
 380         for (final RpcDefinition schemaOp : schemaContext.getOperations()) {
 381             assertTrue(foundOperations.contains(schemaOp.getQName().getLocalName()));
 382         }
 383     }
 384
 385     private static Matcher validateOperationsResponseXml(final String searchIn, final String rpcName,
 386                                                          final String namespace) {
 387         final StringBuilder regex = new StringBuilder();
 388
 389         regex.append("^");
 390
 391         regex.append(".*<operations");
 392         regex.append(".*xmlns=\"urn:ietf:params:xml:ns:yang:ietf-restconf\"");
 393         regex.append(".*>");
 394
 395         regex.append(".*<");
 396         regex.append(".*" + rpcName);
 397         regex.append(".*" + namespace);
 398         regex.append(".*/");
 399         regex.append(".*>");
 400
 401         regex.append(".*</operations.*");
 402         regex.append(".*>");
 403
 404         regex.append(".*");
 405         regex.append("$");
 406         final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
 407         return ptrn.matcher(searchIn);
 408     }
 409
 410     // /operations/pathToMountPoint/yang-ext:mount
 411     @Ignore
 412     @Test
 413     public void getOperationsBehindMountPointTest() throws Exception {
 414         setControllerContext(schemaContextModules);
 415
 416         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 417         when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
 418         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 419         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 420
 421         ControllerContext.getInstance().setMountService(mockMountService);
 422
 423         final String uri = "/operations/ietf-interfaces:interfaces/interface/0/yang-ext:mount/";
 424
 425         Response response = target(uri).request("application/yang.api+xml").get();
 426         assertEquals(500, response.getStatus());
 427
 428         final Document responseDoc = response.readEntity(Document.class);
 429         validateOperationsResponseXml(responseDoc, schemaContextBehindMountPoint);
 430
 431         response = target(uri).request("application/yang.api+json").get();
 432         assertEquals(200, response.getStatus());
 433         final String responseBody = response.readEntity(String.class);
 434         assertTrue("Json response for /operations/mount_point rpc-behind-module1 is incorrect",
 435             validateOperationsResponseJson(responseBody, "rpc-behind-module1", "module1-behind-mount-point").find());
 436         assertTrue("Json response for /operations/mount_point rpc-behind-module2 is incorrect",
 437             validateOperationsResponseJson(responseBody, "rpc-behind-module2", "module2-behind-mount-point").find());
 438
 439     }
 440
 441     private static Matcher validateOperationsResponseJson(final String searchIn, final String rpcName,
 442             final String moduleName) {
 443         final StringBuilder regex = new StringBuilder();
 444         regex.append(".*\"" + rpcName + "\"");
 445         final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
 446         return ptrn.matcher(searchIn);
 447
 448     }
 449
 450     // /restconf/modules/pathToMountPoint/yang-ext:mount
 451     @Test
 452     public void getModulesBehindMountPoint() throws Exception {
 453         setControllerContext(schemaContextModules);
 454
 455         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 456         when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
 457         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 458         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 459
 460         ControllerContext.getInstance().setMountService(mockMountService);
 461
 462         final String uri = "/modules/ietf-interfaces:interfaces/interface/0/yang-ext:mount/";
 463
 464         Response response = target(uri).request("application/yang.api+json").get();
 465         assertEquals(200, response.getStatus());
 466         final String responseBody = response.readEntity(String.class);
 467
 468         assertTrue(
 469                 "module1-behind-mount-point in json wasn't found",
 470                 prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point",
 471                         responseBody).find());
 472         assertTrue(
 473                 "module2-behind-mount-point in json wasn't found",
 474                 prepareJsonRegex("module2-behind-mount-point", "2014-02-04", "module:2:behind:mount:point",
 475                         responseBody).find());
 476
 477         response = target(uri).request("application/yang.api+xml").get();
 478         assertEquals(200, response.getStatus());
 479         validateModulesResponseXml(response, schemaContextBehindMountPoint);
 480
 481     }
 482
 483     // /restconf/modules/module/pathToMountPoint/yang-ext:mount/moduleName/revision
 484     @Test
 485     public void getModuleBehindMountPoint() throws Exception {
 486         setControllerContext(schemaContextModules);
 487
 488         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 489         when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint);
 490         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 491         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 492
 493         ControllerContext.getInstance().setMountService(mockMountService);
 494
 495         final String uri = "/modules/module/ietf-interfaces:interfaces/interface/0/yang-ext:mount/"
 496                 + "module1-behind-mount-point/2014-02-03";
 497
 498         Response response = target(uri).request("application/yang.api+json").get();
 499         assertEquals(200, response.getStatus());
 500         final String responseBody = response.readEntity(String.class);
 501
 502         assertTrue(
 503                 "module1-behind-mount-point in json wasn't found",
 504                 prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point",
 505                         responseBody).find());
 506         final String[] split = responseBody.split("\"module\"");
 507         assertEquals("\"module\" element is returned more then once", 2, split.length);
 508
 509         response = target(uri).request("application/yang.api+xml").get();
 510         assertEquals(200, response.getStatus());
 511         final Document responseXml = response.readEntity(Document.class);
 512
 513         final QName module = assertedModuleXmlToModuleQName(responseXml.getDocumentElement());
 514
 515         assertEquals("module1-behind-mount-point", module.getLocalName());
 516         assertEquals("2014-02-03", module.getFormattedRevision());
 517         assertEquals("module:1:behind:mount:point", module.getNamespace().toString());
 518
 519
 520     }
 521
 522     private static void validateModulesResponseXml(final Response response, final SchemaContext schemaContext) {
 523         assertEquals(200, response.getStatus());
 524         final Document responseBody = response.readEntity(Document.class);
 525         final NodeList moduleNodes = responseBody.getDocumentElement().getElementsByTagNameNS(RESTCONF_NS, "module");
 526
 527         assertTrue(moduleNodes.getLength() > 0);
 528
 529         final HashSet<QName> foundModules = new HashSet<>();
 530
 531         for (int i = 0; i < moduleNodes.getLength(); i++) {
 532             final org.w3c.dom.Node module = moduleNodes.item(i);
 533
 534             final QName name = assertedModuleXmlToModuleQName(module);
 535             foundModules.add(name);
 536         }
 537
 538         assertAllModules(foundModules,schemaContext);
 539     }
 540
 541     private static void assertAllModules(final Set<QName> foundModules, final SchemaContext schemaContext) {
 542         for (final Module module : schemaContext.getModules()) {
 543             final QName current = QName.create(module.getQNameModule(), module.getName());
 544             assertTrue("Module not found in response.", foundModules.contains(current));
 545         }
 546
 547     }
 548
 549     private static QName assertedModuleXmlToModuleQName(final org.w3c.dom.Node module) {
 550         assertEquals("module", module.getLocalName());
 551         assertEquals(RESTCONF_NS, module.getNamespaceURI());
 552         String revision = null;
 553         String namespace = null;
 554         String name = null;
 555
 556
 557         final NodeList childNodes = module.getChildNodes();
 558
 559         for (int i = 0; i < childNodes.getLength(); i++) {
 560             final org.w3c.dom.Node child = childNodes.item(i);
 561             assertEquals(RESTCONF_NS, child.getNamespaceURI());
 562
 563             switch (child.getLocalName()) {
 564                 case "name":
 565                     assertNull("Name element appeared multiple times", name);
 566                     name = child.getTextContent().trim();
 567                     break;
 568                 case "revision":
 569                     assertNull("Revision element appeared multiple times", revision);
 570                     revision = child.getTextContent().trim();
 571                     break;
 572                 case "namespace":
 573                     assertNull("Namespace element appeared multiple times", namespace);
 574                     namespace = child.getTextContent().trim();
 575                     break;
 576                 default:
 577                     break;
 578             }
 579         }
 580
 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);
 584
 585         return QName.create(namespace,revision,name);
 586     }
 587
 588     private static void validateModulesResponseJson(final Response response) {
 589         assertEquals(200, response.getStatus());
 590         final String responseBody = response.readEntity(String.class);
 591
 592         assertTrue("Module1 in json wasn't found", prepareJsonRegex("module1", "2014-01-01", "module:1", responseBody)
 593                 .find());
 594         assertTrue("Module2 in json wasn't found", prepareJsonRegex("module2", "2014-01-02", "module:2", responseBody)
 595                 .find());
 596         assertTrue("Module3 in json wasn't found", prepareJsonRegex("module3", "2014-01-03", "module:3", responseBody)
 597                 .find());
 598     }
 599
 600     private static Matcher prepareJsonRegex(final String module, final String revision, final String namespace,
 601             final String searchIn) {
 602         final StringBuilder regex = new StringBuilder();
 603         regex.append("^");
 604
 605         regex.append(".*\\{");
 606         regex.append(".*\"name\"");
 607         regex.append(".*:");
 608         regex.append(".*\"" + module + "\",");
 609
 610         regex.append(".*\"revision\"");
 611         regex.append(".*:");
 612         regex.append(".*\"" + revision + "\",");
 613
 614         regex.append(".*\"namespace\"");
 615         regex.append(".*:");
 616         regex.append(".*\"" + namespace + "\"");
 617
 618         regex.append(".*\\}");
 619
 620         regex.append(".*");
 621         regex.append("$");
 622         final Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL);
 623         return ptrn.matcher(searchIn);
 624
 625     }
 626
 627
 628     private int get(final String uri, final String mediaType) {
 629         return target(uri).request(mediaType).get().getStatus();
 630     }
 631
 632     /**
 633      * Container structure.
 634      *
 635      * <p>
 636      * container cont {
 637      *   container cont1 {
 638      *       leaf lf11 {
 639      *           type string;
 640      *       }
 641      */
 642     @SuppressWarnings("rawtypes")
 643     private static NormalizedNode prepareCnDataForMountPointTest(final boolean wrapToCont) throws Exception {
 644         final String testModuleDate = "2014-01-09";
 645         final ContainerNode contChild = Builders
 646                 .containerBuilder()
 647                 .withNodeIdentifier(TestUtils.getNodeIdentifier("cont1", "test:module", testModuleDate))
 648                 .withChild(
 649                         Builders.leafBuilder()
 650                                 .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", testModuleDate))
 651                                 .withValue("lf11 value").build()).build();
 652
 653         if (wrapToCont) {
 654             return Builders.containerBuilder()
 655                     .withNodeIdentifier(TestUtils.getNodeIdentifier("cont", "test:module", testModuleDate))
 656                     .withChild(contChild).build();
 657         }
 658         return contChild;
 659
 660     }
 661
 662     @SuppressWarnings("unchecked")
 663     private static void mockReadOperationalDataMethod() {
 664         when(brokerFacade.readOperationalData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet);
 665     }
 666
 667     @SuppressWarnings("unchecked")
 668     private static void mockReadConfigurationDataMethod() {
 669         when(brokerFacade.readConfigurationData(any(YangInstanceIdentifier.class), Mockito.anyString()))
 670                 .thenReturn(answerFromGet);
 671     }
 672
 673     @SuppressWarnings("rawtypes")
 674     private static NormalizedNode prepareCnDataForSlashesBehindMountPointTest() throws Exception {
 675         return ImmutableMapEntryNodeBuilder
 676                 .create()
 677                 .withNodeIdentifier(
 678                         TestUtils.getNodeIdentifierPredicate("lst1", "test:module", "2014-01-09", "lf11",
 679                                 "GigabitEthernet0/0/0/0"))
 680                 .withChild(
 681                         ImmutableLeafNodeBuilder.create()
 682                                 .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", "2014-01-09"))
 683                                 .withValue("GigabitEthernet0/0/0/0").build()).build();
 684
 685     }
 686
 687     /**
 688      * If includeWhiteChars URI parameter is set to false then no white characters can be included in returned output.
 689      */
 690     @Test
 691     public void getDataWithUriIncludeWhiteCharsParameterTest() throws Exception {
 692         getDataWithUriIncludeWhiteCharsParameter("config");
 693         getDataWithUriIncludeWhiteCharsParameter("operational");
 694     }
 695
 696     private void getDataWithUriIncludeWhiteCharsParameter(final String target) throws Exception {
 697         mockReadConfigurationDataMethod();
 698         mockReadOperationalDataMethod();
 699         final String uri = "/" + target + "/ietf-interfaces:interfaces/interface/eth0";
 700         Response response = target(uri).queryParam("prettyPrint", "false").request("application/xml").get();
 701         final String xmlData = response.readEntity(String.class);
 702
 703         Pattern pattern = Pattern.compile(".*(>\\s+|\\s+<).*", Pattern.DOTALL);
 704         Matcher matcher = pattern.matcher(xmlData);
 705         // XML element can't surrounded with white character (e.g ">    " or
 706         // "    <")
 707         assertFalse(matcher.matches());
 708
 709         response = target(uri).queryParam("prettyPrint", "false").request("application/json").get();
 710         final String jsonData = response.readEntity(String.class);
 711         pattern = Pattern.compile(".*(\\}\\s+|\\s+\\{|\\]\\s+|\\s+\\[|\\s+:|:\\s+).*", Pattern.DOTALL);
 712         matcher = pattern.matcher(jsonData);
 713         // JSON element can't surrounded with white character (e.g "} ", " {",
 714         // "] ", " [", " :" or ": ")
 715         assertFalse(matcher.matches());
 716     }
 717
 718     /**
 719      * Tests behavior when invalid value of depth URI parameter.
 720      */
 721     @Test
 722     @Ignore
 723     public void getDataWithInvalidDepthParameterTest() {
 724         setControllerContext(schemaContextModules);
 725
 726         final MultivaluedMap<String, String> paramMap = new MultivaluedHashMap<>();
 727         paramMap.putSingle("depth", "1o");
 728         final UriInfo mockInfo = mock(UriInfo.class);
 729         when(mockInfo.getQueryParameters(false)).thenAnswer(invocation -> paramMap);
 730
 731         getDataWithInvalidDepthParameterTest(mockInfo);
 732
 733         paramMap.putSingle("depth", "0");
 734         getDataWithInvalidDepthParameterTest(mockInfo);
 735
 736         paramMap.putSingle("depth", "-1");
 737         getDataWithInvalidDepthParameterTest(mockInfo);
 738     }
 739
 740     @SuppressWarnings({"rawtypes", "unchecked"})
 741     private static void getDataWithInvalidDepthParameterTest(final UriInfo uriInfo) {
 742         try {
 743             final QName qNameDepth1Cont = QName.create("urn:nested:module", "2014-06-3", "depth1-cont");
 744             final YangInstanceIdentifier ii = YangInstanceIdentifier.builder().node(qNameDepth1Cont).build();
 745             final NormalizedNode value =
 746                     (Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(qNameDepth1Cont)).build());
 747             when(brokerFacade.readConfigurationData(eq(ii))).thenReturn(value);
 748             restconfImpl.readConfigurationData("nested-module:depth1-cont", uriInfo);
 749             fail("Expected RestconfDocumentedException");
 750         } catch (final RestconfDocumentedException e) {
 751             assertTrue("Unexpected error message: " + e.getErrors().get(0).getErrorMessage(), e.getErrors().get(0)
 752                     .getErrorMessage().contains("depth"));
 753         }
 754     }
 755
 756     @SuppressWarnings("unused")
 757     private void verifyXMLResponse(final Response response, final NodeData nodeData) {
 758         final Document doc = response.readEntity(Document.class);
 759         assertNotNull("Could not parse XML document", doc);
 760
 761         verifyContainerElement(doc.getDocumentElement(), nodeData);
 762     }
 763
 764     @SuppressWarnings("unchecked")
 765     private void verifyContainerElement(final Element element, final NodeData nodeData) {
 766
 767         assertEquals("Element local name", nodeData.key, element.getLocalName());
 768
 769         final NodeList childNodes = element.getChildNodes();
 770         if (nodeData.data == null) { // empty container
 771             assertTrue(
 772                     "Expected no child elements for \"" + element.getLocalName() + "\"", childNodes.getLength() == 0);
 773             return;
 774         }
 775
 776         final Map<String, NodeData> expChildMap = Maps.newHashMap();
 777         for (final NodeData expChild : (List<NodeData>) nodeData.data) {
 778             expChildMap.put(expChild.key.toString(), expChild);
 779         }
 780
 781         for (int i = 0; i < childNodes.getLength(); i++) {
 782             final org.w3c.dom.Node actualChild = childNodes.item(i);
 783             if (!(actualChild instanceof Element)) {
 784                 continue;
 785             }
 786
 787             final Element actualElement = (Element) actualChild;
 788             final NodeData expChild = expChildMap.remove(actualElement.getLocalName());
 789             assertNotNull(
 790                     "Unexpected child element for parent \"" + element.getLocalName() + "\": "
 791                             + actualElement.getLocalName(), expChild);
 792
 793             if ((expChild.data == null) || (expChild.data instanceof List)) {
 794                 verifyContainerElement(actualElement, expChild);
 795             } else {
 796                 assertEquals("Text content for element: " + actualElement.getLocalName(), expChild.data,
 797                         actualElement.getTextContent());
 798             }
 799         }
 800
 801         if (!expChildMap.isEmpty()) {
 802             fail("Missing elements for parent \"" + element.getLocalName() + "\": " + expChildMap.keySet());
 803         }
 804     }
 805
 806 }