2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.datastore.entityownership;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNull;
12 import static org.junit.Assert.assertThat;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.AdditionalMatchers.or;
15 import static org.mockito.Mockito.doNothing;
16 import static org.mockito.Mockito.never;
17 import static org.mockito.Mockito.reset;
18 import static org.mockito.Mockito.timeout;
19 import static org.mockito.Mockito.verify;
20 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
21 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
22 import static org.opendaylight.controller.cluster.datastore.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
24 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
26 import akka.actor.ActorRef;
27 import akka.actor.Status.Failure;
28 import akka.actor.Status.Success;
29 import akka.cluster.Cluster;
30 import akka.testkit.JavaTestKit;
31 import com.google.common.base.Optional;
32 import com.google.common.base.Stopwatch;
33 import com.google.common.collect.Iterables;
34 import com.google.common.collect.Lists;
35 import com.google.common.util.concurrent.Uninterruptibles;
36 import java.util.ArrayList;
37 import java.util.Arrays;
38 import java.util.Collection;
39 import java.util.List;
40 import java.util.concurrent.TimeUnit;
41 import org.junit.After;
42 import org.junit.Before;
43 import org.junit.Test;
44 import org.mockito.ArgumentCaptor;
45 import org.mockito.Mock;
46 import org.mockito.Mockito;
47 import org.mockito.MockitoAnnotations;
48 import org.mockito.exceptions.base.MockitoException;
49 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
50 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
51 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
52 import org.opendaylight.controller.cluster.datastore.MemberNode;
53 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
54 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
55 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
56 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
57 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
58 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
59 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
60 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
61 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
62 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
63 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
64 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService;
65 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;
66 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
67 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
68 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
69 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
72 * End-to-end integration tests for the entity ownership functionality.
74 * @author Thomas Pantelis
76 public class DistributedEntityOwnershipIntegrationTest {
77 private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
78 private static final String MODULE_SHARDS_5_NODE_CONFIG = "module-shards-default-5-node.conf";
79 private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
80 private static final String ENTITY_TYPE1 = "entityType1";
81 private static final String ENTITY_TYPE2 = "entityType2";
82 private static final DOMEntity ENTITY1 = new DOMEntity(ENTITY_TYPE1, "entity1");
83 private static final DOMEntity ENTITY1_2 = new DOMEntity(ENTITY_TYPE2, "entity1");
84 private static final DOMEntity ENTITY2 = new DOMEntity(ENTITY_TYPE1, "entity2");
85 private static final DOMEntity ENTITY3 = new DOMEntity(ENTITY_TYPE1, "entity3");
86 private static final DOMEntity ENTITY4 = new DOMEntity(ENTITY_TYPE1, "entity4");
87 private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
89 private final DatastoreContext.Builder leaderDatastoreContextBuilder =
90 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
91 .shardIsolatedLeaderCheckIntervalInMillis(1000000);
93 private final DatastoreContext.Builder followerDatastoreContextBuilder =
94 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
96 private final List<MemberNode> memberNodes = new ArrayList<>();
99 private DOMEntityOwnershipListener leaderMockListener;
102 private DOMEntityOwnershipListener leaderMockListener2;
105 private DOMEntityOwnershipListener follower1MockListener;
108 private DOMEntityOwnershipListener follower2MockListener;
111 public void setUp() {
112 MockitoAnnotations.initMocks(this);
113 InMemoryJournal.clear();
114 InMemorySnapshotStore.clear();
118 public void tearDown() {
119 for (MemberNode m : Lists.reverse(memberNodes)) {
125 private static DistributedEntityOwnershipService newOwnershipService(final AbstractDataStore datastore) {
126 return DistributedEntityOwnershipService.start(datastore.getActorContext(),
127 EntityOwnerSelectionStrategyConfig.newBuilder().build());
131 public void testFunctionalityWithThreeNodes() throws Exception {
132 String name = "testFunctionalityWithThreeNodes";
133 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
134 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
135 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
137 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
138 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
139 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
141 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
142 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
143 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
145 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
147 leaderDistributedDataStore.waitTillReady();
148 follower1Node.configDataStore().waitTillReady();
149 follower2Node.configDataStore().waitTillReady();
151 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
152 final DOMEntityOwnershipService follower1EntityOwnershipService =
153 newOwnershipService(follower1Node.configDataStore());
154 final DOMEntityOwnershipService follower2EntityOwnershipService =
155 newOwnershipService(follower2Node.configDataStore());
157 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
159 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
160 leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
161 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
163 // Register leader candidate for entity1 and verify it becomes owner
165 leaderEntityOwnershipService.registerCandidate(ENTITY1);
166 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
167 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
168 reset(leaderMockListener, follower1MockListener);
170 verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, EntityOwnershipState.IS_OWNER);
171 verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, EntityOwnershipState.OWNED_BY_OTHER);
173 // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
175 leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
176 verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
177 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
178 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1_2));
179 reset(leaderMockListener2);
181 // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
183 follower1EntityOwnershipService.registerCandidate(ENTITY1);
184 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
185 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
186 verifyOwner(follower2Node.configDataStore(), ENTITY1, "member-1");
187 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
188 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
189 verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
191 // Register follower1 candidate for entity2 and verify it becomes owner
193 final DOMEntityOwnershipCandidateRegistration follower1Entity2Reg =
194 follower1EntityOwnershipService.registerCandidate(ENTITY2);
195 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
196 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
197 verifyOwner(follower2Node.configDataStore(), ENTITY2, "member-2");
198 reset(leaderMockListener, follower1MockListener);
200 // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
202 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
203 verify(follower2MockListener, timeout(5000).times(2)).ownershipChanged(or(
204 ownershipChange(ENTITY1, false, false, true), ownershipChange(ENTITY2, false, false, true)));
206 follower2EntityOwnershipService.registerCandidate(ENTITY2);
207 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
208 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
210 // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
212 follower1Entity2Reg.close();
213 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
214 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
215 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
216 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
218 // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
219 // if the original ownership change with "member-2 is replicated to follower2 after the listener is
221 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
222 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
224 // Register follower1 candidate for entity3 and verify it becomes owner
226 follower1EntityOwnershipService.registerCandidate(ENTITY3);
227 verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
228 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
229 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
230 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
232 // Register follower2 candidate for entity4 and verify it becomes owner
234 follower2EntityOwnershipService.registerCandidate(ENTITY4);
235 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
236 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
237 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
238 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
239 reset(follower1MockListener, follower2MockListener);
241 // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
243 follower1EntityOwnershipService.registerCandidate(ENTITY4);
244 verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
245 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
247 // Shutdown follower2 and verify it's owned entities (entity 4) get re-assigned
249 reset(leaderMockListener, follower1MockListener);
250 follower2Node.cleanup();
252 verify(follower1MockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
253 verify(leaderMockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
255 // Register leader candidate for entity2 and verify it becomes owner
257 DOMEntityOwnershipCandidateRegistration leaderEntity2Reg =
258 leaderEntityOwnershipService.registerCandidate(ENTITY2);
259 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
260 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
262 // Unregister leader candidate for entity2 and verify the owner is cleared
264 leaderEntity2Reg.close();
265 verifyOwner(leaderDistributedDataStore, ENTITY2, "");
266 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
267 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
271 public void testLeaderEntityOwnersReassignedAfterShutdown() throws Exception {
272 followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
273 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
275 String name = "testLeaderEntityOwnersReassignedAfterShutdown";
276 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
277 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
278 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
280 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
281 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
282 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
284 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
285 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
286 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
288 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
290 leaderDistributedDataStore.waitTillReady();
291 follower1Node.configDataStore().waitTillReady();
292 follower2Node.configDataStore().waitTillReady();
294 follower1Node.waitForMembersUp("member-1", "member-3");
296 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
297 final DOMEntityOwnershipService follower1EntityOwnershipService =
298 newOwnershipService(follower1Node.configDataStore());
299 final DOMEntityOwnershipService follower2EntityOwnershipService =
300 newOwnershipService(follower2Node.configDataStore());
302 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
304 // Register follower1 candidate for entity1 and verify it becomes owner
306 follower1EntityOwnershipService.registerCandidate(ENTITY1);
307 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
309 // Register leader candidate for entity1
311 leaderEntityOwnershipService.registerCandidate(ENTITY1);
312 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
313 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
315 // Register leader candidate for entity2 and verify it becomes owner
317 leaderEntityOwnershipService.registerCandidate(ENTITY2);
318 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
320 // Register follower2 candidate for entity2
322 follower2EntityOwnershipService.registerCandidate(ENTITY2);
323 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
324 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
326 // Re-enable elections on all remaining followers so one becomes the new leader
328 ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
329 ENTITY_OWNERSHIP_SHARD_NAME);
330 follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
331 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
333 ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorContext(),
334 ENTITY_OWNERSHIP_SHARD_NAME);
335 follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
336 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
338 // Shutdown the leader and verify its removed from the candidate list
340 leaderNode.cleanup();
341 follower1Node.waitForMemberDown("member-1");
342 follower2Node.waitForMemberDown("member-1");
344 // Verify the prior leader's entity owners are re-assigned.
346 verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
347 verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3");
348 verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
349 verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
353 public void testLeaderAndFollowerEntityOwnersReassignedAfterShutdown() throws Exception {
354 followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
355 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
357 String name = "testLeaderAndFollowerEntityOwnersReassignedAfterShutdown";
358 final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
359 .useAkkaArtery(false).testName(name)
360 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
361 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
363 final MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2")
364 .useAkkaArtery(false).testName(name)
365 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
366 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
368 final MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3")
369 .useAkkaArtery(false).testName(name)
370 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
371 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
373 final MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4")
374 .useAkkaArtery(false).testName(name)
375 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
376 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
378 final MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5")
379 .useAkkaArtery(false).testName(name)
380 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
381 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
383 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
385 leaderDistributedDataStore.waitTillReady();
386 follower1Node.configDataStore().waitTillReady();
387 follower2Node.configDataStore().waitTillReady();
388 follower3Node.configDataStore().waitTillReady();
389 follower4Node.configDataStore().waitTillReady();
391 leaderNode.waitForMembersUp("member-2", "member-3", "member-4", "member-5");
392 follower1Node.waitForMembersUp("member-1", "member-3", "member-4", "member-5");
394 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
395 final DOMEntityOwnershipService follower1EntityOwnershipService =
396 newOwnershipService(follower1Node.configDataStore());
397 final DOMEntityOwnershipService follower2EntityOwnershipService =
398 newOwnershipService(follower2Node.configDataStore());
399 final DOMEntityOwnershipService follower3EntityOwnershipService =
400 newOwnershipService(follower3Node.configDataStore());
401 newOwnershipService(follower4Node.configDataStore());
403 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
405 // Register follower1 candidate for entity1 and verify it becomes owner
407 follower1EntityOwnershipService.registerCandidate(ENTITY1);
408 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
410 // Register leader candidate for entity1
412 leaderEntityOwnershipService.registerCandidate(ENTITY1);
413 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
414 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
416 // Register leader candidate for entity2 and verify it becomes owner
418 leaderEntityOwnershipService.registerCandidate(ENTITY2);
419 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
421 // Register follower2 candidate for entity2
423 follower2EntityOwnershipService.registerCandidate(ENTITY2);
424 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
425 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
427 // Register follower3 as a candidate for entity2 as well
429 follower3EntityOwnershipService.registerCandidate(ENTITY2);
430 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
431 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
433 // Re-enable elections on all remaining followers so one becomes the new leader
435 ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
436 ENTITY_OWNERSHIP_SHARD_NAME);
437 follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
438 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
440 ActorRef follower2Shard = IntegrationTestKit.findLocalShard(follower2Node.configDataStore().getActorContext(),
441 ENTITY_OWNERSHIP_SHARD_NAME);
442 follower2Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
443 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
445 ActorRef follower4Shard = IntegrationTestKit.findLocalShard(follower4Node.configDataStore().getActorContext(),
446 ENTITY_OWNERSHIP_SHARD_NAME);
447 follower4Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
448 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
450 // Shutdown the leader and follower3
452 leaderNode.cleanup();
453 follower3Node.cleanup();
455 follower1Node.waitForMemberDown("member-1");
456 follower1Node.waitForMemberDown("member-4");
457 follower2Node.waitForMemberDown("member-1");
458 follower2Node.waitForMemberDown("member-4");
459 follower4Node.waitForMemberDown("member-1");
460 follower4Node.waitForMemberDown("member-4");
462 // Verify the prior leader's and follower3 entity owners are re-assigned.
464 verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
465 verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3", "member-4");
466 verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
467 verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
471 * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
474 public void testCloseCandidateRegistrationInQuickSuccession() throws Exception {
475 String name = "testCloseCandidateRegistrationInQuickSuccession";
476 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
477 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
478 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
480 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
481 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
482 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
484 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
485 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
486 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
488 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
490 leaderDistributedDataStore.waitTillReady();
491 follower1Node.configDataStore().waitTillReady();
492 follower2Node.configDataStore().waitTillReady();
494 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
495 final DOMEntityOwnershipService follower1EntityOwnershipService =
496 newOwnershipService(follower1Node.configDataStore());
497 final DOMEntityOwnershipService follower2EntityOwnershipService =
498 newOwnershipService(follower2Node.configDataStore());
500 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
502 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
503 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
504 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
506 final DOMEntityOwnershipCandidateRegistration candidate1 =
507 leaderEntityOwnershipService.registerCandidate(ENTITY1);
508 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
510 final DOMEntityOwnershipCandidateRegistration candidate2 =
511 follower1EntityOwnershipService.registerCandidate(ENTITY1);
512 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
514 final DOMEntityOwnershipCandidateRegistration candidate3 =
515 follower2EntityOwnershipService.registerCandidate(ENTITY1);
516 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
518 Mockito.reset(leaderMockListener, follower1MockListener, follower2MockListener);
520 ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
521 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
522 ArgumentCaptor<DOMEntityOwnershipChange> follower1ChangeCaptor =
523 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
524 ArgumentCaptor<DOMEntityOwnershipChange> follower2ChangeCaptor =
525 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
526 doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
527 doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
528 doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
534 boolean passed = false;
535 for (int i = 0; i < 100; i++) {
536 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
537 final Optional<EntityOwnershipState> leaderState = leaderEntityOwnershipService.getOwnershipState(ENTITY1);
538 final Optional<EntityOwnershipState> follower1State =
539 follower1EntityOwnershipService.getOwnershipState(ENTITY1);
540 final Optional<EntityOwnershipState> follower2State =
541 follower2EntityOwnershipService.getOwnershipState(ENTITY1);
542 final Optional<DOMEntityOwnershipChange> leaderChange = getValueSafely(leaderChangeCaptor);
543 final Optional<DOMEntityOwnershipChange> follower1Change = getValueSafely(follower1ChangeCaptor);
544 final Optional<DOMEntityOwnershipChange> follower2Change = getValueSafely(follower2ChangeCaptor);
545 if (!leaderState.isPresent() || leaderState.get() == EntityOwnershipState.NO_OWNER
546 && follower1State.isPresent() && follower1State.get() == EntityOwnershipState.NO_OWNER
547 && follower2State.isPresent() && follower2State.get() == EntityOwnershipState.NO_OWNER
548 && leaderChange.isPresent() && !leaderChange.get().getState().hasOwner()
549 && follower1Change.isPresent() && !follower1Change.get().getState().hasOwner()
550 && follower2Change.isPresent() && !follower2Change.get().getState().hasOwner()) {
556 assertTrue("No ownership change message was sent with hasOwner=false", passed);
559 private static Optional<DOMEntityOwnershipChange> getValueSafely(ArgumentCaptor<DOMEntityOwnershipChange> captor) {
561 return Optional.fromNullable(captor.getValue());
562 } catch (MockitoException e) {
563 // No value was captured
564 return Optional.absent();
569 * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
570 * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
571 * an AddShardReplica request to join it to an existing leader.
574 public void testEntityOwnershipShardBootstrapping() throws Exception {
575 String name = "testEntityOwnershipShardBootstrapping";
576 String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
577 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
578 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
579 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
581 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
582 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
584 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
586 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
587 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
588 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
590 AbstractDataStore follower1DistributedDataStore = follower1Node.configDataStore();
591 follower1DistributedDataStore.waitTillReady();
593 leaderNode.waitForMembersUp("member-2");
594 follower1Node.waitForMembersUp("member-1");
596 DOMEntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
598 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
600 // Register a candidate for follower1 - should get queued since follower1 has no leader
601 final DOMEntityOwnershipCandidateRegistration candidateReg =
602 follower1EntityOwnershipService.registerCandidate(ENTITY1);
603 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
604 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
606 // Add replica in follower1
607 AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
608 follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica,
609 follower1Node.kit().getRef());
610 Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"),
611 Success.class, Failure.class);
612 if (reply instanceof Failure) {
613 throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
616 // The queued candidate registration should proceed
617 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
618 reset(leaderMockListener);
620 candidateReg.close();
621 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
622 reset(leaderMockListener);
624 // Restart follower1 and verify the entity ownership shard is re-instated by registering.
625 Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
626 follower1Node.cleanup();
628 follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
629 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
630 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
631 follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
633 follower1EntityOwnershipService.registerCandidate(ENTITY1);
634 verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
636 verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
637 assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
638 assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
639 assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
640 org.hamcrest.CoreMatchers.containsString("member-1"));
645 public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
646 String name = "testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates";
647 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
648 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
649 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
651 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
652 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
653 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
655 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
656 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
657 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
659 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
661 leaderDistributedDataStore.waitTillReady();
662 follower1Node.configDataStore().waitTillReady();
663 follower2Node.configDataStore().waitTillReady();
665 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
666 final DOMEntityOwnershipService follower1EntityOwnershipService =
667 newOwnershipService(follower1Node.configDataStore());
668 newOwnershipService(follower2Node.configDataStore());
670 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
672 // Register leader candidate for entity1 and verify it becomes owner
674 DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
675 leaderEntityOwnershipService.registerCandidate(ENTITY1);
677 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
678 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
680 leaderEntity1Reg.close();
681 follower1EntityOwnershipService.registerCandidate(ENTITY1);
683 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
684 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
688 public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
689 String name = "testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates";
690 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
691 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
692 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
694 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
695 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
696 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
698 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
699 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
700 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
702 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
704 leaderDistributedDataStore.waitTillReady();
705 follower1Node.configDataStore().waitTillReady();
706 follower2Node.configDataStore().waitTillReady();
708 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
709 final DOMEntityOwnershipService follower1EntityOwnershipService =
710 newOwnershipService(follower1Node.configDataStore());
711 newOwnershipService(follower2Node.configDataStore());
713 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
715 // Register leader candidate for entity1 and verify it becomes owner
717 final DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
718 leaderEntityOwnershipService.registerCandidate(ENTITY1);
720 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
721 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
723 follower1EntityOwnershipService.registerCandidate(ENTITY1);
724 leaderEntity1Reg.close();
726 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
727 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
730 private static void verifyGetOwnershipState(final DOMEntityOwnershipService service, final DOMEntity entity,
731 final EntityOwnershipState expState) {
732 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
733 assertEquals("getOwnershipState present", true, state.isPresent());
734 assertEquals("EntityOwnershipState", expState, state.get());
737 private static void verifyCandidates(final AbstractDataStore dataStore, final DOMEntity entity,
738 final String... expCandidates) throws Exception {
739 AssertionError lastError = null;
740 Stopwatch sw = Stopwatch.createStarted();
741 while (sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
742 Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction()
743 .read(entityPath(entity.getType(), entity.getIdentifier()).node(Candidate.QNAME))
744 .get(5, TimeUnit.SECONDS);
746 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
747 Collection<String> actual = new ArrayList<>();
748 for (MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
749 actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
752 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
754 } catch (AssertionError e) {
756 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
763 @SuppressWarnings("checkstyle:IllegalCatch")
764 private static void verifyOwner(final AbstractDataStore dataStore, final DOMEntity entity,
765 final String expOwner) {
766 AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getIdentifier(), path -> {
768 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
769 } catch (Exception e) {