opendaylight/md-sal/sal-remoterpc-connector/src/test/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistryTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 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.remote.rpc.registry;
   9
  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;
  16
  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;
  36 import java.util.Map;
  37 import java.util.Optional;
  38 import java.util.Set;
  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;
  56
  57 public class RpcRegistryTest {
  58     private static final Logger LOG = LoggerFactory.getLogger(RpcRegistryTest.class);
  59
  60     private static ActorSystem node1;
  61     private static ActorSystem node2;
  62     private static ActorSystem node3;
  63
  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;
  73
  74     private int routeIdCounter = 1;
  75
  76     @BeforeClass
  77     public static void staticSetup() {
  78         AkkaConfigurationReader reader = ConfigFactory::load;
  79
  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());
  89
  90         waitForMembersUp(node1, Cluster.get(node2).selfUniqueAddress(), Cluster.get(node3).selfUniqueAddress());
  91         waitForMembersUp(node2, Cluster.get(node1).selfUniqueAddress(), Cluster.get(node3).selfUniqueAddress());
  92     }
  93
  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()) {
 102                     return;
 103                 }
 104             }
 105
 106             Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 107         }
 108
 109         fail("Member(s) " + otherMembersSet + " are not Up");
 110     }
 111
 112     @AfterClass
 113     public static void staticTeardown() {
 114         TestKit.shutdownActorSystem(node1);
 115         TestKit.shutdownActorSystem(node2);
 116         TestKit.shutdownActorSystem(node3);
 117     }
 118
 119     @Before
 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()));
 130     }
 131
 132     private static RemoteOpsProviderConfig config(final ActorSystem node) {
 133         return new RemoteOpsProviderConfig(node.settings().config());
 134     }
 135
 136     @After
 137     public void teardown() {
 138         if (registry1 != null) {
 139             node1.stop(registry1);
 140         }
 141         if (registry2 != null) {
 142             node2.stop(registry2);
 143         }
 144         if (registry3 != null) {
 145             node3.stop(registry3);
 146         }
 147
 148         if (invoker1 != null) {
 149             node1.stop(invoker1.getRef());
 150         }
 151         if (invoker2 != null) {
 152             node2.stop(invoker2.getRef());
 153         }
 154         if (invoker3 != null) {
 155             node3.stop(invoker3.getRef());
 156         }
 157
 158         if (registrar1 != null) {
 159             node1.stop(registrar1.getRef());
 160         }
 161         if (registrar2 != null) {
 162             node2.stop(registrar2.getRef());
 163         }
 164         if (registrar3 != null) {
 165             node3.stop(registrar3.getRef());
 166         }
 167     }
 168
 169     /**
 170      * One node cluster. 1. Register rpc, ensure router can be found 2. Then remove rpc, ensure its
 171      * deleted
 172      */
 173     @Test
 174     public void testAddRemoveRpcOnSameNode() {
 175         LOG.info("testAddRemoveRpcOnSameNode starting");
 176
 177         Address nodeAddress = node1.provider().getDefaultAddress();
 178
 179         // Add rpc on node 1
 180
 181         List<DOMRpcIdentifier> addedRouteIds = createRouteIds();
 182
 183         registry1.tell(new AddOrUpdateRoutes(addedRouteIds), ActorRef.noSender());
 184
 185         // Bucket store should get an update bucket message. Updated bucket contains added rpc.
 186         final TestKit testKit = new TestKit(node1);
 187
 188         Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry1, testKit, nodeAddress);
 189         verifyBucket(buckets.get(nodeAddress), addedRouteIds);
 190
 191         Map<Address, Long> versions = retrieveVersions(registry1, testKit);
 192         assertEquals("Version for bucket " + nodeAddress, (Long) buckets.get(nodeAddress).getVersion(),
 193                 versions.get(nodeAddress));
 194
 195         // Now remove rpc
 196         registry1.tell(new RemoveRoutes(addedRouteIds), ActorRef.noSender());
 197
 198         // Bucket store should get an update bucket message. Rpc is removed in the updated bucket
 199
 200         verifyEmptyBucket(testKit, registry1, nodeAddress);
 201
 202         LOG.info("testAddRemoveRpcOnSameNode ending");
 203
 204     }
 205
 206     /**
 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
 209      */
 210     @Test
 211     public void testRpcAddRemoveInCluster() {
 212
 213         LOG.info("testRpcAddRemoveInCluster starting");
 214
 215         List<DOMRpcIdentifier> addedRouteIds = createRouteIds();
 216
 217         Address node1Address = node1.provider().getDefaultAddress();
 218
 219         // Add rpc on node 1
 220         registry1.tell(new AddOrUpdateRoutes(addedRouteIds), ActorRef.noSender());
 221
 222         // Bucket store on node2 should get a message to update its local copy of remote buckets
 223         final TestKit testKit = new TestKit(node2);
 224
 225         Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry2, testKit, node1Address);
 226         verifyBucket(buckets.get(node1Address), addedRouteIds);
 227
 228         // Now remove
 229         registry1.tell(new RemoveRoutes(addedRouteIds), ActorRef.noSender());
 230
 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.
 233
 234         verifyEmptyBucket(testKit, registry2, node1Address);
 235
 236         LOG.info("testRpcAddRemoveInCluster ending");
 237     }
 238
 239     private void verifyEmptyBucket(final TestKit testKit, final ActorRef registry, final Address address)
 240             throws AssertionError {
 241         Map<Address, Bucket<RoutingTable>> buckets;
 242         int numTries = 0;
 243         while (true) {
 244             buckets = retrieveBuckets(registry1, testKit, address);
 245
 246             try {
 247                 verifyBucket(buckets.get(address), Collections.emptyList());
 248                 break;
 249             } catch (AssertionError e) {
 250                 if (++numTries >= 50) {
 251                     throw e;
 252                 }
 253             }
 254
 255             Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
 256         }
 257     }
 258
 259     /**
 260      * Three node cluster. Register rpc on 2 nodes. Ensure 3rd gets updated.
 261      */
 262     @Test
 263     public void testRpcAddedOnMultiNodes() {
 264         final TestKit testKit = new TestKit(node3);
 265
 266         // Add rpc on node 1
 267         List<DOMRpcIdentifier> addedRouteIds1 = createRouteIds();
 268         registry1.tell(new AddOrUpdateRoutes(addedRouteIds1), ActorRef.noSender());
 269
 270         final UpdateRemoteEndpoints req1 = registrar3.expectMsgClass(Duration.ofSeconds(3),
 271             UpdateRemoteEndpoints.class);
 272
 273         // Add rpc on node 2
 274         List<DOMRpcIdentifier> addedRouteIds2 = createRouteIds();
 275         registry2.tell(new AddOrUpdateRoutes(addedRouteIds2), ActorRef.noSender());
 276
 277         final UpdateRemoteEndpoints req2 = registrar3.expectMsgClass(Duration.ofSeconds(3),
 278             UpdateRemoteEndpoints.class);
 279         Address node2Address = node2.provider().getDefaultAddress();
 280         Address node1Address = node1.provider().getDefaultAddress();
 281
 282         Map<Address, Bucket<RoutingTable>> buckets = retrieveBuckets(registry3, testKit, node1Address,
 283                 node2Address);
 284
 285         verifyBucket(buckets.get(node1Address), addedRouteIds1);
 286         verifyBucket(buckets.get(node2Address), addedRouteIds2);
 287
 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));
 293
 294         assertEndpoints(req1, node1Address, invoker1);
 295         assertEndpoints(req2, node2Address, invoker2);
 296
 297     }
 298
 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());
 302
 303         final Optional<RemoteRpcEndpoint> maybeEndpoint = endpoints.get(address);
 304         assertNotNull(maybeEndpoint);
 305         assertTrue(maybeEndpoint.isPresent());
 306
 307         final RemoteRpcEndpoint endpoint = maybeEndpoint.get();
 308         final ActorRef router = endpoint.getRouter();
 309         assertNotNull(router);
 310
 311         router.tell("hello", ActorRef.noSender());
 312         final String s = invoker.expectMsgClass(Duration.ofSeconds(3), String.class);
 313         assertEquals("hello", s);
 314     }
 315
 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);
 320         return reply;
 321     }
 322
 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);
 329             }
 330         }
 331
 332         assertEquals("RoutingTable size", expRouteIds.size(), table.size());
 333     }
 334
 335     private static Map<Address, Bucket<RoutingTable>> retrieveBuckets(final ActorRef bucketStore,
 336             final TestKit testKit, final Address... addresses) {
 337         int numTries = 0;
 338         while (true) {
 339             bucketStore.tell(GET_ALL_BUCKETS, testKit.getRef());
 340             @SuppressWarnings("unchecked")
 341             Map<Address, Bucket<RoutingTable>> buckets = testKit.expectMsgClass(Duration.ofSeconds(3), Map.class);
 342
 343             boolean foundAll = true;
 344             for (Address addr : addresses) {
 345                 Bucket<RoutingTable> bucket = buckets.get(addr);
 346                 if (bucket == null) {
 347                     foundAll = false;
 348                     break;
 349                 }
 350             }
 351
 352             if (foundAll) {
 353                 return buckets;
 354             }
 355
 356             if (++numTries >= 50) {
 357                 fail("Missing expected buckets for addresses: " + Arrays.toString(addresses) + ", Actual: " + buckets);
 358             }
 359
 360             Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
 361         }
 362     }
 363
 364     @Test
 365     public void testAddRoutesConcurrency() {
 366         final TestKit testKit = new TestKit(node1);
 367
 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));
 372             added.add(routeId);
 373
 374             //Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 375             registry1.tell(new AddOrUpdateRoutes(Arrays.asList(routeId)),
 376                     ActorRef.noSender());
 377         }
 378
 379         int numTries = 0;
 380         while (true) {
 381             registry1.tell(GET_ALL_BUCKETS, testKit.getRef());
 382             @SuppressWarnings("unchecked")
 383             Map<Address, Bucket<RoutingTable>> buckets = testKit.expectMsgClass(Duration.ofSeconds(3), Map.class);
 384
 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));
 390                 }
 391
 392                 break;
 393             }
 394
 395             if (++numTries >= 50) {
 396                 fail("Expected # routes: " + nRoutes + ", Actual: " + table.size());
 397             }
 398
 399             Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
 400         }
 401     }
 402
 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));
 407         return routeIds;
 408     }
 409 }