More defensive RPC handling in DOM Broker
[controller.git] / opendaylight / md-sal / sal-binding-dom-it / src / test / java / org / opendaylight / controller / sal / binding / test / connect / dom / CrossBrokerRpcTest.java
1 /*
2  * Copyright (c) 2013 Cisco 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.sal.binding.test.connect.dom;
9
10 import static junit.framework.Assert.assertEquals;
11 import static junit.framework.Assert.assertNotNull;
12 import static junit.framework.Assert.assertNotSame;
13 import static junit.framework.Assert.assertTrue;
14
15 import java.math.BigInteger;
16 import java.util.Collections;
17 import java.util.Set;
18 import java.util.concurrent.Future;
19
20 import org.junit.After;
21 import org.junit.Before;
22 import org.junit.Test;
23 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
24 import org.opendaylight.controller.sal.binding.test.util.BindingBrokerTestFactory;
25 import org.opendaylight.controller.sal.binding.test.util.BindingTestContext;
26 import org.opendaylight.controller.sal.common.util.Rpcs;
27 import org.opendaylight.controller.sal.core.api.RpcImplementation;
28 import org.opendaylight.controller.sal.core.api.RpcProvisionRegistry;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutputBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeFlowRemoved;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
42 import org.opendaylight.yangtools.yang.binding.DataObject;
43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
44 import org.opendaylight.yangtools.yang.common.QName;
45 import org.opendaylight.yangtools.yang.common.RpcError;
46 import org.opendaylight.yangtools.yang.common.RpcResult;
47 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
48 import org.opendaylight.yangtools.yang.data.impl.CompositeNodeTOImpl;
49
50 import com.google.common.collect.ImmutableList;
51 import com.google.common.collect.ImmutableSet;
52 import com.google.common.util.concurrent.Futures;
53 import com.google.common.util.concurrent.MoreExecutors;
54
55 public class CrossBrokerRpcTest {
56
57     protected RpcProviderRegistry baRpcRegistry;
58     protected RpcProvisionRegistry biRpcRegistry;
59     private BindingTestContext testContext;
60     private RpcImplementation biRpcInvoker;
61     private MessageCapturingFlowService flowService;
62
63     public static final NodeId NODE_A = new NodeId("a");
64     public static final NodeId NODE_B = new NodeId("b");
65     public static final NodeId NODE_C = new NodeId("c");
66     public static final NodeId NODE_D = new NodeId("d");
67     
68     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME, "id");
69     private static final QName ADD_FLOW_QNAME = QName.create(NodeFlowRemoved.QNAME, "add-flow");
70
71     public static final InstanceIdentifier<Node> BA_NODE_A_ID = createBANodeIdentifier(NODE_A);
72     public static final InstanceIdentifier<Node> BA_NODE_B_ID = createBANodeIdentifier(NODE_B);
73     public static final InstanceIdentifier<Node> BA_NODE_C_ID = createBANodeIdentifier(NODE_C);
74     public static final InstanceIdentifier<Node> BA_NODE_D_ID = createBANodeIdentifier(NODE_D);
75
76     public static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier BI_NODE_A_ID = createBINodeIdentifier(NODE_A);
77     public static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier BI_NODE_B_ID = createBINodeIdentifier(NODE_B);
78     public static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier BI_NODE_C_ID = createBINodeIdentifier(NODE_C);
79     public static final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier BI_NODE_D_ID = createBINodeIdentifier(NODE_D);
80
81     
82
83     @Before
84     public void setup() {
85         BindingBrokerTestFactory testFactory = new BindingBrokerTestFactory();
86         testFactory.setExecutor(MoreExecutors.sameThreadExecutor());
87         testFactory.setStartWithParsedSchema(true);
88         testContext = testFactory.getTestContext();
89
90         testContext.start();
91         baRpcRegistry = testContext.getBindingRpcRegistry();
92         biRpcRegistry = testContext.getDomRpcRegistry();
93         biRpcInvoker = testContext.getDomRpcInvoker();
94         assertNotNull(baRpcRegistry);
95         assertNotNull(biRpcRegistry);
96
97         flowService = MessageCapturingFlowService.create(baRpcRegistry);
98
99     }
100
101     @Test
102     public void bindingRoutedRpcProvider_DomInvokerTest() {
103
104         flowService//
105                 .registerPath(NodeContext.class, BA_NODE_A_ID) //
106                 .registerPath(NodeContext.class, BA_NODE_B_ID) //
107                 .setAddFlowResult(addFlowResult(true, 10));
108
109         SalFlowService baFlowInvoker = baRpcRegistry.getRpcService(SalFlowService.class);
110         assertNotSame(flowService, baFlowInvoker);
111
112         AddFlowInput addFlowA = addFlow(BA_NODE_A_ID) //
113                 .setPriority(100).setBarrier(true).build();
114
115         CompositeNode addFlowDom = toDomRpc(ADD_FLOW_QNAME, addFlowA);
116         assertNotNull(addFlowDom);
117         RpcResult<CompositeNode> domResult = biRpcInvoker.invokeRpc(ADD_FLOW_QNAME, addFlowDom);
118         assertNotNull(domResult);
119         assertTrue("DOM result is successful.", domResult.isSuccessful());
120         assertTrue("Bidning Add Flow RPC was captured.", flowService.getReceivedAddFlows().containsKey(BA_NODE_A_ID));
121         assertEquals(addFlowA, flowService.getReceivedAddFlows().get(BA_NODE_A_ID).iterator().next());
122     }
123
124     @Test
125     public void bindingRpcInvoker_DomRoutedProviderTest() throws Exception {
126         AddFlowOutputBuilder builder = new AddFlowOutputBuilder();
127         builder.setTransactionId(new TransactionId(BigInteger.valueOf(10)));
128         final AddFlowOutput output = builder.build();
129         org.opendaylight.controller.sal.core.api.Broker.RoutedRpcRegistration registration = biRpcRegistry.addRoutedRpcImplementation(ADD_FLOW_QNAME, new RpcImplementation() {
130             @Override
131             public RpcResult<CompositeNode> invokeRpc(QName rpc, CompositeNode input) {
132                 CompositeNode result = testContext.getBindingToDomMappingService().toDataDom(output);
133                 return Rpcs.getRpcResult(true, result, ImmutableList.<RpcError>of());
134             }
135
136             @Override
137             public Set<QName> getSupportedRpcs() {
138                 return ImmutableSet.of(ADD_FLOW_QNAME);
139             }
140         });
141         registration.registerPath(NodeContext.QNAME, BI_NODE_C_ID);
142         
143         SalFlowService baFlowInvoker = baRpcRegistry.getRpcService(SalFlowService.class);
144         Future<RpcResult<AddFlowOutput>> baResult = baFlowInvoker.addFlow(addFlow(BA_NODE_C_ID).setPriority(500).build());
145         assertNotNull(baResult);
146         assertEquals(output,baResult.get().getResult());
147     }
148
149     private CompositeNode toDomRpcInput(DataObject addFlowA) {
150         return testContext.getBindingToDomMappingService().toDataDom(addFlowA);
151     }
152
153     @After
154     public void teardown() throws Exception {
155         testContext.close();
156     }
157
158     private static InstanceIdentifier<Node> createBANodeIdentifier(NodeId node) {
159         return InstanceIdentifier.builder(Nodes.class).child(Node.class, new NodeKey(node)).toInstance();
160     }
161
162     private static org.opendaylight.yangtools.yang.data.api.InstanceIdentifier createBINodeIdentifier(NodeId node) {
163         return org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.builder().node(Nodes.QNAME)
164                 .nodeWithKey(Node.QNAME, NODE_ID_QNAME, node.getValue()).toInstance();
165     }
166
167     private Future<RpcResult<AddFlowOutput>> addFlowResult(boolean success, long xid) {
168         AddFlowOutput output = new AddFlowOutputBuilder() //
169                 .setTransactionId(new TransactionId(BigInteger.valueOf(xid))).build();
170         RpcResult<AddFlowOutput> result = Rpcs.getRpcResult(success, output, ImmutableList.<RpcError> of());
171         return Futures.immediateFuture(result);
172     }
173
174     private static AddFlowInputBuilder addFlow(InstanceIdentifier<Node> nodeId) {
175         AddFlowInputBuilder builder = new AddFlowInputBuilder();
176         builder.setNode(new NodeRef(nodeId));
177         return builder;
178     }
179
180     private CompositeNode toDomRpc(QName rpcName, AddFlowInput addFlowA) {
181         return new CompositeNodeTOImpl(rpcName, null,
182                 Collections.<org.opendaylight.yangtools.yang.data.api.Node<?>> singletonList(toDomRpcInput(addFlowA)));
183     }
184 }