X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frestconf%2Fimpl%2Ftest%2FRestGetOperationTest.java;h=41a1c3827d21973180e01b7fd3cb11e2e73f993c;hp=ebc8a09f151adccaf9916c5d8a0062c9a2eef7bb;hb=92f1fd15e99ce5b9e52612c0b52f70cd661b99cc;hpb=cbdf09d099f297db7712c3dd4637475c88f92113 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 ebc8a09f15..41a1c3827d 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 @@ -1,52 +1,97 @@ +/* + * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ package org.opendaylight.controller.sal.restconf.impl.test; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +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 static org.opendaylight.controller.sal.restconf.impl.test.RestOperationUtils.XML; -import static org.opendaylight.controller.sal.restconf.impl.test.RestOperationUtils.createUri; import java.io.FileNotFoundException; +import java.io.InputStream; import java.io.UnsupportedEncodingException; import java.net.URI; import java.net.URISyntaxException; +import java.text.ParseException; +import java.text.SimpleDateFormat; import java.util.ArrayList; +import java.util.Date; import java.util.List; +import java.util.Map; +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.Test; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; import org.opendaylight.controller.sal.core.api.mount.MountInstance; import org.opendaylight.controller.sal.core.api.mount.MountService; -import org.opendaylight.controller.sal.rest.api.Draft02; 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.impl.ImmutableCompositeNode; +import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder; import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; + +import com.google.common.collect.Lists; +import com.google.common.collect.Maps; 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 SchemaContext schemaContextModules; + private static SchemaContext schemaContextBehindMountPoint; + @BeforeClass public static void init() throws FileNotFoundException { schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs"); @@ -58,50 +103,36 @@ public class RestGetOperationTest extends JerseyTest { restconfImpl.setBroker(brokerFacade); restconfImpl.setControllerContext(controllerContext); answerFromGet = prepareCompositeNodeWithIetfInterfacesInterfacesData(); + + schemaContextModules = TestUtils.loadSchemaContext("/modules"); + schemaContextBehindMountPoint = TestUtils.loadSchemaContext("/modules/modules-behind-mount-point"); } @Override protected Application configure() { /* enable/disable Jersey logs to console */ -// enable(TestProperties.LOG_TRAFFIC); -// enable(TestProperties.DUMP_ENTITY); -// enable(TestProperties.RECORD_LOG_LEVEL); -// set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue()); + // enable(TestProperties.LOG_TRAFFIC); + // enable(TestProperties.DUMP_ENTITY); + // enable(TestProperties.RECORD_LOG_LEVEL); + // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue()); ResourceConfig resourceConfig = new ResourceConfig(); resourceConfig = resourceConfig.registerInstances(restconfImpl, StructuredDataToXmlProvider.INSTANCE, StructuredDataToJsonProvider.INSTANCE, XmlToCompositeNodeProvider.INSTANCE, JsonToCompositeNodeProvider.INSTANCE); + resourceConfig.registerClasses( RestconfDocumentedExceptionMapper.class ); return resourceConfig; } - /** - * Tests of status codes for "/datastore/{identifier}". - */ - @Test - public void getDatastoreStatusCodes() throws FileNotFoundException, UnsupportedEncodingException { - mockReadOperationalDataMethod(); - String uri = createUri("/datastore/", "ietf-interfaces:interfaces/interface/eth0"); - assertEquals(200, get(uri, MediaType.APPLICATION_XML)); - - uri = createUri("/datastore/", "wrong-module:interfaces/interface/eth0"); - assertEquals(400, get(uri, MediaType.APPLICATION_XML)); - - // Test of request for not existing data. Returning status code 404 - uri = createUri("/datastore/", "ietf-interfaces:interfaces/interface/eth0"); - when(brokerFacade.readOperationalData(any(InstanceIdentifier.class))).thenReturn(null); - assertEquals(404, get(uri, MediaType.APPLICATION_XML)); - } - /** * Tests of status codes for "/operational/{identifier}". */ @Test public void getOperationalStatusCodes() throws UnsupportedEncodingException { mockReadOperationalDataMethod(); - String uri = createUri("/operational/", "ietf-interfaces:interfaces/interface/eth0"); + String uri = "/operational/ietf-interfaces:interfaces/interface/eth0"; assertEquals(200, get(uri, MediaType.APPLICATION_XML)); - - uri = createUri("/operational/", "wrong-module:interfaces/interface/eth0"); + + uri = "/operational/wrong-module:interfaces/interface/eth0"; assertEquals(400, get(uri, MediaType.APPLICATION_XML)); } @@ -111,10 +142,10 @@ public class RestGetOperationTest extends JerseyTest { @Test public void getConfigStatusCodes() throws UnsupportedEncodingException { mockReadConfigurationDataMethod(); - String uri = createUri("/config/", "ietf-interfaces:interfaces/interface/eth0"); + String uri = "/config/ietf-interfaces:interfaces/interface/eth0"; assertEquals(200, get(uri, MediaType.APPLICATION_XML)); - - uri = createUri("/config/", "wrong-module:interfaces/interface/eth0"); + + uri = "/config/wrong-module:interfaces/interface/eth0"; assertEquals(400, get(uri, MediaType.APPLICATION_XML)); } @@ -123,7 +154,73 @@ public class RestGetOperationTest extends JerseyTest { */ @Test public void getDataWithUrlMountPoint() throws UnsupportedEncodingException, URISyntaxException { - when(brokerFacade.readConfigurationDataBehindMountPoint(any(MountInstance.class), + when( + brokerFacade.readConfigurationDataBehindMountPoint(any(MountInstance.class), + any(InstanceIdentifier.class))).thenReturn(prepareCnDataForMountPointTest()); + MountInstance mountInstance = mock(MountInstance.class); + when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule); + MountService mockMountService = mock(MountService.class); + when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + + ControllerContext.getInstance().setMountService(mockMountService); + + String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/cont1"; + assertEquals(200, get(uri, MediaType.APPLICATION_XML)); + + uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont/cont1"; + assertEquals(200, get(uri, MediaType.APPLICATION_XML)); + } + + /** + * 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} + * + * + * @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); + when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule); + MountService mockMountService = mock(MountService.class); + when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + + ControllerContext.getInstance().setMountService(mockMountService); + + String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/lst1/GigabitEthernet0%2F0%2F0%2F0"; + assertEquals(200, get(uri, MediaType.APPLICATION_XML)); + } + + private InstanceIdentifier prepareInstanceIdentifierForList() throws URISyntaxException, ParseException { + List parameters = new ArrayList<>(); + + Date revision = new SimpleDateFormat("yyyy-MM-dd").parse("2014-01-09"); + URI uri = new URI("test:module"); + QName qNameCont = QName.create(uri, revision, "cont"); + 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, + "GigabitEthernet0/0/0/0")); + return InstanceIdentifier.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); when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule); @@ -132,18 +229,356 @@ public class RestGetOperationTest extends JerseyTest { ControllerContext.getInstance().setMountService(mockMountService); - String uri = createUri("/config/", - "ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/cont1"); - Response response = target(uri).request(Draft02.MediaTypes.DATA + XML).get(); + String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/"; + assertEquals(200, get(uri, MediaType.APPLICATION_XML)); + } + + // /modules + @Test + public void getModulesTest() throws UnsupportedEncodingException, FileNotFoundException { + ControllerContext.getInstance().setGlobalSchema(schemaContextModules); + + String uri = "/modules"; + + Response response = target(uri).request("application/yang.api+json").get(); + validateModulesResponseJson(response); + + response = target(uri).request("application/yang.api+xml").get(); + validateModulesResponseXml(response); + } + + // /streams/ + @Test + public void getStreamsTest() throws UnsupportedEncodingException, FileNotFoundException { + ControllerContext.getInstance().setGlobalSchema(schemaContextModules); + + String uri = "/streams"; + + Response response = target(uri).request("application/yang.api+json").get(); + String responseBody = response.readEntity(String.class); + assertNotNull(responseBody); + assertTrue(responseBody.contains("streams")); + + response = target(uri).request("application/yang.api+xml").get(); + responseBody = response.readEntity(String.class); + assertNotNull(responseBody); + assertTrue(responseBody.contains(""); + + regex.append(".*<"); + regex.append(".*" + rpcName); + regex.append(".*" + namespace); + regex.append(".*/"); + regex.append(".*>"); + + regex.append(".*"); + + regex.append(".*"); + regex.append("$"); + Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL); + return ptrn.matcher(searchIn); + } + + // /restconf/modules/pathToMountPoint/yang-ext:mount + @Test + public void getModulesBehindMountPoint() throws FileNotFoundException, UnsupportedEncodingException { + ControllerContext controllerContext = ControllerContext.getInstance(); + controllerContext.setGlobalSchema(schemaContextModules); + + MountInstance mountInstance = mock(MountInstance.class); + when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint); + MountService mockMountService = mock(MountService.class); + when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + + controllerContext.setMountService(mockMountService); + + String uri = "/modules/ietf-interfaces:interfaces/interface/0/yang-ext:mount/"; + + Response response = target(uri).request("application/yang.api+json").get(); + assertEquals(200, response.getStatus()); + String responseBody = response.readEntity(String.class); + + assertTrue( + "module1-behind-mount-point in json wasn't found", + prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point", + responseBody).find()); + assertTrue( + "module2-behind-mount-point in json wasn't found", + prepareJsonRegex("module2-behind-mount-point", "2014-02-04", "module:2:behind:mount:point", + responseBody).find()); + + response = target(uri).request("application/yang.api+xml").get(); assertEquals(200, response.getStatus()); - - uri = createUri("/config/", - "ietf-interfaces:interfaces/yang-ext:mount/test-module:cont/cont1"); - response = target(uri).request(Draft02.MediaTypes.DATA + XML).get(); + 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()); + + } + + // /restconf/modules/module/pathToMountPoint/yang-ext:mount/moduleName/revision + @Test + public void getModuleBehindMountPoint() throws FileNotFoundException, UnsupportedEncodingException { + ControllerContext controllerContext = ControllerContext.getInstance(); + controllerContext.setGlobalSchema(schemaContextModules); + + MountInstance mountInstance = mock(MountInstance.class); + when(mountInstance.getSchemaContext()).thenReturn(schemaContextBehindMountPoint); + MountService mockMountService = mock(MountService.class); + when(mockMountService.getMountPoint(any(InstanceIdentifier.class))).thenReturn(mountInstance); + + controllerContext.setMountService(mockMountService); + + String uri = "/modules/module/ietf-interfaces:interfaces/interface/0/yang-ext:mount/module1-behind-mount-point/2014-02-03"; + + Response response = target(uri).request("application/yang.api+json").get(); assertEquals(200, response.getStatus()); + String responseBody = response.readEntity(String.class); + + assertTrue( + "module1-behind-mount-point in json wasn't found", + prepareJsonRegex("module1-behind-mount-point", "2014-02-03", "module:1:behind:mount:point", + responseBody).find()); + String[] split = responseBody.split("\"module\""); + assertEquals("\"module\" element is returned more then once", 2, split.length); + + 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(""); + + regex.append(".*"); + regex.append(".*" + module); + regex.append(".*<\\/name>"); + + regex.append(".*"); + regex.append(".*" + revision); + regex.append(".*<\\/revision>"); + + regex.append(".*"); + regex.append(".*" + namespace); + regex.append(".*<\\/namespace>"); + + regex.append(".*<\\/module.*>"); + + regex.append(".*"); + regex.append("$"); + + Pattern ptrn = Pattern.compile(regex.toString(), Pattern.DOTALL); + return ptrn.matcher(searchIn); } - - private int get(String uri, String mediaType) { + + private void prepareMockForModulesTest(final ControllerContext mockedControllerContext) throws FileNotFoundException { + SchemaContext schemaContext = TestUtils.loadSchemaContext("/modules"); + mockedControllerContext.setGlobalSchema(schemaContext); + // when(mockedControllerContext.getGlobalSchema()).thenReturn(schemaContext); + } + + private int get(final String uri, final String mediaType) { return target(uri).request(mediaType).get().getStatus(); } @@ -180,4 +615,314 @@ public class RestGetOperationTest extends JerseyTest { return null; } + @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" ) + ) ); + + when( brokerFacade.readConfigurationData( any( InstanceIdentifier.class ) ) ) + .thenReturn( depth1Cont ); + + // 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" ) + ) ); + + when( brokerFacade.readOperationalData( any( InstanceIdentifier.class ) ) ) + .thenReturn( depth2Cont1 ); + + 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" ) + ) ); + } + + @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( final InvocationOnMock invocation ) { + return paramMap; + } + } ); + + getDataWithInvalidDepthParameterTest( mockInfo ); + + paramMap.putSingle( "depth", "0" ); + getDataWithInvalidDepthParameterTest( mockInfo ); + + paramMap.putSingle( "depth", "-1" ); + getDataWithInvalidDepthParameterTest( mockInfo ); + } + + private void getDataWithInvalidDepthParameterTest( final UriInfo uriInfo ) { + try { + 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 = TestUtils.loadDocumentFrom( (InputStream) response.getEntity() ); + 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.getNodeName() ); + + NodeList childNodes = element.getChildNodes(); + if( nodeData.data == null ) { // empty container + assertTrue( "Expected no child elements for \"" + element.getNodeName() + "\"", + 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.getNodeName() ); + assertNotNull( "Unexpected child element for parent \"" + element.getNodeName() + + "\": " + actualElement.getNodeName(), expChild ); + + if( expChild.data == null || expChild.data instanceof List ) { + verifyContainerElement( actualElement, expChild ); + } + else { + assertEquals( "Text content for element: " + actualElement.getNodeName(), + expChild.data, actualElement.getTextContent() ); + } + } + + if( !expChildMap.isEmpty() ) { + fail( "Missing elements for parent \"" + element.getNodeName() + + "\": " + 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 ); + } }