2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.binding.impl.connect.dom;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.mockito.Matchers.any;
13 import static org.mockito.Matchers.eq;
14 import static org.mockito.Mockito.mock;
15 import static org.mockito.Mockito.when;
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.ListenableFuture;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.Date;
22 import java.util.concurrent.ExecutionException;
23 import java.util.concurrent.Future;
24 import org.junit.Before;
25 import org.junit.Test;
26 import org.mockito.Mock;
27 import org.mockito.MockitoAnnotations;
28 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
29 import org.opendaylight.yangtools.yang.binding.DataObject;
30 import org.opendaylight.yangtools.yang.binding.RpcService;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.common.RpcError;
33 import org.opendaylight.yangtools.yang.common.RpcResult;
34 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
35 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
36 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
38 public class RpcInvocationStrategyTest {
41 private BindingIndependentMappingService mockMappingService;
43 private RpcProvisionRegistry mockbiRpcRegistry;
45 private RpcInvocationStrategy rpcInvocationStrategy;
46 private ListenableFuture<RpcResult<DataObject>> futureDataObj;
47 private ListenableFuture<RpcResult<CompositeNode>> futureCompNode;
48 private final RpcError rpcError = mock(RpcError.class);
49 private final Collection<RpcError> errors = new ArrayList<RpcError>();
51 private final CompositeNode inputInvokeOn = mock(CompositeNode.class);
52 private final CompositeNode outputInvokeOn = mock(CompositeNode.class);
54 private final DataObject toDataDomInput = mock(DataObject.class);
55 private final CompositeNode toDataDomReturn = mock(CompositeNode.class);
56 private final CompositeNode invokeRpcResult = mock(CompositeNode.class);
58 private final DataObject inputForward = mock(DataObject.class);
59 private final DataObject outputForward = mock(DataObject.class);
61 private QName mockQName;
64 private final MockRpcService mockRpcService = new MockRpcService();
66 public class MockRpcService implements RpcService {
68 public Future<?> rpcnameWithInputNoOutput(final DataObject input) {
72 public Future<RpcResult<DataObject>> rpcnameWithInputWithOutput(final DataObject input) {
76 public Future<RpcResult<DataObject>> rpcnameNoInputWithOutput() {
80 public Future<?> rpcnameNoInputNoOutput() {
85 public RpcInvocationStrategyTest() {
86 MockitoAnnotations.initMocks(this);
90 public void testInit() throws Exception {
91 urn = new URI(new String("urn:a:valid:urn"));
94 private void setupForForwardToDom(final boolean hasOutput, final boolean hasInput, final int expectedErrorSize) {
96 if (expectedErrorSize > 0) {
99 RpcResult<CompositeNode> result = RpcResultBuilder.<CompositeNode>success(invokeRpcResult)
100 .withRpcErrors( errors ).build();
101 futureCompNode = Futures.immediateFuture(result);
104 when(mockMappingService.toDataDom(inputForward)).thenReturn(toDataDomReturn);
106 when(mockbiRpcRegistry.invokeRpc(eq(mockQName), any(CompositeNode.class))).thenReturn(
110 mockMappingService.dataObjectFromDataDom(eq(rpcInvocationStrategy
111 .getOutputClass().get()), any(CompositeNode.class))).thenReturn(
117 private void validateForwardToDomBroker(final ListenableFuture<RpcResult<?>> forwardToDomBroker,
118 final boolean expectedSuccess, final DataObject expectedResult, final int expectedErrorSize)
119 throws InterruptedException, ExecutionException {
120 assertNotNull(forwardToDomBroker);
121 assertEquals(expectedSuccess, forwardToDomBroker.get().isSuccessful());
122 assertEquals(expectedResult, forwardToDomBroker.get().getResult());
123 assertEquals(expectedErrorSize, forwardToDomBroker.get().getErrors().size());
126 private void setupTestMethod(final String rpcName, final String testMethodName, final boolean hasInput)
127 throws NoSuchMethodException {
128 mockQName = QName.create(urn, new Date(0L), new String(rpcName));
129 java.lang.reflect.Method rpcMethod = hasInput ? MockRpcService.class.getMethod(rpcName,
130 DataObject.class) : MockRpcService.class.getMethod(rpcName);
131 rpcInvocationStrategy = new RpcInvocationStrategy(mockQName, rpcMethod, mockMappingService,
136 * forwardToDomBroker tests
139 public void testForwardToDomBroker_WithInputNoOutput() throws Exception {
140 setupTestMethod("rpcnameWithInputNoOutput", "testForwardToDomBroker_WithInputNoOutput",
142 setupForForwardToDom(false, true, 0);
143 ListenableFuture<RpcResult<?>> forwardToDomBroker = rpcInvocationStrategy
144 .forwardToDomBroker(inputForward);
146 validateForwardToDomBroker(forwardToDomBroker, true, null, 0);
150 public void testForwardToDomBroker_WithInputNoOutput_error() throws Exception {
151 setupTestMethod("rpcnameWithInputNoOutput",
152 "testForwardToDomBroker_WithInputNoOutput_error", true);
153 setupForForwardToDom(false, true, 1);
154 ListenableFuture<RpcResult<?>> forwardToDomBroker = rpcInvocationStrategy
155 .forwardToDomBroker(inputForward);
157 validateForwardToDomBroker(forwardToDomBroker, true, null, 1);
161 public void testForwardToDomBroker_WithInputWithOutput() throws Exception {
162 setupTestMethod("rpcnameWithInputWithOutput", "testForwardToDomBroker_WithInputWithOutput",
164 setupForForwardToDom(true, true, 0);
165 ListenableFuture<RpcResult<?>> forwardToDomBroker = rpcInvocationStrategy
166 .forwardToDomBroker(inputForward);
167 validateForwardToDomBroker(forwardToDomBroker, true, outputForward, 0);
171 public void testForwardToDomBroker_NoInputWithOutput() throws Exception {
172 setupTestMethod("rpcnameNoInputWithOutput", "testForwardToDomBroker_NoInputWithOutput",
174 setupForForwardToDom(true, false, 0);
175 ListenableFuture<RpcResult<?>> forwardToDomBroker = rpcInvocationStrategy
176 .forwardToDomBroker(null);
177 validateForwardToDomBroker(forwardToDomBroker, true, outputForward, 0);
181 public void testForwardToDomBroker_NoInputNoOutput() throws Exception {
182 setupTestMethod("rpcnameNoInputNoOutput", "testForwardToDomBroker_NoInputNoOutput", false);
183 setupForForwardToDom(false, false, 0);
184 ListenableFuture<RpcResult<?>> forwardToDomBroker = rpcInvocationStrategy
185 .forwardToDomBroker(null);
186 validateForwardToDomBroker(forwardToDomBroker, true, null, 0);
192 private void setupRpcResultsWithOutput(final int expectedErrorSize) {
193 if (expectedErrorSize > 0) {
194 errors.add(rpcError);
196 RpcResult<CompositeNode> resultCompNode = RpcResultBuilder.<CompositeNode>success(inputInvokeOn)
197 .withRpcErrors(errors).build();
198 futureCompNode = Futures.immediateFuture(resultCompNode);
199 RpcResult<DataObject> resultDataObj = RpcResultBuilder.<DataObject>success(toDataDomInput)
200 .withRpcErrors(errors).build();
201 futureDataObj = Futures.immediateFuture(resultDataObj);
203 when(mockMappingService.toDataDom(toDataDomInput)).thenReturn(outputInvokeOn);
206 private void setupRpcResultsNoOutput(final int expectedErrorSize) {
207 if (expectedErrorSize > 0) {
208 errors.add(rpcError);
210 RpcResult<CompositeNode> resultCompNode = RpcResultBuilder.<CompositeNode>success(inputInvokeOn)
211 .withRpcErrors(errors).build();
212 futureCompNode = Futures.immediateFuture(resultCompNode);
213 RpcResult<DataObject> resultDataObj = RpcResultBuilder.<DataObject>success()
214 .withRpcErrors(errors).build();
215 futureDataObj = Futures.immediateFuture(resultDataObj);
218 private void validateReturnedImmediateFuture(
219 final ListenableFuture<RpcResult<CompositeNode>> immediateFuture, final boolean expectedSuccess,
220 final CompositeNode expectedReturn, final int expectedErrorSize) throws InterruptedException,
222 assertNotNull(immediateFuture);
223 assertEquals(expectedSuccess, immediateFuture.get().isSuccessful());
224 assertEquals(expectedReturn, immediateFuture.get().getResult());
225 assertEquals(expectedErrorSize, immediateFuture.get().getErrors().size());
229 public void testInvokeOn_NoInputNoOutput() throws Exception {
230 setupTestMethod("rpcnameNoInputNoOutput", "testInvokeOn_NoInputNoOutput", false);
231 setupRpcResultsNoOutput(0);
232 ListenableFuture<RpcResult<CompositeNode>> immediateFuture = Futures
233 .immediateFuture(rpcInvocationStrategy.invokeOn(mockRpcService, inputInvokeOn));
234 validateReturnedImmediateFuture(immediateFuture, true, null, 0);
238 public void testInvokeOn_NoInputNoOutput_errors() throws Exception {
239 setupTestMethod("rpcnameNoInputNoOutput", "testInvokeOn_NoInputNoOutput", false);
240 setupRpcResultsNoOutput(1);
241 ListenableFuture<RpcResult<CompositeNode>> immediateFuture = Futures
242 .immediateFuture(rpcInvocationStrategy.invokeOn(mockRpcService, inputInvokeOn));
243 validateReturnedImmediateFuture(immediateFuture, true, null, 1);
247 public void testInvokeOn_WithInputNoOutput() throws Exception {
248 setupTestMethod("rpcnameWithInputNoOutput", "testInvokeOn_WithInputNoOutput", true);
249 setupRpcResultsNoOutput(0);
250 ListenableFuture<RpcResult<CompositeNode>> immediateFuture = Futures
251 .immediateFuture(rpcInvocationStrategy.invokeOn(mockRpcService, inputInvokeOn));
252 validateReturnedImmediateFuture(immediateFuture, true, null, 0);
256 public void testInvokeOn_WithInputWithOutput() throws Exception {
257 setupTestMethod("rpcnameWithInputWithOutput", "testInvokeOn_WithInputWithOutput", true);
258 setupRpcResultsWithOutput(0);
259 ListenableFuture<RpcResult<CompositeNode>> immediateFuture = Futures
260 .immediateFuture(rpcInvocationStrategy.invokeOn(mockRpcService, inputInvokeOn));
261 validateReturnedImmediateFuture(immediateFuture, true, outputInvokeOn, 0);
265 public void testInvokeOn_NoInputWithOutput() throws Exception {
266 setupTestMethod("rpcnameNoInputWithOutput", "testInvokeOn_NoInputWithOutput", false);
267 setupRpcResultsWithOutput(0);
268 ListenableFuture<RpcResult<CompositeNode>> immediateFuture = Futures
269 .immediateFuture(rpcInvocationStrategy.invokeOn(mockRpcService, inputInvokeOn));
270 validateReturnedImmediateFuture(immediateFuture, true, outputInvokeOn, 0);