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