X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frestconf%2Fimpl%2Ftest%2FRestGetOperationTest.java;h=539248a147cd4eea16dca9f4725cf26e9b185496;hb=c74d5c2399e500fe3e690edc8cee497b1cb6f867;hp=4198e20b838e15391c650f5ffd34afdcc5693840;hpb=04a788d2df5303c60cdbcff02254291f411566bd;p=controller.git diff --git a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestGetOperationTest.java b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestGetOperationTest.java index 4198e20b83..539248a147 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestGetOperationTest.java +++ b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestGetOperationTest.java @@ -7,14 +7,20 @@ */ package org.opendaylight.controller.sal.restconf.impl.test; -import static junit.framework.Assert.assertNotNull; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; import static org.mockito.Matchers.any; import static org.mockito.Matchers.eq; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; +import com.google.common.base.Optional; +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; import java.io.FileNotFoundException; import java.io.UnsupportedEncodingException; import java.net.URI; @@ -23,50 +29,81 @@ import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Date; +import java.util.HashSet; import java.util.List; +import java.util.Map; +import java.util.Set; import java.util.regex.Matcher; import java.util.regex.Pattern; - import javax.ws.rs.core.Application; import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.MultivaluedHashMap; +import javax.ws.rs.core.MultivaluedMap; import javax.ws.rs.core.Response; - +import javax.ws.rs.core.UriInfo; import org.glassfish.jersey.server.ResourceConfig; import org.glassfish.jersey.test.JerseyTest; import org.junit.BeforeClass; -import org.junit.Ignore; import org.junit.Test; -import org.opendaylight.controller.sal.core.api.mount.MountInstance; -import org.opendaylight.controller.sal.core.api.mount.MountService; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; +import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint; +import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService; import org.opendaylight.controller.sal.rest.impl.JsonToCompositeNodeProvider; +import org.opendaylight.controller.sal.rest.impl.RestconfDocumentedExceptionMapper; import org.opendaylight.controller.sal.rest.impl.StructuredDataToJsonProvider; import org.opendaylight.controller.sal.rest.impl.StructuredDataToXmlProvider; import org.opendaylight.controller.sal.rest.impl.XmlToCompositeNodeProvider; import org.opendaylight.controller.sal.restconf.impl.BrokerFacade; -import org.opendaylight.controller.sal.restconf.impl.CompositeNodeWrapper; import org.opendaylight.controller.sal.restconf.impl.ControllerContext; +import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException; import org.opendaylight.controller.sal.restconf.impl.RestconfImpl; -import org.opendaylight.controller.sal.restconf.impl.SimpleNodeWrapper; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.CompositeNode; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument; -import org.opendaylight.yangtools.yang.data.api.Node; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; +import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode; +import org.opendaylight.yangtools.yang.data.impl.schema.Builders; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder; +import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder; +import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; +import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; +import org.opendaylight.yangtools.yang.model.api.Module; +import org.opendaylight.yangtools.yang.model.api.RpcDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; public class RestGetOperationTest extends JerseyTest { + static class NodeData { + Object key; + Object data; // List for a CompositeNode, value Object for a SimpleNode + + NodeData(final Object key, final Object data) { + this.key = key; + this.data = data; + } + } + private static BrokerFacade brokerFacade; private static RestconfImpl restconfImpl; private static SchemaContext schemaContextYangsIetf; private static SchemaContext schemaContextTestModule; - private static CompositeNode answerFromGet; + private static NormalizedNode answerFromGet; private static SchemaContext schemaContextModules; private static SchemaContext schemaContextBehindMountPoint; + private static final String RESTCONF_NS = "urn:ietf:params:xml:ns:yang:ietf-restconf"; + @BeforeClass - public static void init() throws FileNotFoundException { + public static void init() throws FileNotFoundException, ParseException { schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs"); schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module"); ControllerContext controllerContext = ControllerContext.getInstance(); @@ -75,7 +112,7 @@ public class RestGetOperationTest extends JerseyTest { restconfImpl = RestconfImpl.getInstance(); restconfImpl.setBroker(brokerFacade); restconfImpl.setControllerContext(controllerContext); - answerFromGet = prepareCompositeNodeWithIetfInterfacesInterfacesData(); + answerFromGet = TestUtils.prepareNormalizedNodeWithIetfInterfacesInterfacesData(); schemaContextModules = TestUtils.loadSchemaContext("/modules"); schemaContextBehindMountPoint = TestUtils.loadSchemaContext("/modules/modules-behind-mount-point"); @@ -92,6 +129,7 @@ public class RestGetOperationTest extends JerseyTest { resourceConfig = resourceConfig.registerInstances(restconfImpl, StructuredDataToXmlProvider.INSTANCE, StructuredDataToJsonProvider.INSTANCE, XmlToCompositeNodeProvider.INSTANCE, JsonToCompositeNodeProvider.INSTANCE); + resourceConfig.registerClasses(RestconfDocumentedExceptionMapper.class); return resourceConfig; } @@ -125,14 +163,13 @@ public class RestGetOperationTest extends JerseyTest { * MountPoint test. URI represents mount point. */ @Test - public void getDataWithUrlMountPoint() throws UnsupportedEncodingException, URISyntaxException { - when( - brokerFacade.readConfigurationDataBehindMountPoint(any(MountInstance.class), - any(InstanceIdentifier.class))).thenReturn(prepareCnDataForMountPointTest()); - MountInstance mountInstance = mock(MountInstance.class); + public void getDataWithUrlMountPoint() throws UnsupportedEncodingException, URISyntaxException, ParseException { + when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class))).thenReturn( + prepareCnDataForMountPointTest(false)); + DOMMountPoint mountInstance = mock(DOMMountPoint.class); when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule); - MountService mockMountService = mock(MountService.class); - when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + DOMMountPointService mockMountService = mock(DOMMountPointService.class); + when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance)); ControllerContext.getInstance().setMountService(mockMountService); @@ -145,28 +182,25 @@ public class RestGetOperationTest extends JerseyTest { /** * MountPoint test. URI represents mount point. - * - * Slashes in URI behind mount point. lst1 element with key - * GigabitEthernet0%2F0%2F0%2F0 (GigabitEthernet0/0/0/0) is requested via - * GET HTTP operation. It is tested whether %2F character is replaced with - * simple / in InstanceIdentifier parameter in method - * {@link BrokerFacade#readConfigurationDataBehindMountPoint(MountInstance, InstanceIdentifier)} - * which is called in method {@link RestconfImpl#readConfigurationData} - * - * + * + * Slashes in URI behind mount point. lst1 element with key GigabitEthernet0%2F0%2F0%2F0 (GigabitEthernet0/0/0/0) is + * requested via GET HTTP operation. It is tested whether %2F character is replaced with simple / in + * InstanceIdentifier parameter in method + * {@link BrokerFacade#readConfigurationDataBehindMountPoint(MountInstance, YangInstanceIdentifier)} which is called in + * method {@link RestconfImpl#readConfigurationData} + * * @throws ParseException */ @Test public void getDataWithSlashesBehindMountPoint() throws UnsupportedEncodingException, URISyntaxException, ParseException { - InstanceIdentifier awaitedInstanceIdentifier = prepareInstanceIdentifierForList(); - when( - brokerFacade.readConfigurationDataBehindMountPoint(any(MountInstance.class), - eq(awaitedInstanceIdentifier))).thenReturn(prepareCnDataForMountPointTest()); - MountInstance mountInstance = mock(MountInstance.class); + YangInstanceIdentifier awaitedInstanceIdentifier = prepareInstanceIdentifierForList(); + when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), eq(awaitedInstanceIdentifier))).thenReturn( + prepareCnDataForSlashesBehindMountPointTest()); + DOMMountPoint mountInstance = mock(DOMMountPoint.class); when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule); - MountService mockMountService = mock(MountService.class); - when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + DOMMountPointService mockMountService = mock(DOMMountPointService.class); + when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance)); ControllerContext.getInstance().setMountService(mockMountService); @@ -174,7 +208,7 @@ public class RestGetOperationTest extends JerseyTest { assertEquals(200, get(uri, MediaType.APPLICATION_XML)); } - private InstanceIdentifier prepareInstanceIdentifierForList() throws URISyntaxException, ParseException { + private YangInstanceIdentifier prepareInstanceIdentifierForList() throws URISyntaxException, ParseException { List parameters = new ArrayList<>(); Date revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-01-09"); @@ -183,25 +217,26 @@ public class RestGetOperationTest extends JerseyTest { QName qNameList = QName.create(uri, revision, "lst1"); QName qNameKeyList = QName.create(uri, revision, "lf11"); - parameters.add(new InstanceIdentifier.NodeIdentifier(qNameCont)); - parameters.add(new InstanceIdentifier.NodeIdentifierWithPredicates(qNameList, qNameKeyList, + parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameCont)); + parameters.add(new YangInstanceIdentifier.NodeIdentifier(qNameList)); + parameters.add(new YangInstanceIdentifier.NodeIdentifierWithPredicates(qNameList, qNameKeyList, "GigabitEthernet0/0/0/0")); - return new InstanceIdentifier(parameters); + return YangInstanceIdentifier.create(parameters); } @Test - public void getDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException { - when( - brokerFacade.readConfigurationDataBehindMountPoint(any(MountInstance.class), - any(InstanceIdentifier.class))).thenReturn(prepareCnDataForMountPointTest()); - MountInstance mountInstance = mock(MountInstance.class); + public void getDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException, + ParseException { + when(brokerFacade.readConfigurationData(any(DOMMountPoint.class), any(YangInstanceIdentifier.class))).thenReturn( + prepareCnDataForMountPointTest(true)); + DOMMountPoint mountInstance = mock(DOMMountPoint.class); when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule); - MountService mockMountService = mock(MountService.class); - when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + DOMMountPointService mockMountService = mock(DOMMountPointService.class); + when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance)); ControllerContext.getInstance().setMountService(mockMountService); - String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/"; + String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont"; assertEquals(200, get(uri, MediaType.APPLICATION_XML)); } @@ -216,7 +251,7 @@ public class RestGetOperationTest extends JerseyTest { validateModulesResponseJson(response); response = target(uri).request("application/yang.api+xml").get(); - validateModulesResponseXml(response); + validateModulesResponseXml(response,schemaContextModules); } // /streams/ @@ -232,9 +267,12 @@ public class RestGetOperationTest extends JerseyTest { assertTrue(responseBody.contains("streams")); response = target(uri).request("application/yang.api+xml").get(); - responseBody = response.readEntity(String.class); - assertNotNull(responseBody); - assertTrue(responseBody.contains(" foundOperations = new HashSet<>(); + + NodeList operationsList = operationsElem.getChildNodes(); + for(int i = 0;i < operationsList.getLength();i++) { + org.w3c.dom.Node operation = operationsList.item(i); + + String namespace = operation.getNamespaceURI(); + String name = operation.getLocalName(); + QName opQName = QName.create(URI.create(namespace), null, name); + foundOperations.add(opQName); + } + + for(RpcDefinition schemaOp : schemaContext.getOperations()) { + assertTrue(foundOperations.contains(schemaOp.getQName().withoutRevision())); + } + + } + // /operations/pathToMountPoint/yang-ext:mount @Test public void getOperationsBehindMountPointTest() throws FileNotFoundException, UnsupportedEncodingException { ControllerContext controllerContext = ControllerContext.getInstance(); controllerContext.setGlobalSchema(schemaContextModules); - MountInstance mountInstance = mock(MountInstance.class); + DOMMountPoint mountInstance = mock(DOMMountPoint.class); when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint); - MountService mockMountService = mock(MountService.class); - when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + DOMMountPointService mockMountService = mock(DOMMountPointService.class); + when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance)); controllerContext.setMountService(mockMountService); @@ -312,15 +372,13 @@ public class RestGetOperationTest extends JerseyTest { Response response = target(uri).request("application/yang.api+xml").get(); assertEquals(200, response.getStatus()); - String responseBody = response.readEntity(String.class); - assertTrue("Xml response for /operations/mount_point rpc-behind-module1 is incorrect", - validateOperationsResponseXml(responseBody, "rpc-behind-module1", "module:1:behind:mount:point").find()); - assertTrue("Xml response for /operations/mount_point rpc-behind-module2 is incorrect", - validateOperationsResponseXml(responseBody, "rpc-behind-module2", "module:2:behind:mount:point").find()); + + Document responseDoc = response.readEntity(Document.class); + validateOperationsResponseXml(responseDoc, schemaContextBehindMountPoint); response = target(uri).request("application/yang.api+json").get(); assertEquals(200, response.getStatus()); - responseBody = response.readEntity(String.class); + String responseBody = response.readEntity(String.class); assertTrue("Json response for /operations/mount_point rpc-behind-module1 is incorrect", validateOperationsResponseJson(responseBody, "rpc-behind-module1", "module1-behind-mount-point").find()); assertTrue("Json response for /operations/mount_point rpc-behind-module2 is incorrect", @@ -328,7 +386,7 @@ public class RestGetOperationTest extends JerseyTest { } - private Matcher validateOperationsResponseJson(String searchIn, String rpcName, String moduleName) { + private Matcher validateOperationsResponseJson(final String searchIn, final String rpcName, final String moduleName) { StringBuilder regex = new StringBuilder(); regex.append("^"); @@ -362,7 +420,7 @@ public class RestGetOperationTest extends JerseyTest { } - private Matcher validateOperationsResponseXml(String searchIn, String rpcName, String namespace) { + private Matcher validateOperationsResponseXml(final String searchIn, final String rpcName, final String namespace) { StringBuilder regex = new StringBuilder(); regex.append("^"); @@ -392,10 +450,10 @@ public class RestGetOperationTest extends JerseyTest { ControllerContext controllerContext = ControllerContext.getInstance(); controllerContext.setGlobalSchema(schemaContextModules); - MountInstance mountInstance = mock(MountInstance.class); + DOMMountPoint mountInstance = mock(DOMMountPoint.class); when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint); - MountService mockMountService = mock(MountService.class); - when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + DOMMountPointService mockMountService = mock(DOMMountPointService.class); + when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance)); controllerContext.setMountService(mockMountService); @@ -416,15 +474,7 @@ public class RestGetOperationTest extends JerseyTest { response = target(uri).request("application/yang.api+xml").get(); assertEquals(200, response.getStatus()); - responseBody = response.readEntity(String.class); - assertTrue( - "module1-behind-mount-point in json wasn't found", - prepareXmlRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point", responseBody) - .find()); - assertTrue( - "module2-behind-mount-point in json wasn't found", - prepareXmlRegex("module2-behind-mount-point", "2014-02-04", "module:2:behind:mount:point", responseBody) - .find()); + validateModulesResponseXml(response, schemaContextBehindMountPoint); } @@ -434,10 +484,10 @@ public class RestGetOperationTest extends JerseyTest { ControllerContext controllerContext = ControllerContext.getInstance(); controllerContext.setGlobalSchema(schemaContextModules); - MountInstance mountInstance = mock(MountInstance.class); + DOMMountPoint mountInstance = mock(DOMMountPoint.class); when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint); - MountService mockMountService = mock(MountService.class); - when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + DOMMountPointService mockMountService = mock(DOMMountPointService.class); + when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance)); controllerContext.setMountService(mockMountService); @@ -456,29 +506,86 @@ public class RestGetOperationTest extends JerseyTest { response = target(uri).request("application/yang.api+xml").get(); assertEquals(200, response.getStatus()); - responseBody = response.readEntity(String.class); - assertTrue( - "module1-behind-mount-point in json wasn't found", - prepareXmlRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point", responseBody) - .find()); - split = responseBody.split(" 0); + + HashSet foundModules = new HashSet<>(); + + for(int i=0;i < moduleNodes.getLength();i++) { + org.w3c.dom.Node module = moduleNodes.item(i); + + QName name = assertedModuleXmlToModuleQName(module); + foundModules.add(name); + } + + assertAllModules(foundModules,schemaContext); } - private void validateModulesResponseJson(Response response) { + private void assertAllModules(final Set foundModules, final SchemaContext schemaContext) { + for(Module module : schemaContext.getModules()) { + QName current = QName.create(module.getQNameModule(),module.getName()); + assertTrue("Module not found in response.",foundModules.contains(current)); + } + + } + + private QName assertedModuleXmlToModuleQName(final org.w3c.dom.Node module) { + assertEquals("module", module.getLocalName()); + assertEquals(RESTCONF_NS, module.getNamespaceURI()); + String revision = null; + String namespace = null; + String name = null; + + + NodeList childNodes = module.getChildNodes(); + + for(int i =0;i < childNodes.getLength(); i++) { + org.w3c.dom.Node child = childNodes.item(i); + assertEquals(RESTCONF_NS, child.getNamespaceURI()); + + switch(child.getLocalName()) { + case "name": + assertNull("Name element appeared multiple times",name); + name = child.getTextContent().trim(); + break; + case "revision": + assertNull("Revision element appeared multiple times",revision); + revision = child.getTextContent().trim(); + break; + + case "namespace": + assertNull("Namespace element appeared multiple times",namespace); + namespace = child.getTextContent().trim(); + break; + } + } + + assertNotNull("Revision was not part of xml",revision); + assertNotNull("Module namespace was not part of xml",namespace); + assertNotNull("Module identiffier was not part of xml",name); + + + // TODO Auto-generated method stub + + return QName.create(namespace,revision,name); + } + + private void validateModulesResponseJson(final Response response) { assertEquals(200, response.getStatus()); String responseBody = response.readEntity(String.class); @@ -490,7 +597,8 @@ public class RestGetOperationTest extends JerseyTest { .find()); } - private Matcher prepareJsonRegex(String module, String revision, String namespace, String searchIn) { + private Matcher prepareJsonRegex(final String module, final String revision, final String namespace, + final String searchIn) { StringBuilder regex = new StringBuilder(); regex.append("^"); @@ -516,75 +624,412 @@ public class RestGetOperationTest extends JerseyTest { } - private Matcher prepareXmlRegex(String module, String revision, String namespace, String searchIn) { - StringBuilder regex = new StringBuilder(); - regex.append("^"); - - regex.append(".*"); - regex.append(".*"); - regex.append(".*" + module); - regex.append(".*<\\/name>"); + private void prepareMockForModulesTest(final ControllerContext mockedControllerContext) + throws FileNotFoundException { + SchemaContext schemaContext = TestUtils.loadSchemaContext("/modules"); + mockedControllerContext.setGlobalSchema(schemaContext); + // when(mockedControllerContext.getGlobalSchema()).thenReturn(schemaContext); + } - regex.append(".*"); - regex.append(".*" + revision); - regex.append(".*<\\/revision>"); + private int get(final String uri, final String mediaType) { + return target(uri).request(mediaType).get().getStatus(); + } - regex.append(".*"); - regex.append(".*" + namespace); - regex.append(".*<\\/namespace>"); + /** + container cont { + container cont1 { + leaf lf11 { + type string; + } + */ + private NormalizedNode prepareCnDataForMountPointTest(boolean wrapToCont) throws URISyntaxException, ParseException { + String testModuleDate = "2014-01-09"; + ContainerNode contChild = Builders + .containerBuilder() + .withNodeIdentifier(TestUtils.getNodeIdentifier("cont1", "test:module", testModuleDate)) + .withChild( + Builders.leafBuilder() + .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", testModuleDate)) + .withValue("lf11 value").build()).build(); + + if (wrapToCont) { + return Builders.containerBuilder() + .withNodeIdentifier(TestUtils.getNodeIdentifier("cont", "test:module", testModuleDate)) + .withChild(contChild).build(); + } + return contChild; - regex.append(".*<\\/module.*>"); + } - regex.append(".*"); - regex.append("$"); + private void mockReadOperationalDataMethod() { + when(brokerFacade.readOperationalData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet); + } - Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL); - return ptrn.matcher(searchIn); + private void mockReadConfigurationDataMethod() { + when(brokerFacade.readConfigurationData(any(YangInstanceIdentifier.class))).thenReturn(answerFromGet); } - private void prepareMockForModulesTest(ControllerContext mockedControllerContext) throws FileNotFoundException { - SchemaContext schemaContext = TestUtils.loadSchemaContext("/modules"); - mockedControllerContext.setGlobalSchema(schemaContext); - // when(mockedControllerContext.getGlobalSchema()).thenReturn(schemaContext); + private NormalizedNode prepareCnDataForSlashesBehindMountPointTest() throws ParseException { + return ImmutableMapEntryNodeBuilder + .create() + .withNodeIdentifier( + TestUtils.getNodeIdentifierPredicate("lst1", "test:module", "2014-01-09", "lf11", + "GigabitEthernet0/0/0/0")) + .withChild( + ImmutableLeafNodeBuilder.create() + .withNodeIdentifier(TestUtils.getNodeIdentifier("lf11", "test:module", "2014-01-09")) + .withValue("GigabitEthernet0/0/0/0").build()).build(); + } - private int get(String uri, String mediaType) { - return target(uri).request(mediaType).get().getStatus(); + /** + * If includeWhiteChars URI parameter is set to false then no white characters can be included in returned output + * + * @throws UnsupportedEncodingException + */ + @Test + public void getDataWithUriIncludeWhiteCharsParameterTest() throws UnsupportedEncodingException { + getDataWithUriIncludeWhiteCharsParameter("config"); + getDataWithUriIncludeWhiteCharsParameter("operational"); } - private CompositeNode prepareCnDataForMountPointTest() throws URISyntaxException { - CompositeNodeWrapper cont1 = new CompositeNodeWrapper(new URI("test:module"), "cont1"); - SimpleNodeWrapper lf11 = new SimpleNodeWrapper(new URI("test:module"), "lf11", "lf11 value"); - cont1.addValue(lf11); - return cont1.unwrap(); + private void getDataWithUriIncludeWhiteCharsParameter(final String target) throws UnsupportedEncodingException { + mockReadConfigurationDataMethod(); + mockReadOperationalDataMethod(); + String uri = "/" + target + "/ietf-interfaces:interfaces/interface/eth0"; + Response response = target(uri).queryParam("prettyPrint", "false").request("application/xml").get(); + String xmlData = response.readEntity(String.class); + + Pattern pattern = Pattern.compile(".*(>\\s+|\\s+<).*", Pattern.DOTALL); + Matcher matcher = pattern.matcher(xmlData); + // XML element can't surrounded with white character (e.g "> " or + // " <") + assertFalse(matcher.matches()); + + response = target(uri).queryParam("prettyPrint", "false").request("application/json").get(); + String jsonData = response.readEntity(String.class); + pattern = Pattern.compile(".*(\\}\\s+|\\s+\\{|\\]\\s+|\\s+\\[|\\s+:|:\\s+).*", Pattern.DOTALL); + matcher = pattern.matcher(jsonData); + // JSON element can't surrounded with white character (e.g "} ", " {", + // "] ", " [", " :" or ": ") + assertFalse(matcher.matches()); } - private void mockReadOperationalDataMethod() { - when(brokerFacade.readOperationalData(any(InstanceIdentifier.class))).thenReturn(answerFromGet); + @Test + public void getDataWithUriDepthParameterTest() throws UnsupportedEncodingException { + + ControllerContext.getInstance().setGlobalSchema(schemaContextModules); + + CompositeNode depth1Cont = toCompositeNode(toCompositeNodeData( + toNestedQName("depth1-cont"), + toCompositeNodeData( + toNestedQName("depth2-cont1"), + toCompositeNodeData( + toNestedQName("depth3-cont1"), + toCompositeNodeData(toNestedQName("depth4-cont1"), + toSimpleNodeData(toNestedQName("depth5-leaf1"), "depth5-leaf1-value")), + toSimpleNodeData(toNestedQName("depth4-leaf1"), "depth4-leaf1-value")), + toSimpleNodeData(toNestedQName("depth3-leaf1"), "depth3-leaf1-value")), + toCompositeNodeData( + toNestedQName("depth2-cont2"), + toCompositeNodeData( + toNestedQName("depth3-cont2"), + toCompositeNodeData(toNestedQName("depth4-cont2"), + toSimpleNodeData(toNestedQName("depth5-leaf2"), "depth5-leaf2-value")), + toSimpleNodeData(toNestedQName("depth4-leaf2"), "depth4-leaf2-value")), + toSimpleNodeData(toNestedQName("depth3-leaf2"), "depth3-leaf2-value")), + toSimpleNodeData(toNestedQName("depth2-leaf1"), "depth2-leaf1-value"))); + + Module module = TestUtils.findModule(schemaContextModules.getModules(), "nested-module"); + assertNotNull(module); + + DataSchemaNode dataSchemaNode = TestUtils.resolveDataSchemaNode("depth1-cont", module); + assertNotNull(dataSchemaNode); + + when(brokerFacade.readConfigurationData(any(YangInstanceIdentifier.class))).thenReturn( + TestUtils.compositeNodeToDatastoreNormalizedNode(depth1Cont, dataSchemaNode)); + + // Test config with depth 1 + + Response response = target("/config/nested-module:depth1-cont").queryParam("depth", "1") + .request("application/xml").get(); + + verifyXMLResponse(response, expectEmptyContainer("depth1-cont")); + + // Test config with depth 2 + + response = target("/config/nested-module:depth1-cont").queryParam("depth", "2").request("application/xml") + .get(); + + // String + // xml="depth2-leaf1-value"; + // Response mr=mock(Response.class); + // when(mr.getEntity()).thenReturn( new + // java.io.StringBufferInputStream(xml) ); + + verifyXMLResponse( + response, + expectContainer("depth1-cont", expectEmptyContainer("depth2-cont1"), + expectEmptyContainer("depth2-cont2"), expectLeaf("depth2-leaf1", "depth2-leaf1-value"))); + + // Test config with depth 3 + + response = target("/config/nested-module:depth1-cont").queryParam("depth", "3").request("application/xml") + .get(); + + verifyXMLResponse( + response, + expectContainer( + "depth1-cont", + expectContainer("depth2-cont1", expectEmptyContainer("depth3-cont1"), + expectLeaf("depth3-leaf1", "depth3-leaf1-value")), + expectContainer("depth2-cont2", expectEmptyContainer("depth3-cont2"), + expectLeaf("depth3-leaf2", "depth3-leaf2-value")), + expectLeaf("depth2-leaf1", "depth2-leaf1-value"))); + + // Test config with depth 4 + + response = target("/config/nested-module:depth1-cont").queryParam("depth", "4").request("application/xml") + .get(); + + verifyXMLResponse( + response, + expectContainer( + "depth1-cont", + expectContainer( + "depth2-cont1", + expectContainer("depth3-cont1", expectEmptyContainer("depth4-cont1"), + expectLeaf("depth4-leaf1", "depth4-leaf1-value")), + expectLeaf("depth3-leaf1", "depth3-leaf1-value")), + expectContainer( + "depth2-cont2", + expectContainer("depth3-cont2", expectEmptyContainer("depth4-cont2"), + expectLeaf("depth4-leaf2", "depth4-leaf2-value")), + expectLeaf("depth3-leaf2", "depth3-leaf2-value")), + expectLeaf("depth2-leaf1", "depth2-leaf1-value"))); + + // Test config with depth 5 + + response = target("/config/nested-module:depth1-cont").queryParam("depth", "5").request("application/xml") + .get(); + + verifyXMLResponse( + response, + expectContainer( + "depth1-cont", + expectContainer( + "depth2-cont1", + expectContainer( + "depth3-cont1", + expectContainer("depth4-cont1", + expectLeaf("depth5-leaf1", "depth5-leaf1-value")), + expectLeaf("depth4-leaf1", "depth4-leaf1-value")), + expectLeaf("depth3-leaf1", "depth3-leaf1-value")), + expectContainer( + "depth2-cont2", + expectContainer( + "depth3-cont2", + expectContainer("depth4-cont2", + expectLeaf("depth5-leaf2", "depth5-leaf2-value")), + expectLeaf("depth4-leaf2", "depth4-leaf2-value")), + expectLeaf("depth3-leaf2", "depth3-leaf2-value")), + expectLeaf("depth2-leaf1", "depth2-leaf1-value"))); + + // Test config with depth unbounded + + response = target("/config/nested-module:depth1-cont").queryParam("depth", "unbounded") + .request("application/xml").get(); + + verifyXMLResponse( + response, + expectContainer( + "depth1-cont", + expectContainer( + "depth2-cont1", + expectContainer( + "depth3-cont1", + expectContainer("depth4-cont1", + expectLeaf("depth5-leaf1", "depth5-leaf1-value")), + expectLeaf("depth4-leaf1", "depth4-leaf1-value")), + expectLeaf("depth3-leaf1", "depth3-leaf1-value")), + expectContainer( + "depth2-cont2", + expectContainer( + "depth3-cont2", + expectContainer("depth4-cont2", + expectLeaf("depth5-leaf2", "depth5-leaf2-value")), + expectLeaf("depth4-leaf2", "depth4-leaf2-value")), + expectLeaf("depth3-leaf2", "depth3-leaf2-value")), + expectLeaf("depth2-leaf1", "depth2-leaf1-value"))); + + // Test operational + + CompositeNode depth2Cont1 = toCompositeNode(toCompositeNodeData( + toNestedQName("depth2-cont1"), + toCompositeNodeData( + toNestedQName("depth3-cont1"), + toCompositeNodeData(toNestedQName("depth4-cont1"), + toSimpleNodeData(toNestedQName("depth5-leaf1"), "depth5-leaf1-value")), + toSimpleNodeData(toNestedQName("depth4-leaf1"), "depth4-leaf1-value")), + toSimpleNodeData(toNestedQName("depth3-leaf1"), "depth3-leaf1-value"))); + + assertTrue(dataSchemaNode instanceof DataNodeContainer); + DataSchemaNode depth2cont1Schema = null; + for (DataSchemaNode childNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) { + if (childNode.getQName().getLocalName().equals("depth2-cont1")) { + depth2cont1Schema = childNode; + break; + } + } + assertNotNull(depth2Cont1); + + when(brokerFacade.readOperationalData(any(YangInstanceIdentifier.class))).thenReturn( + TestUtils.compositeNodeToDatastoreNormalizedNode(depth2Cont1, depth2cont1Schema)); + + response = target("/operational/nested-module:depth1-cont/depth2-cont1").queryParam("depth", "3") + .request("application/xml").get(); + + verifyXMLResponse( + response, + expectContainer( + "depth2-cont1", + expectContainer("depth3-cont1", expectEmptyContainer("depth4-cont1"), + expectLeaf("depth4-leaf1", "depth4-leaf1-value")), + expectLeaf("depth3-leaf1", "depth3-leaf1-value"))); } - private void mockReadConfigurationDataMethod() { - when(brokerFacade.readConfigurationData(any(InstanceIdentifier.class))).thenReturn(answerFromGet); + /** + * Tests behavior when invalid value of depth URI parameter + */ + @Test + public void getDataWithInvalidDepthParameterTest() { + + ControllerContext.getInstance().setGlobalSchema(schemaContextModules); + + final MultivaluedMap paramMap = new MultivaluedHashMap<>(); + paramMap.putSingle("depth", "1o"); + UriInfo mockInfo = mock(UriInfo.class); + when(mockInfo.getQueryParameters(false)).thenAnswer(new Answer>() { + @Override + public MultivaluedMap answer(InvocationOnMock invocation) { + return paramMap; + } + }); + + getDataWithInvalidDepthParameterTest(mockInfo); + + paramMap.putSingle("depth", "0"); + getDataWithInvalidDepthParameterTest(mockInfo); + + paramMap.putSingle("depth", "-1"); + getDataWithInvalidDepthParameterTest(mockInfo); } - private static CompositeNode prepareCompositeNodeWithIetfInterfacesInterfacesData() { - CompositeNode intface; + private void getDataWithInvalidDepthParameterTest(final UriInfo uriInfo) { try { - intface = new CompositeNodeWrapper(new URI("interface"), "interface"); - List> childs = new ArrayList<>(); - - childs.add(new SimpleNodeWrapper(new URI("name"), "name", "eth0")); - childs.add(new SimpleNodeWrapper(new URI("type"), "type", "ethernetCsmacd")); - childs.add(new SimpleNodeWrapper(new URI("enabled"), "enabled", Boolean.FALSE)); - childs.add(new SimpleNodeWrapper(new URI("description"), "description", "some interface")); - intface.setValue(childs); - return intface; - } catch (URISyntaxException e) { + QName qNameDepth1Cont = QName.create("urn:nested:module", "2014-06-3", "depth1-cont"); + YangInstanceIdentifier ii = YangInstanceIdentifier.builder().node(qNameDepth1Cont).build(); + NormalizedNode value = (NormalizedNode)(Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(qNameDepth1Cont)).build()); + when(brokerFacade.readConfigurationData(eq(ii))).thenReturn(value); + restconfImpl.readConfigurationData("nested-module:depth1-cont", uriInfo); + fail("Expected RestconfDocumentedException"); + } catch (RestconfDocumentedException e) { + assertTrue("Unexpected error message: " + e.getErrors().get(0).getErrorMessage(), e.getErrors().get(0) + .getErrorMessage().contains("depth")); + } + } + + private void verifyXMLResponse(final Response response, final NodeData nodeData) { + Document doc = response.readEntity(Document.class); +// Document doc = TestUtils.loadDocumentFrom((InputStream) response.getEntity()); +// System.out.println(); + assertNotNull("Could not parse XML document", doc); + + // System.out.println(TestUtils.getDocumentInPrintableForm( doc )); + + verifyContainerElement(doc.getDocumentElement(), nodeData); + } + + @SuppressWarnings("unchecked") + private void verifyContainerElement(final Element element, final NodeData nodeData) { + + assertEquals("Element local name", nodeData.key, element.getLocalName()); + + NodeList childNodes = element.getChildNodes(); + if (nodeData.data == null) { // empty container + assertTrue("Expected no child elements for \"" + element.getLocalName() + "\"", childNodes.getLength() == 0); + return; + } + + Map expChildMap = Maps.newHashMap(); + for (NodeData expChild : (List) nodeData.data) { + expChildMap.put(expChild.key.toString(), expChild); + } + + for (int i = 0; i < childNodes.getLength(); i++) { + org.w3c.dom.Node actualChild = childNodes.item(i); + if (!(actualChild instanceof Element)) { + continue; + } + + Element actualElement = (Element) actualChild; + NodeData expChild = expChildMap.remove(actualElement.getLocalName()); + assertNotNull( + "Unexpected child element for parent \"" + element.getLocalName() + "\": " + + actualElement.getLocalName(), expChild); + + if (expChild.data == null || expChild.data instanceof List) { + verifyContainerElement(actualElement, expChild); + } else { + assertEquals("Text content for element: " + actualElement.getLocalName(), expChild.data, + actualElement.getTextContent()); + } } - return null; + if (!expChildMap.isEmpty()) { + fail("Missing elements for parent \"" + element.getLocalName() + "\": " + expChildMap.keySet()); + } + } + + private NodeData expectContainer(final String name, final NodeData... childData) { + return new NodeData(name, Lists.newArrayList(childData)); + } + + private NodeData expectEmptyContainer(final String name) { + return new NodeData(name, null); + } + + private NodeData expectLeaf(final String name, final Object value) { + return new NodeData(name, value); + } + + private QName toNestedQName(final String localName) { + return QName.create("urn:nested:module", "2014-06-3", localName); + } + + @SuppressWarnings("unchecked") + private CompositeNode toCompositeNode(final NodeData nodeData) { + CompositeNodeBuilder builder = ImmutableCompositeNode.builder(); + builder.setQName((QName) nodeData.key); + + for (NodeData child : (List) nodeData.data) { + if (child.data instanceof List) { + builder.add(toCompositeNode(child)); + } else { + builder.addLeaf((QName) child.key, child.data); + } + } + + return builder.toInstance(); + } + + private NodeData toCompositeNodeData(final QName key, final NodeData... childData) { + return new NodeData(key, Lists.newArrayList(childData)); + } + + private NodeData toSimpleNodeData(final QName key, final Object value) { + return new NodeData(key, value); } }