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
8 package org.opendaylight.controller.remote.rpc.registry;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertTrue;
13 import static org.junit.Assert.fail;
14 import static org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreAccess.Singletons.GET_ALL_BUCKETS;
15 import static org.opendaylight.controller.remote.rpc.registry.gossip.BucketStoreAccess.Singletons.GET_BUCKET_VERSIONS;
17 import akka.actor.ActorRef;
18 import akka.actor.ActorSystem;
19 import akka.actor.Address;
20 import akka.cluster.Cluster;
21 import akka.cluster.ClusterEvent.CurrentClusterState;
22 import akka.cluster.Member;
23 import akka.cluster.MemberStatus;
24 import akka.cluster.UniqueAddress;
25 import akka.testkit.javadsl.TestKit;
26 import com.google.common.base.Stopwatch;
27 import com.google.common.collect.Sets;
28 import com.google.common.util.concurrent.Uninterruptibles;
29 import com.typesafe.config.ConfigFactory;
30 import java.time.Duration;
31 import java.util.ArrayList;
32 import java.util.Arrays;
33 import java.util.Collection;
34 import java.util.Collections;
35 import java.util.List;
37 import java.util.Optional;
39 import java.util.concurrent.TimeUnit;
40 import org.junit.After;
41 import org.junit.AfterClass;
42 import org.junit.Before;
43 import org.junit.BeforeClass;
44 import org.junit.Test;
45 import org.opendaylight.controller.cluster.common.actor.AkkaConfigurationReader;
46 import org.opendaylight.controller.remote.rpc.RemoteOpsProviderConfig;
47 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.AddOrUpdateRoutes;
48 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.RemoveRoutes;
49 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.Messages.UpdateRemoteEndpoints;
50 import org.opendaylight.controller.remote.rpc.registry.RpcRegistry.RemoteRpcEndpoint;
51 import org.opendaylight.controller.remote.rpc.registry.gossip.Bucket;
52 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
53 import org.opendaylight.yangtools.yang.common.QName;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
57 public class RpcRegistryTest {
58 private static final Logger LOG = LoggerFactory.getLogger(RpcRegistryTest.class);
60 private static ActorSystem node1;
61 private static ActorSystem node2;
62 private static ActorSystem node3;
64 private TestKit invoker1;
65 private TestKit invoker2;
66 private TestKit invoker3;
67 private TestKit registrar1;
68 private TestKit registrar2;
69 private TestKit registrar3;
70 private ActorRef registry1;
71 private ActorRef registry2;
72 private ActorRef registry3;
74 private int routeIdCounter = 1;
77 public static void staticSetup() {
78 AkkaConfigurationReader reader = ConfigFactory::load;
80 RemoteOpsProviderConfig config1 = new RemoteOpsProviderConfig.Builder("memberA").gossipTickInterval("200ms")
81 .withConfigReader(reader).build();
82 RemoteOpsProviderConfig config2 = new RemoteOpsProviderConfig.Builder("memberB").gossipTickInterval("200ms")
83 .withConfigReader(reader).build();
84 RemoteOpsProviderConfig config3 = new RemoteOpsProviderConfig.Builder("memberC").gossipTickInterval("200ms")
85 .withConfigReader(reader).build();
86 node1 = ActorSystem.create("opendaylight-rpc", config1.get());
87 node2 = ActorSystem.create("opendaylight-rpc", config2.get());
88 node3 = ActorSystem.create("opendaylight-rpc", config3.get());
90 waitForMembersUp(node1, Cluster.get(node2).selfUniqueAddress(), Cluster.get(node3).selfUniqueAddress());
91 waitForMembersUp(node2, Cluster.get(node1).selfUniqueAddress(), Cluster.get(node3).selfUniqueAddress());
94 static void waitForMembersUp(final ActorSystem node, final UniqueAddress... addresses) {
95 Set<UniqueAddress> otherMembersSet = Sets.newHashSet(addresses);
96 Stopwatch sw = Stopwatch.createStarted();
97 while (sw.elapsed(TimeUnit.SECONDS) <= 10) {
98 CurrentClusterState state = Cluster.get(node).state();
99 for (Member m : state.getMembers()) {
100 if (m.status() == MemberStatus.up() && otherMembersSet.remove(m.uniqueAddress())
101 && otherMembersSet.isEmpty()) {
106 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
109 fail("Member(s) " + otherMembersSet + " are not Up");
113 public static void staticTeardown() {
114 TestKit.shutdownActorSystem(node1);
115 TestKit.shutdownActorSystem(node2);
116 TestKit.shutdownActorSystem(node3);
120 public void setup() {
121 invoker1 = new TestKit(node1);
122 registrar1 = new TestKit(node1);
123 registry1 = node1.actorOf(RpcRegistry.props(config(node1), invoker1.getRef(), registrar1.getRef()));
124 invoker2 = new TestKit(node2);
125 registrar2 = new TestKit(node2);
126 registry2 = node2.actorOf(RpcRegistry.props(config(node2), invoker2.getRef(), registrar2.getRef()));
127 invoker3 = new TestKit(node3);
128 registrar3 = new TestKit(node3);
129 registry3 = node3.actorOf(RpcRegistry.props(config(node3), invoker3.getRef(), registrar3.getRef()));
132 private static RemoteOpsProviderConfig config(final ActorSystem node) {
133 return new RemoteOpsProviderConfig(node.settings().config());
137 public void teardown() {
138 if (registry1 != null) {
139 node1.stop(registry1);
141 if (registry2 != null) {
142 node2.stop(registry2);
144 if (registry3 != null) {
145 node3.stop(registry3);
148 if (invoker1 != null) {
149 node1.stop(invoker1.getRef());
151 if (invoker2 != null) {
152 node2.stop(invoker2.getRef());
154 if (invoker3 != null) {
155 node3.stop(invoker3.getRef());
158 if (registrar1 != null) {
159 node1.stop(registrar1.getRef());
161 if (registrar2 != null) {
162 node2.stop(registrar2.getRef());
164 if (registrar3 != null) {
165 node3.stop(registrar3.getRef());
170 * One node cluster. 1. Register rpc, ensure router can be found 2. Then remove rpc, ensure its
174 public void testAddRemoveRpcOnSameNode() {
175 LOG.info("testAddRemoveRpcOnSameNode starting");
177 Address nodeAddress = node1.provider().getDefaultAddress();
181 List<DOMRpcIdentifier> addedRouteIds = createRouteIds();
183 registry1.tell(new AddOrUpdateRoutes(addedRouteIds), ActorRef.noSender());
185 // Bucket store should get an update bucket message. Updated bucket contains added rpc.
186 final TestKit testKit = new TestKit(node1);
188 Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry1, testKit, nodeAddress);
189 verifyBucket(buckets.get(nodeAddress), addedRouteIds);
191 Map<Address, Long> versions = retrieveVersions(registry1, testKit);
192 assertEquals("Version for bucket " + nodeAddress, (Long) buckets.get(nodeAddress).getVersion(),
193 versions.get(nodeAddress));
196 registry1.tell(new RemoveRoutes(addedRouteIds), ActorRef.noSender());
198 // Bucket store should get an update bucket message. Rpc is removed in the updated bucket
200 verifyEmptyBucket(testKit, registry1, nodeAddress);
202 LOG.info("testAddRemoveRpcOnSameNode ending");
207 * Three node cluster. 1. Register rpc on 1 node, ensure 2nd node gets updated 2. Remove rpc on
208 * 1 node, ensure 2nd node gets updated
211 public void testRpcAddRemoveInCluster() {
213 LOG.info("testRpcAddRemoveInCluster starting");
215 List<DOMRpcIdentifier> addedRouteIds = createRouteIds();
217 Address node1Address = node1.provider().getDefaultAddress();
220 registry1.tell(new AddOrUpdateRoutes(addedRouteIds), ActorRef.noSender());
222 // Bucket store on node2 should get a message to update its local copy of remote buckets
223 final TestKit testKit = new TestKit(node2);
225 Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry2, testKit, node1Address);
226 verifyBucket(buckets.get(node1Address), addedRouteIds);
229 registry1.tell(new RemoveRoutes(addedRouteIds), ActorRef.noSender());
231 // Bucket store on node2 should get a message to update its local copy of remote buckets.
232 // Wait for the bucket for node1 to be empty.
234 verifyEmptyBucket(testKit, registry2, node1Address);
236 LOG.info("testRpcAddRemoveInCluster ending");
239 private void verifyEmptyBucket(final TestKit testKit, final ActorRef registry, final Address address)
240 throws AssertionError {
241 Map<Address, Bucket<RoutingTable>> buckets;
244 buckets = retrieveBuckets(registry1, testKit, address);
247 verifyBucket(buckets.get(address), Collections.emptyList());
249 } catch (AssertionError e) {
250 if (++numTries >= 50) {
255 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
260 * Three node cluster. Register rpc on 2 nodes. Ensure 3rd gets updated.
263 public void testRpcAddedOnMultiNodes() {
264 final TestKit testKit = new TestKit(node3);
267 List<DOMRpcIdentifier> addedRouteIds1 = createRouteIds();
268 registry1.tell(new AddOrUpdateRoutes(addedRouteIds1), ActorRef.noSender());
270 final UpdateRemoteEndpoints req1 = registrar3.expectMsgClass(Duration.ofSeconds(3),
271 UpdateRemoteEndpoints.class);
274 List<DOMRpcIdentifier> addedRouteIds2 = createRouteIds();
275 registry2.tell(new AddOrUpdateRoutes(addedRouteIds2), ActorRef.noSender());
277 final UpdateRemoteEndpoints req2 = registrar3.expectMsgClass(Duration.ofSeconds(3),
278 UpdateRemoteEndpoints.class);
279 Address node2Address = node2.provider().getDefaultAddress();
280 Address node1Address = node1.provider().getDefaultAddress();
282 Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry3, testKit, node1Address,
285 verifyBucket(buckets.get(node1Address), addedRouteIds1);
286 verifyBucket(buckets.get(node2Address), addedRouteIds2);
288 Map<Address, Long> versions = retrieveVersions(registry3, testKit);
289 assertEquals("Version for bucket " + node1Address, (Long) buckets.get(node1Address).getVersion(),
290 versions.get(node1Address));
291 assertEquals("Version for bucket " + node2Address, (Long) buckets.get(node2Address).getVersion(),
292 versions.get(node2Address));
294 assertEndpoints(req1, node1Address, invoker1);
295 assertEndpoints(req2, node2Address, invoker2);
299 private static void assertEndpoints(final UpdateRemoteEndpoints msg, final Address address, final TestKit invoker) {
300 final Map<Address, Optional<RemoteRpcEndpoint>> endpoints = msg.getRpcEndpoints();
301 assertEquals(1, endpoints.size());
303 final Optional<RemoteRpcEndpoint> maybeEndpoint = endpoints.get(address);
304 assertNotNull(maybeEndpoint);
305 assertTrue(maybeEndpoint.isPresent());
307 final RemoteRpcEndpoint endpoint = maybeEndpoint.get();
308 final ActorRef router = endpoint.getRouter();
309 assertNotNull(router);
311 router.tell("hello", ActorRef.noSender());
312 final String s = invoker.expectMsgClass(Duration.ofSeconds(3), String.class);
313 assertEquals("hello", s);
316 private static Map<Address, Long> retrieveVersions(final ActorRef bucketStore, final TestKit testKit) {
317 bucketStore.tell(GET_BUCKET_VERSIONS, testKit.getRef());
318 @SuppressWarnings("unchecked")
319 final Map<Address, Long> reply = testKit.expectMsgClass(Duration.ofSeconds(3), Map.class);
323 private static void verifyBucket(final Bucket<RoutingTable> bucket, final List<DOMRpcIdentifier> expRouteIds) {
324 RoutingTable table = bucket.getData();
325 assertNotNull("Bucket RoutingTable is null", table);
326 for (DOMRpcIdentifier r : expRouteIds) {
327 if (!table.contains(r)) {
328 fail("RoutingTable does not contain " + r + ". Actual: " + table);
332 assertEquals("RoutingTable size", expRouteIds.size(), table.size());
335 private static Map<Address, Bucket<RoutingTable>> retrieveBuckets(final ActorRef bucketStore,
336 final TestKit testKit, final Address... addresses) {
339 bucketStore.tell(GET_ALL_BUCKETS, testKit.getRef());
340 @SuppressWarnings("unchecked")
341 Map<Address, Bucket<RoutingTable>> buckets = testKit.expectMsgClass(Duration.ofSeconds(3), Map.class);
343 boolean foundAll = true;
344 for (Address addr : addresses) {
345 Bucket<RoutingTable> bucket = buckets.get(addr);
346 if (bucket == null) {
356 if (++numTries >= 50) {
357 fail("Missing expected buckets for addresses: " + Arrays.toString(addresses) + ", Actual: " + buckets);
360 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
365 public void testAddRoutesConcurrency() {
366 final TestKit testKit = new TestKit(node1);
368 final int nRoutes = 500;
369 final Collection<DOMRpcIdentifier> added = new ArrayList<>(nRoutes);
370 for (int i = 0; i < nRoutes; i++) {
371 final DOMRpcIdentifier routeId = DOMRpcIdentifier.create(QName.create("/mockrpc", "type" + i));
374 //Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
375 registry1.tell(new AddOrUpdateRoutes(Arrays.asList(routeId)),
376 ActorRef.noSender());
381 registry1.tell(GET_ALL_BUCKETS, testKit.getRef());
382 @SuppressWarnings("unchecked")
383 Map<Address, Bucket<RoutingTable>> buckets = testKit.expectMsgClass(Duration.ofSeconds(3), Map.class);
385 Bucket<RoutingTable> localBucket = buckets.values().iterator().next();
386 RoutingTable table = localBucket.getData();
387 if (table != null && table.size() == nRoutes) {
388 for (DOMRpcIdentifier r : added) {
389 assertTrue("RoutingTable contains " + r, table.contains(r));
395 if (++numTries >= 50) {
396 fail("Expected # routes: " + nRoutes + ", Actual: " + table.size());
399 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
403 private List<DOMRpcIdentifier> createRouteIds() {
404 QName type = QName.create("/mockrpc", "mockrpc" + routeIdCounter++);
405 List<DOMRpcIdentifier> routeIds = new ArrayList<>(1);
406 routeIds.add(DOMRpcIdentifier.create(type));