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%2FInvokeRpcMethodTest.java;h=b90097bc94a0e7888b589f33960343cc94d36c12;hp=2370035861759584655b0f104516c231f3a6419c;hb=a9533db1d57a2729772ee192a2f96d358c71bede;hpb=4043d42c401e0ad6369c9ec35f2c926dcc18c80d diff --git a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/InvokeRpcMethodTest.java b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/InvokeRpcMethodTest.java index 2370035861..b90097bc94 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/InvokeRpcMethodTest.java +++ b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/InvokeRpcMethodTest.java @@ -1,52 +1,95 @@ +/* + * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. + * Copyright (c) 2014 Brocade Communications Systems, Inc. + * + * 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.assertSame; 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.spy; import static org.mockito.Mockito.when; +import com.google.common.base.Optional; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; +import java.io.FileNotFoundException; import java.net.URI; import java.net.URISyntaxException; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; import java.util.Set; - +import javax.ws.rs.core.MultivaluedHashMap; +import javax.ws.rs.core.MultivaluedMap; +import javax.ws.rs.core.UriInfo; +import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; -import org.mockito.invocation.InvocationOnMock; -import org.mockito.stubbing.Answer; +import org.opendaylight.controller.sal.common.util.RpcErrors; +import org.opendaylight.controller.sal.common.util.Rpcs; +import org.opendaylight.controller.sal.core.api.mount.MountInstance; import org.opendaylight.controller.sal.restconf.impl.BrokerFacade; import org.opendaylight.controller.sal.restconf.impl.ControllerContext; +import org.opendaylight.controller.sal.restconf.impl.InstanceIdWithSchemaNode; +import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException; +import org.opendaylight.controller.sal.restconf.impl.RestconfError; +import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag; +import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorType; import org.opendaylight.controller.sal.restconf.impl.RestconfImpl; import org.opendaylight.controller.sal.restconf.impl.StructuredData; import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.common.RpcError; +import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity; import org.opendaylight.yangtools.yang.common.RpcResult; import org.opendaylight.yangtools.yang.data.api.CompositeNode; import org.opendaylight.yangtools.yang.data.api.ModifyAction; import org.opendaylight.yangtools.yang.data.api.MutableCompositeNode; import org.opendaylight.yangtools.yang.data.api.MutableSimpleNode; -import org.opendaylight.yangtools.yang.data.api.Node; import org.opendaylight.yangtools.yang.data.impl.NodeFactory; import org.opendaylight.yangtools.yang.model.api.Module; +import org.opendaylight.yangtools.yang.model.api.RpcDefinition; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; public class InvokeRpcMethodTest { - private static Set modules; + private RestconfImpl restconfImpl = null; + private static ControllerContext controllerContext = null; + private static UriInfo uriInfo; - private class AnswerImpl implements Answer> { - @Override - public RpcResult answer(InvocationOnMock invocation) throws Throwable { - CompositeNode compNode = (CompositeNode) invocation.getArguments()[1]; - return new DummyRpcResult.Builder().result(compNode).isSuccessful(true).build(); - } - } @BeforeClass - public static void initialization() { - modules = TestUtils.loadModulesFrom("/invoke-rpc"); - assertEquals(1, modules.size()); - Module module = TestUtils.resolveModule("invoke-rpc-module", modules); + public static void init() throws FileNotFoundException { + Set allModules = new HashSet( TestUtils + .loadModulesFrom("/full-versions/yangs") ); + allModules.addAll( TestUtils.loadModulesFrom("/invoke-rpc") ); + assertNotNull(allModules); + Module module = TestUtils.resolveModule("invoke-rpc-module", allModules); assertNotNull(module); + SchemaContext schemaContext = TestUtils.loadSchemaContext(allModules); + controllerContext = spy( ControllerContext.getInstance() ); + controllerContext.setSchemas(schemaContext); + uriInfo = mock(UriInfo.class); + MultivaluedMap map = new MultivaluedHashMap<>(); + map.put("prettyPrint", Collections.singletonList("true")); + when(uriInfo.getQueryParameters(any(Boolean.class))).thenReturn(map); + } + + @Before + public void initMethod() + { + restconfImpl = RestconfImpl.getInstance(); + restconfImpl.setControllerContext( controllerContext ); } /** @@ -56,11 +99,10 @@ public class InvokeRpcMethodTest { * from string - first argument). */ @Test - public void invokeRpcMethodTest() { - ControllerContext contContext = ControllerContext.getInstance(); - contContext.onGlobalContextUpdated(TestUtils.loadSchemaContext(modules)); + public void invokeRpcMtethodTest() { + ControllerContext contContext = controllerContext; try { - contContext.findModuleByNamespace(new URI("invoke:rpc:module")); + contContext.findModuleNameByNamespace(new URI("invoke:rpc:module")); } catch (URISyntaxException e) { assertTrue("Uri wasn't created sucessfuly", false); } @@ -71,24 +113,14 @@ public class InvokeRpcMethodTest { restconf.setBroker(mockedBrokerFacade); restconf.setControllerContext(contContext); - when(mockedBrokerFacade.invokeRpc(any(QName.class), any(CompositeNode.class))).thenAnswer(new AnswerImpl()); + CompositeNode payload = preparePayload(); - StructuredData structData = restconf.invokeRpc("invoke-rpc-module:rpc-test", preparePayload()); + when(mockedBrokerFacade.invokeRpc(any(QName.class), any(CompositeNode.class))) + .thenReturn( Futures.>immediateFuture( + Rpcs.getRpcResult( true ) ) ); - CompositeNode rpcCompNode = structData.getData(); - CompositeNode cont = null; - assertEquals("invoke:rpc:module", rpcCompNode.getNodeType().getNamespace().toString()); - assertEquals("rpc-test", rpcCompNode.getNodeType().getLocalName()); - - for (Node node : rpcCompNode.getChildren()) { - if (node.getNodeType().getLocalName().equals("cont") - && node.getNodeType().getNamespace().toString().equals("nmspc")) { - if (node instanceof CompositeNode) { - cont = (CompositeNode) node; - } - } - } - assertNotNull(cont); + StructuredData structData = restconf.invokeRpc("invoke-rpc-module:rpc-test", payload,uriInfo); + assertTrue(structData == null); } @@ -97,10 +129,215 @@ public class InvokeRpcMethodTest { TestUtils.buildQName("cont", "nmspc", "2013-12-04"), null, null, ModifyAction.CREATE, null); MutableSimpleNode lf = NodeFactory.createMutableSimpleNode( TestUtils.buildQName("lf", "nmspc", "2013-12-04"), cont, "any value", ModifyAction.CREATE, null); - cont.getChildren().add(lf); + cont.getValue().add(lf); cont.init(); return cont; } + @Test + public void testInvokeRpcWithNoPayloadRpc_FailNoErrors() { + RpcResult rpcResult = Rpcs.getRpcResult( false ); + + BrokerFacade brokerFacade = mock(BrokerFacade.class); + when( brokerFacade.invokeRpc( + eq(QName.create("(http://netconfcentral.org/ns/toaster?revision=2009-11-20)cancel-toast")), + any(CompositeNode.class))) + .thenReturn( Futures.>immediateFuture( rpcResult ) ); + + restconfImpl.setBroker(brokerFacade); + + try { + restconfImpl.invokeRpc("toaster:cancel-toast", "",uriInfo); + fail("Expected an exception to be thrown."); + } + catch (RestconfDocumentedException e) { + verifyRestconfDocumentedException( e, 0, ErrorType.RPC, ErrorTag.OPERATION_FAILED, + Optional.absent(), Optional.absent() ); + } + } + + void verifyRestconfDocumentedException( final RestconfDocumentedException e, final int index, + final ErrorType expErrorType, final ErrorTag expErrorTag, + final Optional expErrorMsg, + final Optional expAppTag ) { + RestconfError actual = null; + try { + actual = e.getErrors().get( index ); + } + catch( ArrayIndexOutOfBoundsException ex ) { + fail( "RestconfError not found at index " + index ); + } + + assertEquals( "getErrorType", expErrorType, actual.getErrorType() ); + assertEquals( "getErrorTag", expErrorTag, actual.getErrorTag() ); + assertNotNull( "getErrorMessage is null", actual.getErrorMessage() ); + + if( expErrorMsg.isPresent() ) { + assertEquals( "getErrorMessage", expErrorMsg.get(), actual.getErrorMessage() ); + } + + if( expAppTag.isPresent() ) { + assertEquals( "getErrorAppTag", expAppTag.get(), actual.getErrorAppTag() ); + } + } + + @Test + public void testInvokeRpcWithNoPayloadRpc_FailWithRpcError() { + List rpcErrors = Arrays.asList( + RpcErrors.getRpcError( null, "bogusTag", null, ErrorSeverity.ERROR, "foo", + RpcError.ErrorType.TRANSPORT, null ), + RpcErrors.getRpcError( "app-tag", "in-use", null, ErrorSeverity.WARNING, "bar", + RpcError.ErrorType.RPC, null )); + + RpcResult rpcResult = Rpcs.getRpcResult( false, rpcErrors ); + + BrokerFacade brokerFacade = mock(BrokerFacade.class); + when( brokerFacade.invokeRpc( + eq(QName.create("(http://netconfcentral.org/ns/toaster?revision=2009-11-20)cancel-toast")), + any(CompositeNode.class))) + .thenReturn( Futures.>immediateFuture( rpcResult ) ); + + restconfImpl.setBroker(brokerFacade); + + try { + restconfImpl.invokeRpc("toaster:cancel-toast", "",uriInfo); + fail("Expected an exception to be thrown."); + } + catch (RestconfDocumentedException e) { + verifyRestconfDocumentedException( e, 0, ErrorType.TRANSPORT, ErrorTag.OPERATION_FAILED, + Optional.of( "foo" ), Optional.absent() ); + verifyRestconfDocumentedException( e, 1, ErrorType.RPC, ErrorTag.IN_USE, + Optional.of( "bar" ), Optional.of( "app-tag" ) ); + } + } + + @Test + public void testInvokeRpcWithNoPayload_Success() { + RpcResult rpcResult = Rpcs.getRpcResult( true ); + + BrokerFacade brokerFacade = mock(BrokerFacade.class); + when( brokerFacade.invokeRpc( + eq(QName.create("(http://netconfcentral.org/ns/toaster?revision=2009-11-20)cancel-toast")), + any( CompositeNode.class ))) + .thenReturn( Futures.>immediateFuture( rpcResult ) ); + + restconfImpl.setBroker(brokerFacade); + + StructuredData output = restconfImpl.invokeRpc("toaster:cancel-toast", + "",uriInfo); + assertEquals(null, output); + //additional validation in the fact that the restconfImpl does not throw an exception. + } + + @Test + public void testInvokeRpcMethodExpectingNoPayloadButProvidePayload() { + try { + restconfImpl.invokeRpc("toaster:cancel-toast", " a payload ",uriInfo); + fail("Expected an exception"); + } catch (RestconfDocumentedException e) { + verifyRestconfDocumentedException( e, 0, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, + Optional.absent(), Optional.absent() ); + } + } + + @Test + public void testInvokeRpcMethodWithBadMethodName() { + try { + restconfImpl.invokeRpc("toaster:bad-method", "",uriInfo); + fail("Expected an exception"); + } + catch (RestconfDocumentedException e) { + verifyRestconfDocumentedException( e, 0, ErrorType.RPC, ErrorTag.UNKNOWN_ELEMENT, + Optional.absent(), Optional.absent() ); + } + } + + @Test + public void testInvokeRpcMethodWithInput() { + RpcResult rpcResult = Rpcs.getRpcResult( true ); + + CompositeNode payload = mock(CompositeNode.class); + + BrokerFacade brokerFacade = mock(BrokerFacade.class); + when( brokerFacade.invokeRpc( + eq(QName.create("(http://netconfcentral.org/ns/toaster?revision=2009-11-20)make-toast")), + any(CompositeNode.class))) + .thenReturn( Futures.>immediateFuture( rpcResult ) ); + + restconfImpl.setBroker(brokerFacade); + + StructuredData output = restconfImpl.invokeRpc("toaster:make-toast", + payload,uriInfo); + assertEquals(null, output); + //additional validation in the fact that the restconfImpl does not throw an exception. + } + + @Test + public void testThrowExceptionWhenSlashInModuleName() { + try { + restconfImpl.invokeRpc("toaster/slash", "",uriInfo); + fail("Expected an exception."); + } + catch (RestconfDocumentedException e) { + verifyRestconfDocumentedException( e, 0, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, + Optional.absent(), Optional.absent() ); + } + } + + @Test + public void testInvokeRpcWithNoPayloadWithOutput_Success() { + CompositeNode compositeNode = mock( CompositeNode.class ); + RpcResult rpcResult = Rpcs.getRpcResult( true, compositeNode, + Collections.emptyList() ); + + BrokerFacade brokerFacade = mock(BrokerFacade.class); + when( brokerFacade.invokeRpc( + eq(QName.create("(http://netconfcentral.org/ns/toaster?revision=2009-11-20)testOutput")), + any( CompositeNode.class ))) + .thenReturn( Futures.>immediateFuture( rpcResult ) ); + + restconfImpl.setBroker(brokerFacade); + + StructuredData output = restconfImpl.invokeRpc("toaster:testOutput", "",uriInfo); + assertNotNull( output ); + assertSame( compositeNode, output.getData() ); + assertNotNull( output.getSchema() ); + } + + @Test + public void testMountedRpcCallNoPayload_Success() throws Exception + { + RpcResult rpcResult = Rpcs.getRpcResult( true ); + + ListenableFuture> mockListener = mock( ListenableFuture.class ); + when( mockListener.get() ).thenReturn( rpcResult ); + + QName cancelToastQName = QName.create( "namespace", "2014-05-28", "cancelToast" ); + + RpcDefinition mockRpc = mock( RpcDefinition.class ); + when( mockRpc.getQName() ).thenReturn( cancelToastQName ); + + MountInstance mockMountPoint = mock( MountInstance.class ); + when( mockMountPoint.rpc( eq( cancelToastQName ), any( CompositeNode.class ) ) ) + .thenReturn( mockListener ); + + InstanceIdWithSchemaNode mockedInstanceId = mock( InstanceIdWithSchemaNode.class ); + when( mockedInstanceId.getMountPoint() ).thenReturn( mockMountPoint ); + + ControllerContext mockedContext = mock( ControllerContext.class ); + String cancelToastStr = "toaster:cancel-toast"; + when( mockedContext.urlPathArgDecode( cancelToastStr ) ).thenReturn( cancelToastStr ); + when( mockedContext.getRpcDefinition( cancelToastStr ) ).thenReturn( mockRpc ); + when( mockedContext.toMountPointIdentifier( "opendaylight-inventory:nodes/node/" + + "REMOTE_HOST/yang-ext:mount/toaster:cancel-toast" ) ).thenReturn( mockedInstanceId ); + + restconfImpl.setControllerContext( mockedContext ); + StructuredData output = restconfImpl.invokeRpc( + "opendaylight-inventory:nodes/node/REMOTE_HOST/yang-ext:mount/toaster:cancel-toast", + "",uriInfo); + assertEquals(null, output); + + //additional validation in the fact that the restconfImpl does not throw an exception. + } }