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