9d91c272ac5ecb087d20411aa0dd99666c8b2fd3
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / entityownership / DistributedEntityOwnershipIntegrationTest.java
1 /*
2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.cluster.datastore.entityownership;
9
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNull;
12 import static org.junit.Assert.assertThat;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.AdditionalMatchers.or;
15 import static org.mockito.Mockito.doNothing;
16 import static org.mockito.Mockito.never;
17 import static org.mockito.Mockito.reset;
18 import static org.mockito.Mockito.timeout;
19 import static org.mockito.Mockito.verify;
20 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
21 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
22 import static org.opendaylight.controller.cluster.datastore.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
24 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
25
26 import akka.actor.ActorRef;
27 import akka.actor.Status.Failure;
28 import akka.actor.Status.Success;
29 import akka.cluster.Cluster;
30 import akka.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.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
56 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
57 import org.opendaylight.controller.cluster.datastore.messages.ChangeShardMembersVotingStatus;
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.controller.md.cluster.datastore.model.SchemaContextHelper;
62 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
63 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
64 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
65 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
66 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
67 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService;
68 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;
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;
73 import scala.concurrent.Await;
74 import scala.concurrent.Future;
75 import scala.concurrent.duration.FiniteDuration;
76
77 /**
78  * End-to-end integration tests for the entity ownership functionality.
79  *
80  * @author Thomas Pantelis
81  */
82 public class DistributedEntityOwnershipIntegrationTest {
83     private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
84     private static final String MODULE_SHARDS_5_NODE_CONFIG = "module-shards-default-5-node.conf";
85     private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
86     private static final String ENTITY_TYPE1 = "entityType1";
87     private static final String ENTITY_TYPE2 = "entityType2";
88     private static final DOMEntity ENTITY1 = new DOMEntity(ENTITY_TYPE1, "entity1");
89     private static final DOMEntity ENTITY1_2 = new DOMEntity(ENTITY_TYPE2, "entity1");
90     private static final DOMEntity ENTITY2 = new DOMEntity(ENTITY_TYPE1, "entity2");
91     private static final DOMEntity ENTITY3 = new DOMEntity(ENTITY_TYPE1, "entity3");
92     private static final DOMEntity ENTITY4 = new DOMEntity(ENTITY_TYPE1, "entity4");
93     private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
94
95     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
96             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
97                     .shardIsolatedLeaderCheckIntervalInMillis(1000000);
98
99     private final DatastoreContext.Builder followerDatastoreContextBuilder =
100             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
101
102     private final List<MemberNode> memberNodes = new ArrayList<>();
103
104     @Mock
105     private DOMEntityOwnershipListener leaderMockListener;
106
107     @Mock
108     private DOMEntityOwnershipListener leaderMockListener2;
109
110     @Mock
111     private DOMEntityOwnershipListener follower1MockListener;
112
113     @Mock
114     private DOMEntityOwnershipListener follower2MockListener;
115
116     @Before
117     public void setUp() {
118         MockitoAnnotations.initMocks(this);
119         InMemoryJournal.clear();
120         InMemorySnapshotStore.clear();
121     }
122
123     @After
124     public void tearDown() {
125         for (MemberNode m : Lists.reverse(memberNodes)) {
126             m.cleanup();
127         }
128         memberNodes.clear();
129     }
130
131     private static DistributedEntityOwnershipService newOwnershipService(final AbstractDataStore datastore) {
132         return DistributedEntityOwnershipService.start(datastore.getActorContext(),
133                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
134     }
135
136     @Test
137     public void testFunctionalityWithThreeNodes() throws Exception {
138         String name = "testFunctionalityWithThreeNodes";
139         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
140                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
141                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
142
143         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
144                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
145                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
146
147         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
148                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
149                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
150
151         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
152
153         leaderDistributedDataStore.waitTillReady();
154         follower1Node.configDataStore().waitTillReady();
155         follower2Node.configDataStore().waitTillReady();
156
157         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
158         final DOMEntityOwnershipService follower1EntityOwnershipService =
159                 newOwnershipService(follower1Node.configDataStore());
160         final DOMEntityOwnershipService follower2EntityOwnershipService =
161                 newOwnershipService(follower2Node.configDataStore());
162
163         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
164
165         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
166         leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
167         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
168
169         // Register leader candidate for entity1 and verify it becomes owner
170
171         leaderEntityOwnershipService.registerCandidate(ENTITY1);
172         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
173         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
174         reset(leaderMockListener, follower1MockListener);
175
176         verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, EntityOwnershipState.IS_OWNER);
177         verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, EntityOwnershipState.OWNED_BY_OTHER);
178
179         // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
180
181         leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
182         verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
183         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
184         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1_2));
185         reset(leaderMockListener2);
186
187         // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
188
189         follower1EntityOwnershipService.registerCandidate(ENTITY1);
190         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
191         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
192         verifyOwner(follower2Node.configDataStore(), ENTITY1, "member-1");
193         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
194         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
195         verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
196
197         // Register follower1 candidate for entity2 and verify it becomes owner
198
199         final DOMEntityOwnershipCandidateRegistration follower1Entity2Reg =
200                 follower1EntityOwnershipService.registerCandidate(ENTITY2);
201         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
202         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
203         verifyOwner(follower2Node.configDataStore(), ENTITY2, "member-2");
204         reset(leaderMockListener, follower1MockListener);
205
206         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
207
208         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
209         verify(follower2MockListener, timeout(5000).times(2)).ownershipChanged(or(
210                 ownershipChange(ENTITY1, false, false, true), ownershipChange(ENTITY2, false, false, true)));
211
212         follower2EntityOwnershipService.registerCandidate(ENTITY2);
213         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
214         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
215
216         // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
217
218         follower1Entity2Reg.close();
219         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
220         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
221         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
222         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
223
224         // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
225         // if the original ownership change with "member-2 is replicated to follower2 after the listener is
226         // registered.
227         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
228         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
229
230         // Register follower1 candidate for entity3 and verify it becomes owner
231
232         follower1EntityOwnershipService.registerCandidate(ENTITY3);
233         verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
234         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
235         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
236         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
237
238         // Register follower2 candidate for entity4 and verify it becomes owner
239
240         follower2EntityOwnershipService.registerCandidate(ENTITY4);
241         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
242         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
243         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
244         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
245         reset(follower1MockListener, follower2MockListener);
246
247         // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
248
249         follower1EntityOwnershipService.registerCandidate(ENTITY4);
250         verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
251         verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
252
253         // Shutdown follower2 and verify it's owned entities (entity 4) get re-assigned
254
255         reset(leaderMockListener, follower1MockListener);
256         follower2Node.cleanup();
257
258         verify(follower1MockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
259         verify(leaderMockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
260
261         // Register leader candidate for entity2 and verify it becomes owner
262
263         DOMEntityOwnershipCandidateRegistration leaderEntity2Reg =
264                 leaderEntityOwnershipService.registerCandidate(ENTITY2);
265         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
266         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
267
268         // Unregister leader candidate for entity2 and verify the owner is cleared
269
270         leaderEntity2Reg.close();
271         verifyOwner(leaderDistributedDataStore, ENTITY2, "");
272         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
273         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
274     }
275
276     @Test
277     public void testLeaderEntityOwnersReassignedAfterShutdown() throws Exception {
278         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
279                     .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
280
281         String name = "testLeaderEntityOwnersReassignedAfterShutdown";
282         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
283                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
284                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
285
286         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
287                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
288                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
289
290         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
291                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
292                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
293
294         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
295
296         leaderDistributedDataStore.waitTillReady();
297         follower1Node.configDataStore().waitTillReady();
298         follower2Node.configDataStore().waitTillReady();
299
300         follower1Node.waitForMembersUp("member-1", "member-3");
301
302         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
303         final DOMEntityOwnershipService follower1EntityOwnershipService =
304                 newOwnershipService(follower1Node.configDataStore());
305         final DOMEntityOwnershipService follower2EntityOwnershipService =
306                 newOwnershipService(follower2Node.configDataStore());
307
308         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
309
310         // Register follower1 candidate for entity1 and verify it becomes owner
311
312         follower1EntityOwnershipService.registerCandidate(ENTITY1);
313         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
314
315         // Register leader candidate for entity1
316
317         leaderEntityOwnershipService.registerCandidate(ENTITY1);
318         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
319         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
320
321         // Register leader candidate for entity2 and verify it becomes owner
322
323         leaderEntityOwnershipService.registerCandidate(ENTITY2);
324         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
325
326         // Register follower2 candidate for entity2
327
328         follower2EntityOwnershipService.registerCandidate(ENTITY2);
329         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
330         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
331
332         // Re-enable elections on all remaining followers so one becomes the new leader
333
334         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
335                 ENTITY_OWNERSHIP_SHARD_NAME);
336         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
337                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
338
339         ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorContext(),
340                 ENTITY_OWNERSHIP_SHARD_NAME);
341         follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
342                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
343
344         // Shutdown the leader and verify its removed from the candidate list
345
346         leaderNode.cleanup();
347         follower1Node.waitForMemberDown("member-1");
348         follower2Node.waitForMemberDown("member-1");
349
350         // Verify the prior leader's entity owners are re-assigned.
351
352         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
353         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3");
354         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
355         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
356     }
357
358     @Test
359     public void testLeaderAndFollowerEntityOwnersReassignedAfterShutdown() throws Exception {
360         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
361                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
362
363         String name = "testLeaderAndFollowerEntityOwnersReassignedAfterShutdown";
364         final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
365                 .useAkkaArtery(false).testName(name)
366                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
367                 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
368
369         final MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2")
370                 .useAkkaArtery(false).testName(name)
371                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
372                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
373
374         final MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3")
375                 .useAkkaArtery(false).testName(name)
376                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
377                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
378
379         final MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4")
380                 .useAkkaArtery(false).testName(name)
381                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
382                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
383
384         final MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5")
385                 .useAkkaArtery(false).testName(name)
386                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
387                 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
388
389         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
390
391         leaderDistributedDataStore.waitTillReady();
392         follower1Node.configDataStore().waitTillReady();
393         follower2Node.configDataStore().waitTillReady();
394         follower3Node.configDataStore().waitTillReady();
395         follower4Node.configDataStore().waitTillReady();
396
397         leaderNode.waitForMembersUp("member-2", "member-3", "member-4", "member-5");
398         follower1Node.waitForMembersUp("member-1", "member-3", "member-4", "member-5");
399
400         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
401         final DOMEntityOwnershipService follower1EntityOwnershipService =
402                 newOwnershipService(follower1Node.configDataStore());
403         final DOMEntityOwnershipService follower2EntityOwnershipService =
404                 newOwnershipService(follower2Node.configDataStore());
405         final DOMEntityOwnershipService follower3EntityOwnershipService =
406                 newOwnershipService(follower3Node.configDataStore());
407         newOwnershipService(follower4Node.configDataStore());
408
409         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
410
411         // Register follower1 candidate for entity1 and verify it becomes owner
412
413         follower1EntityOwnershipService.registerCandidate(ENTITY1);
414         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
415
416         // Register leader candidate for entity1
417
418         leaderEntityOwnershipService.registerCandidate(ENTITY1);
419         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
420         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
421
422         // Register leader candidate for entity2 and verify it becomes owner
423
424         leaderEntityOwnershipService.registerCandidate(ENTITY2);
425         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
426
427         // Register follower2 candidate for entity2
428
429         follower2EntityOwnershipService.registerCandidate(ENTITY2);
430         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
431         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
432
433         // Register follower3 as a candidate for entity2 as well
434
435         follower3EntityOwnershipService.registerCandidate(ENTITY2);
436         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
437         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
438
439         // Re-enable elections on all remaining followers so one becomes the new leader
440
441         ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
442                 ENTITY_OWNERSHIP_SHARD_NAME);
443         follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
444                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
445
446         ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorContext(),
447                 ENTITY_OWNERSHIP_SHARD_NAME);
448         follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
449                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
450
451         ActorRef follower4Shard = IntegrationTestKit.findLocalShard(follower4Node.configDataStore().getActorContext(),
452                 ENTITY_OWNERSHIP_SHARD_NAME);
453         follower4Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
454                 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
455
456         // Shutdown the leader and follower3
457
458         leaderNode.cleanup();
459         follower3Node.cleanup();
460
461         follower1Node.waitForMemberDown("member-1");
462         follower1Node.waitForMemberDown("member-4");
463         follower2Node.waitForMemberDown("member-1");
464         follower2Node.waitForMemberDown("member-4");
465         follower4Node.waitForMemberDown("member-1");
466         follower4Node.waitForMemberDown("member-4");
467
468         // Verify the prior leader's and follower3 entity owners are re-assigned.
469
470         verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
471         verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3", "member-4");
472         verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
473         verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
474     }
475
476     /**
477      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
478      */
479     @Test
480     public void testCloseCandidateRegistrationInQuickSuccession() throws Exception {
481         String name = "testCloseCandidateRegistrationInQuickSuccession";
482         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
483                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
484                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
485
486         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
487                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
488                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
489
490         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
491                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
492                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
493
494         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
495
496         leaderDistributedDataStore.waitTillReady();
497         follower1Node.configDataStore().waitTillReady();
498         follower2Node.configDataStore().waitTillReady();
499
500         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
501         final DOMEntityOwnershipService follower1EntityOwnershipService =
502                 newOwnershipService(follower1Node.configDataStore());
503         final DOMEntityOwnershipService follower2EntityOwnershipService =
504                 newOwnershipService(follower2Node.configDataStore());
505
506         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
507
508         leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
509         follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
510         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
511
512         final DOMEntityOwnershipCandidateRegistration candidate1 =
513                 leaderEntityOwnershipService.registerCandidate(ENTITY1);
514         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
515
516         final DOMEntityOwnershipCandidateRegistration candidate2 =
517                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
518         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
519
520         final DOMEntityOwnershipCandidateRegistration candidate3 =
521                 follower2EntityOwnershipService.registerCandidate(ENTITY1);
522         verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
523
524         Mockito.reset(leaderMockListener, follower1MockListener, follower2MockListener);
525
526         ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
527                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
528         ArgumentCaptor<DOMEntityOwnershipChange> follower1ChangeCaptor =
529                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
530         ArgumentCaptor<DOMEntityOwnershipChange> follower2ChangeCaptor =
531                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
532         doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
533         doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
534         doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
535
536         candidate1.close();
537         candidate2.close();
538         candidate3.close();
539
540         boolean passed = false;
541         for (int i = 0; i < 100; i++) {
542             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
543             final Optional<EntityOwnershipState> leaderState = leaderEntityOwnershipService.getOwnershipState(ENTITY1);
544             final Optional<EntityOwnershipState> follower1State =
545                     follower1EntityOwnershipService.getOwnershipState(ENTITY1);
546             final Optional<EntityOwnershipState> follower2State =
547                     follower2EntityOwnershipService.getOwnershipState(ENTITY1);
548             final Optional<DOMEntityOwnershipChange> leaderChange = getValueSafely(leaderChangeCaptor);
549             final Optional<DOMEntityOwnershipChange> follower1Change = getValueSafely(follower1ChangeCaptor);
550             final Optional<DOMEntityOwnershipChange> follower2Change = getValueSafely(follower2ChangeCaptor);
551             if (!leaderState.isPresent() || leaderState.get() == EntityOwnershipState.NO_OWNER
552                     && follower1State.isPresent() && follower1State.get() == EntityOwnershipState.NO_OWNER
553                     && follower2State.isPresent() && follower2State.get() == EntityOwnershipState.NO_OWNER
554                     && leaderChange.isPresent() && !leaderChange.get().getState().hasOwner()
555                     && follower1Change.isPresent() && !follower1Change.get().getState().hasOwner()
556                     && follower2Change.isPresent() && !follower2Change.get().getState().hasOwner()) {
557                 passed = true;
558                 break;
559             }
560         }
561
562         assertTrue("No ownership change message was sent with hasOwner=false", passed);
563     }
564
565     private static Optional<DOMEntityOwnershipChange> getValueSafely(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(SCHEMA_CONTEXT).createOperDatastore(false)
585                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
586
587         AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
588         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
589
590         leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
591
592         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
593                 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
594                 .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.getActorContext().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(SCHEMA_CONTEXT).createOperDatastore(false)
636                 .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(SCHEMA_CONTEXT).createOperDatastore(false)
655                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
656
657         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
658                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
659                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
660
661         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
662                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
663                 .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().getActorContext(), 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(SCHEMA_CONTEXT).createOperDatastore(false)
698                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
699
700         MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
701                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
702                 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
703
704         MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
705                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
706                 .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().getActorContext(), 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(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(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(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(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(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().getActorContext(),
786                 ENTITY_OWNERSHIP_SHARD_NAME);
787
788         // Make member4 and member5 non-voting
789
790         Future<Object> future = Patterns.ask(leaderDistributedDataStore.getActorContext().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.getActorContext().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 }