opendaylight/md-sal/sal-remoterpc-connector/src/test/java/org/opendaylight/controller/remote/rpc/RemoteOpsImplementationTest.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.remote.rpc;
   9
  10 import static org.hamcrest.CoreMatchers.instanceOf;
  11 import static org.hamcrest.MatcherAssert.assertThat;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertThrows;
  15 import static org.mockito.ArgumentMatchers.any;
  16 import static org.mockito.ArgumentMatchers.eq;
  17 import static org.mockito.Mockito.doReturn;
  18 import static org.mockito.Mockito.doThrow;
  19
  20 import com.google.common.util.concurrent.ListenableFuture;
  21 import java.util.Collections;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.concurrent.TimeUnit;
  24 import org.junit.Ignore;
  25 import org.junit.Test;
  26 import org.mockito.ArgumentCaptor;
  27 import org.opendaylight.mdsal.dom.api.DOMActionException;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  29 import org.opendaylight.mdsal.dom.api.DOMRpcException;
  30 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  31 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  32 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  33 import org.opendaylight.yangtools.yang.common.QName;
  34 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  37
  38 /**
  39  * Unit tests for RemoteRpcImplementation.
  40  *
  41  * @author Thomas Pantelis
  42  */
  43 public class RemoteOpsImplementationTest extends AbstractOpsTest {
  44
  45     /**
  46      * This test method invokes and executes the remote rpc.
  47      */
  48     @Test
  49     public void testInvokeRpc() throws Exception {
  50         final ContainerNode rpcOutput = makeRPCOutput("bar");
  51         final DOMRpcResult rpcResult = new DefaultDOMRpcResult(rpcOutput);
  52
  53         final ContainerNode invokeRpcInput = makeRPCInput("foo");
  54         final ArgumentCaptor<ContainerNode> inputCaptor = ArgumentCaptor.forClass(ContainerNode.class);
  55
  56         doReturn(FluentFutures.immediateFluentFuture(rpcResult)).when(domRpcService2)
  57             .invokeRpc(eq(TEST_RPC), inputCaptor.capture());
  58
  59         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteRpcImpl1.invokeRpc(TEST_RPC_ID, invokeRpcInput);
  60         assertThat(frontEndFuture, instanceOf(RemoteDOMRpcFuture.class));
  61
  62         final DOMRpcResult result = frontEndFuture.get(5, TimeUnit.SECONDS);
  63         assertEquals(rpcOutput, result.value());
  64     }
  65
  66     /**
  67      * This test method invokes and executes the remote action.
  68      */
  69     @Test
  70     public void testInvokeAction() throws Exception {
  71         final ContainerNode actionOutput = makeRPCOutput("bar");
  72         final DOMRpcResult actionResult = new DefaultDOMRpcResult(actionOutput, Collections.emptyList());
  73         final NormalizedNode invokeActionInput = makeRPCInput("foo");
  74         final ArgumentCaptor<ContainerNode> inputCaptor =
  75                 ArgumentCaptor.forClass(ContainerNode.class);
  76         doReturn(FluentFutures.immediateFluentFuture(actionResult)).when(domActionService2).invokeAction(
  77                 eq(TEST_RPC_TYPE), eq(TEST_DATA_TREE_ID), inputCaptor.capture());
  78         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteActionImpl1.invokeAction(TEST_RPC_TYPE,
  79                 TEST_DATA_TREE_ID, (ContainerNode) invokeActionInput);
  80         assertThat(frontEndFuture, instanceOf(RemoteDOMActionFuture.class));
  81         final DOMRpcResult result = frontEndFuture.get(5, TimeUnit.SECONDS);
  82         assertEquals(actionOutput, result.value());
  83     }
  84
  85     /**
  86      * This test method invokes and executes the remote rpc.
  87      */
  88     @Test
  89     public void testInvokeRpcWithNullInput() throws Exception {
  90         final ContainerNode rpcOutput = makeRPCOutput("bar");
  91         final DOMRpcResult rpcResult = new DefaultDOMRpcResult(rpcOutput);
  92
  93         final ArgumentCaptor<ContainerNode> inputCaptor = ArgumentCaptor.forClass(ContainerNode.class);
  94
  95         doReturn(FluentFutures.immediateFluentFuture(rpcResult)).when(domRpcService2)
  96             .invokeRpc(eq(TEST_RPC), inputCaptor.capture());
  97
  98         ListenableFuture<DOMRpcResult> frontEndFuture = remoteRpcImpl1.invokeRpc(TEST_RPC_ID, null);
  99         assertThat(frontEndFuture, instanceOf(RemoteDOMRpcFuture.class));
 100
 101         final DOMRpcResult result = frontEndFuture.get(5, TimeUnit.SECONDS);
 102         assertEquals(rpcOutput, result.value());
 103     }
 104
 105     /**
 106      * This test method invokes and executes the remote action.
 107      */
 108     @Test
 109     public void testInvokeActionWithNullInput() throws Exception {
 110         final ContainerNode actionOutput = makeRPCOutput("bar");
 111         final DOMRpcResult actionResult = new DefaultDOMRpcResult(actionOutput);
 112
 113         final ArgumentCaptor<ContainerNode> inputCaptor = ArgumentCaptor.forClass(ContainerNode.class);
 114         doReturn(FluentFutures.immediateFluentFuture(actionResult)).when(domActionService2).invokeAction(
 115                 eq(TEST_RPC_TYPE), eq(TEST_DATA_TREE_ID), inputCaptor.capture());
 116
 117         ListenableFuture<DOMRpcResult> frontEndFuture = remoteActionImpl1.invokeAction(TEST_RPC_TYPE,
 118                 TEST_DATA_TREE_ID, actionOutput);
 119         assertThat(frontEndFuture, instanceOf(RemoteDOMActionFuture.class));
 120
 121         final DOMRpcResult result = frontEndFuture.get(5, TimeUnit.SECONDS);
 122         assertEquals(actionOutput, result.value());
 123     }
 124
 125     /**
 126      * This test method invokes and executes the remote rpc.
 127      */
 128     @Test
 129     public void testInvokeRpcWithNoOutput() throws Exception {
 130         final ContainerNode rpcOutput = null;
 131         final DOMRpcResult rpcResult = new DefaultDOMRpcResult(rpcOutput);
 132
 133         final ContainerNode invokeRpcInput = makeRPCInput("foo");
 134         final ArgumentCaptor<ContainerNode> inputCaptor = ArgumentCaptor.forClass(ContainerNode.class);
 135
 136         doReturn(FluentFutures.immediateFluentFuture(rpcResult)).when(domRpcService2)
 137             .invokeRpc(eq(TEST_RPC), inputCaptor.capture());
 138
 139         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteRpcImpl1.invokeRpc(TEST_RPC_ID, invokeRpcInput);
 140         assertThat(frontEndFuture, instanceOf(RemoteDOMRpcFuture.class));
 141
 142         final DOMRpcResult result = frontEndFuture.get(5, TimeUnit.SECONDS);
 143         assertNull(result.value());
 144     }
 145
 146     /**
 147      * This test method invokes and executes the remote rpc.
 148      */
 149     @Test
 150     public void testInvokeRpcWithRemoteFailedFuture() {
 151         final ContainerNode invokeRpcInput = makeRPCInput("foo");
 152         final ArgumentCaptor<ContainerNode> inputCaptor = ArgumentCaptor.forClass(ContainerNode.class);
 153
 154         doReturn(FluentFutures.immediateFailedFluentFuture(new RemoteDOMRpcException("Test Exception", null)))
 155             .when(domRpcService2).invokeRpc(eq(TEST_RPC), inputCaptor.capture());
 156
 157         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteRpcImpl1.invokeRpc(TEST_RPC_ID, invokeRpcInput);
 158         assertThat(frontEndFuture, instanceOf(RemoteDOMRpcFuture.class));
 159
 160         final var ex = assertThrows(ExecutionException.class, () -> frontEndFuture.get(5, TimeUnit.SECONDS)).getCause();
 161         assertThat(ex, instanceOf(DOMRpcException.class));
 162     }
 163
 164     /**
 165      * This test method invokes and executes the remote rpc.
 166      */
 167     @Test
 168     public void testInvokeActionWithRemoteFailedFuture() {
 169         final ContainerNode invokeActionInput = makeRPCInput("foo");
 170         final ArgumentCaptor<ContainerNode> inputCaptor = ArgumentCaptor.forClass(ContainerNode.class);
 171
 172         doReturn(FluentFutures.immediateFailedFluentFuture(new RemoteDOMRpcException("Test Exception", null)))
 173             .when(domActionService2).invokeAction(eq(TEST_RPC_TYPE), eq(TEST_DATA_TREE_ID), inputCaptor.capture());
 174
 175         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteActionImpl1.invokeAction(TEST_RPC_TYPE,
 176                 TEST_DATA_TREE_ID, invokeActionInput);
 177         assertThat(frontEndFuture, instanceOf(RemoteDOMActionFuture.class));
 178
 179         final var ex = assertThrows(ExecutionException.class, () -> frontEndFuture.get(5, TimeUnit.SECONDS)).getCause();
 180         assertThat(ex, instanceOf(DOMActionException.class));
 181     }
 182
 183     /**
 184      * This test method invokes and tests exceptions when akka timeout occured
 185      * Currently ignored since this test with current config takes around 15 seconds to complete.
 186      */
 187     @Ignore
 188     @Test
 189     public void testInvokeRpcWithAkkaTimeoutException() {
 190         final ContainerNode invokeRpcInput = makeRPCInput("foo");
 191         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteRpcImpl1.invokeRpc(TEST_RPC_ID, invokeRpcInput);
 192         assertThat(frontEndFuture, instanceOf(RemoteDOMRpcFuture.class));
 193
 194         assertThrows(RemoteDOMRpcException.class, () -> frontEndFuture.get(20, TimeUnit.SECONDS));
 195     }
 196
 197     /**
 198      * This test method invokes remote rpc and lookup failed with runtime exception.
 199      */
 200     @Test
 201     public void testInvokeRpcWithLookupException() {
 202         final ContainerNode invokeRpcInput = makeRPCInput("foo");
 203
 204         doThrow(new RuntimeException("test")).when(domRpcService2).invokeRpc(any(QName.class),
 205             any(ContainerNode.class));
 206
 207         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteRpcImpl1.invokeRpc(TEST_RPC_ID, invokeRpcInput);
 208         assertThat(frontEndFuture, instanceOf(RemoteDOMRpcFuture.class));
 209
 210         final var ex = assertThrows(ExecutionException.class, () -> frontEndFuture.get(5, TimeUnit.SECONDS)).getCause();
 211         assertThat(ex, instanceOf(DOMRpcException.class));
 212     }
 213
 214     /**
 215      * This test method invokes remote rpc and lookup failed
 216      * with runtime exception.
 217      */
 218     @Test
 219     public void testInvokeActionWithLookupException() {
 220         final ContainerNode invokeRpcInput = makeRPCInput("foo");
 221
 222         doThrow(new RuntimeException("test")).when(domActionService2).invokeAction(any(Absolute.class),
 223                 any(DOMDataTreeIdentifier.class), any(ContainerNode.class));
 224
 225         final ListenableFuture<DOMRpcResult> frontEndFuture = remoteActionImpl1.invokeAction(TEST_RPC_TYPE,
 226                 TEST_DATA_TREE_ID, invokeRpcInput);
 227         assertThat(frontEndFuture, instanceOf(RemoteDOMActionFuture.class));
 228
 229         final var ex = assertThrows(ExecutionException.class, () -> frontEndFuture.get(5, TimeUnit.SECONDS)).getCause();
 230         assertThat(ex, instanceOf(DOMActionException.class));
 231     }
 232 }