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.Function;
31 import com.google.common.base.Optional;
32 import com.google.common.base.Stopwatch;
33 import com.google.common.collect.Iterables;
34 import com.google.common.util.concurrent.Uninterruptibles;
35 import java.util.ArrayList;
36 import java.util.Arrays;
37 import java.util.Collection;
38 import java.util.List;
39 import java.util.concurrent.TimeUnit;
40 import org.junit.After;
41 import org.junit.Before;
42 import org.junit.Test;
43 import org.mockito.ArgumentCaptor;
44 import org.mockito.Mock;
45 import org.mockito.Mockito;
46 import org.mockito.MockitoAnnotations;
47 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
48 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
49 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
50 import org.opendaylight.controller.cluster.datastore.MemberNode;
51 import org.opendaylight.controller.cluster.datastore.MemberNode.RaftStateVerifier;
52 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
53 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
54 import org.opendaylight.controller.cluster.raft.RaftState;
55 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
56 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
57 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
58 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
59 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
60 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
61 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
62 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
63 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
64 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
65 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
66 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity.Candidate;
68 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
69 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
70 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
71 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
72 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
75 * End-to-end integration tests for the entity ownership functionality.
77 * @author Thomas Pantelis
79 public class DistributedEntityOwnershipIntegrationTest {
80 private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
81 private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
82 private static final String ENTITY_TYPE1 = "entityType1";
83 private static final String ENTITY_TYPE2 = "entityType2";
84 private static final Entity ENTITY1 = new Entity(ENTITY_TYPE1, "entity1");
85 private static final Entity ENTITY1_2 = new Entity(ENTITY_TYPE2, "entity1");
86 private static final Entity ENTITY2 = new Entity(ENTITY_TYPE1, "entity2");
87 private static final Entity ENTITY3 = new Entity(ENTITY_TYPE1, "entity3");
88 private static final Entity ENTITY4 = new Entity(ENTITY_TYPE1, "entity4");
89 private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
91 private final DatastoreContext.Builder leaderDatastoreContextBuilder =
92 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5).
93 shardIsolatedLeaderCheckIntervalInMillis(1000000);
95 private final DatastoreContext.Builder followerDatastoreContextBuilder =
96 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
98 private final List<MemberNode> memberNodes = new ArrayList<>();
101 private EntityOwnershipListener leaderMockListener;
104 private EntityOwnershipListener leaderMockListener2;
107 private EntityOwnershipListener follower1MockListener;
110 private EntityOwnershipListener follower2MockListener;
113 public void setUp() {
114 MockitoAnnotations.initMocks(this);
115 InMemoryJournal.clear();
116 InMemorySnapshotStore.clear();
120 public void tearDown() {
121 for(MemberNode m: memberNodes) {
126 private static DistributedEntityOwnershipService newOwnershipService(DistributedDataStore datastore) {
127 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(datastore,
128 EntityOwnerSelectionStrategyConfig.newBuilder().build());
134 public void testFunctionalityWithThreeNodes() throws Exception {
135 String name = "test";
136 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
137 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
138 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
140 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
141 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
142 datastoreContextBuilder(followerDatastoreContextBuilder).build();
144 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
145 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
146 datastoreContextBuilder(followerDatastoreContextBuilder).build();
148 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
150 leaderDistributedDataStore.waitTillReady();
151 follower1Node.configDataStore().waitTillReady();
152 follower2Node.configDataStore().waitTillReady();
154 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
155 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
156 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
158 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
160 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
161 leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
162 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
164 // Register leader candidate for entity1 and verify it becomes owner
166 leaderEntityOwnershipService.registerCandidate(ENTITY1);
167 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
168 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
169 reset(leaderMockListener, follower1MockListener);
171 verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
172 verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
174 // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
176 leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
177 verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
178 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
179 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1_2));
180 reset(leaderMockListener2);
182 // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
184 follower1EntityOwnershipService.registerCandidate(ENTITY1);
185 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
186 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
187 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
188 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
189 verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
191 // Register follower1 candidate for entity2 and verify it becomes owner
193 EntityOwnershipCandidateRegistration follower1Entity2Reg = follower1EntityOwnershipService.registerCandidate(ENTITY2);
194 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
195 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
196 reset(leaderMockListener, follower1MockListener);
198 // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
200 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
201 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
202 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
204 follower2EntityOwnershipService.registerCandidate(ENTITY2);
205 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
206 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
208 // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
210 follower1Entity2Reg.close();
211 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
212 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
213 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
214 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
216 // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
217 // if the original ownership change with "member-2 is replicated to follower2 after the listener is
219 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
220 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
222 // Register follower1 candidate for entity3 and verify it becomes owner
224 follower1EntityOwnershipService.registerCandidate(ENTITY3);
225 verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
226 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
227 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
228 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
230 // Register follower2 candidate for entity4 and verify it becomes owner
232 follower2EntityOwnershipService.registerCandidate(ENTITY4);
233 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
234 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
235 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
236 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
237 reset(follower1MockListener, follower2MockListener);
239 // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
241 follower1EntityOwnershipService.registerCandidate(ENTITY4);
242 verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
243 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
245 // Shutdown follower2 and verify it's owned entities (entity 2 & 4) get re-assigned
247 reset(leaderMockListener, follower1MockListener);
248 follower2Node.cleanup();
250 verify(follower1MockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, true, true),
251 ownershipChange(ENTITY2, false, false, false)));
252 verify(leaderMockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, false, true),
253 ownershipChange(ENTITY2, false, false, false)));
254 verifyOwner(leaderDistributedDataStore, ENTITY2, ""); // no other candidate
256 // Register leader candidate for entity2 and verify it becomes owner
258 EntityOwnershipCandidateRegistration leaderEntity2Reg = leaderEntityOwnershipService.registerCandidate(ENTITY2);
259 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
260 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
262 // Unregister leader candidate for entity2 and verify the owner is cleared
264 leaderEntity2Reg.close();
265 verifyOwner(leaderDistributedDataStore, ENTITY2, "");
266 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
267 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
271 public void testLeaderCandidatesRemovedAfterShutdown() throws Exception {
272 followerDatastoreContextBuilder.shardElectionTimeoutFactor(5).
273 customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
275 String name = "test";
276 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
277 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
278 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
280 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
281 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
282 datastoreContextBuilder(followerDatastoreContextBuilder).build();
284 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
285 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
286 datastoreContextBuilder(followerDatastoreContextBuilder).build();
288 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
290 leaderDistributedDataStore.waitTillReady();
291 follower1Node.configDataStore().waitTillReady();
292 follower2Node.configDataStore().waitTillReady();
294 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
295 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
296 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
298 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
300 // Register follower1 candidate for entity1 and verify it becomes owner
302 follower1EntityOwnershipService.registerCandidate(ENTITY1);
303 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
305 // Register leader candidate for entity1
307 leaderEntityOwnershipService.registerCandidate(ENTITY1);
308 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
309 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
311 // Register leader candidate for entity2 and verify it becomes owner
313 leaderEntityOwnershipService.registerCandidate(ENTITY2);
314 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
316 // Register follower2 candidate for entity2
318 follower2EntityOwnershipService.registerCandidate(ENTITY2);
319 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
320 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
322 // Shutdown the leader and verify its removed from the candidate list
324 leaderNode.cleanup();
325 follower1Node.waitForMemberDown("member-1");
327 // Re-enable elections on folower1 so it becomes the leader
329 ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().
330 getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
331 follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).
332 customRaftPolicyImplementation(null).build(), ActorRef.noSender());
334 MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, new RaftStateVerifier() {
336 public void verify(OnDemandRaftState raftState) {
337 assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState());
341 // Verify the prior leader's candidates are removed
343 verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2");
344 verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-3");
345 verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
346 verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
350 * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>
352 * @throws CandidateAlreadyRegisteredException
355 public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
356 String name = "testCloseCandidateRegistrationInQuickSuccession";
357 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
358 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
359 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
361 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
362 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
363 datastoreContextBuilder(followerDatastoreContextBuilder).build();
365 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
366 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
367 datastoreContextBuilder(followerDatastoreContextBuilder).build();
369 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
371 leaderDistributedDataStore.waitTillReady();
372 follower1Node.configDataStore().waitTillReady();
373 follower2Node.configDataStore().waitTillReady();
375 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
376 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
377 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
379 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
381 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
382 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
383 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
385 final EntityOwnershipCandidateRegistration candidate1 = leaderEntityOwnershipService.registerCandidate(ENTITY1);
386 final EntityOwnershipCandidateRegistration candidate2 = follower1EntityOwnershipService.registerCandidate(ENTITY1);
387 final EntityOwnershipCandidateRegistration candidate3 = follower2EntityOwnershipService.registerCandidate(ENTITY1);
389 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
391 Mockito.reset(leaderMockListener);
393 ArgumentCaptor<EntityOwnershipChange> leaderChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
394 ArgumentCaptor<EntityOwnershipChange> follower1ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
395 ArgumentCaptor<EntityOwnershipChange> follower2ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
396 doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
397 doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
398 doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
404 boolean passed = false;
405 for(int i=0;i<100;i++) {
406 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
407 if(!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent() ||
408 !leaderEntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
409 follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
410 !follower1EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
411 follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent() &&
412 !follower2EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
413 leaderChangeCaptor.getAllValues().size() > 0 && !leaderChangeCaptor.getValue().hasOwner() &&
414 leaderChangeCaptor.getAllValues().size() > 0 && !follower1ChangeCaptor.getValue().hasOwner() &&
415 leaderChangeCaptor.getAllValues().size() > 0 && !follower2ChangeCaptor.getValue().hasOwner()) {
421 assertTrue("No ownership change message was sent with hasOwner=false", passed);
425 * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
426 * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
427 * an AddShardReplica request to join it to an existing leader.
430 public void testEntityOwnershipShardBootstrapping() throws Throwable {
431 String name = "testEntityOwnershipShardBootstrapping";
432 String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
433 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
434 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
435 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
437 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
438 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
440 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
442 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
443 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
444 datastoreContextBuilder(followerDatastoreContextBuilder).build();
446 DistributedDataStore follower1DistributedDataStore = follower1Node.configDataStore();
447 follower1DistributedDataStore.waitTillReady();
449 leaderNode.waitForMembersUp("member-2");
450 follower1Node.waitForMembersUp("member-1");
452 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
454 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
456 // Register a candidate for follower1 - should get queued since follower1 has no leader
457 EntityOwnershipCandidateRegistration candidateReg = follower1EntityOwnershipService.registerCandidate(ENTITY1);
458 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
459 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
461 // Add replica in follower1
462 AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
463 follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica , follower1Node.kit().getRef());
464 Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"), Success.class, Failure.class);
465 if(reply instanceof Failure) {
466 throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
469 // The queued candidate registration should proceed
470 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
471 reset(leaderMockListener);
473 candidateReg.close();
474 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
475 reset(leaderMockListener);
477 // Restart follower1 and verify the entity ownership shard is re-instated by registering.
478 Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
479 follower1Node.cleanup();
481 follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
482 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
483 datastoreContextBuilder(followerDatastoreContextBuilder).build();
484 follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
486 follower1EntityOwnershipService.registerCandidate(ENTITY1);
487 verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
489 verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, new RaftStateVerifier() {
491 public void verify(OnDemandRaftState raftState) {
492 assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
493 assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
494 assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
495 org.hamcrest.CoreMatchers.containsString("member-1"));
500 private static void verifyGetOwnershipState(EntityOwnershipService service, Entity entity,
501 boolean isOwner, boolean hasOwner) {
502 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
503 assertEquals("getOwnershipState present", true, state.isPresent());
504 assertEquals("isOwner", isOwner, state.get().isOwner());
505 assertEquals("hasOwner", hasOwner, state.get().hasOwner());
508 private static void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
509 AssertionError lastError = null;
510 Stopwatch sw = Stopwatch.createStarted();
511 while(sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
512 Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction().read(
513 entityPath(entity.getType(), entity.getId()).node(Candidate.QNAME)).get(5, TimeUnit.SECONDS);
515 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
516 Collection<String> actual = new ArrayList<>();
517 for(MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
518 actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
521 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
523 } catch (AssertionError e) {
525 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
532 private static void verifyOwner(final DistributedDataStore dataStore, Entity entity, String expOwner) {
533 AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
534 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
536 public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
538 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
539 } catch (Exception e) {