opendaylight/md-sal/sal-remoterpc-connector/src/test/java/org/opendaylight/controller/remote/rpc/AbstractRpcTest.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
   9 package org.opendaylight.controller.remote.rpc;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertTrue;
  15
  16 import akka.actor.ActorRef;
  17 import akka.actor.ActorSystem;
  18 import akka.testkit.JavaTestKit;
  19 import com.google.common.io.ByteSource;
  20 import java.io.IOException;
  21 import java.io.InputStream;
  22 import java.net.URI;
  23 import java.util.Arrays;
  24 import java.util.Collection;
  25 import org.junit.AfterClass;
  26 import org.junit.Before;
  27 import org.junit.BeforeClass;
  28 import org.mockito.Mock;
  29 import org.mockito.MockitoAnnotations;
  30 import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier;
  31 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  32 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  33 import org.opendaylight.controller.sal.core.api.Broker;
  34 import org.opendaylight.yangtools.yang.common.QName;
  35 import org.opendaylight.yangtools.yang.common.RpcError;
  36 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  37 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  47 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  48 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
  49
  50 /**
  51  * Base class for RPC tests.
  52  *
  53  * @author Thomas Pantelis
  54  */
  55 public class AbstractRpcTest {
  56     static final String TEST_REV = "2014-08-28";
  57     static final String TEST_NS = "urn:test";
  58     static final URI TEST_URI = URI.create(TEST_NS);
  59     static final QName TEST_RPC = QName.create(TEST_NS, TEST_REV, "test-rpc");
  60     static final QName TEST_RPC_INPUT = QName.create(TEST_NS, TEST_REV, "input");
  61     static final QName TEST_RPC_INPUT_DATA = QName.create(TEST_NS, TEST_REV, "input-data");
  62     static final QName TEST_RPC_OUTPUT = QName.create(TEST_NS, TEST_REV, "output");
  63     static final QName TEST_RPC_OUTPUT_DATA = new QName(TEST_URI, "output-data");
  64
  65
  66     static final SchemaPath TEST_RPC_TYPE = SchemaPath.create(true, TEST_RPC);
  67     static final YangInstanceIdentifier TEST_PATH = YangInstanceIdentifier.create(new YangInstanceIdentifier.NodeIdentifier(TEST_RPC));
  68     static final DOMRpcIdentifier TEST_RPC_ID = DOMRpcIdentifier.create(TEST_RPC_TYPE, TEST_PATH);
  69
  70     static ActorSystem node1;
  71     static ActorSystem node2;
  72     static RemoteRpcProviderConfig config1;
  73     static RemoteRpcProviderConfig config2;
  74
  75     protected ActorRef rpcInvoker1;
  76     protected JavaTestKit rpcRegistry1Probe;
  77     protected ActorRef rpcInvoker2;
  78     protected JavaTestKit rpcRegistry2Probe;
  79     protected Broker.ProviderSession brokerSession;
  80     protected SchemaContext schemaContext;
  81     protected RemoteRpcImplementation remoteRpcImpl1;
  82     protected RemoteRpcImplementation remoteRpcImpl2;
  83
  84     @Mock
  85     protected DOMRpcService domRpcService1;
  86     @Mock
  87     protected DOMRpcService domRpcService2;
  88
  89     @BeforeClass
  90     public static void setup() throws InterruptedException {
  91         config1 = new RemoteRpcProviderConfig.Builder("memberA").build();
  92         config2 = new RemoteRpcProviderConfig.Builder("memberB").build();
  93         node1 = ActorSystem.create("opendaylight-rpc", config1.get());
  94         node2 = ActorSystem.create("opendaylight-rpc", config2.get());
  95     }
  96
  97     @AfterClass
  98     public static void teardown() {
  99         JavaTestKit.shutdownActorSystem(node1);
 100         JavaTestKit.shutdownActorSystem(node2);
 101         node1 = null;
 102         node2 = null;
 103     }
 104
 105     @Before
 106     public void setUp() throws IOException, ReactorException {
 107         final ByteSource byteSource = new ByteSource() {
 108             @Override
 109             public InputStream openStream() {
 110                 return AbstractRpcTest.this.getClass().getResourceAsStream("/test-rpc.yang");
 111             }
 112         };
 113
 114         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
 115         schemaContext = reactor.buildEffective(Arrays.asList(byteSource));
 116
 117         MockitoAnnotations.initMocks(this);
 118
 119         rpcRegistry1Probe = new JavaTestKit(node1);
 120         rpcInvoker1 = node1.actorOf(RpcInvoker.props(domRpcService1));
 121         rpcRegistry2Probe = new JavaTestKit(node2);
 122         rpcInvoker2 = node2.actorOf(RpcInvoker.props(domRpcService2));
 123         remoteRpcImpl1 = new RemoteRpcImplementation(rpcInvoker2, config1);
 124         remoteRpcImpl2 = new RemoteRpcImplementation(rpcInvoker1, config2);
 125     }
 126
 127     static void assertRpcErrorEquals(final RpcError rpcError, final ErrorSeverity severity,
 128             final ErrorType errorType, final String tag, final String message, final String applicationTag, final String info,
 129             final String causeMsg) {
 130         assertEquals("getSeverity", severity, rpcError.getSeverity());
 131         assertEquals("getErrorType", errorType, rpcError.getErrorType());
 132         assertEquals("getTag", tag, rpcError.getTag());
 133         assertTrue("getMessage contains " + message, rpcError.getMessage().contains(message));
 134         assertEquals("getApplicationTag", applicationTag, rpcError.getApplicationTag());
 135         assertEquals("getInfo", info, rpcError.getInfo());
 136
 137         if(causeMsg == null) {
 138             assertNull("Unexpected cause " + rpcError.getCause(), rpcError.getCause());
 139         } else {
 140             assertEquals("Cause message", causeMsg, rpcError.getCause().getMessage());
 141         }
 142     }
 143
 144     static void assertCompositeNodeEquals(final NormalizedNode<? , ?> exp, final NormalizedNode<? , ? > actual) {
 145         assertEquals(exp, actual);
 146     }
 147
 148     static ContainerNode makeRPCInput(final String data) {
 149         return Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(TEST_RPC_INPUT))
 150             .withChild(ImmutableNodes.leafNode(TEST_RPC_INPUT_DATA, data)).build();
 151
 152     }
 153
 154     static ContainerNode makeRPCOutput(final String data) {
 155         return Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(TEST_RPC_OUTPUT))
 156                 .withChild(ImmutableNodes.leafNode(TEST_RPC_OUTPUT, data)).build();
 157     }
 158
 159     static void assertFailedRpcResult(final DOMRpcResult rpcResult, final ErrorSeverity severity,
 160             final ErrorType errorType, final String tag, final String message, final String applicationTag, final String info,
 161             final String causeMsg) {
 162
 163         assertNotNull("RpcResult was null", rpcResult);
 164         final Collection<RpcError> rpcErrors = rpcResult.getErrors();
 165         assertEquals("RpcErrors count", 1, rpcErrors.size());
 166         assertRpcErrorEquals(rpcErrors.iterator().next(), severity, errorType, tag, message,
 167                 applicationTag, info, causeMsg);
 168     }
 169
 170     static void assertSuccessfulRpcResult(final DOMRpcResult rpcResult,
 171             final NormalizedNode<? , ?> expOutput) {
 172         assertNotNull("RpcResult was null", rpcResult);
 173         assertCompositeNodeEquals(expOutput, rpcResult.getResult());
 174     }
 175
 176     static class TestException extends Exception {
 177         private static final long serialVersionUID = 1L;
 178
 179         static final String MESSAGE = "mock error";
 180
 181         TestException() {
 182             super(MESSAGE);
 183         }
 184     }
 185 }