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.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 import akka.actor.ActorRef;
  25 import akka.actor.Status.Failure;
  26 import akka.actor.Status.Success;
  27 import akka.cluster.Cluster;
  28 import akka.testkit.JavaTestKit;
  29 import com.google.common.base.Function;
  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.util.concurrent.Uninterruptibles;
  34 import java.util.ArrayList;
  35 import java.util.Arrays;
  36 import java.util.Collection;
  37 import java.util.List;
  38 import java.util.concurrent.TimeUnit;
  39 import org.junit.After;
  40 import org.junit.Before;
  41 import org.junit.Test;
  42 import org.mockito.ArgumentCaptor;
  43 import org.mockito.Mock;
  44 import org.mockito.Mockito;
  45 import org.mockito.MockitoAnnotations;
  46 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  47 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  48 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
  49 import org.opendaylight.controller.cluster.datastore.MemberNode;
  50 import org.opendaylight.controller.cluster.datastore.MemberNode.RaftStateVerifier;
  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.client.messages.OnDemandRaftState;
  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.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  60 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  61 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  62 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
  63 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  64 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  65 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
  66 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;
  67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  68 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  69 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  70 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  71 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  72
  73 /**
  74  * End-to-end integration tests for the entity ownership functionality.
  75  *
  76  * @author Thomas Pantelis
  77  */
  78 public class DistributedEntityOwnershipIntegrationTest {
  79     private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
  80     private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
  81     private static final String ENTITY_TYPE1 = "entityType1";
  82     private static final String ENTITY_TYPE2 = "entityType2";
  83     private static final Entity ENTITY1 = new Entity(ENTITY_TYPE1, "entity1");
  84     private static final Entity ENTITY1_2 = new Entity(ENTITY_TYPE2, "entity1");
  85     private static final Entity ENTITY2 = new Entity(ENTITY_TYPE1, "entity2");
  86     private static final Entity ENTITY3 = new Entity(ENTITY_TYPE1, "entity3");
  87     private static final Entity ENTITY4 = new Entity(ENTITY_TYPE1, "entity4");
  88     private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
  89
  90     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
  91             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5).
  92                     shardIsolatedLeaderCheckIntervalInMillis(1000000);
  93
  94     private final DatastoreContext.Builder followerDatastoreContextBuilder =
  95             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
  96
  97     private final List<MemberNode> memberNodes = new ArrayList<>();
  98
  99     @Mock
 100     private EntityOwnershipListener leaderMockListener;
 101
 102     @Mock
 103     private EntityOwnershipListener leaderMockListener2;
 104
 105     @Mock
 106     private EntityOwnershipListener follower1MockListener;
 107
 108     @Mock
 109     private EntityOwnershipListener follower2MockListener;
 110
 111     @Before
 112     public void setUp() {
 113         MockitoAnnotations.initMocks(this);
 114         InMemoryJournal.clear();
 115         InMemorySnapshotStore.clear();
 116     }
 117
 118     @After
 119     public void tearDown() {
 120         for(MemberNode m: memberNodes) {
 121             m.cleanup();
 122         }
 123     }
 124
 125     private static DistributedEntityOwnershipService newOwnershipService(DistributedDataStore datastore) {
 126         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(datastore,
 127                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
 128         service.start();
 129         return service;
 130     }
 131
 132     @Test
 133     public void testFunctionalityWithThreeNodes() throws Exception {
 134         String name = "test";
 135         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 136                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 137                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 138
 139         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 140                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 141                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 142
 143         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 144                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 145                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 146
 147         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 148
 149         leaderDistributedDataStore.waitTillReady();
 150         follower1Node.configDataStore().waitTillReady();
 151         follower2Node.configDataStore().waitTillReady();
 152
 153         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 154         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 155         EntityOwnershipService follower2EntityOwnershipService = 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, true, true);
 171         verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
 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         verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1_2));
 178         reset(leaderMockListener2);
 179
 180         // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
 181
 182         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 183         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
 184         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 185         verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
 186         verify(follower1MockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
 187
 188         // Register follower1 candidate for entity2 and verify it becomes owner
 189
 190         EntityOwnershipCandidateRegistration follower1Entity2Reg = follower1EntityOwnershipService.registerCandidate(ENTITY2);
 191         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 192         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 193         reset(leaderMockListener, follower1MockListener);
 194
 195         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
 196
 197         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 198         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 199         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 200
 201         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 202         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
 203         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
 204
 205         // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
 206
 207         follower1Entity2Reg.close();
 208         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
 209         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
 210         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
 211         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
 212
 213         // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
 214         // if the original ownership change with "member-2 is replicated to follower2 after the listener is
 215         // registered.
 216         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 217         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 218
 219         // Register follower1 candidate for entity3 and verify it becomes owner
 220
 221         follower1EntityOwnershipService.registerCandidate(ENTITY3);
 222         verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
 223         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
 224         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 225         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
 226
 227         // Register follower2 candidate for entity4 and verify it becomes owner
 228
 229         follower2EntityOwnershipService.registerCandidate(ENTITY4);
 230         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 231         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
 232         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 233         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
 234         reset(follower1MockListener, follower2MockListener);
 235
 236         // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
 237
 238         follower1EntityOwnershipService.registerCandidate(ENTITY4);
 239         verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
 240         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
 241
 242         // Shutdown follower2 and verify it's owned entities (entity 2 & 4) get re-assigned
 243
 244         reset(leaderMockListener, follower1MockListener);
 245         follower2Node.cleanup();
 246
 247         verify(follower1MockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, true, true),
 248                 ownershipChange(ENTITY2, false, false, false)));
 249         verify(leaderMockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, false, true),
 250                 ownershipChange(ENTITY2, false, false, false)));
 251         verifyOwner(leaderDistributedDataStore, ENTITY2, ""); // no other candidate
 252
 253         // Register leader candidate for entity2 and verify it becomes owner
 254
 255         EntityOwnershipCandidateRegistration leaderEntity2Reg = leaderEntityOwnershipService.registerCandidate(ENTITY2);
 256         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
 257         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 258
 259         // Unregister leader candidate for entity2 and verify the owner is cleared
 260
 261         leaderEntity2Reg.close();
 262         verifyOwner(leaderDistributedDataStore, ENTITY2, "");
 263         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
 264         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
 265     }
 266
 267     @Test
 268     public void testLeaderCandidatesRemovedAfterShutdown() throws Exception {
 269         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5).
 270                     customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 271
 272         String name = "test";
 273         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 274                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 275                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 276
 277         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 278                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 279                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 280
 281         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 282                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 283                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 284
 285         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 286
 287         leaderDistributedDataStore.waitTillReady();
 288         follower1Node.configDataStore().waitTillReady();
 289         follower2Node.configDataStore().waitTillReady();
 290
 291         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 292         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 293         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 294
 295         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 296
 297         // Register follower1 candidate for entity1 and verify it becomes owner
 298
 299         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 300         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 301
 302         // Register leader candidate for entity1
 303
 304         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 305         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
 306         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 307
 308         // Register leader candidate for entity2 and verify it becomes owner
 309
 310         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 311         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 312
 313         // Register follower2 candidate for entity2
 314
 315         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 316         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
 317         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 318
 319         // Shutdown the leader and verify its removed from the candidate list
 320
 321         leaderNode.cleanup();
 322         follower1Node.waitForMemberDown("member-1");
 323
 324         // Re-enable elections on folower1 so it becomes the leader
 325
 326         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().
 327                 getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 328         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).
 329                 customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 330
 331         MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, new RaftStateVerifier() {
 332             @Override
 333             public void verify(OnDemandRaftState raftState) {
 334                 assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState());
 335             }
 336         });
 337
 338         // Verify the prior leader's candidates are removed
 339
 340         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2");
 341         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-3");
 342         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 343         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 344     }
 345
 346     /**
 347      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>
 348      *
 349      * @throws CandidateAlreadyRegisteredException
 350      */
 351     @Test
 352     public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
 353         String name = "testCloseCandidateRegistrationInQuickSuccession";
 354         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 355                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 356                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 357
 358         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 359                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 360                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 361
 362         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 363                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 364                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 365
 366         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 367
 368         leaderDistributedDataStore.waitTillReady();
 369         follower1Node.configDataStore().waitTillReady();
 370         follower2Node.configDataStore().waitTillReady();
 371
 372         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 373         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 374         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 375
 376         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 377
 378         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 379         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 380         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 381
 382         final EntityOwnershipCandidateRegistration candidate1 = leaderEntityOwnershipService.registerCandidate(ENTITY1);
 383         final EntityOwnershipCandidateRegistration candidate2 = follower1EntityOwnershipService.registerCandidate(ENTITY1);
 384         final EntityOwnershipCandidateRegistration candidate3 = follower2EntityOwnershipService.registerCandidate(ENTITY1);
 385
 386         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 387
 388         Mockito.reset(leaderMockListener);
 389
 390         ArgumentCaptor<EntityOwnershipChange> leaderChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 391         ArgumentCaptor<EntityOwnershipChange> follower1ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 392         ArgumentCaptor<EntityOwnershipChange> follower2ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 393         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
 394         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
 395         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
 396
 397         candidate1.close();
 398         candidate2.close();
 399         candidate3.close();
 400
 401         boolean passed = false;
 402         for(int i=0;i<100;i++) {
 403             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 404             if(!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent() ||
 405                     !leaderEntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 406                     follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
 407                     !follower1EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 408                     follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
 409                     !follower2EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 410                     leaderChangeCaptor.getAllValues().size() > 0 && !leaderChangeCaptor.getValue().hasOwner() &&
 411                     leaderChangeCaptor.getAllValues().size() > 0 && !follower1ChangeCaptor.getValue().hasOwner() &&
 412                     leaderChangeCaptor.getAllValues().size() > 0 && !follower2ChangeCaptor.getValue().hasOwner()) {
 413                 passed = true;
 414                 break;
 415             }
 416         }
 417
 418         assertTrue("No ownership change message was sent with hasOwner=false", passed);
 419     }
 420
 421     /**
 422      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
 423      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
 424      * an AddShardReplica request to join it to an existing leader.
 425      */
 426     @Test
 427     public void testEntityOwnershipShardBootstrapping() throws Throwable {
 428         String name = "testEntityOwnershipShardBootstrapping";
 429         String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
 430         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 431                 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 432                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 433
 434         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 435         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 436
 437         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 438
 439         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 440                 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 441                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 442
 443         DistributedDataStore follower1DistributedDataStore = follower1Node.configDataStore();
 444         follower1DistributedDataStore.waitTillReady();
 445
 446         leaderNode.waitForMembersUp("member-2");
 447         follower1Node.waitForMembersUp("member-1");
 448
 449         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
 450
 451         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 452
 453         // Register a candidate for follower1 - should get queued since follower1 has no leader
 454         EntityOwnershipCandidateRegistration candidateReg = follower1EntityOwnershipService.registerCandidate(ENTITY1);
 455         verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
 456
 457         // Add replica in follower1
 458         AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
 459         follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica , follower1Node.kit().getRef());
 460         Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"), Success.class, Failure.class);
 461         if(reply instanceof Failure) {
 462             throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
 463         }
 464
 465         // The queued candidate registration should proceed
 466         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 467         reset(leaderMockListener);
 468
 469         candidateReg.close();
 470         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
 471         reset(leaderMockListener);
 472
 473         // Restart follower1 and verify the entity ownership shard is re-instated by registering.
 474         Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
 475         follower1Node.cleanup();
 476
 477         follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 478                 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 479                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 480         follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 481
 482         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 483         verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 484
 485         verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, new RaftStateVerifier() {
 486             @Override
 487             public void verify(OnDemandRaftState raftState) {
 488                 assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
 489                 assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
 490                 assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
 491                         org.hamcrest.CoreMatchers.containsString("member-1"));
 492             }
 493         });
 494     }
 495
 496     private static void verifyGetOwnershipState(EntityOwnershipService service, Entity entity,
 497             boolean isOwner, boolean hasOwner) {
 498         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 499         assertEquals("getOwnershipState present", true, state.isPresent());
 500         assertEquals("isOwner", isOwner, state.get().isOwner());
 501         assertEquals("hasOwner", hasOwner, state.get().hasOwner());
 502     }
 503
 504     private static void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
 505         AssertionError lastError = null;
 506         Stopwatch sw = Stopwatch.createStarted();
 507         while(sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
 508             Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction().read(
 509                     entityPath(entity.getType(), entity.getId()).node(Candidate.QNAME)).get(5, TimeUnit.SECONDS);
 510             try {
 511                 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
 512                 Collection<String> actual = new ArrayList<>();
 513                 for(MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
 514                     actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
 515                 }
 516
 517                 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
 518                 return;
 519             } catch (AssertionError e) {
 520                 lastError = e;
 521                 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 522             }
 523         }
 524
 525         throw lastError;
 526     }
 527
 528     private static void verifyOwner(final DistributedDataStore dataStore, Entity entity, String expOwner) {
 529         AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
 530                 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
 531                     @Override
 532                     public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
 533                         try {
 534                             return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 535                         } catch (Exception e) {
 536                             return null;
 537                         }
 538                     }
 539                 });
 540     }
 541 }