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 import akka.actor.ActorRef;
  26 import akka.actor.Status.Failure;
  27 import akka.actor.Status.Success;
  28 import akka.cluster.Cluster;
  29 import akka.testkit.JavaTestKit;
  30 import com.google.common.base.Optional;
  31 import com.google.common.base.Stopwatch;
  32 import com.google.common.collect.Iterables;
  33 import com.google.common.collect.Lists;
  34 import com.google.common.util.concurrent.Uninterruptibles;
  35 import java.util.ArrayList;
  36 import java.util.Arrays;
  37 import java.util.Collection;
  38 import java.util.List;
  39 import java.util.concurrent.TimeUnit;
  40 import org.junit.After;
  41 import org.junit.Before;
  42 import org.junit.Test;
  43 import org.mockito.ArgumentCaptor;
  44 import org.mockito.Mock;
  45 import org.mockito.Mockito;
  46 import org.mockito.MockitoAnnotations;
  47 import org.opendaylight.controller.cluster.datastore.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.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
  52 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  53 import org.opendaylight.controller.cluster.raft.RaftState;
  54 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
  55 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  56 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  57 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  58 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  59 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  60 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  61 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
  62 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  63 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  64 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
  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 Entity ENTITY1 = new Entity(ENTITY_TYPE1, "entity1");
  83     private static final Entity ENTITY1_2 = new Entity(ENTITY_TYPE2, "entity1");
  84     private static final Entity ENTITY2 = new Entity(ENTITY_TYPE1, "entity2");
  85     private static final Entity ENTITY3 = new Entity(ENTITY_TYPE1, "entity3");
  86     private static final Entity ENTITY4 = new Entity(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 EntityOwnershipListener leaderMockListener;
 100
 101     @Mock
 102     private EntityOwnershipListener leaderMockListener2;
 103
 104     @Mock
 105     private EntityOwnershipListener follower1MockListener;
 106
 107     @Mock
 108     private EntityOwnershipListener 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 DistributedDataStore datastore) {
 126         return DistributedEntityOwnershipService.start(datastore.getActorContext(),
 127                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
 128     }
 129
 130     @Test
 131     public void testFunctionalityWithThreeNodes() throws Exception {
 132         String name = "test";
 133         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 134                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 135                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 136
 137         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 138                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 139                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 140
 141         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 142                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 143                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 144
 145         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 146
 147         leaderDistributedDataStore.waitTillReady();
 148         follower1Node.configDataStore().waitTillReady();
 149         follower2Node.configDataStore().waitTillReady();
 150
 151         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 152         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 153         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 154
 155         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 156
 157         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 158         leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
 159         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 160
 161         // Register leader candidate for entity1 and verify it becomes owner
 162
 163         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 164         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 165         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 166         reset(leaderMockListener, follower1MockListener);
 167
 168         verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
 169         verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
 170
 171         // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
 172
 173         leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
 174         verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
 175         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 176         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1_2));
 177         reset(leaderMockListener2);
 178
 179         // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
 180
 181         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 182         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
 183         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 184         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 185         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 186         verify(follower1MockListener, 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 follower1 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,
 332             raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
 333
 334         // Verify the prior leader's candidates are removed
 335
 336         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2");
 337         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-3");
 338         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 339         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 340     }
 341
 342     @Test
 343     public void testLeaderAndFollowerCandidatesRemovedAfterShutdown() throws Exception {
 344         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5).
 345                 customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 346
 347         String name = "test";
 348         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 349                 moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 350                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 351
 352         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 353                 moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 354                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 355
 356         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 357                 moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 358                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 359
 360         MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4").testName(name ).
 361                 moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 362                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 363
 364         MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5").testName(name ).
 365                 moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 366                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 367
 368         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 369
 370         leaderDistributedDataStore.waitTillReady();
 371         follower1Node.configDataStore().waitTillReady();
 372         follower2Node.configDataStore().waitTillReady();
 373
 374         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 375         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 376         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 377         EntityOwnershipService follower3EntityOwnershipService = newOwnershipService(follower3Node.configDataStore());
 378         EntityOwnershipService follower4EntityOwnershipService = newOwnershipService(follower4Node.configDataStore());
 379
 380         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 381
 382         // Register follower1 candidate for entity1 and verify it becomes owner
 383
 384         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 385         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 386
 387         // Register leader candidate for entity1
 388
 389         leaderEntityOwnershipService.registerCandidate(ENTITY1);
 390         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
 391         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 392
 393         // Register leader candidate for entity2 and verify it becomes owner
 394
 395         leaderEntityOwnershipService.registerCandidate(ENTITY2);
 396         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 397
 398         // Register follower2 candidate for entity2
 399
 400         follower2EntityOwnershipService.registerCandidate(ENTITY2);
 401         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
 402         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 403
 404         // Register follower3 as a candidate for entity2 as well
 405
 406         follower3EntityOwnershipService.registerCandidate(ENTITY2);
 407         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
 408         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 409
 410
 411         // Shutdown the leader and verify its removed from the candidate list
 412
 413         leaderNode.cleanup();
 414         follower3Node.cleanup();
 415
 416         follower1Node.waitForMemberDown("member-1");
 417         follower1Node.waitForMemberDown("member-4");
 418
 419         // Re-enable elections on follower1 so it becomes the leader
 420
 421         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().
 422                 getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 423         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).
 424                 customRaftPolicyImplementation(null).build(), ActorRef.noSender());
 425
 426         MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
 427                 raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
 428
 429         // Verify the prior leader's and follower3 candidates are removed
 430
 431         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2");
 432         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-3");
 433         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
 434         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
 435     }
 436
 437     /**
 438      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>
 439      *
 440      * @throws CandidateAlreadyRegisteredException
 441      */
 442     @Test
 443     public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
 444         String name = "testCloseCandidateRegistrationInQuickSuccession";
 445         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 446                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 447                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 448
 449         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 450                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 451                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 452
 453         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 454                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 455                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 456
 457         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 458
 459         leaderDistributedDataStore.waitTillReady();
 460         follower1Node.configDataStore().waitTillReady();
 461         follower2Node.configDataStore().waitTillReady();
 462
 463         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 464         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 465         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 466
 467         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 468
 469         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 470         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
 471         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
 472
 473         final EntityOwnershipCandidateRegistration candidate1 = leaderEntityOwnershipService.registerCandidate(ENTITY1);
 474         final EntityOwnershipCandidateRegistration candidate2 = follower1EntityOwnershipService.registerCandidate(ENTITY1);
 475         final EntityOwnershipCandidateRegistration candidate3 = follower2EntityOwnershipService.registerCandidate(ENTITY1);
 476
 477         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
 478
 479         Mockito.reset(leaderMockListener);
 480
 481         ArgumentCaptor<EntityOwnershipChange> leaderChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 482         ArgumentCaptor<EntityOwnershipChange> follower1ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 483         ArgumentCaptor<EntityOwnershipChange> follower2ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
 484         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
 485         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
 486         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
 487
 488         candidate1.close();
 489         candidate2.close();
 490         candidate3.close();
 491
 492         boolean passed = false;
 493         for(int i=0;i<100;i++) {
 494             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 495             if(!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent() ||
 496                     !leaderEntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 497                     follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
 498                     !follower1EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 499                     follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
 500                     !follower2EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
 501                     leaderChangeCaptor.getAllValues().size() > 0 && !leaderChangeCaptor.getValue().hasOwner() &&
 502                     leaderChangeCaptor.getAllValues().size() > 0 && !follower1ChangeCaptor.getValue().hasOwner() &&
 503                     leaderChangeCaptor.getAllValues().size() > 0 && !follower2ChangeCaptor.getValue().hasOwner()) {
 504                 passed = true;
 505                 break;
 506             }
 507         }
 508
 509         assertTrue("No ownership change message was sent with hasOwner=false", passed);
 510     }
 511
 512     /**
 513      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
 514      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
 515      * an AddShardReplica request to join it to an existing leader.
 516      */
 517     @Test
 518     public void testEntityOwnershipShardBootstrapping() throws Throwable {
 519         String name = "testEntityOwnershipShardBootstrapping";
 520         String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
 521         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 522                 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 523                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 524
 525         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 526         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 527
 528         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 529
 530         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 531                 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 532                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 533
 534         DistributedDataStore follower1DistributedDataStore = follower1Node.configDataStore();
 535         follower1DistributedDataStore.waitTillReady();
 536
 537         leaderNode.waitForMembersUp("member-2");
 538         follower1Node.waitForMembersUp("member-1");
 539
 540         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
 541
 542         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
 543
 544         // Register a candidate for follower1 - should get queued since follower1 has no leader
 545         EntityOwnershipCandidateRegistration candidateReg = follower1EntityOwnershipService.registerCandidate(ENTITY1);
 546         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 547         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
 548
 549         // Add replica in follower1
 550         AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
 551         follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica , follower1Node.kit().getRef());
 552         Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"), Success.class, Failure.class);
 553         if(reply instanceof Failure) {
 554             throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
 555         }
 556
 557         // The queued candidate registration should proceed
 558         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 559         reset(leaderMockListener);
 560
 561         candidateReg.close();
 562         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
 563         reset(leaderMockListener);
 564
 565         // Restart follower1 and verify the entity ownership shard is re-instated by registering.
 566         Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
 567         follower1Node.cleanup();
 568
 569         follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 570                 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 571                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 572         follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 573
 574         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 575         verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
 576
 577         verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
 578             assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
 579             assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
 580             assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
 581                     org.hamcrest.CoreMatchers.containsString("member-1"));
 582         });
 583     }
 584
 585     @Test
 586     public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
 587         String name = "test";
 588         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 589                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 590                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 591
 592         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 593                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 594                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 595
 596         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 597                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 598                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 599
 600         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 601
 602         leaderDistributedDataStore.waitTillReady();
 603         follower1Node.configDataStore().waitTillReady();
 604         follower2Node.configDataStore().waitTillReady();
 605
 606         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 607         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 608         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 609
 610         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 611
 612         // Register leader candidate for entity1 and verify it becomes owner
 613
 614         EntityOwnershipCandidateRegistration leaderEntity1Reg = leaderEntityOwnershipService.registerCandidate(ENTITY1);
 615
 616         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
 617         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 618
 619         leaderEntity1Reg.close();
 620         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 621
 622         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
 623         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 624     }
 625
 626     @Test
 627     public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
 628         String name = "test";
 629         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
 630                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 631                 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
 632
 633         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
 634                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 635                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 636
 637         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
 638                 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
 639                 datastoreContextBuilder(followerDatastoreContextBuilder).build();
 640
 641         DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
 642
 643         leaderDistributedDataStore.waitTillReady();
 644         follower1Node.configDataStore().waitTillReady();
 645         follower2Node.configDataStore().waitTillReady();
 646
 647         EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
 648         EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
 649         EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
 650
 651         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
 652
 653         // Register leader candidate for entity1 and verify it becomes owner
 654
 655         EntityOwnershipCandidateRegistration leaderEntity1Reg = leaderEntityOwnershipService.registerCandidate(ENTITY1);
 656
 657         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
 658         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
 659
 660         follower1EntityOwnershipService.registerCandidate(ENTITY1);
 661         leaderEntity1Reg.close();
 662
 663         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
 664         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
 665     }
 666
 667     private static void verifyGetOwnershipState(EntityOwnershipService service, Entity entity,
 668             boolean isOwner, boolean hasOwner) {
 669         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 670         assertEquals("getOwnershipState present", true, state.isPresent());
 671         assertEquals("isOwner", isOwner, state.get().isOwner());
 672         assertEquals("hasOwner", hasOwner, state.get().hasOwner());
 673     }
 674
 675     private static void verifyCandidates(final DistributedDataStore dataStore, final Entity entity, final String... expCandidates) throws Exception {
 676         AssertionError lastError = null;
 677         Stopwatch sw = Stopwatch.createStarted();
 678         while(sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
 679             Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction().read(
 680                     entityPath(entity.getType(), entity.getId()).node(Candidate.QNAME)).get(5, TimeUnit.SECONDS);
 681             try {
 682                 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
 683                 Collection<String> actual = new ArrayList<>();
 684                 for(MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
 685                     actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
 686                 }
 687
 688                 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
 689                 return;
 690             } catch (AssertionError e) {
 691                 lastError = e;
 692                 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 693             }
 694         }
 695
 696         throw lastError;
 697     }
 698
 699     private static void verifyOwner(final DistributedDataStore dataStore, final Entity entity, final String expOwner) {
 700         AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
 701                 path -> {
 702                     try {
 703                         return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 704                     } catch (Exception e) {
 705                         return null;
 706                     }
 707                 });
 708     }
 709 }