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.Mockito.doNothing;
15 import static org.mockito.Mockito.never;
16 import static org.mockito.Mockito.reset;
17 import static org.mockito.Mockito.timeout;
18 import static org.mockito.Mockito.verify;
19 import static org.opendaylight.controller.cluster.datastore.MemberNode.verifyRaftState;
20 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
21 import static org.opendaylight.controller.cluster.datastore.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
22 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
25 import akka.actor.ActorRef;
26 import akka.actor.Status.Failure;
27 import akka.actor.Status.Success;
28 import akka.cluster.Cluster;
29 import akka.testkit.JavaTestKit;
30 import com.google.common.base.Optional;
31 import com.google.common.base.Stopwatch;
32 import com.google.common.collect.Iterables;
33 import com.google.common.collect.Lists;
34 import com.google.common.util.concurrent.Uninterruptibles;
35 import java.util.ArrayList;
36 import java.util.Arrays;
37 import java.util.Collection;
38 import java.util.List;
39 import java.util.concurrent.TimeUnit;
40 import org.junit.After;
41 import org.junit.Before;
42 import org.junit.Test;
43 import org.mockito.ArgumentCaptor;
44 import org.mockito.Mock;
45 import org.mockito.Mockito;
46 import org.mockito.MockitoAnnotations;
47 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
48 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
49 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
50 import org.opendaylight.controller.cluster.datastore.MemberNode;
51 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
52 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
53 import org.opendaylight.controller.cluster.raft.RaftState;
54 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
55 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
56 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
57 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
58 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
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 = "test";
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 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
187 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
188 verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
190 // Register follower1 candidate for entity2 and verify it becomes owner
192 final DOMEntityOwnershipCandidateRegistration follower1Entity2Reg =
193 follower1EntityOwnershipService.registerCandidate(ENTITY2);
194 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
195 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
196 reset(leaderMockListener, follower1MockListener);
198 // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
200 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
201 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
202 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
204 follower2EntityOwnershipService.registerCandidate(ENTITY2);
205 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
206 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
208 // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
210 follower1Entity2Reg.close();
211 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
212 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
213 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
214 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
216 // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
217 // if the original ownership change with "member-2 is replicated to follower2 after the listener is
219 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
220 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
222 // Register follower1 candidate for entity3 and verify it becomes owner
224 follower1EntityOwnershipService.registerCandidate(ENTITY3);
225 verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
226 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
227 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
228 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
230 // Register follower2 candidate for entity4 and verify it becomes owner
232 follower2EntityOwnershipService.registerCandidate(ENTITY4);
233 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
234 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
235 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
236 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
237 reset(follower1MockListener, follower2MockListener);
239 // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
241 follower1EntityOwnershipService.registerCandidate(ENTITY4);
242 verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
243 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
245 // Shutdown follower2 and verify it's owned entities (entity 4) get re-assigned
247 reset(leaderMockListener, follower1MockListener);
248 follower2Node.cleanup();
250 verify(follower1MockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
251 verify(leaderMockListener, timeout(15000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
253 // Register leader candidate for entity2 and verify it becomes owner
255 DOMEntityOwnershipCandidateRegistration leaderEntity2Reg =
256 leaderEntityOwnershipService.registerCandidate(ENTITY2);
257 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
258 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
260 // Unregister leader candidate for entity2 and verify the owner is cleared
262 leaderEntity2Reg.close();
263 verifyOwner(leaderDistributedDataStore, ENTITY2, "");
264 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
265 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
269 public void testLeaderEntityOwnersReassignedAfterShutdown() throws Exception {
270 followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
271 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
273 String name = "test";
274 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
275 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
276 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
278 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
279 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
280 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
282 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
283 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
284 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
286 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
288 leaderDistributedDataStore.waitTillReady();
289 follower1Node.configDataStore().waitTillReady();
290 follower2Node.configDataStore().waitTillReady();
292 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
293 final DOMEntityOwnershipService follower1EntityOwnershipService =
294 newOwnershipService(follower1Node.configDataStore());
295 final DOMEntityOwnershipService follower2EntityOwnershipService =
296 newOwnershipService(follower2Node.configDataStore());
298 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
300 // Register follower1 candidate for entity1 and verify it becomes owner
302 follower1EntityOwnershipService.registerCandidate(ENTITY1);
303 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
305 // Register leader candidate for entity1
307 leaderEntityOwnershipService.registerCandidate(ENTITY1);
308 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
309 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
311 // Register leader candidate for entity2 and verify it becomes owner
313 leaderEntityOwnershipService.registerCandidate(ENTITY2);
314 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
316 // Register follower2 candidate for entity2
318 follower2EntityOwnershipService.registerCandidate(ENTITY2);
319 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
320 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
322 // Shutdown the leader and verify its removed from the candidate list
324 leaderNode.cleanup();
325 follower1Node.waitForMemberDown("member-1");
327 // Re-enable elections on follower1 so it becomes the leader
329 ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
330 ENTITY_OWNERSHIP_SHARD_NAME);
331 follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
332 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
334 MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
335 raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
337 // Verify the prior leader's entity owners are re-assigned.
339 verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
340 verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3");
341 verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
342 verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
346 public void testLeaderAndFollowerEntityOwnersReassignedAfterShutdown() throws Exception {
347 followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
348 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
350 String name = "test";
351 final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
352 .useAkkaArtery(false).testName(name)
353 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
354 .createOperDatastore(false).datastoreContextBuilder(leaderDatastoreContextBuilder).build();
356 final MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2")
357 .useAkkaArtery(false).testName(name)
358 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
359 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
361 final MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3")
362 .useAkkaArtery(false).testName(name)
363 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
364 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
366 final MemberNode follower3Node = MemberNode.builder(memberNodes).akkaConfig("Member4")
367 .useAkkaArtery(false).testName(name)
368 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
369 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
371 final MemberNode follower4Node = MemberNode.builder(memberNodes).akkaConfig("Member5")
372 .useAkkaArtery(false).testName(name)
373 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
374 .createOperDatastore(false).datastoreContextBuilder(followerDatastoreContextBuilder).build();
376 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
378 leaderDistributedDataStore.waitTillReady();
379 follower1Node.configDataStore().waitTillReady();
380 follower2Node.configDataStore().waitTillReady();
382 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
383 final DOMEntityOwnershipService follower1EntityOwnershipService =
384 newOwnershipService(follower1Node.configDataStore());
385 final DOMEntityOwnershipService follower2EntityOwnershipService =
386 newOwnershipService(follower2Node.configDataStore());
387 final DOMEntityOwnershipService follower3EntityOwnershipService =
388 newOwnershipService(follower3Node.configDataStore());
389 newOwnershipService(follower4Node.configDataStore());
391 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
393 // Register follower1 candidate for entity1 and verify it becomes owner
395 follower1EntityOwnershipService.registerCandidate(ENTITY1);
396 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
398 // Register leader candidate for entity1
400 leaderEntityOwnershipService.registerCandidate(ENTITY1);
401 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2", "member-1");
402 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
404 // Register leader candidate for entity2 and verify it becomes owner
406 leaderEntityOwnershipService.registerCandidate(ENTITY2);
407 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
409 // Register follower2 candidate for entity2
411 follower2EntityOwnershipService.registerCandidate(ENTITY2);
412 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
413 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
415 // Register follower3 as a candidate for entity2 as well
417 follower3EntityOwnershipService.registerCandidate(ENTITY2);
418 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
419 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
421 // Shutdown the leader and follower3
423 leaderNode.cleanup();
424 follower3Node.cleanup();
426 follower1Node.waitForMemberDown("member-1");
427 follower1Node.waitForMemberDown("member-4");
429 // Re-enable elections on follower1 so it becomes the leader
431 ActorRef follower1Shard = IntegrationTestKit.findLocalShard(follower1Node.configDataStore().getActorContext(),
432 ENTITY_OWNERSHIP_SHARD_NAME);
433 follower1Shard.tell(DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build())
434 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
436 MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
437 raftState -> assertEquals("Raft state", RaftState.Leader.toString(), raftState.getRaftState()));
439 // Verify the prior leader's and follower3 entity owners are re-assigned.
441 verifyCandidates(follower1Node.configDataStore(), ENTITY1, "member-2", "member-1");
442 verifyCandidates(follower1Node.configDataStore(), ENTITY2, "member-1", "member-3", "member-4");
443 verifyOwner(follower1Node.configDataStore(), ENTITY1, "member-2");
444 verifyOwner(follower1Node.configDataStore(), ENTITY2, "member-3");
448 * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
451 public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
452 String name = "testCloseCandidateRegistrationInQuickSuccession";
453 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
454 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
455 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
457 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
458 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
459 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
461 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
462 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
463 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
465 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
467 leaderDistributedDataStore.waitTillReady();
468 follower1Node.configDataStore().waitTillReady();
469 follower2Node.configDataStore().waitTillReady();
471 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
472 final DOMEntityOwnershipService follower1EntityOwnershipService =
473 newOwnershipService(follower1Node.configDataStore());
474 final DOMEntityOwnershipService follower2EntityOwnershipService =
475 newOwnershipService(follower2Node.configDataStore());
477 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
479 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
480 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
481 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
483 final DOMEntityOwnershipCandidateRegistration candidate1 =
484 leaderEntityOwnershipService.registerCandidate(ENTITY1);
485 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
487 final DOMEntityOwnershipCandidateRegistration candidate2 =
488 follower1EntityOwnershipService.registerCandidate(ENTITY1);
489 final DOMEntityOwnershipCandidateRegistration candidate3 =
490 follower2EntityOwnershipService.registerCandidate(ENTITY1);
492 Mockito.reset(leaderMockListener);
494 ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
495 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
496 ArgumentCaptor<DOMEntityOwnershipChange> follower1ChangeCaptor =
497 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
498 ArgumentCaptor<DOMEntityOwnershipChange> follower2ChangeCaptor =
499 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
500 doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
501 doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
502 doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
508 boolean passed = false;
509 for (int i = 0; i < 100; i++) {
510 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
511 if (!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
512 || leaderEntityOwnershipService.getOwnershipState(ENTITY1).get() == EntityOwnershipState.NO_OWNER
513 && follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
514 && follower1EntityOwnershipService.getOwnershipState(ENTITY1)
515 .get() == EntityOwnershipState.NO_OWNER
516 && follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
517 && follower2EntityOwnershipService.getOwnershipState(ENTITY1)
518 .get() == EntityOwnershipState.NO_OWNER
519 && leaderChangeCaptor.getAllValues().size() > 0
520 && !leaderChangeCaptor.getValue().getState().hasOwner()
521 && leaderChangeCaptor.getAllValues().size() > 0
522 && !follower1ChangeCaptor.getValue().getState().hasOwner()
523 && leaderChangeCaptor.getAllValues().size() > 0
524 && !follower2ChangeCaptor.getValue().getState().hasOwner()) {
530 assertTrue("No ownership change message was sent with hasOwner=false", passed);
534 * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
535 * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
536 * an AddShardReplica request to join it to an existing leader.
539 public void testEntityOwnershipShardBootstrapping() throws Exception {
540 String name = "testEntityOwnershipShardBootstrapping";
541 String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
542 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
543 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
544 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
546 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
547 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
549 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
551 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
552 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
553 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
555 AbstractDataStore follower1DistributedDataStore = follower1Node.configDataStore();
556 follower1DistributedDataStore.waitTillReady();
558 leaderNode.waitForMembersUp("member-2");
559 follower1Node.waitForMembersUp("member-1");
561 DOMEntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
563 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
565 // Register a candidate for follower1 - should get queued since follower1 has no leader
566 final DOMEntityOwnershipCandidateRegistration candidateReg =
567 follower1EntityOwnershipService.registerCandidate(ENTITY1);
568 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
569 verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
571 // Add replica in follower1
572 AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
573 follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica,
574 follower1Node.kit().getRef());
575 Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"),
576 Success.class, Failure.class);
577 if (reply instanceof Failure) {
578 throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
581 // The queued candidate registration should proceed
582 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
583 reset(leaderMockListener);
585 candidateReg.close();
586 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, false));
587 reset(leaderMockListener);
589 // Restart follower1 and verify the entity ownership shard is re-instated by registering.
590 Cluster.get(leaderNode.kit().getSystem()).down(Cluster.get(follower1Node.kit().getSystem()).selfAddress());
591 follower1Node.cleanup();
593 follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
594 .moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
595 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
596 follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
598 follower1EntityOwnershipService.registerCandidate(ENTITY1);
599 verify(leaderMockListener, timeout(20000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
601 verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME, raftState -> {
602 assertNull("Custom RaftPolicy class name", raftState.getCustomRaftPolicyClassName());
603 assertEquals("Peer count", 1, raftState.getPeerAddresses().keySet().size());
604 assertThat("Peer Id", Iterables.<String>getLast(raftState.getPeerAddresses().keySet()),
605 org.hamcrest.CoreMatchers.containsString("member-1"));
610 public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
611 String name = "test";
612 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
613 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
614 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
616 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
617 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
618 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
620 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
621 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
622 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
624 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
626 leaderDistributedDataStore.waitTillReady();
627 follower1Node.configDataStore().waitTillReady();
628 follower2Node.configDataStore().waitTillReady();
630 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
631 final DOMEntityOwnershipService follower1EntityOwnershipService =
632 newOwnershipService(follower1Node.configDataStore());
633 newOwnershipService(follower2Node.configDataStore());
635 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
637 // Register leader candidate for entity1 and verify it becomes owner
639 DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
640 leaderEntityOwnershipService.registerCandidate(ENTITY1);
642 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
643 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
645 leaderEntity1Reg.close();
646 follower1EntityOwnershipService.registerCandidate(ENTITY1);
648 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
649 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
653 public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
654 String name = "test";
655 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
656 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
657 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
659 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name)
660 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
661 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
663 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name)
664 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
665 .datastoreContextBuilder(followerDatastoreContextBuilder).build();
667 AbstractDataStore leaderDistributedDataStore = leaderNode.configDataStore();
669 leaderDistributedDataStore.waitTillReady();
670 follower1Node.configDataStore().waitTillReady();
671 follower2Node.configDataStore().waitTillReady();
673 final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
674 final DOMEntityOwnershipService follower1EntityOwnershipService =
675 newOwnershipService(follower1Node.configDataStore());
676 newOwnershipService(follower2Node.configDataStore());
678 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
680 // Register leader candidate for entity1 and verify it becomes owner
682 final DOMEntityOwnershipCandidateRegistration leaderEntity1Reg =
683 leaderEntityOwnershipService.registerCandidate(ENTITY1);
685 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1");
686 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
688 follower1EntityOwnershipService.registerCandidate(ENTITY1);
689 leaderEntity1Reg.close();
691 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-2");
692 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-2");
695 private static void verifyGetOwnershipState(final DOMEntityOwnershipService service, final DOMEntity entity,
696 final EntityOwnershipState expState) {
697 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
698 assertEquals("getOwnershipState present", true, state.isPresent());
699 assertEquals("EntityOwnershipState", expState, state.get());
702 private static void verifyCandidates(final AbstractDataStore dataStore, final DOMEntity entity,
703 final String... expCandidates) throws Exception {
704 AssertionError lastError = null;
705 Stopwatch sw = Stopwatch.createStarted();
706 while (sw.elapsed(TimeUnit.MILLISECONDS) <= 10000) {
707 Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction()
708 .read(entityPath(entity.getType(), entity.getIdentifier()).node(Candidate.QNAME))
709 .get(5, TimeUnit.SECONDS);
711 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
712 Collection<String> actual = new ArrayList<>();
713 for (MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
714 actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
717 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
719 } catch (AssertionError e) {
721 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
728 @SuppressWarnings("checkstyle:IllegalCatch")
729 private static void verifyOwner(final AbstractDataStore dataStore, final DOMEntity entity,
730 final String expOwner) {
731 AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getIdentifier(), path -> {
733 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
734 } catch (Exception e) {