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.AdditionalMatchers.or;
  15 import static org.mockito.Mockito.doNothing;
  16 import static org.mockito.Mockito.never;
  17 import static org.mockito.Mockito.reset;
  18 import static org.mockito.Mockito.timeout;
  19 import static org.mockito.Mockito.verify;
  20 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
  21 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
  22 import static org.opendaylight.controller.cluster.datastore.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
  23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
  24 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
  25
  26 import akka.actor.ActorRef;
  27 import akka.actor.Status.Failure;
  28 import akka.actor.Status.Success;
  29 import akka.cluster.Cluster;
  30 import akka.testkit.JavaTestKit;
  31 import com.google.common.base.Optional;
  32 import com.google.common.base.Stopwatch;
  33 import com.google.common.collect.Iterables;
  34 import com.google.common.collect.Lists;
  35 import com.google.common.util.concurrent.Uninterruptibles;
  36 import java.util.ArrayList;
  37 import java.util.Arrays;
  38 import java.util.Collection;
  39 import java.util.List;
  40 import java.util.concurrent.TimeUnit;
  41 import org.junit.After;
  42 import org.junit.Before;
  43 import org.junit.Test;
  44 import org.mockito.ArgumentCaptor;
  45 import org.mockito.Mock;
  46 import org.mockito.Mockito;
  47 import org.mockito.MockitoAnnotations;
  48 import org.mockito.exceptions.base.MockitoException;
  49 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
  50 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  51 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
  52 import org.opendaylight.controller.cluster.datastore.MemberNode;
  53 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
  54 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  55 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
  56 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  57 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  58 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  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 = "testFunctionalityWithThreeNodes";
 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         verifyOwner(follower2Node.configDataStore(), ENTITY1, "member-1");
 187         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 188         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 189         verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 190
 191         // Register follower1 candidate for entity2 and verify it becomes owner
 192
 193         final DOMEntityOwnershipCandidateRegistration follower1Entity2Reg =
 194                 follower1EntityOwnershipService.registerCandidate(ENTITY2);
 195         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 196         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 197         verifyOwner(follower2Node.configDataStore(), ENTITY2, "member-2");
 198         reset(leaderMockListener, follower1MockListener);
 199
 200         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
 201
 202         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 203         verify(follower2MockListener, timeout(5000).times(2)).ownershipChanged(or(
 204                 ownershipChange(ENTITY1, false, false, true), ownershipChange(ENTITY2, false, false, true)));
 205
 206         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 207         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
 208         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
 209
 210         // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
 211
 212         follower1Entity2Reg.close();
 213         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
 214         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
 215         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
 216         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 217
 218         // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
 219         // if the original ownership change with "member-2 is replicated to follower2 after the listener is
 220         // registered.
 221         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 222         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 223
 224         // Register follower1 candidate for entity3 and verify it becomes owner
 225
 226         follower1EntityOwnershipService.registerCandidate(ENTITY3);
 227         verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
 228         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
 229         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 230         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 231
 232         // Register follower2 candidate for entity4 and verify it becomes owner
 233
 234         follower2EntityOwnershipService.registerCandidate(ENTITY4);
 235         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 236         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
 237         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 238         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 239         reset(follower1MockListener, follower2MockListener);
 240
 241         // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
 242
 243         follower1EntityOwnershipService.registerCandidate(ENTITY4);
 244         verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
 245         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 246
 247         // Shutdown follower2 and verify it's owned entities (entity 4) get re-assigned
 248
 249         reset(leaderMockListener, follower1MockListener);
 250         follower2Node.cleanup();
 251
 252         verify(follower1MockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
 253         verify(leaderMockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 254
 255         // Register leader candidate for entity2 and verify it becomes owner
 256
 257         DOMEntityOwnershipCandidateRegistration leaderEntity2Reg =
 258                 leaderEntityOwnershipService.registerCandidate(ENTITY2);
 259         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 260         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 261
 262         // Unregister leader candidate for entity2 and verify the owner is cleared
 263
 264         leaderEntity2Reg.close();
 265         verifyOwner(leaderDistributedDataStore, ENTITY2, "");
 266         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
 267         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
 268     }
 269
 270     @Test
 271     public void testLeaderEntityOwnersReassignedAfterShutdown() throws Exception {
 272         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
 273                     .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 274
 275         String name = "testLeaderEntityOwnersReassignedAfterShutdown";
 276         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 277                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 278                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 279
 280         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 281                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 282                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 283
 284         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 285                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 286                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 287
 288         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 289
 290         leaderDistributedDataStore.waitTillReady();
 291         follower1Node.configDataStore().waitTillReady();
 292         follower2Node.configDataStore().waitTillReady();
 293
 294         follower1Node.waitForMembersUp("member-1", "member-3");
 295
 296         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 297         final DOMEntityOwnershipService follower1EntityOwnershipService =
 298                 newOwnershipService(follower1Node.configDataStore());
 299         final DOMEntityOwnershipService follower2EntityOwnershipService =
 300                 newOwnershipService(follower2Node.configDataStore());
 301
 302         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 303
 304         // Register follower1 candidate for entity1 and verify it becomes owner
 305
 306         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 307         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 308
 309         // Register leader candidate for entity1
 310
 311         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 312         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
 313         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 314
 315         // Register leader candidate for entity2 and verify it becomes owner
 316
 317         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 318         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 319
 320         // Register follower2 candidate for entity2
 321
 322         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 323         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
 324         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 325
 326         // Re-enable elections on all remaining followers so one becomes the new leader
 327
 328         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
 329                 ENTITY_OWNERSHIP_SHARD_NAME);
 330         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 331                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 332
 333         ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorContext(),
 334                 ENTITY_OWNERSHIP_SHARD_NAME);
 335         follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 336                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 337
 338         // Shutdown the leader and verify its removed from the candidate list
 339
 340         leaderNode.cleanup();
 341         follower1Node.waitForMemberDown("member-1");
 342         follower2Node.waitForMemberDown("member-1");
 343
 344         // Verify the prior leader's entity owners are re-assigned.
 345
 346         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
 347         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3");
 348         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 349         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 350     }
 351
 352     @Test
 353     public void testLeaderAndFollowerEntityOwnersReassignedAfterShutdown() throws Exception {
 354         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
 355                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 356
 357         String name = "testLeaderAndFollowerEntityOwnersReassignedAfterShutdown";
 358         final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
 359                 .useAkkaArtery(false).testName(name)
 360                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 361                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 362
 363         final MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2")
 364                 .useAkkaArtery(false).testName(name)
 365                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 366                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 367
 368         final MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3")
 369                 .useAkkaArtery(false).testName(name)
 370                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 371                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 372
 373         final MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4")
 374                 .useAkkaArtery(false).testName(name)
 375                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 376                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 377
 378         final MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5")
 379                 .useAkkaArtery(false).testName(name)
 380                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
 381                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
 382
 383         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 384
 385         leaderDistributedDataStore.waitTillReady();
 386         follower1Node.configDataStore().waitTillReady();
 387         follower2Node.configDataStore().waitTillReady();
 388         follower3Node.configDataStore().waitTillReady();
 389         follower4Node.configDataStore().waitTillReady();
 390
 391         leaderNode.waitForMembersUp("member-2", "member-3", "member-4", "member-5");
 392         follower1Node.waitForMembersUp("member-1", "member-3", "member-4", "member-5");
 393
 394         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 395         final DOMEntityOwnershipService follower1EntityOwnershipService =
 396                 newOwnershipService(follower1Node.configDataStore());
 397         final DOMEntityOwnershipService follower2EntityOwnershipService =
 398                 newOwnershipService(follower2Node.configDataStore());
 399         final DOMEntityOwnershipService follower3EntityOwnershipService =
 400                 newOwnershipService(follower3Node.configDataStore());
 401         newOwnershipService(follower4Node.configDataStore());
 402
 403         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 404
 405         // Register follower1 candidate for entity1 and verify it becomes owner
 406
 407         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 408         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 409
 410         // Register leader candidate for entity1
 411
 412         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 413         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
 414         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 415
 416         // Register leader candidate for entity2 and verify it becomes owner
 417
 418         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 419         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 420
 421         // Register follower2 candidate for entity2
 422
 423         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 424         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
 425         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 426
 427         // Register follower3 as a candidate for entity2 as well
 428
 429         follower3EntityOwnershipService.registerCandidate(ENTITY2);
 430         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
 431         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 432
 433         // Re-enable elections on all remaining followers so one becomes the new leader
 434
 435         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
 436                 ENTITY_OWNERSHIP_SHARD_NAME);
 437         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 438                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 439
 440         ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorContext(),
 441                 ENTITY_OWNERSHIP_SHARD_NAME);
 442         follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 443                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 444
 445         ActorRef follower4Shard = IntegrationTestKit.findLocalShard(follower4Node.configDataStore().getActorContext(),
 446                 ENTITY_OWNERSHIP_SHARD_NAME);
 447         follower4Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
 448                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 449
 450         // Shutdown the leader and follower3
 451
 452         leaderNode.cleanup();
 453         follower3Node.cleanup();
 454
 455         follower1Node.waitForMemberDown("member-1");
 456         follower1Node.waitForMemberDown("member-4");
 457         follower2Node.waitForMemberDown("member-1");
 458         follower2Node.waitForMemberDown("member-4");
 459         follower4Node.waitForMemberDown("member-1");
 460         follower4Node.waitForMemberDown("member-4");
 461
 462         // Verify the prior leader's and follower3 entity owners are re-assigned.
 463
 464         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
 465         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3", "member-4");
 466         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 467         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 468     }
 469
 470     /**
 471      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
 472      */
 473     @Test
 474     public void testCloseCandidateRegistrationInQuickSuccession() throws Exception {
 475         String name = "testCloseCandidateRegistrationInQuickSuccession";
 476         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 477                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 478                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 479
 480         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 481                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 482                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 483
 484         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 485                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 486                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 487
 488         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 489
 490         leaderDistributedDataStore.waitTillReady();
 491         follower1Node.configDataStore().waitTillReady();
 492         follower2Node.configDataStore().waitTillReady();
 493
 494         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 495         final DOMEntityOwnershipService follower1EntityOwnershipService =
 496                 newOwnershipService(follower1Node.configDataStore());
 497         final DOMEntityOwnershipService follower2EntityOwnershipService =
 498                 newOwnershipService(follower2Node.configDataStore());
 499
 500         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 501
 502         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 503         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 504         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 505
 506         final DOMEntityOwnershipCandidateRegistration candidate1 =
 507                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
 508         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 509
 510         final DOMEntityOwnershipCandidateRegistration candidate2 =
 511                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
 512         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 513
 514         final DOMEntityOwnershipCandidateRegistration candidate3 =
 515                 follower2EntityOwnershipService.registerCandidate(ENTITY1);
 516         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 517
 518         Mockito.reset(leaderMockListener, follower1MockListener, follower2MockListener);
 519
 520         ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
 521                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 522         ArgumentCaptor<DOMEntityOwnershipChange> follower1ChangeCaptor =
 523                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 524         ArgumentCaptor<DOMEntityOwnershipChange> follower2ChangeCaptor =
 525                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 526         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
 527         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
 528         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
 529
 530         candidate1.close();
 531         candidate2.close();
 532         candidate3.close();
 533
 534         boolean passed = false;
 535         for (int i = 0; i < 100; i++) {
 536             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 537             final Optional<EntityOwnershipState> leaderState = leaderEntityOwnershipService.getOwnershipState(ENTITY1);
 538             final Optional<EntityOwnershipState> follower1State =
 539                     follower1EntityOwnershipService.getOwnershipState(ENTITY1);
 540             final Optional<EntityOwnershipState> follower2State =
 541                     follower2EntityOwnershipService.getOwnershipState(ENTITY1);
 542             final Optional<DOMEntityOwnershipChange> leaderChange = getValueSafely(leaderChangeCaptor);
 543             final Optional<DOMEntityOwnershipChange> follower1Change = getValueSafely(follower1ChangeCaptor);
 544             final Optional<DOMEntityOwnershipChange> follower2Change = getValueSafely(follower2ChangeCaptor);
 545             if (!leaderState.isPresent() || leaderState.get() == EntityOwnershipState.NO_OWNER
 546                     && follower1State.isPresent() && follower1State.get() == EntityOwnershipState.NO_OWNER
 547                     && follower2State.isPresent() && follower2State.get() == EntityOwnershipState.NO_OWNER
 548                     && leaderChange.isPresent() && !leaderChange.get().getState().hasOwner()
 549                     && follower1Change.isPresent() && !follower1Change.get().getState().hasOwner()
 550                     && follower2Change.isPresent() && !follower2Change.get().getState().hasOwner()) {
 551                 passed = true;
 552                 break;
 553             }
 554         }
 555
 556         assertTrue("No ownership change message was sent with hasOwner=false", passed);
 557     }
 558
 559     private static Optional<DOMEntityOwnershipChange> getValueSafely(ArgumentCaptor<DOMEntityOwnershipChange> captor) {
 560         try {
 561             return Optional.fromNullable(captor.getValue());
 562         } catch (MockitoException e) {
 563             // No value was captured
 564             return Optional.absent();
 565         }
 566     }
 567
 568     /**
 569      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
 570      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
 571      * an AddShardReplica request to join it to an existing leader.
 572      */
 573     @Test
 574     public void testEntityOwnershipShardBootstrapping() throws Exception {
 575         String name = "testEntityOwnershipShardBootstrapping";
 576         String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
 577         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 578                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 579                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 580
 581         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 582         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 583
 584         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 585
 586         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 587                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 588                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 589
 590         AbstractDataStore follower1DistributedDataStore = follower1Node.configDataStore();
 591         follower1DistributedDataStore.waitTillReady();
 592
 593         leaderNode.waitForMembersUp("member-2");
 594         follower1Node.waitForMembersUp("member-1");
 595
 596         DOMEntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
 597
 598         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 599
 600         // Register a candidate for follower1 - should get queued since follower1 has no leader
 601         final DOMEntityOwnershipCandidateRegistration candidateReg =
 602                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
 603         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 604         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 605
 606         // Add replica in follower1
 607         AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
 608         follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica,
 609                 follower1Node.kit().getRef());
 610         Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"),
 611                 Success.class, Failure.class);
 612         if (reply instanceof Failure) {
 613             throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
 614         }
 615
 616         // The queued candidate registration should proceed
 617         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 618         reset(leaderMockListener);
 619
 620         candidateReg.close();
 621         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
 622         reset(leaderMockListener);
 623
 624         // Restart follower1 and verify the entity ownership shard is re-instated by registering.
 625         Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
 626         follower1Node.cleanup();
 627
 628         follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 629                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 630                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 631         follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 632
 633         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 634         verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 635
 636         verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
 637             assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
 638             assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
 639             assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
 640                     org.hamcrest.CoreMatchers.containsString("member-1"));
 641         });
 642     }
 643
 644     @Test
 645     public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
 646         String name = "testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates";
 647         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 648                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 649                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 650
 651         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 652                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 653                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 654
 655         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 656                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 657                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 658
 659         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 660
 661         leaderDistributedDataStore.waitTillReady();
 662         follower1Node.configDataStore().waitTillReady();
 663         follower2Node.configDataStore().waitTillReady();
 664
 665         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 666         final DOMEntityOwnershipService follower1EntityOwnershipService =
 667                 newOwnershipService(follower1Node.configDataStore());
 668         newOwnershipService(follower2Node.configDataStore());
 669
 670         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 671
 672         // Register leader candidate for entity1 and verify it becomes owner
 673
 674         DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
 675                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
 676
 677         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
 678         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 679
 680         leaderEntity1Reg.close();
 681         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 682
 683         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
 684         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 685     }
 686
 687     @Test
 688     public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
 689         String name = "testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates";
 690         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
 691                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 692                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 693
 694         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
 695                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 696                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 697
 698         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
 699                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
 700                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
 701
 702         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 703
 704         leaderDistributedDataStore.waitTillReady();
 705         follower1Node.configDataStore().waitTillReady();
 706         follower2Node.configDataStore().waitTillReady();
 707
 708         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 709         final DOMEntityOwnershipService follower1EntityOwnershipService =
 710                 newOwnershipService(follower1Node.configDataStore());
 711         newOwnershipService(follower2Node.configDataStore());
 712
 713         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 714
 715         // Register leader candidate for entity1 and verify it becomes owner
 716
 717         final DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
 718                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
 719
 720         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
 721         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 722
 723         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 724         leaderEntity1Reg.close();
 725
 726         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
 727         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 728     }
 729
 730     private static void verifyGetOwnershipState(final DOMEntityOwnershipService service, final DOMEntity entity,
 731             final EntityOwnershipState expState) {
 732         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 733         assertEquals("getOwnershipState present", true, state.isPresent());
 734         assertEquals("EntityOwnershipState", expState, state.get());
 735     }
 736
 737     private static void verifyCandidates(final AbstractDataStore dataStore, final DOMEntity entity,
 738             final String... expCandidates) throws Exception {
 739         AssertionError lastError = null;
 740         Stopwatch sw = Stopwatch.createStarted();
 741         while (sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
 742             Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction()
 743                     .read(entityPath(entity.getType(), entity.getIdentifier()).node(Candidate.QNAME))
 744                     .get(5, TimeUnit.SECONDS);
 745             try {
 746                 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
 747                 Collection<String> actual = new ArrayList<>();
 748                 for (MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
 749                     actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
 750                 }
 751
 752                 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
 753                 return;
 754             } catch (AssertionError e) {
 755                 lastError = e;
 756                 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 757             }
 758         }
 759
 760         throw lastError;
 761     }
 762
 763     @SuppressWarnings("checkstyle:IllegalCatch")
 764     private static void verifyOwner(final AbstractDataStore dataStore, final DOMEntity entity,
 765             final String expOwner) {
 766         AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getIdentifier(), path -> {
 767             try {
 768                 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 769             } catch (Exception e) {
 770                 return null;
 771             }
 772         });
 773     }
 774 }