Bump akka to 2.6.12
[controller.git] / opendaylight / md-sal / sal-distributed-eos / src / test / java / org / opendaylight / controller / cluster / 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.entityownership;
9
10 import static org.hamcrest.MatcherAssert.assertThat;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNull;
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.entityownership.AbstractEntityOwnershipTest.ownershipChange;
22 import static org.opendaylight.controller.cluster.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
23 import static org.opendaylight.controller.cluster.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
24 import static org.opendaylight.controller.cluster.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.pattern.Patterns;
31 import akka.util.Timeout;
32 import com.google.common.base.Stopwatch;
33 import com.google.common.collect.ImmutableMap;
34 import com.google.common.collect.Iterables;
35 import com.google.common.collect.Lists;
36 import com.google.common.util.concurrent.Uninterruptibles;
37 import java.util.ArrayList;
38 import java.util.Arrays;
39 import java.util.Collection;
40 import java.util.List;
41 import java.util.Optional;
42 import java.util.concurrent.TimeUnit;
43 import org.junit.After;
44 import org.junit.Before;
45 import org.junit.Test;
46 import org.mockito.ArgumentCaptor;
47 import org.mockito.Mock;
48 import org.mockito.Mockito;
49 import org.mockito.MockitoAnnotations;
50 import org.mockito.exceptions.base.MockitoException;
51 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
52 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
53 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
54 import org.opendaylight.controller.cluster.datastore.MemberNode;
55 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
56 import org.opendaylight.controller.cluster.datastore.messages.ChangeShardMembersVotingStatus;
57 import org.opendaylight.controller.cluster.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
58 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
59 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
60 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
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 scala.concurrent.Await;
72 import scala.concurrent.Future;
73 import scala.concurrent.duration.FiniteDuration;
74
75 /**
76  * End-to-end integration tests for the entity ownership functionality.
77  *
78  * @author Thomas Pantelis
79  */
80 public class DistributedEntityOwnershipIntegrationTest {
81     private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
82     private static final String MODULE_SHARDS_5_NODE_CONFIG = "module-shards-default-5-node.conf";
83     private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
84     private static final String ENTITY_TYPE1 = "entityType1";
85     private static final String ENTITY_TYPE2 = "entityType2";
86     private static final DOMEntity ENTITY1 = new DOMEntity(ENTITY_TYPE1, "entity1");
87     private static final DOMEntity ENTITY1_2 = new DOMEntity(ENTITY_TYPE2, "entity1");
88     private static final DOMEntity ENTITY2 = new DOMEntity(ENTITY_TYPE1, "entity2");
89     private static final DOMEntity ENTITY3 = new DOMEntity(ENTITY_TYPE1, "entity3");
90     private static final DOMEntity ENTITY4 = new DOMEntity(ENTITY_TYPE1, "entity4");
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.getActorUtils(),
129                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
130     }
131
132     @Test
133     public void testFunctionalityWithThreeNodes() throws Exception {
134         String name = "testFunctionalityWithThreeNodes";
135         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
136                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
137                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
138
139         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
140                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
141                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
142
143         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
144                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
145                 .createOperDatastore(false).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().getActorUtils(), 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 = "testLeaderEntityOwnersReassignedAfterShutdown";
278         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
279                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
280                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
281
282         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
283                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
284                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
285
286         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
287                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
288                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
289
290         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
291
292         leaderDistributedDataStore.waitTillReady();
293         follower1Node.configDataStore().waitTillReady();
294         follower2Node.configDataStore().waitTillReady();
295
296         follower1Node.waitForMembersUp("member-1", "member-3");
297
298         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
299         final DOMEntityOwnershipService follower1EntityOwnershipService =
300                 newOwnershipService(follower1Node.configDataStore());
301         final DOMEntityOwnershipService follower2EntityOwnershipService =
302                 newOwnershipService(follower2Node.configDataStore());
303
304         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorUtils(), ENTITY_OWNERSHIP_SHARD_NAME);
305
306         // Register follower1 candidate for entity1 and verify it becomes owner
307
308         follower1EntityOwnershipService.registerCandidate(ENTITY1);
309         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
310
311         // Register leader candidate for entity1
312
313         leaderEntityOwnershipService.registerCandidate(ENTITY1);
314         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
315         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
316
317         // Register leader candidate for entity2 and verify it becomes owner
318
319         leaderEntityOwnershipService.registerCandidate(ENTITY2);
320         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
321
322         // Register follower2 candidate for entity2
323
324         follower2EntityOwnershipService.registerCandidate(ENTITY2);
325         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
326         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
327
328         // Re-enable elections on all remaining followers so one becomes the new leader
329
330         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorUtils(),
331                 ENTITY_OWNERSHIP_SHARD_NAME);
332         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
333                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
334
335         ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorUtils(),
336                 ENTITY_OWNERSHIP_SHARD_NAME);
337         follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
338                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
339
340         // Shutdown the leader and verify its removed from the candidate list
341
342         leaderNode.cleanup();
343         follower1Node.waitForMemberDown("member-1");
344         follower2Node.waitForMemberDown("member-1");
345
346         // Verify the prior leader's entity owners are re-assigned.
347
348         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
349         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3");
350         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
351         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
352     }
353
354     @Test
355     public void testLeaderAndFollowerEntityOwnersReassignedAfterShutdown() throws Exception {
356         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
357                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
358
359         String name = "testLeaderAndFollowerEntityOwnersReassignedAfterShutdown";
360         final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
361                 .useAkkaArtery(false).testName(name)
362                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG)
363                 .schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
364                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
365
366         final MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2")
367                 .testName(name).moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG)
368                 .useAkkaArtery(false).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
369                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
370
371         final MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3")
372                 .testName(name).moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG)
373                 .useAkkaArtery(false).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
374                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
375
376         final MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4")
377                 .testName(name).moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG)
378                 .useAkkaArtery(false).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
379                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
380
381         final MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5")
382                 .testName(name).moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG)
383                 .useAkkaArtery(false).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
384                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
385
386         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
387
388         leaderDistributedDataStore.waitTillReady();
389         follower1Node.configDataStore().waitTillReady();
390         follower2Node.configDataStore().waitTillReady();
391         follower3Node.configDataStore().waitTillReady();
392         follower4Node.configDataStore().waitTillReady();
393
394         leaderNode.waitForMembersUp("member-2", "member-3", "member-4", "member-5");
395         follower1Node.waitForMembersUp("member-1", "member-3", "member-4", "member-5");
396
397         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
398         final DOMEntityOwnershipService follower1EntityOwnershipService =
399                 newOwnershipService(follower1Node.configDataStore());
400         final DOMEntityOwnershipService follower2EntityOwnershipService =
401                 newOwnershipService(follower2Node.configDataStore());
402         final DOMEntityOwnershipService follower3EntityOwnershipService =
403                 newOwnershipService(follower3Node.configDataStore());
404         newOwnershipService(follower4Node.configDataStore());
405
406         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorUtils(), ENTITY_OWNERSHIP_SHARD_NAME);
407
408         // Register follower1 candidate for entity1 and verify it becomes owner
409
410         follower1EntityOwnershipService.registerCandidate(ENTITY1);
411         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
412
413         // Register leader candidate for entity1
414
415         leaderEntityOwnershipService.registerCandidate(ENTITY1);
416         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
417         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
418
419         // Register leader candidate for entity2 and verify it becomes owner
420
421         leaderEntityOwnershipService.registerCandidate(ENTITY2);
422         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
423
424         // Register follower2 candidate for entity2
425
426         follower2EntityOwnershipService.registerCandidate(ENTITY2);
427         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
428         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
429
430         // Register follower3 as a candidate for entity2 as well
431
432         follower3EntityOwnershipService.registerCandidate(ENTITY2);
433         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
434         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
435
436         // Re-enable elections on all remaining followers so one becomes the new leader
437
438         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorUtils(),
439                 ENTITY_OWNERSHIP_SHARD_NAME);
440         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
441                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
442
443         ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorUtils(),
444                 ENTITY_OWNERSHIP_SHARD_NAME);
445         follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
446                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
447
448         ActorRef follower4Shard = IntegrationTestKit.findLocalShard(follower4Node.configDataStore().getActorUtils(),
449                 ENTITY_OWNERSHIP_SHARD_NAME);
450         follower4Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
451                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
452
453         // Shutdown the leader and follower3
454
455         leaderNode.cleanup();
456
457         follower1Node.waitForMemberDown("member-1");
458         follower2Node.waitForMemberDown("member-1");
459         follower4Node.waitForMemberDown("member-1");
460
461         follower3Node.cleanup();
462
463         follower1Node.waitForMemberDown("member-4");
464         follower2Node.waitForMemberDown("member-4");
465         follower4Node.waitForMemberDown("member-4");
466
467         // Verify the prior leader's and follower3 entity owners are re-assigned.
468
469         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
470         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3", "member-4");
471         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
472         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
473     }
474
475     /**
476      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
477      */
478     @Test
479     public void testCloseCandidateRegistrationInQuickSuccession() throws Exception {
480         String name = "testCloseCandidateRegistrationInQuickSuccession";
481         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
482                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
483                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
484
485         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
486                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
487                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
488
489         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
490                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
491                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
492
493         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
494
495         leaderDistributedDataStore.waitTillReady();
496         follower1Node.configDataStore().waitTillReady();
497         follower2Node.configDataStore().waitTillReady();
498
499         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
500         final DOMEntityOwnershipService follower1EntityOwnershipService =
501                 newOwnershipService(follower1Node.configDataStore());
502         final DOMEntityOwnershipService follower2EntityOwnershipService =
503                 newOwnershipService(follower2Node.configDataStore());
504
505         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorUtils(), ENTITY_OWNERSHIP_SHARD_NAME);
506
507         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
508         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
509         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
510
511         final DOMEntityOwnershipCandidateRegistration candidate1 =
512                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
513         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
514
515         final DOMEntityOwnershipCandidateRegistration candidate2 =
516                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
517         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
518
519         final DOMEntityOwnershipCandidateRegistration candidate3 =
520                 follower2EntityOwnershipService.registerCandidate(ENTITY1);
521         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
522
523         Mockito.reset(leaderMockListener, follower1MockListener, follower2MockListener);
524
525         ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
526                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
527         ArgumentCaptor<DOMEntityOwnershipChange> follower1ChangeCaptor =
528                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
529         ArgumentCaptor<DOMEntityOwnershipChange> follower2ChangeCaptor =
530                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
531         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
532         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
533         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
534
535         candidate1.close();
536         candidate2.close();
537         candidate3.close();
538
539         boolean passed = false;
540         for (int i = 0; i < 100; i++) {
541             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
542             final Optional<EntityOwnershipState> leaderState = leaderEntityOwnershipService.getOwnershipState(ENTITY1);
543             final Optional<EntityOwnershipState> follower1State =
544                     follower1EntityOwnershipService.getOwnershipState(ENTITY1);
545             final Optional<EntityOwnershipState> follower2State =
546                     follower2EntityOwnershipService.getOwnershipState(ENTITY1);
547             final Optional<DOMEntityOwnershipChange> leaderChange = getValueSafely(leaderChangeCaptor);
548             final Optional<DOMEntityOwnershipChange> follower1Change = getValueSafely(follower1ChangeCaptor);
549             final Optional<DOMEntityOwnershipChange> follower2Change = getValueSafely(follower2ChangeCaptor);
550             if (!leaderState.isPresent() || leaderState.get() == EntityOwnershipState.NO_OWNER
551                     && follower1State.isPresent() && follower1State.get() == EntityOwnershipState.NO_OWNER
552                     && follower2State.isPresent() && follower2State.get() == EntityOwnershipState.NO_OWNER
553                     && leaderChange.isPresent() && !leaderChange.get().getState().hasOwner()
554                     && follower1Change.isPresent() && !follower1Change.get().getState().hasOwner()
555                     && follower2Change.isPresent() && !follower2Change.get().getState().hasOwner()) {
556                 passed = true;
557                 break;
558             }
559         }
560
561         assertTrue("No ownership change message was sent with hasOwner=false", passed);
562     }
563
564     private static Optional<DOMEntityOwnershipChange> getValueSafely(
565             final ArgumentCaptor<DOMEntityOwnershipChange> captor) {
566         try {
567             return Optional.ofNullable(captor.getValue());
568         } catch (MockitoException e) {
569             // No value was captured
570             return Optional.empty();
571         }
572     }
573
574     /**
575      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
576      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
577      * an AddShardReplica request to join it to an existing leader.
578      */
579     @Test
580     public void testEntityOwnershipShardBootstrapping() throws Exception {
581         String name = "testEntityOwnershipShardBootstrapping";
582         String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
583         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
584                 .moduleShardsConfig(moduleShardsConfig).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
585                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
586
587         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
588         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
589
590         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorUtils(), ENTITY_OWNERSHIP_SHARD_NAME);
591
592         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
593                 .moduleShardsConfig(moduleShardsConfig).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
594                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
595
596         AbstractDataStore follower1DistributedDataStore = follower1Node.configDataStore();
597         follower1DistributedDataStore.waitTillReady();
598
599         leaderNode.waitForMembersUp("member-2");
600         follower1Node.waitForMembersUp("member-1");
601
602         DOMEntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
603
604         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
605
606         // Register a candidate for follower1 - should get queued since follower1 has no leader
607         final DOMEntityOwnershipCandidateRegistration candidateReg =
608                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
609         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
610         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
611
612         // Add replica in follower1
613         AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
614         follower1DistributedDataStore.getActorUtils().getShardManager().tell(addReplica,
615                 follower1Node.kit().getRef());
616         Object reply = follower1Node.kit().expectMsgAnyClassOf(follower1Node.kit().duration("5 sec"),
617                 Success.class, Failure.class);
618         if (reply instanceof Failure) {
619             throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
620         }
621
622         // The queued candidate registration should proceed
623         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
624         reset(leaderMockListener);
625
626         candidateReg.close();
627         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
628         reset(leaderMockListener);
629
630         // Restart follower1 and verify the entity ownership shard is re-instated by registering.
631         Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
632         follower1Node.cleanup();
633
634         follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
635                 .moduleShardsConfig(moduleShardsConfig).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
636                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
637         follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
638
639         follower1EntityOwnershipService.registerCandidate(ENTITY1);
640         verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
641
642         verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
643             assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
644             assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
645             assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
646                     org.hamcrest.CoreMatchers.containsString("member-1"));
647         });
648     }
649
650     @Test
651     public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
652         String name = "testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates";
653         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
654                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
655                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
656
657         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
658                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
659                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
660
661         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
662                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
663                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
664
665         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
666
667         leaderDistributedDataStore.waitTillReady();
668         follower1Node.configDataStore().waitTillReady();
669         follower2Node.configDataStore().waitTillReady();
670
671         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
672         final DOMEntityOwnershipService follower1EntityOwnershipService =
673                 newOwnershipService(follower1Node.configDataStore());
674         newOwnershipService(follower2Node.configDataStore());
675
676         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorUtils(), ENTITY_OWNERSHIP_SHARD_NAME);
677
678         // Register leader candidate for entity1 and verify it becomes owner
679
680         DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
681                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
682
683         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
684         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
685
686         leaderEntity1Reg.close();
687         follower1EntityOwnershipService.registerCandidate(ENTITY1);
688
689         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
690         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
691     }
692
693     @Test
694     public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
695         String name = "testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates";
696         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
697                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
698                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
699
700         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
701                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
702                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
703
704         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
705                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
706                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
707
708         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
709
710         leaderDistributedDataStore.waitTillReady();
711         follower1Node.configDataStore().waitTillReady();
712         follower2Node.configDataStore().waitTillReady();
713
714         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
715         final DOMEntityOwnershipService follower1EntityOwnershipService =
716                 newOwnershipService(follower1Node.configDataStore());
717         newOwnershipService(follower2Node.configDataStore());
718
719         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorUtils(), ENTITY_OWNERSHIP_SHARD_NAME);
720
721         // Register leader candidate for entity1 and verify it becomes owner
722
723         final DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
724                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
725
726         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
727         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
728
729         follower1EntityOwnershipService.registerCandidate(ENTITY1);
730         leaderEntity1Reg.close();
731
732         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
733         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
734     }
735
736     @Test
737     public void testEntityOwnershipWithNonVotingMembers() throws Exception {
738         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
739                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
740
741         String name = "testEntityOwnershipWithNonVotingMembers";
742         final MemberNode member1LeaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
743                 .useAkkaArtery(false).testName(name)
744                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
745                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
746
747         final MemberNode member2FollowerNode = MemberNode.builder(memberNodes).akkaConfig("Member2")
748                 .useAkkaArtery(false).testName(name)
749                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
750                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
751
752         final MemberNode member3FollowerNode = MemberNode.builder(memberNodes).akkaConfig("Member3")
753                 .useAkkaArtery(false).testName(name)
754                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
755                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
756
757         final MemberNode member4FollowerNode = MemberNode.builder(memberNodes).akkaConfig("Member4")
758                 .useAkkaArtery(false).testName(name)
759                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
760                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
761
762         final MemberNode member5FollowerNode = MemberNode.builder(memberNodes).akkaConfig("Member5")
763                 .useAkkaArtery(false).testName(name)
764                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(EOSTestUtils.SCHEMA_CONTEXT)
765                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
766
767         AbstractDataStore leaderDistributedDataStore = member1LeaderNode.configDataStore();
768
769         leaderDistributedDataStore.waitTillReady();
770         member2FollowerNode.configDataStore().waitTillReady();
771         member3FollowerNode.configDataStore().waitTillReady();
772         member4FollowerNode.configDataStore().waitTillReady();
773         member5FollowerNode.configDataStore().waitTillReady();
774
775         member1LeaderNode.waitForMembersUp("member-2", "member-3", "member-4", "member-5");
776
777         final DOMEntityOwnershipService member3EntityOwnershipService =
778                 newOwnershipService(member3FollowerNode.configDataStore());
779         final DOMEntityOwnershipService member4EntityOwnershipService =
780                 newOwnershipService(member4FollowerNode.configDataStore());
781         final DOMEntityOwnershipService member5EntityOwnershipService =
782                 newOwnershipService(member5FollowerNode.configDataStore());
783
784         newOwnershipService(member1LeaderNode.configDataStore());
785         member1LeaderNode.kit().waitUntilLeader(member1LeaderNode.configDataStore().getActorUtils(),
786                 ENTITY_OWNERSHIP_SHARD_NAME);
787
788         // Make member4 and member5 non-voting
789
790         Future<Object> future = Patterns.ask(leaderDistributedDataStore.getActorUtils().getShardManager(),
791                 new ChangeShardMembersVotingStatus(ENTITY_OWNERSHIP_SHARD_NAME,
792                         ImmutableMap.of("member-4", Boolean.FALSE, "member-5", Boolean.FALSE)),
793                 new Timeout(10, TimeUnit.SECONDS));
794         Object response = Await.result(future, FiniteDuration.apply(10, TimeUnit.SECONDS));
795         if (response instanceof Throwable) {
796             throw new AssertionError("ChangeShardMembersVotingStatus failed", (Throwable)response);
797         }
798
799         assertNull("Expected null Success response. Actual " + response, response);
800
801         // Register member4 candidate for entity1 - it should not become owner since it's non-voting
802
803         member4EntityOwnershipService.registerCandidate(ENTITY1);
804         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-4");
805
806         // Register member5 candidate for entity2 - it should not become owner since it's non-voting
807
808         member5EntityOwnershipService.registerCandidate(ENTITY2);
809         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-5");
810
811         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
812         verifyOwner(leaderDistributedDataStore, ENTITY1, "");
813         verifyOwner(leaderDistributedDataStore, ENTITY2, "");
814
815         // Register member3 candidate for entity1 - it should become owner since it's voting
816
817         member3EntityOwnershipService.registerCandidate(ENTITY1);
818         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-4", "member-3");
819         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-3");
820
821         // Switch member4 and member5 back to voting and member3 non-voting. This should result in member4 and member5
822         // to become entity owners.
823
824         future = Patterns.ask(leaderDistributedDataStore.getActorUtils().getShardManager(),
825                 new ChangeShardMembersVotingStatus(ENTITY_OWNERSHIP_SHARD_NAME,
826                         ImmutableMap.of("member-3", Boolean.FALSE, "member-4", Boolean.TRUE, "member-5", Boolean.TRUE)),
827                 new Timeout(10, TimeUnit.SECONDS));
828         response = Await.result(future, FiniteDuration.apply(10, TimeUnit.SECONDS));
829         if (response instanceof Throwable) {
830             throw new AssertionError("ChangeShardMembersVotingStatus failed", (Throwable)response);
831         }
832
833         assertNull("Expected null Success response. Actual " + response, response);
834
835         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-4");
836         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-5");
837     }
838
839     private static void verifyGetOwnershipState(final DOMEntityOwnershipService service, final DOMEntity entity,
840             final EntityOwnershipState expState) {
841         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
842         assertTrue("getOwnershipState present", state.isPresent());
843         assertEquals("EntityOwnershipState", expState, state.get());
844     }
845
846     private static void verifyCandidates(final AbstractDataStore dataStore, final DOMEntity entity,
847             final String... expCandidates) throws Exception {
848         AssertionError lastError = null;
849         Stopwatch sw = Stopwatch.createStarted();
850         while (sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
851             Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction()
852                     .read(entityPath(entity.getType(), entity.getIdentifier()).node(Candidate.QNAME))
853                     .get(5, TimeUnit.SECONDS);
854             try {
855                 assertTrue("Candidates not found for " + entity, possible.isPresent());
856                 Collection<String> actual = new ArrayList<>();
857                 for (MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
858                     actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
859                 }
860
861                 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
862                 return;
863             } catch (AssertionError e) {
864                 lastError = e;
865                 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
866             }
867         }
868
869         throw lastError;
870     }
871
872     @SuppressWarnings("checkstyle:IllegalCatch")
873     private static void verifyOwner(final AbstractDataStore dataStore, final DOMEntity entity,
874             final String expOwner) {
875         AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getIdentifier(), path -> {
876             try {
877                 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
878             } catch (Exception e) {
879                 return null;
880             }
881         });
882     }
883 }