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.assertTrue;
12 import static org.mockito.AdditionalMatchers.or;
13 import static org.mockito.Mockito.atMost;
14 import static org.mockito.Mockito.doNothing;
15 import static org.mockito.Mockito.reset;
16 import static org.mockito.Mockito.timeout;
17 import static org.mockito.Mockito.verify;
18 import static org.opendaylight.controller.cluster.datastore.entityownership.AbstractEntityOwnershipTest.ownershipChange;
19 import static org.opendaylight.controller.cluster.datastore.entityownership.DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
20 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
21 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
22 import akka.actor.Status.Failure;
23 import akka.actor.Status.Success;
24 import akka.testkit.JavaTestKit;
25 import com.google.common.base.Function;
26 import com.google.common.base.Optional;
27 import com.google.common.base.Stopwatch;
28 import com.google.common.util.concurrent.Uninterruptibles;
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.Collection;
32 import java.util.List;
33 import java.util.concurrent.TimeUnit;
34 import org.junit.After;
35 import org.junit.Before;
36 import org.junit.Test;
37 import org.mockito.ArgumentCaptor;
38 import org.mockito.Mock;
39 import org.mockito.Mockito;
40 import org.mockito.MockitoAnnotations;
41 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
42 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
43 import org.opendaylight.controller.cluster.datastore.MemberNode;
44 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
45 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
46 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
47 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
48 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
49 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
50 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
51 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
52 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
53 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
54 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
55 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
56 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;
57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
58 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
59 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
61 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
64 * End-to-end integration tests for the entity ownership functionality.
66 * @author Thomas Pantelis
68 public class DistributedEntityOwnershipIntegrationTest {
69 private static final String MODULE_SHARDS_CONFIG = "module-shards-default.conf";
70 private static final String MODULE_SHARDS_MEMBER_1_CONFIG = "module-shards-default-member-1.conf";
71 private static final String ENTITY_TYPE1 = "entityType1";
72 private static final String ENTITY_TYPE2 = "entityType2";
73 private static final Entity ENTITY1 = new Entity(ENTITY_TYPE1, "entity1");
74 private static final Entity ENTITY1_2 = new Entity(ENTITY_TYPE2, "entity1");
75 private static final Entity ENTITY2 = new Entity(ENTITY_TYPE1, "entity2");
76 private static final Entity ENTITY3 = new Entity(ENTITY_TYPE1, "entity3");
77 private static final Entity ENTITY4 = new Entity(ENTITY_TYPE1, "entity4");
78 private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
80 private final DatastoreContext.Builder leaderDatastoreContextBuilder =
81 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5).
82 shardIsolatedLeaderCheckIntervalInMillis(1000000);
84 private final DatastoreContext.Builder followerDatastoreContextBuilder =
85 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000);
87 private final List<MemberNode> memberNodes = new ArrayList<>();
90 private EntityOwnershipListener leaderMockListener;
93 private EntityOwnershipListener leaderMockListener2;
96 private EntityOwnershipListener follower1MockListener;
99 private EntityOwnershipListener follower2MockListener;
102 public void setUp() {
103 MockitoAnnotations.initMocks(this);
104 InMemoryJournal.clear();
105 InMemorySnapshotStore.clear();
109 public void tearDown() {
110 for(MemberNode m: memberNodes) {
115 private DistributedEntityOwnershipService newOwnershipService(DistributedDataStore datastore) {
116 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(datastore,
117 EntityOwnerSelectionStrategyConfig.newBuilder().build());
123 public void testFunctionalityWithThreeNodes() throws Exception {
124 String name = "test";
125 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
126 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
127 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
129 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
130 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
131 datastoreContextBuilder(followerDatastoreContextBuilder).build();
133 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
134 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
135 datastoreContextBuilder(followerDatastoreContextBuilder).build();
137 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
139 leaderDistributedDataStore.waitTillReady();
140 follower1Node.configDataStore().waitTillReady();
141 follower2Node.configDataStore().waitTillReady();
143 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
144 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
145 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
147 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
149 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
150 leaderEntityOwnershipService.registerListener(ENTITY_TYPE2, leaderMockListener2);
151 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
153 // Register leader candidate for entity1 and verify it becomes owner
155 leaderEntityOwnershipService.registerCandidate(ENTITY1);
156 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
157 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
158 reset(leaderMockListener, follower1MockListener);
160 verifyGetOwnershipState(leaderEntityOwnershipService, ENTITY1, true, true);
161 verifyGetOwnershipState(follower1EntityOwnershipService, ENTITY1, false, true);
163 // Register leader candidate for entity1_2 (same id, different type) and verify it becomes owner
165 leaderEntityOwnershipService.registerCandidate(ENTITY1_2);
166 verify(leaderMockListener2, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1_2, false, true, true));
167 verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1_2));
168 reset(leaderMockListener2);
170 // Register follower1 candidate for entity1 and verify it gets added but doesn't become owner
172 follower1EntityOwnershipService.registerCandidate(ENTITY1);
173 verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
174 verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
175 verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
176 verify(follower1MockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
178 // Register follower1 candidate for entity2 and verify it becomes owner
180 EntityOwnershipCandidateRegistration follower1Entity2Reg = follower1EntityOwnershipService.registerCandidate(ENTITY2);
181 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
182 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
183 reset(leaderMockListener, follower1MockListener);
185 // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
187 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
188 follower2EntityOwnershipService.registerCandidate(ENTITY2);
189 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
190 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-2");
192 // Unregister follower1 candidate for entity2 and verify follower2 becomes owner
194 follower1Entity2Reg.close();
195 verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-3");
196 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-3");
197 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, true));
198 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
200 // Depending on timing, follower2MockListener could get ownershipChanged with "false, false, true" if
201 // if the original ownership change with "member-2 is replicated to follower2 after the listener is
203 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
204 verify(follower2MockListener, atMost(1)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
205 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
207 // Register follower1 candidate for entity3 and verify it becomes owner
209 follower1EntityOwnershipService.registerCandidate(ENTITY3);
210 verifyOwner(leaderDistributedDataStore, ENTITY3, "member-2");
211 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, true, true));
212 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
213 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY3, false, false, true));
215 // Register follower2 candidate for entity4 and verify it becomes owner
217 follower2EntityOwnershipService.registerCandidate(ENTITY4);
218 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
219 verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, true, true));
220 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
221 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY4, false, false, true));
222 reset(follower1MockListener, follower2MockListener);
224 // Register follower1 candidate for entity4 and verify it gets added but doesn't become owner
226 follower1EntityOwnershipService.registerCandidate(ENTITY4);
227 verifyCandidates(leaderDistributedDataStore, ENTITY4, "member-3", "member-2");
228 verifyOwner(leaderDistributedDataStore, ENTITY4, "member-3");
230 // Shutdown follower2 and verify it's owned entities (entity 2 & 4) get re-assigned
232 reset(leaderMockListener, follower1MockListener);
233 follower2Node.cleanup();
235 verify(follower1MockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, true, true),
236 ownershipChange(ENTITY2, false, false, false)));
237 verify(leaderMockListener, timeout(15000).times(2)).ownershipChanged(or(ownershipChange(ENTITY4, false, false, true),
238 ownershipChange(ENTITY2, false, false, false)));
239 verifyOwner(leaderDistributedDataStore, ENTITY2, ""); // no other candidate
241 // Register leader candidate for entity2 and verify it becomes owner
243 EntityOwnershipCandidateRegistration leaderEntity2Reg = leaderEntityOwnershipService.registerCandidate(ENTITY2);
244 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
245 verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
247 // Unregister leader candidate for entity2 and verify the owner is cleared
249 leaderEntity2Reg.close();
250 verifyOwner(leaderDistributedDataStore, ENTITY2, "");
251 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, true, false, false));
252 verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, false));
256 * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>
258 * @throws CandidateAlreadyRegisteredException
261 public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
262 String name = "testCloseCandidateRegistrationInQuickSuccession";
263 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
264 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
265 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
267 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
268 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
269 datastoreContextBuilder(followerDatastoreContextBuilder).build();
271 MemberNode follower2Node = MemberNode.builder(memberNodes).akkaConfig("Member3").testName(name ).
272 moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
273 datastoreContextBuilder(followerDatastoreContextBuilder).build();
275 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
277 leaderDistributedDataStore.waitTillReady();
278 follower1Node.configDataStore().waitTillReady();
279 follower2Node.configDataStore().waitTillReady();
281 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
282 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1Node.configDataStore());
283 EntityOwnershipService follower2EntityOwnershipService = newOwnershipService(follower2Node.configDataStore());
285 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
287 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
288 follower1EntityOwnershipService.registerListener(ENTITY_TYPE1, follower1MockListener);
289 follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
291 final EntityOwnershipCandidateRegistration candidate1 = leaderEntityOwnershipService.registerCandidate(ENTITY1);
292 final EntityOwnershipCandidateRegistration candidate2 = follower1EntityOwnershipService.registerCandidate(ENTITY1);
293 final EntityOwnershipCandidateRegistration candidate3 = follower2EntityOwnershipService.registerCandidate(ENTITY1);
295 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, true, true));
297 Mockito.reset(leaderMockListener);
303 ArgumentCaptor<EntityOwnershipChange> leaderChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
304 ArgumentCaptor<EntityOwnershipChange> follower1ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
305 ArgumentCaptor<EntityOwnershipChange> follower2ChangeCaptor = ArgumentCaptor.forClass(EntityOwnershipChange.class);
306 doNothing().when(leaderMockListener).ownershipChanged(leaderChangeCaptor.capture());
307 doNothing().when(follower1MockListener).ownershipChanged(follower1ChangeCaptor.capture());
308 doNothing().when(follower2MockListener).ownershipChanged(follower2ChangeCaptor.capture());
310 boolean passed = false;
311 for(int i=0;i<100;i++) {
312 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
313 if(!leaderEntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
314 !follower1EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
315 !follower2EntityOwnershipService.getOwnershipState(ENTITY1).get().hasOwner() &&
316 leaderChangeCaptor.getAllValues().size() > 0 && !leaderChangeCaptor.getValue().hasOwner() &&
317 leaderChangeCaptor.getAllValues().size() > 0 && !follower1ChangeCaptor.getValue().hasOwner() &&
318 leaderChangeCaptor.getAllValues().size() > 0 && !follower2ChangeCaptor.getValue().hasOwner()) {
324 assertTrue("No ownership change message was sent with hasOwner=false", passed);
328 * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
329 * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
330 * an AddShardReplica request to join it to an existing leader.
333 public void testEntityOwnershipShardBootstrapping() throws Throwable {
334 String name = "testEntityOwnershipShardBootstrapping";
335 String moduleShardsConfig = MODULE_SHARDS_MEMBER_1_CONFIG;
336 MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name ).
337 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
338 datastoreContextBuilder(leaderDatastoreContextBuilder).build();
340 DistributedDataStore leaderDistributedDataStore = leaderNode.configDataStore();
341 EntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
343 leaderNode.kit().waitUntilLeader(leaderNode.configDataStore().getActorContext(), ENTITY_OWNERSHIP_SHARD_NAME);
345 MemberNode follower1Node = MemberNode.builder(memberNodes).akkaConfig("Member2").testName(name ).
346 moduleShardsConfig(moduleShardsConfig).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false).
347 datastoreContextBuilder(followerDatastoreContextBuilder).build();
349 DistributedDataStore follower1DistributedDataStore = follower1Node.configDataStore();
350 follower1DistributedDataStore.waitTillReady();
352 leaderNode.waitForMembersUp("member-2");
353 follower1Node.waitForMembersUp("member-1");
355 EntityOwnershipService follower1EntityOwnershipService = newOwnershipService(follower1DistributedDataStore);
357 leaderEntityOwnershipService.registerListener(ENTITY_TYPE1, leaderMockListener);
359 // Register a candidate for follower1 - should get queued since follower1 has no leader
360 EntityOwnershipCandidateRegistration candidateReg = follower1EntityOwnershipService.registerCandidate(ENTITY1);
361 verify(leaderMockListener, timeout(300).never()).ownershipChanged(ownershipChange(ENTITY1));
363 // Add replica in follower1
364 AddShardReplica addReplica = new AddShardReplica(ENTITY_OWNERSHIP_SHARD_NAME);
365 follower1DistributedDataStore.getActorContext().getShardManager().tell(addReplica , follower1Node.kit().getRef());
366 Object reply = follower1Node.kit().expectMsgAnyClassOf(JavaTestKit.duration("5 sec"), Success.class, Failure.class);
367 if(reply instanceof Failure) {
368 throw new AssertionError("AddShardReplica failed", ((Failure)reply).cause());
371 // The queued candidate registration should proceed
372 verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
375 private static void verifyGetOwnershipState(EntityOwnershipService service, Entity entity,
376 boolean isOwner, boolean hasOwner) {
377 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
378 assertEquals("getOwnershipState present", true, state.isPresent());
379 assertEquals("isOwner", isOwner, state.get().isOwner());
380 assertEquals("hasOwner", hasOwner, state.get().hasOwner());
383 private static void verifyCandidates(DistributedDataStore dataStore, Entity entity, String... expCandidates) throws Exception {
384 AssertionError lastError = null;
385 Stopwatch sw = Stopwatch.createStarted();
386 while(sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
387 Optional<NormalizedNode<?, ?>> possible = dataStore.newReadOnlyTransaction().read(
388 entityPath(entity.getType(), entity.getId()).node(Candidate.QNAME)).get(5, TimeUnit.SECONDS);
390 assertEquals("Candidates not found for " + entity, true, possible.isPresent());
391 Collection<String> actual = new ArrayList<>();
392 for(MapEntryNode candidate: ((MapNode)possible.get()).getValue()) {
393 actual.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
396 assertEquals("Candidates for " + entity, Arrays.asList(expCandidates), actual);
398 } catch (AssertionError e) {
400 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
407 private static void verifyOwner(final DistributedDataStore dataStore, Entity entity, String expOwner) {
408 AbstractEntityOwnershipTest.verifyOwner(expOwner, entity.getType(), entity.getId(),
409 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
411 public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
413 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
414 } catch (Exception e) {