opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipIntegrationTest.java

   1 /*
   2  * Copyright (c) 2015 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 package org.opendaylight.controller.cluster.datastore.entityownership;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNull;
  12 import static org.junit.Assert.assertThat;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.never;
  16 import static org.mockito.Mockito.reset;
  17 import static org.mockito.Mockito.timeout;
  18 import static org.mockito.Mockito.verify;
  19 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
  20 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
  21 import static org.opendaylight.controller.cluster.datastore.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
  22 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
  23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
  24
  25 import akka.actor.ActorRef;
  26 import akka.actor.Status.Failure;
  27 import akka.actor.Status.Success;
  28 import akka.cluster.Cluster;
  29 import akka.testkit.JavaTestKit;
  30 import com.google.common.base.Optional;
  31 import com.google.common.base.Stopwatch;
  32 import com.google.common.collect.Iterables;
  33 import com.google.common.collect.Lists;
  34 import com.google.common.util.concurrent.Uninterruptibles;
  35 import java.util.ArrayList;
  36 import java.util.Arrays;
  37 import java.util.Collection;
  38 import java.util.List;
  39 import java.util.concurrent.TimeUnit;
  40 import org.junit.After;
  41 import org.junit.Before;
  42 import org.junit.Test;
  43 import org.mockito.ArgumentCaptor;
  44 import org.mockito.Mock;
  45 import org.mockito.Mockito;
  46 import org.mockito.MockitoAnnotations;
  47 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
  48 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  49 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
  50 import org.opendaylight.controller.cluster.datastore.MemberNode;
  51 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
  52 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  53 import org.opendaylight.controller.cluster.raft.RaftState;
  54 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
  55 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  56 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  57 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  58 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  59 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
  60 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
  61 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
  62 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
  63 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
  64 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity.Candidate;
  66 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  67 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  68 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  69 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  70
  71 /**
  72  * End-to-end integration tests for the entity ownership functionality.
  73  *
  74  * @author Thomas Pantelis
  75  */
  76 public class DistributedEntityOwnershipIntegrationTest {
  77     private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
  78     private static final String MODULE_SHARDS_5_NODE_CONFIG = "module-shards-default-5-node.conf";
  79     private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
  80     private static final String ENTITY_TYPE1 = "entityType1";
  81     private static final String ENTITY_TYPE2 = "entityType2";
  82     private static final DOMEntity ENTITY1 = new DOMEntity(ENTITY_TYPE1, "entity1");
  83     private static final DOMEntity ENTITY1_2 = new DOMEntity(ENTITY_TYPE2, "entity1");
  84     private static final DOMEntity ENTITY2 = new DOMEntity(ENTITY_TYPE1, "entity2");
  85     private static final DOMEntity ENTITY3 = new DOMEntity(ENTITY_TYPE1, "entity3");
  86     private static final DOMEntity ENTITY4 = new DOMEntity(ENTITY_TYPE1, "entity4");
  87     private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
  88
  89     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
  90             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
  91                     .shardIsolatedLeaderCheckIntervalInMillis(1000000);
  92
  93     private final DatastoreContext.Builder followerDatastoreContextBuilder =
  94             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
  95
  96     private final List<MemberNode> memberNodes = new ArrayList<>();
  97
  98     @Mock
  99     private DOMEntityOwnershipListener leaderMockListener;
 100
 101     @Mock
 102     private DOMEntityOwnershipListener leaderMockListener2;
 103
 104     @Mock
 105     private DOMEntityOwnershipListener follower1MockListener;
 106
 107     @Mock
 108     private DOMEntityOwnershipListener follower2MockListener;
 109
 110     @Before
 111     public void setUp() {
 112         MockitoAnnotations.initMocks(this);
 113         InMemoryJournal.clear();
 114         InMemorySnapshotStore.clear();
 115     }
 116
 117     @After
 118     public void tearDown() {
 119         for (MemberNode m : Lists.reverse(memberNodes)) {
 120             m.cleanup();
 121         }
 122         memberNodes.clear();
 123     }
 124
 125     private static DistributedEntityOwnershipService newOwnershipService(final AbstractDataStore datastore) {
 126         return DistributedEntityOwnershipService.start(datastore.getActorContext(),
 127                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
 128     }
 129
 130     @Test
 131     public void testFunctionalityWithThreeNodes() throws Exception {
 132         String name = "test";
 133         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 134                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 135                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 136
 137         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 138                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 139                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 140
 141         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 142                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 143                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 144
 145         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 146
 147         leaderDistributedDataStore.waitTillReady();
 148         follower1Node.configDataStore().waitTillReady();
 149         follower2Node.configDataStore().waitTillReady();
 150
 151         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 152         final DOMEntityOwnershipService follower1EntityOwnershipService =
 153                 newOwnershipService(follower1Node.configDataStore());
 154         final DOMEntityOwnershipService follower2EntityOwnershipService =
 155                 newOwnershipService(follower2Node.configDataStore());
 156
 157         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 158
 159         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 160         leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
 161         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 162
 163         // Register leader candidate for entity1 and verify it becomes owner
 164
 165         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 166         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 167         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 168         reset(leaderMockListener, follower1MockListener);
 169
 170         verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, EntityOwnershipState.IS_OWNER);
 171         verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, EntityOwnershipState.OWNED_BY_OTHER);
 172
 173         // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
 174
 175         leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
 176         verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
 177         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 178         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1_2));
 179         reset(leaderMockListener2);
 180
 181         // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
 182
 183         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 184         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
 185         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 186         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 187         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 188         verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 189
 190         // Register follower1 candidate for entity2 and verify it becomes owner
 191
 192         final DOMEntityOwnershipCandidateRegistration follower1Entity2Reg =
 193                 follower1EntityOwnershipService.registerCandidate(ENTITY2);
 194         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 195         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 196         reset(leaderMockListener, follower1MockListener);
 197
 198         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
 199
 200         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 201         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 202         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 203
 204         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 205         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
 206         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
 207
 208         // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
 209
 210         follower1Entity2Reg.close();
 211         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
 212         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
 213         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
 214         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 215
 216         // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
 217         // if the original ownership change with "member-2 is replicated to follower2 after the listener is
 218         // registered.
 219         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 220         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 221
 222         // Register follower1 candidate for entity3 and verify it becomes owner
 223
 224         follower1EntityOwnershipService.registerCandidate(ENTITY3);
 225         verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
 226         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
 227         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 228         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 229
 230         // Register follower2 candidate for entity4 and verify it becomes owner
 231
 232         follower2EntityOwnershipService.registerCandidate(ENTITY4);
 233         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 234         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
 235         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 236         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 237         reset(follower1MockListener, follower2MockListener);
 238
 239         // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
 240
 241         follower1EntityOwnershipService.registerCandidate(ENTITY4);
 242         verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
 243         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 244
 245         // Shutdown follower2 and verify it's owned entities (entity 4) get re-assigned
 246
 247         reset(leaderMockListener, follower1MockListener);
 248         follower2Node.cleanup();
 249
 250         verify(follower1MockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
 251         verify(leaderMockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 252
 253         // Register leader candidate for entity2 and verify it becomes owner
 254
 255         DOMEntityOwnershipCandidateRegistration leaderEntity2Reg =
 256                 leaderEntityOwnershipService.registerCandidate(ENTITY2);
 257         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 258         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 259
 260         // Unregister leader candidate for entity2 and verify the owner is cleared
 261
 262         leaderEntity2Reg.close();
 263         verifyOwner(leaderDistributedDataStore, ENTITY2, "");
 264         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
 265         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
 266     }
 267
 268     @Test
 269     public void testLeaderEntityOwnersReassignedAfterShutdown() throws Exception {
 270         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
 271                     .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 272
 273         String name = "test";
 274         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 275                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 276                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 277
 278         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 279                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 280                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 281
 282         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 283                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 284                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 285
 286         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 287
 288         leaderDistributedDataStore.waitTillReady();
 289         follower1Node.configDataStore().waitTillReady();
 290         follower2Node.configDataStore().waitTillReady();
 291
 292         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 293         final DOMEntityOwnershipService follower1EntityOwnershipService =
 294                 newOwnershipService(follower1Node.configDataStore());
 295         final DOMEntityOwnershipService follower2EntityOwnershipService =
 296                 newOwnershipService(follower2Node.configDataStore());
 297
 298         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 299
 300         // Register follower1 candidate for entity1 and verify it becomes owner
 301
 302         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 303         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 304
 305         // Register leader candidate for entity1
 306
 307         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 308         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
 309         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 310
 311         // Register leader candidate for entity2 and verify it becomes owner
 312
 313         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 314         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 315
 316         // Register follower2 candidate for entity2
 317
 318         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 319         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
 320         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 321
 322         // Shutdown the leader and verify its removed from the candidate list
 323
 324         leaderNode.cleanup();
 325         follower1Node.waitForMemberDown("member-1");
 326
 327         // Re-enable elections on follower1 so it becomes the leader
 328
 329         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
 330                 ENTITY_OWNERSHIP_SHARD_NAME);
 331         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 332                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 333
 334         MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
 335             raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
 336
 337         // Verify the prior leader's entity owners are re-assigned.
 338
 339         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
 340         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3");
 341         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 342         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 343     }
 344
 345     @Test
 346     public void testLeaderAndFollowerEntityOwnersReassignedAfterShutdown() throws Exception {
 347         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
 348                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 349
 350         String name = "test";
 351         final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 352                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 353                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 354
 355         final MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 356                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 357                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 358
 359         final MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 360                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 361                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 362
 363         final MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4").testName(name)
 364                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 365                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 366
 367         final MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5").testName(name)
 368                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 369                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 370
 371         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 372
 373         leaderDistributedDataStore.waitTillReady();
 374         follower1Node.configDataStore().waitTillReady();
 375         follower2Node.configDataStore().waitTillReady();
 376
 377         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 378         final DOMEntityOwnershipService follower1EntityOwnershipService =
 379                 newOwnershipService(follower1Node.configDataStore());
 380         final DOMEntityOwnershipService follower2EntityOwnershipService =
 381                 newOwnershipService(follower2Node.configDataStore());
 382         final DOMEntityOwnershipService follower3EntityOwnershipService =
 383                 newOwnershipService(follower3Node.configDataStore());
 384         newOwnershipService(follower4Node.configDataStore());
 385
 386         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 387
 388         // Register follower1 candidate for entity1 and verify it becomes owner
 389
 390         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 391         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 392
 393         // Register leader candidate for entity1
 394
 395         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 396         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
 397         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 398
 399         // Register leader candidate for entity2 and verify it becomes owner
 400
 401         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 402         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 403
 404         // Register follower2 candidate for entity2
 405
 406         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 407         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
 408         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 409
 410         // Register follower3 as a candidate for entity2 as well
 411
 412         follower3EntityOwnershipService.registerCandidate(ENTITY2);
 413         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
 414         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 415
 416         // Shutdown the leader and follower3
 417
 418         leaderNode.cleanup();
 419         follower3Node.cleanup();
 420
 421         follower1Node.waitForMemberDown("member-1");
 422         follower1Node.waitForMemberDown("member-4");
 423
 424         // Re-enable elections on follower1 so it becomes the leader
 425
 426         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
 427                 ENTITY_OWNERSHIP_SHARD_NAME);
 428         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 429                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 430
 431         MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
 432             raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
 433
 434         // Verify the prior leader's and follower3 entity owners are re-assigned.
 435
 436         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
 437         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3", "member-4");
 438         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 439         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 440     }
 441
 442     /**
 443      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
 444      */
 445     @Test
 446     public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
 447         String name = "testCloseCandidateRegistrationInQuickSuccession";
 448         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 449                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 450                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 451
 452         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 453                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 454                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 455
 456         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 457                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 458                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 459
 460         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 461
 462         leaderDistributedDataStore.waitTillReady();
 463         follower1Node.configDataStore().waitTillReady();
 464         follower2Node.configDataStore().waitTillReady();
 465
 466         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 467         final DOMEntityOwnershipService follower1EntityOwnershipService =
 468                 newOwnershipService(follower1Node.configDataStore());
 469         final DOMEntityOwnershipService follower2EntityOwnershipService =
 470                 newOwnershipService(follower2Node.configDataStore());
 471
 472         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 473
 474         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 475         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 476         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 477
 478         final DOMEntityOwnershipCandidateRegistration candidate1 =
 479                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
 480         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 481
 482         final DOMEntityOwnershipCandidateRegistration candidate2 =
 483                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
 484         final DOMEntityOwnershipCandidateRegistration candidate3 =
 485                 follower2EntityOwnershipService.registerCandidate(ENTITY1);
 486
 487         Mockito.reset(leaderMockListener);
 488
 489         ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
 490                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 491         ArgumentCaptor<DOMEntityOwnershipChange> follower1ChangeCaptor =
 492                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 493         ArgumentCaptor<DOMEntityOwnershipChange> follower2ChangeCaptor =
 494                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 495         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
 496         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
 497         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
 498
 499         candidate1.close();
 500         candidate2.close();
 501         candidate3.close();
 502
 503         boolean passed = false;
 504         for (int i = 0; i < 100; i++) {
 505             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 506             if (!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
 507                     || leaderEntityOwnershipService.getOwnershipState(ENTITY1).get() == EntityOwnershipState.NO_OWNER
 508                             && follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
 509                             && follower1EntityOwnershipService.getOwnershipState(ENTITY1)
 510                                     .get() == EntityOwnershipState.NO_OWNER
 511                             && follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
 512                             && follower2EntityOwnershipService.getOwnershipState(ENTITY1)
 513                                     .get() == EntityOwnershipState.NO_OWNER
 514                             && leaderChangeCaptor.getAllValues().size() > 0
 515                             && !leaderChangeCaptor.getValue().getState().hasOwner()
 516                             && leaderChangeCaptor.getAllValues().size() > 0
 517                             && !follower1ChangeCaptor.getValue().getState().hasOwner()
 518                             && leaderChangeCaptor.getAllValues().size() > 0
 519                             && !follower2ChangeCaptor.getValue().getState().hasOwner()) {
 520                 passed = true;
 521                 break;
 522             }
 523         }
 524
 525         assertTrue("No ownership change message was sent with hasOwner=false", passed);
 526     }
 527
 528     /**
 529      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
 530      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
 531      * an AddShardReplica request to join it to an existing leader.
 532      */
 533     @Test
 534     public void testEntityOwnershipShardBootstrapping() throws Exception {
 535         String name = "testEntityOwnershipShardBootstrapping";
 536         String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
 537         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 538                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 539                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 540
 541         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 542         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 543
 544         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 545
 546         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 547                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 548                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 549
 550         AbstractDataStore follower1DistributedDataStore = follower1Node.configDataStore();
 551         follower1DistributedDataStore.waitTillReady();
 552
 553         leaderNode.waitForMembersUp("member-2");
 554         follower1Node.waitForMembersUp("member-1");
 555
 556         DOMEntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
 557
 558         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 559
 560         // Register a candidate for follower1 - should get queued since follower1 has no leader
 561         final DOMEntityOwnershipCandidateRegistration candidateReg =
 562                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
 563         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 564         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 565
 566         // Add replica in follower1
 567         AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
 568         follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica,
 569                 follower1Node.kit().getRef());
 570         Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"),
 571                 Success.class, Failure.class);
 572         if (reply instanceof Failure) {
 573             throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
 574         }
 575
 576         // The queued candidate registration should proceed
 577         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 578         reset(leaderMockListener);
 579
 580         candidateReg.close();
 581         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
 582         reset(leaderMockListener);
 583
 584         // Restart follower1 and verify the entity ownership shard is re-instated by registering.
 585         Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
 586         follower1Node.cleanup();
 587
 588         follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 589                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 590                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 591         follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 592
 593         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 594         verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 595
 596         verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
 597             assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
 598             assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
 599             assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
 600                     org.hamcrest.CoreMatchers.containsString("member-1"));
 601         });
 602     }
 603
 604     @Test
 605     public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
 606         String name = "test";
 607         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 608                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 609                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 610
 611         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 612                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 613                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 614
 615         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 616                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 617                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 618
 619         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 620
 621         leaderDistributedDataStore.waitTillReady();
 622         follower1Node.configDataStore().waitTillReady();
 623         follower2Node.configDataStore().waitTillReady();
 624
 625         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 626         final DOMEntityOwnershipService follower1EntityOwnershipService =
 627                 newOwnershipService(follower1Node.configDataStore());
 628         newOwnershipService(follower2Node.configDataStore());
 629
 630         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 631
 632         // Register leader candidate for entity1 and verify it becomes owner
 633
 634         DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
 635                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
 636
 637         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
 638         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 639
 640         leaderEntity1Reg.close();
 641         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 642
 643         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
 644         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 645     }
 646
 647     @Test
 648     public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
 649         String name = "test";
 650         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 651                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 652                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 653
 654         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 655                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 656                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 657
 658         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 659                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 660                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 661
 662         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 663
 664         leaderDistributedDataStore.waitTillReady();
 665         follower1Node.configDataStore().waitTillReady();
 666         follower2Node.configDataStore().waitTillReady();
 667
 668         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 669         final DOMEntityOwnershipService follower1EntityOwnershipService =
 670                 newOwnershipService(follower1Node.configDataStore());
 671         newOwnershipService(follower2Node.configDataStore());
 672
 673         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 674
 675         // Register leader candidate for entity1 and verify it becomes owner
 676
 677         final DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
 678                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
 679
 680         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
 681         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 682
 683         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 684         leaderEntity1Reg.close();
 685
 686         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
 687         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 688     }
 689
 690     private static void verifyGetOwnershipState(final DOMEntityOwnershipService service, final DOMEntity entity,
 691             final EntityOwnershipState expState) {
 692         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 693         assertEquals("getOwnershipState present", true, state.isPresent());
 694         assertEquals("EntityOwnershipState", expState, state.get());
 695     }
 696
 697     private static void verifyCandidates(final AbstractDataStore dataStore, final DOMEntity entity,
 698             final String... expCandidates) throws Exception {
 699         AssertionError lastError = null;
 700         Stopwatch sw = Stopwatch.createStarted();
 701         while (sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
 702             Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction()
 703                     .read(entityPath(entity.getType(), entity.getIdentifier()).node(Candidate.QNAME))
 704                     .get(5, TimeUnit.SECONDS);
 705             try {
 706                 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
 707                 Collection<String> actual = new ArrayList<>();
 708                 for (MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
 709                     actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
 710                 }
 711
 712                 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
 713                 return;
 714             } catch (AssertionError e) {
 715                 lastError = e;
 716                 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 717             }
 718         }
 719
 720         throw lastError;
 721     }
 722
 723     @SuppressWarnings("checkstyle:IllegalCatch")
 724     private static void verifyOwner(final AbstractDataStore dataStore, final DOMEntity entity,
 725             final String expOwner) {
 726         AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getIdentifier(), path -> {
 727             try {
 728                 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 729             } catch (Exception e) {
 730                 return null;
 731             }
 732         });
 733     }
 734 }