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=9aab841546016a5cb09f669c168307b2aaf0f725;hp=d58b7e9dab0cecac48f4d5641dd2b6ff9bc8ba3a;hb=79db355d656708bcaf66940627c4adc935ecb36d;hpb=43b37a609662f705d2dd701cb8b7c479144d2ef1 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 d58b7e9dab..9aab841546 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,56 +1,102 @@ +/* + * 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 java.net.*; -import java.util.*; - -import org.junit.*; -import org.mockito.invocation.InvocationOnMock; -import org.mockito.stubbing.Answer; -import org.opendaylight.controller.sal.restconf.impl.*; -import org.opendaylight.yangtools.yang.common.*; -import org.opendaylight.yangtools.yang.data.api.*; +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.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.RpcResult; +import org.opendaylight.yangtools.yang.common.RpcResultBuilder; +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.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 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(); - } - } + private RestconfImpl restconfImpl = null; + private static ControllerContext controllerContext = null; + private static UriInfo uriInfo; @BeforeClass - public static void initialization() { - modules = TestUtils.resolveModules("/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); } /** - * Test method invokeRpc in RestconfImpl class tests if composite node as - * input parameter of method invokeRpc (second argument) is wrapped to - * parent composite node which has QName equals to QName of rpc (resolved - * from string - first argument). + * Test method invokeRpc in RestconfImpl class tests if composite node as input parameter of method invokeRpc + * (second argument) is wrapped to parent composite node which has QName equals to QName of rpc (resolved from + * string - first argument). */ @Test public void invokeRpcMethodTest() { - ControllerContext contContext = ControllerContext.getInstance(); - contContext.onGlobalContextUpdated(TestUtils.loadSchemaContext(modules)); + 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); } @@ -61,24 +107,13 @@ 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(RpcResultBuilder.success().build())); - 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); } @@ -87,10 +122,232 @@ 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 = RpcResultBuilder.failed().build(); + + 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( + RpcResultBuilder.newError( RpcError.ErrorType.TRANSPORT, "bogusTag", "foo" ), + RpcResultBuilder.newWarning( RpcError.ErrorType.RPC, "in-use", "bar", + "app-tag", null, null ) ); + + RpcResult rpcResult = RpcResultBuilder.failed() + .withRpcErrors(rpcErrors).build(); + + 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 = RpcResultBuilder.success().build(); + + 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 = RpcResultBuilder.success().build(); + + 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 = + RpcResultBuilder.success(compositeNode).build(); + + 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()); + } + + /** + * + * Tests calling of RestConfImpl method invokeRpc. In the method there is searched rpc in remote schema context. + * This rpc is then executed. + * + * I wasn't able to simulate calling of rpc on remote device therefore this testing method raise method when rpc is + * invoked. + */ + @Test + public void testMountedRpcCallNoPayload_Success() throws Exception { + RpcResult rpcResult = RpcResultBuilder.success().build(); + + 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); + + when(mockMountPoint.getSchemaContext()).thenReturn(TestUtils.loadSchemaContext("/invoke-rpc")); + + InstanceIdWithSchemaNode mockedInstanceId = mock(InstanceIdWithSchemaNode.class); + when(mockedInstanceId.getMountPoint()).thenReturn(mockMountPoint); + + ControllerContext mockedContext = mock(ControllerContext.class); + String rpcNoop = "invoke-rpc-module:rpc-noop"; + when(mockedContext.urlPathArgDecode(rpcNoop)).thenReturn(rpcNoop); + when(mockedContext.getRpcDefinition(rpcNoop)).thenReturn(mockRpc); + when( + mockedContext.toMountPointIdentifier(eq("opendaylight-inventory:nodes/node/" + + "REMOTE_HOST/yang-ext:mount/invoke-rpc-module:rpc-noop"))).thenReturn(mockedInstanceId); + + restconfImpl.setControllerContext(mockedContext); + try { + restconfImpl.invokeRpc( + "opendaylight-inventory:nodes/node/REMOTE_HOST/yang-ext:mount/invoke-rpc-module:rpc-noop", "", + uriInfo); + fail("RestconfDocumentedException wasn't raised"); + } catch (RestconfDocumentedException e) { + List errors = e.getErrors(); + assertNotNull(errors); + assertEquals(1, errors.size()); + assertEquals(ErrorType.APPLICATION, errors.iterator().next().getErrorType()); + assertEquals(ErrorTag.OPERATION_FAILED, errors.iterator().next().getErrorTag()); + } + + // additional validation in the fact that the restconfImpl does not + // throw an exception. + } }