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

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