2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.entityownership;
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.util.concurrent.Uninterruptibles;
34 import java.util.ArrayList;
35 import java.util.Arrays;
36 import java.util.Collection;
37 import java.util.List;
38 import java.util.concurrent.TimeUnit;
39 import org.junit.After;
40 import org.junit.Before;
41 import org.junit.Test;
42 import org.mockito.ArgumentCaptor;
43 import org.mockito.Mock;
44 import org.mockito.Mockito;
45 import org.mockito.MockitoAnnotations;
46 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
47 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
48 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
49 import org.opendaylight.controller.cluster.datastore.MemberNode;
50 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
51 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
52 import org.opendaylight.controller.cluster.raft.RaftState;
53 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
54 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
55 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
56 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
57 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
58 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
59 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
60 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
61 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
62 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
63 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
64 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;
65 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
66 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
67 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
68 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
71 * End-to-end integration tests for the entity ownership functionality.
73 * @author Thomas Pantelis
75 public class DistributedEntityOwnershipIntegrationTest {
76 private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
77 private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
78 private static final String ENTITY_TYPE1 = "entityType1";
79 private static final String ENTITY_TYPE2 = "entityType2";
80 private static final Entity ENTITY1 = new Entity(ENTITY_TYPE1, "entity1");
81 private static final Entity ENTITY1_2 = new Entity(ENTITY_TYPE2, "entity1");
82 private static final Entity ENTITY2 = new Entity(ENTITY_TYPE1, "entity2");
83 private static final Entity ENTITY3 = new Entity(ENTITY_TYPE1, "entity3");
84 private static final Entity ENTITY4 = new Entity(ENTITY_TYPE1, "entity4");
85 private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
87 private final DatastoreContext.Builder leaderDatastoreContextBuilder =
88 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5).
89 shardIsolatedLeaderCheckIntervalInMillis(1000000);
91 private final DatastoreContext.Builder followerDatastoreContextBuilder =
92 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
94 private final List<MemberNode> memberNodes = new ArrayList<>();
97 private EntityOwnershipListener leaderMockListener;
100 private EntityOwnershipListener leaderMockListener2;
103 private EntityOwnershipListener follower1MockListener;
106 private EntityOwnershipListener follower2MockListener;
109 public void setUp() {
110 MockitoAnnotations.initMocks(this);
111 InMemoryJournal.clear();
112 InMemorySnapshotStore.clear();
116 public void tearDown() {
117 for(MemberNode m: memberNodes) {
122 private static DistributedEntityOwnershipService newOwnershipService(final DistributedDataStore datastore) {
123 return DistributedEntityOwnershipService.start(datastore.getActorContext(),
124 EntityOwnerSelectionStrategyConfig.newBuilder().build());
128 public void testFunctionalityWithThreeNodes() throws Exception {
129 String name = "test";
130 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
131 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
132 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
134 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
135 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
136 datastoreContextBuilder(followerDatastoreContextBuilder).build();
138 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
139 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
140 datastoreContextBuilder(followerDatastoreContextBuilder).build();
142 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
144 leaderDistributedDataStore.waitTillReady();
145 follower1Node.configDataStore().waitTillReady();
146 follower2Node.configDataStore().waitTillReady();
148 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
149 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
150 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
152 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
154 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
155 leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
156 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
158 // Register leader candidate for entity1 and verify it becomes owner
160 leaderEntityOwnershipService.registerCandidate(ENTITY1);
161 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
162 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
163 reset(leaderMockListener, follower1MockListener);
165 verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
166 verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
168 // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
170 leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
171 verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
172 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
173 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1_2));
174 reset(leaderMockListener2);
176 // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
178 follower1EntityOwnershipService.registerCandidate(ENTITY1);
179 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
180 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
181 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
182 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
183 verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
185 // Register follower1 candidate for entity2 and verify it becomes owner
187 EntityOwnershipCandidateRegistration follower1Entity2Reg = follower1EntityOwnershipService.registerCandidate(ENTITY2);
188 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
189 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
190 reset(leaderMockListener, follower1MockListener);
192 // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
194 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
195 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
196 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
198 follower2EntityOwnershipService.registerCandidate(ENTITY2);
199 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
200 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
202 // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
204 follower1Entity2Reg.close();
205 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
206 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
207 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
208 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
210 // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
211 // if the original ownership change with "member-2 is replicated to follower2 after the listener is
213 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
214 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
216 // Register follower1 candidate for entity3 and verify it becomes owner
218 follower1EntityOwnershipService.registerCandidate(ENTITY3);
219 verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
220 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
221 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
222 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
224 // Register follower2 candidate for entity4 and verify it becomes owner
226 follower2EntityOwnershipService.registerCandidate(ENTITY4);
227 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
228 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
229 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
230 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
231 reset(follower1MockListener, follower2MockListener);
233 // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
235 follower1EntityOwnershipService.registerCandidate(ENTITY4);
236 verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
237 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
239 // Shutdown follower2 and verify it's owned entities (entity 2 & 4) get re-assigned
241 reset(leaderMockListener, follower1MockListener);
242 follower2Node.cleanup();
244 verify(follower1MockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, true, true),
245 ownershipChange(ENTITY2, false, false, false)));
246 verify(leaderMockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, false, true),
247 ownershipChange(ENTITY2, false, false, false)));
248 verifyOwner(leaderDistributedDataStore, ENTITY2, ""); // no other candidate
250 // Register leader candidate for entity2 and verify it becomes owner
252 EntityOwnershipCandidateRegistration leaderEntity2Reg = leaderEntityOwnershipService.registerCandidate(ENTITY2);
253 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
254 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
256 // Unregister leader candidate for entity2 and verify the owner is cleared
258 leaderEntity2Reg.close();
259 verifyOwner(leaderDistributedDataStore, ENTITY2, "");
260 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
261 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
265 public void testLeaderCandidatesRemovedAfterShutdown() throws Exception {
266 followerDatastoreContextBuilder.shardElectionTimeoutFactor(5).
267 customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
269 String name = "test";
270 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
271 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
272 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
274 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
275 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
276 datastoreContextBuilder(followerDatastoreContextBuilder).build();
278 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
279 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
280 datastoreContextBuilder(followerDatastoreContextBuilder).build();
282 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
284 leaderDistributedDataStore.waitTillReady();
285 follower1Node.configDataStore().waitTillReady();
286 follower2Node.configDataStore().waitTillReady();
288 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
289 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
290 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
292 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
294 // Register follower1 candidate for entity1 and verify it becomes owner
296 follower1EntityOwnershipService.registerCandidate(ENTITY1);
297 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
299 // Register leader candidate for entity1
301 leaderEntityOwnershipService.registerCandidate(ENTITY1);
302 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
303 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
305 // Register leader candidate for entity2 and verify it becomes owner
307 leaderEntityOwnershipService.registerCandidate(ENTITY2);
308 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
310 // Register follower2 candidate for entity2
312 follower2EntityOwnershipService.registerCandidate(ENTITY2);
313 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
314 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
316 // Shutdown the leader and verify its removed from the candidate list
318 leaderNode.cleanup();
319 follower1Node.waitForMemberDown("member-1");
321 // Re-enable elections on folower1 so it becomes the leader
323 ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().
324 getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
325 follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).
326 customRaftPolicyImplementation(null).build(), ActorRef.noSender());
328 MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
329 raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
331 // Verify the prior leader's candidates are removed
333 verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2");
334 verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-3");
335 verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
336 verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
340 * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>
342 * @throws CandidateAlreadyRegisteredException
345 public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
346 String name = "testCloseCandidateRegistrationInQuickSuccession";
347 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
348 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
349 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
351 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
352 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
353 datastoreContextBuilder(followerDatastoreContextBuilder).build();
355 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
356 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
357 datastoreContextBuilder(followerDatastoreContextBuilder).build();
359 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
361 leaderDistributedDataStore.waitTillReady();
362 follower1Node.configDataStore().waitTillReady();
363 follower2Node.configDataStore().waitTillReady();
365 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
366 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
367 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
369 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
371 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
372 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
373 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
375 final EntityOwnershipCandidateRegistration candidate1 = leaderEntityOwnershipService.registerCandidate(ENTITY1);
376 final EntityOwnershipCandidateRegistration candidate2 = follower1EntityOwnershipService.registerCandidate(ENTITY1);
377 final EntityOwnershipCandidateRegistration candidate3 = follower2EntityOwnershipService.registerCandidate(ENTITY1);
379 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
381 Mockito.reset(leaderMockListener);
383 ArgumentCaptor<EntityOwnershipChange> leaderChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
384 ArgumentCaptor<EntityOwnershipChange> follower1ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
385 ArgumentCaptor<EntityOwnershipChange> follower2ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
386 doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
387 doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
388 doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
394 boolean passed = false;
395 for(int i=0;i<100;i++) {
396 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
397 if(!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent() ||
398 !leaderEntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
399 follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
400 !follower1EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
401 follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
402 !follower2EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
403 leaderChangeCaptor.getAllValues().size() > 0 && !leaderChangeCaptor.getValue().hasOwner() &&
404 leaderChangeCaptor.getAllValues().size() > 0 && !follower1ChangeCaptor.getValue().hasOwner() &&
405 leaderChangeCaptor.getAllValues().size() > 0 && !follower2ChangeCaptor.getValue().hasOwner()) {
411 assertTrue("No ownership change message was sent with hasOwner=false", passed);
415 * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
416 * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
417 * an AddShardReplica request to join it to an existing leader.
420 public void testEntityOwnershipShardBootstrapping() throws Throwable {
421 String name = "testEntityOwnershipShardBootstrapping";
422 String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
423 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
424 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
425 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
427 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
428 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
430 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
432 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
433 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
434 datastoreContextBuilder(followerDatastoreContextBuilder).build();
436 DistributedDataStore follower1DistributedDataStore = follower1Node.configDataStore();
437 follower1DistributedDataStore.waitTillReady();
439 leaderNode.waitForMembersUp("member-2");
440 follower1Node.waitForMembersUp("member-1");
442 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
444 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
446 // Register a candidate for follower1 - should get queued since follower1 has no leader
447 EntityOwnershipCandidateRegistration candidateReg = follower1EntityOwnershipService.registerCandidate(ENTITY1);
448 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
449 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
451 // Add replica in follower1
452 AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
453 follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica , follower1Node.kit().getRef());
454 Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"), Success.class, Failure.class);
455 if(reply instanceof Failure) {
456 throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
459 // The queued candidate registration should proceed
460 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
461 reset(leaderMockListener);
463 candidateReg.close();
464 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
465 reset(leaderMockListener);
467 // Restart follower1 and verify the entity ownership shard is re-instated by registering.
468 Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
469 follower1Node.cleanup();
471 follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
472 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
473 datastoreContextBuilder(followerDatastoreContextBuilder).build();
474 follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
476 follower1EntityOwnershipService.registerCandidate(ENTITY1);
477 verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
479 verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
480 assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
481 assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
482 assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
483 org.hamcrest.CoreMatchers.containsString("member-1"));
487 private static void verifyGetOwnershipState(final EntityOwnershipService service, final Entity entity,
488 final boolean isOwner, final boolean hasOwner) {
489 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
490 assertEquals("getOwnershipState present", true, state.isPresent());
491 assertEquals("isOwner", isOwner, state.get().isOwner());
492 assertEquals("hasOwner", hasOwner, state.get().hasOwner());
495 private static void verifyCandidates(final DistributedDataStore dataStore, final Entity entity, final String... expCandidates) throws Exception {
496 AssertionError lastError = null;
497 Stopwatch sw = Stopwatch.createStarted();
498 while(sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
499 Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction().read(
500 entityPath(entity.getType(), entity.getId()).node(Candidate.QNAME)).get(5, TimeUnit.SECONDS);
502 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
503 Collection<String> actual = new ArrayList<>();
504 for(MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
505 actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
508 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
510 } catch (AssertionError e) {
512 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
519 private static void verifyOwner(final DistributedDataStore dataStore, final Entity entity, final String expOwner) {
520 AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
523 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
524 } catch (Exception e) {