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=f2d6aaf44f49585cfc95508f8e104bdb8ce95f32;hb=92f1fd15e99ce5b9e52612c0b52f70cd661b99cc;hpb=1c70f484cd268220d9df91d7c6377a5fdc89cd4f 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 f2d6aaf44f..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 @@ -7,49 +7,82 @@ */ package org.opendaylight.controller.sal.restconf.impl.test; -import static org.junit.Assert.*; 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.mockito.Mockito.verify; -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.Response; 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.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.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; @@ -86,6 +119,7 @@ public class RestGetOperationTest extends JerseyTest { resourceConfig = resourceConfig.registerInstances(restconfImpl, StructuredDataToXmlProvider.INSTANCE, StructuredDataToJsonProvider.INSTANCE, XmlToCompositeNodeProvider.INSTANCE, JsonToCompositeNodeProvider.INSTANCE); + resourceConfig.registerClasses( RestconfDocumentedExceptionMapper.class ); return resourceConfig; } @@ -95,10 +129,10 @@ public class RestGetOperationTest extends JerseyTest { @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)); } @@ -108,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)); } @@ -130,14 +164,59 @@ 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"); + String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont/cont1"; assertEquals(200, get(uri, MediaType.APPLICATION_XML)); - uri = createUri("/config/", "ietf-interfaces:interfaces/yang-ext:mount/test-module:cont/cont1"); + 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( @@ -150,7 +229,7 @@ public class RestGetOperationTest extends JerseyTest { ControllerContext.getInstance().setMountService(mockMountService); - String uri = createUri("/config/", "ietf-interfaces:interfaces/interface/0/yang-ext:mount/"); + String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/"; assertEquals(200, get(uri, MediaType.APPLICATION_XML)); } @@ -159,7 +238,7 @@ public class RestGetOperationTest extends JerseyTest { public void getModulesTest() throws UnsupportedEncodingException, FileNotFoundException { ControllerContext.getInstance().setGlobalSchema(schemaContextModules); - String uri = createUri("/modules", ""); + String uri = "/modules"; Response response = target(uri).request("application/yang.api+json").get(); validateModulesResponseJson(response); @@ -168,12 +247,30 @@ public class RestGetOperationTest extends JerseyTest { 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(" 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 ); + } }