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 java.io.File;
  17 import java.net.URI;
  18 import java.util.Arrays;
  19 import java.util.Collection;
  20 import java.util.List;
  21
  22 import org.junit.AfterClass;
  23 import org.junit.Before;
  24 import org.junit.BeforeClass;
  25 import org.mockito.Mockito;
  26 import org.opendaylight.controller.sal.core.api.Broker;
  27 import org.opendaylight.yangtools.yang.common.QName;
  28 import org.opendaylight.yangtools.yang.common.RpcError;
  29 import org.opendaylight.yangtools.yang.common.RpcResult;
  30 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  31 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  32 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  33 import org.opendaylight.yangtools.yang.data.api.Node;
  34 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
  35 import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
  38
  39 import akka.actor.ActorRef;
  40 import akka.actor.ActorSystem;
  41 import akka.testkit.JavaTestKit;
  42
  43 import com.google.common.collect.ImmutableList;
  44 import com.typesafe.config.ConfigFactory;
  45
  46 /**
  47  * Base class for RPC tests.
  48  *
  49  * @author Thomas Pantelis
  50  */
  51 public class AbstractRpcTest {
  52     static final String TEST_REV = "2014-08-28";
  53     static final String TEST_NS = "urn:test";
  54     static final URI TEST_URI = URI.create(TEST_NS);
  55     static final QName TEST_RPC = QName.create(TEST_NS, TEST_REV, "test-rpc");
  56     static final QName TEST_RPC_INPUT = QName.create(TEST_NS, TEST_REV, "input");
  57     static final QName TEST_RPC_INPUT_DATA = QName.create(TEST_NS, TEST_REV, "input-data");
  58     static final QName TEST_RPC_OUTPUT = QName.create(TEST_NS, TEST_REV, "output");
  59     static final QName TEST_RPC_OUTPUT_DATA = new QName(TEST_URI, "output-data");
  60
  61     static ActorSystem node1;
  62     static ActorSystem node2;
  63
  64     protected ActorRef rpcBroker1;
  65     protected JavaTestKit probeReg1;
  66     protected ActorRef rpcBroker2;
  67     protected JavaTestKit probeReg2;
  68     protected Broker.ProviderSession brokerSession;
  69     protected SchemaContext schemaContext;
  70
  71     @BeforeClass
  72     public static void setup() throws InterruptedException {
  73         node1 = ActorSystem.create("opendaylight-rpc", ConfigFactory.load().getConfig("memberA"));
  74         node2 = ActorSystem.create("opendaylight-rpc", ConfigFactory.load().getConfig("memberB"));
  75     }
  76
  77     @AfterClass
  78     public static void teardown() {
  79         JavaTestKit.shutdownActorSystem(node1);
  80         JavaTestKit.shutdownActorSystem(node2);
  81         node1 = null;
  82         node2 = null;
  83     }
  84
  85     @Before
  86     public void setUp() {
  87         schemaContext = new YangParserImpl().parseFiles(Arrays.asList(
  88                 new File(RpcBrokerTest.class.getResource("/test-rpc.yang").getPath())));
  89
  90         brokerSession = Mockito.mock(Broker.ProviderSession.class);
  91         probeReg1 = new JavaTestKit(node1);
  92         rpcBroker1 = node1.actorOf(RpcBroker.props(brokerSession, probeReg1.getRef(), schemaContext));
  93         probeReg2 = new JavaTestKit(node2);
  94         rpcBroker2 = node2.actorOf(RpcBroker.props(brokerSession, probeReg2.getRef(), schemaContext));
  95
  96     }
  97
  98     static void assertRpcErrorEquals(RpcError rpcError, ErrorSeverity severity,
  99             ErrorType errorType, String tag, String message, String applicationTag, String info,
 100             String causeMsg) {
 101         assertEquals("getSeverity", severity, rpcError.getSeverity());
 102         assertEquals("getErrorType", errorType, rpcError.getErrorType());
 103         assertEquals("getTag", tag, rpcError.getTag());
 104         assertTrue("getMessage contains " + message, rpcError.getMessage().contains(message));
 105         assertEquals("getApplicationTag", applicationTag, rpcError.getApplicationTag());
 106         assertEquals("getInfo", info, rpcError.getInfo());
 107
 108         if(causeMsg == null) {
 109             assertNull("Unexpected cause " + rpcError.getCause(), rpcError.getCause());
 110         } else {
 111             assertEquals("Cause message", causeMsg, rpcError.getCause().getMessage());
 112         }
 113     }
 114
 115     static void assertCompositeNodeEquals(CompositeNode exp, CompositeNode actual) {
 116         assertEquals("NodeType getNamespace", exp.getNodeType().getNamespace(),
 117                 actual.getNodeType().getNamespace());
 118         assertEquals("NodeType getLocalName", exp.getNodeType().getLocalName(),
 119                 actual.getNodeType().getLocalName());
 120         for(Node<?> child: exp.getValue()) {
 121             List<Node<?>> c = actual.get(child.getNodeType());
 122             assertNotNull("Missing expected child " + child.getNodeType(), c);
 123             if(child instanceof CompositeNode) {
 124                 assertCompositeNodeEquals((CompositeNode) child, (CompositeNode)c.get(0));
 125             } else {
 126                 assertEquals("Value for Node " + child.getNodeType(), child.getValue(),
 127                         c.get(0).getValue());
 128             }
 129         }
 130     }
 131
 132     static CompositeNode makeRPCInput(String data) {
 133         CompositeNodeBuilder<ImmutableCompositeNode> builder = ImmutableCompositeNode.builder()
 134                 .setQName(TEST_RPC_INPUT).addLeaf(TEST_RPC_INPUT_DATA, data);
 135         return ImmutableCompositeNode.create(
 136                 TEST_RPC, ImmutableList.<Node<?>>of(builder.toInstance()));
 137     }
 138
 139     static CompositeNode makeRPCOutput(String data) {
 140         CompositeNodeBuilder<ImmutableCompositeNode> builder = ImmutableCompositeNode.builder()
 141                 .setQName(TEST_RPC_OUTPUT).addLeaf(TEST_RPC_OUTPUT_DATA, data);
 142         return ImmutableCompositeNode.create(
 143                 TEST_RPC, ImmutableList.<Node<?>>of(builder.toInstance()));
 144     }
 145
 146     static void assertFailedRpcResult(RpcResult<CompositeNode> rpcResult, ErrorSeverity severity,
 147             ErrorType errorType, String tag, String message, String applicationTag, String info,
 148             String causeMsg) {
 149
 150         assertNotNull("RpcResult was null", rpcResult);
 151         assertEquals("isSuccessful", false, rpcResult.isSuccessful());
 152         Collection<RpcError> rpcErrors = rpcResult.getErrors();
 153         assertEquals("RpcErrors count", 1, rpcErrors.size());
 154         assertRpcErrorEquals(rpcErrors.iterator().next(), severity, errorType, tag, message,
 155                 applicationTag, info, causeMsg);
 156     }
 157
 158     static void assertSuccessfulRpcResult(RpcResult<CompositeNode> rpcResult,
 159             CompositeNode expOutput) {
 160
 161         assertNotNull("RpcResult was null", rpcResult);
 162         assertEquals("isSuccessful", true, rpcResult.isSuccessful());
 163         assertCompositeNodeEquals(expOutput, rpcResult.getResult());
 164     }
 165
 166     static class TestException extends Exception {
 167         private static final long serialVersionUID = 1L;
 168
 169         static final String MESSAGE = "mock error";
 170
 171         TestException() {
 172             super(MESSAGE);
 173         }
 174     }
 175 }