2 * Copyright (c) 2014, 2015 Cisco 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
9 package org.opendaylight.controller.remote.rpc.registry;
11 import akka.actor.ActorRef;
12 import akka.actor.ActorSystem;
13 import akka.actor.Address;
14 import akka.actor.Props;
15 import akka.japi.Pair;
16 import akka.testkit.JavaTestKit;
17 import com.google.common.util.concurrent.Uninterruptibles;
18 import com.typesafe.config.Config;
19 import com.typesafe.config.ConfigFactory;
21 import java.net.URISyntaxException;
22 import java.util.ArrayList;
23 import java.util.Arrays;
24 import java.util.Collections;
25 import java.util.List;
27 import java.util.concurrent.TimeUnit;
28 import org.junit.After;
29 import org.junit.AfterClass;
30 import org.junit.Assert;
31 import org.junit.Before;
32 import org.junit.BeforeClass;
33 import org.junit.Test;
34 import org.opendaylight.controller.cluster.common.actor.AkkaConfigurationReader;
35 import org.opendaylight.controller.remote.rpc.RemoteRpcProviderConfig;
36 import org.opendaylight.controller.remote.rpc.RouteIdentifierImpl;
37 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.AddOrUpdateRoutes;
38 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.FindRouters;
39 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.FindRoutersReply;
40 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.RemoveRoutes;
41 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.SetLocalRouter;
42 import org.opendaylight.controller.remote.rpc.registry.gossip.Bucket;
43 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBuckets;
44 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetAllBucketsReply;
45 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketVersions;
46 import org.opendaylight.controller.remote.rpc.registry.gossip.Messages.BucketStoreMessages.GetBucketVersionsReply;
47 import org.opendaylight.controller.sal.connector.api.RpcRouter;
48 import org.opendaylight.controller.sal.connector.api.RpcRouter.RouteIdentifier;
49 import org.opendaylight.yangtools.yang.common.QName;
50 import scala.concurrent.duration.Duration;
51 import scala.concurrent.duration.FiniteDuration;
53 public class RpcRegistryTest {
55 private static ActorSystem node1;
56 private static ActorSystem node2;
57 private static ActorSystem node3;
59 private ActorRef registry1;
60 private ActorRef registry2;
61 private ActorRef registry3;
63 private int routeIdCounter = 1;
66 public static void staticSetup() throws InterruptedException {
67 AkkaConfigurationReader reader = new AkkaConfigurationReader() {
69 public Config read() {
70 return ConfigFactory.load();
74 RemoteRpcProviderConfig config1 = new RemoteRpcProviderConfig.Builder("memberA").withConfigReader(reader).build();
75 RemoteRpcProviderConfig config2 = new RemoteRpcProviderConfig.Builder("memberB").withConfigReader(reader).build();
76 RemoteRpcProviderConfig config3 = new RemoteRpcProviderConfig.Builder("memberC").withConfigReader(reader).build();
77 node1 = ActorSystem.create("opendaylight-rpc", config1.get());
78 node2 = ActorSystem.create("opendaylight-rpc", config2.get());
79 node3 = ActorSystem.create("opendaylight-rpc", config3.get());
83 public static void staticTeardown() {
84 JavaTestKit.shutdownActorSystem(node1);
85 JavaTestKit.shutdownActorSystem(node2);
86 JavaTestKit.shutdownActorSystem(node3);
91 registry1 = node1.actorOf(Props.create(RpcRegistry.class, config(node1)));
92 registry2 = node2.actorOf(Props.create(RpcRegistry.class, config(node2)));
93 registry3 = node3.actorOf(Props.create(RpcRegistry.class, config(node3)));
96 private RemoteRpcProviderConfig config(ActorSystem node){
97 return new RemoteRpcProviderConfig(node.settings().config());
101 public void teardown() {
102 if (registry1 != null) {
103 node1.stop(registry1);
105 if (registry2 != null) {
106 node2.stop(registry2);
108 if (registry3 != null) {
109 node3.stop(registry3);
114 * One node cluster. 1. Register rpc, ensure router can be found 2. Then remove rpc, ensure its
117 * @throws URISyntaxException
118 * @throws InterruptedException
121 public void testAddRemoveRpcOnSameNode() throws Exception {
123 System.out.println("testAddRemoveRpcOnSameNode starting");
125 final JavaTestKit mockBroker = new JavaTestKit(node1);
127 Address nodeAddress = node1.provider().getDefaultAddress();
130 registry1.tell(new SetLocalRouter(mockBroker.getRef()), mockBroker.getRef());
132 List<RpcRouter.RouteIdentifier<?, ?, ?>> addedRouteIds = createRouteIds();
134 registry1.tell(new AddOrUpdateRoutes(addedRouteIds), mockBroker.getRef());
136 // Bucket store should get an update bucket message. Updated bucket contains added rpc.
138 Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry1, mockBroker, nodeAddress);
139 verifyBucket(buckets.get(nodeAddress), addedRouteIds);
141 Map<Address, Long> versions = retrieveVersions(registry1, mockBroker);
142 Assert.assertEquals("Version for bucket " + nodeAddress, buckets.get(nodeAddress).getVersion(),
143 versions.get(nodeAddress));
146 registry1.tell(new RemoveRoutes(addedRouteIds), mockBroker.getRef());
148 // Bucket store should get an update bucket message. Rpc is removed in the updated bucket
150 verifyEmptyBucket(mockBroker, registry1, nodeAddress);
152 System.out.println("testAddRemoveRpcOnSameNode ending");
157 * Three node cluster. 1. Register rpc on 1 node, ensure 2nd node gets updated 2. Remove rpc on
158 * 1 node, ensure 2nd node gets updated
160 * @throws URISyntaxException
161 * @throws InterruptedException
164 public void testRpcAddRemoveInCluster() throws Exception {
166 System.out.println("testRpcAddRemoveInCluster starting");
168 final JavaTestKit mockBroker1 = new JavaTestKit(node1);
169 final JavaTestKit mockBroker2 = new JavaTestKit(node2);
171 List<RpcRouter.RouteIdentifier<?, ?, ?>> addedRouteIds = createRouteIds();
173 Address node1Address = node1.provider().getDefaultAddress();
176 registry1.tell(new SetLocalRouter(mockBroker1.getRef()), mockBroker1.getRef());
177 registry1.tell(new AddOrUpdateRoutes(addedRouteIds), mockBroker1.getRef());
179 // Bucket store on node2 should get a message to update its local copy of remote buckets
181 Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry2, mockBroker2, node1Address);
182 verifyBucket(buckets.get(node1Address), addedRouteIds);
185 registry1.tell(new RemoveRoutes(addedRouteIds), mockBroker1.getRef());
187 // Bucket store on node2 should get a message to update its local copy of remote buckets.
188 // Wait for the bucket for node1 to be empty.
190 verifyEmptyBucket(mockBroker2, registry2, node1Address);
192 System.out.println("testRpcAddRemoveInCluster ending");
195 private void verifyEmptyBucket(JavaTestKit testKit, ActorRef registry, Address address)
196 throws AssertionError {
197 Map<Address, Bucket<RoutingTable>> buckets;
200 buckets = retrieveBuckets(registry1, testKit, address);
203 verifyBucket(buckets.get(address), Collections.<RouteIdentifier<?, ?, ?>>emptyList());
205 } catch (AssertionError e) {
211 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
216 * Three node cluster. Register rpc on 2 nodes. Ensure 3rd gets updated.
221 public void testRpcAddedOnMultiNodes() throws Exception {
223 final JavaTestKit mockBroker1 = new JavaTestKit(node1);
224 final JavaTestKit mockBroker2 = new JavaTestKit(node2);
225 final JavaTestKit mockBroker3 = new JavaTestKit(node3);
227 registry3.tell(new SetLocalRouter(mockBroker3.getRef()), mockBroker3.getRef());
230 List<RpcRouter.RouteIdentifier<?, ?, ?>> addedRouteIds1 = createRouteIds();
231 registry1.tell(new SetLocalRouter(mockBroker1.getRef()), mockBroker1.getRef());
232 registry1.tell(new AddOrUpdateRoutes(addedRouteIds1), mockBroker1.getRef());
235 List<RpcRouter.RouteIdentifier<?, ?, ?>> addedRouteIds2 = createRouteIds();
236 registry2.tell(new SetLocalRouter(mockBroker2.getRef()), mockBroker2.getRef());
237 registry2.tell(new AddOrUpdateRoutes(addedRouteIds2), mockBroker2.getRef());
239 Address node1Address = node1.provider().getDefaultAddress();
240 Address node2Address = node2.provider().getDefaultAddress();
242 Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry3, mockBroker3, node1Address,
245 verifyBucket(buckets.get(node1Address), addedRouteIds1);
246 verifyBucket(buckets.get(node2Address), addedRouteIds2);
248 Map<Address, Long> versions = retrieveVersions(registry3, mockBroker3);
249 Assert.assertEquals("Version for bucket " + node1Address, buckets.get(node1Address).getVersion(),
250 versions.get(node1Address));
251 Assert.assertEquals("Version for bucket " + node2Address, buckets.get(node2Address).getVersion(),
252 versions.get(node2Address));
254 RouteIdentifier<?, ?, ?> routeID = addedRouteIds1.get(0);
255 registry3.tell(new FindRouters(routeID), mockBroker3.getRef());
257 FindRoutersReply reply = mockBroker3.expectMsgClass(Duration.create(3, TimeUnit.SECONDS),
258 FindRoutersReply.class);
260 List<Pair<ActorRef, Long>> respList = reply.getRouterWithUpdateTime();
261 Assert.assertEquals("getRouterWithUpdateTime size", 1, respList.size());
263 respList.get(0).first().tell("hello", ActorRef.noSender());
264 mockBroker1.expectMsgEquals(Duration.create(3, TimeUnit.SECONDS), "hello");
267 private Map<Address, Long> retrieveVersions(ActorRef bucketStore, JavaTestKit testKit) {
268 bucketStore.tell(new GetBucketVersions(), testKit.getRef());
269 GetBucketVersionsReply reply = testKit.expectMsgClass(Duration.create(3, TimeUnit.SECONDS),
270 GetBucketVersionsReply.class);
271 return reply.getVersions();
274 private void verifyBucket(Bucket<RoutingTable> bucket, List<RouteIdentifier<?, ?, ?>> expRouteIds) {
275 RoutingTable table = bucket.getData();
276 Assert.assertNotNull("Bucket RoutingTable is null", table);
277 for(RouteIdentifier<?, ?, ?> r: expRouteIds) {
278 if(!table.contains(r)) {
279 Assert.fail("RoutingTable does not contain " + r + ". Actual: " + table);
283 Assert.assertEquals("RoutingTable size", expRouteIds.size(), table.size());
286 private Map<Address, Bucket<RoutingTable>> retrieveBuckets(ActorRef bucketStore, JavaTestKit testKit,
287 Address... addresses) {
290 bucketStore.tell(new GetAllBuckets(), testKit.getRef());
291 @SuppressWarnings("unchecked")
292 GetAllBucketsReply<RoutingTable> reply = testKit.expectMsgClass(Duration.create(3, TimeUnit.SECONDS),
293 GetAllBucketsReply.class);
295 Map<Address, Bucket<RoutingTable>> buckets = reply.getBuckets();
296 boolean foundAll = true;
297 for(Address addr: addresses) {
298 Bucket<RoutingTable> bucket = buckets.get(addr);
310 Assert.fail("Missing expected buckets for addresses: " + Arrays.toString(addresses)
311 + ", Actual: " + buckets);
314 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
319 public void testAddRoutesConcurrency() throws Exception {
320 final JavaTestKit testKit = new JavaTestKit(node1);
322 registry1.tell(new SetLocalRouter(testKit.getRef()), ActorRef.noSender());
324 final int nRoutes = 500;
325 final RouteIdentifier<?, ?, ?>[] added = new RouteIdentifier<?, ?, ?>[nRoutes];
326 for(int i = 0; i < nRoutes; i++) {
327 final RouteIdentifierImpl routeId = new RouteIdentifierImpl(null,
328 new QName(new URI("/mockrpc"), "type" + i), null);
331 //Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
332 registry1.tell(new AddOrUpdateRoutes(Arrays.<RouteIdentifier<?, ?, ?>>asList(routeId)),
333 ActorRef.noSender());
336 GetAllBuckets getAllBuckets = new GetAllBuckets();
337 FiniteDuration duration = Duration.create(3, TimeUnit.SECONDS);
340 registry1.tell(getAllBuckets, testKit.getRef());
341 @SuppressWarnings("unchecked")
342 GetAllBucketsReply<RoutingTable> reply = testKit.expectMsgClass(duration, GetAllBucketsReply.class);
344 Bucket<RoutingTable> localBucket = reply.getBuckets().values().iterator().next();
345 RoutingTable table = localBucket.getData();
346 if(table != null && table.size() == nRoutes) {
347 for(RouteIdentifier<?, ?, ?> r: added) {
348 Assert.assertEquals("RoutingTable contains " + r, true, table.contains(r));
355 Assert.fail("Expected # routes: " + nRoutes + ", Actual: " + table.size());
358 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
362 private List<RpcRouter.RouteIdentifier<?, ?, ?>> createRouteIds() throws URISyntaxException {
363 QName type = new QName(new URI("/mockrpc"), "mockrpc" + routeIdCounter++);
364 List<RpcRouter.RouteIdentifier<?, ?, ?>> routeIds = new ArrayList<>();
365 routeIds.add(new RouteIdentifierImpl(null, type, null));