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