2 * Copyright (c) 2014, 2015 Cisco 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
9 package org.opendaylight.controller.cluster.datastore;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertFalse;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertSame;
15 import static org.junit.Assert.assertTrue;
16 import static org.junit.Assert.fail;
17 import static org.mockito.Matchers.any;
18 import static org.mockito.Mockito.doThrow;
19 import static org.mockito.Mockito.inOrder;
20 import static org.mockito.Mockito.mock;
21 import static org.opendaylight.controller.cluster.datastore.DataStoreVersions.CURRENT_VERSION;
23 import akka.actor.ActorRef;
24 import akka.actor.ActorSelection;
25 import akka.actor.Props;
26 import akka.actor.Status.Failure;
27 import akka.dispatch.Dispatchers;
28 import akka.dispatch.OnComplete;
29 import akka.japi.Creator;
30 import akka.pattern.Patterns;
31 import akka.persistence.SaveSnapshotSuccess;
32 import akka.testkit.TestActorRef;
33 import akka.util.Timeout;
34 import com.google.common.base.Stopwatch;
35 import com.google.common.base.Throwables;
36 import com.google.common.util.concurrent.Uninterruptibles;
37 import java.io.IOException;
38 import java.util.Collections;
39 import java.util.HashSet;
42 import java.util.concurrent.CountDownLatch;
43 import java.util.concurrent.TimeUnit;
44 import java.util.concurrent.atomic.AtomicBoolean;
45 import java.util.concurrent.atomic.AtomicReference;
46 import org.junit.Test;
47 import org.mockito.InOrder;
48 import org.opendaylight.controller.cluster.DataPersistenceProvider;
49 import org.opendaylight.controller.cluster.DelegatingPersistentDataProvider;
50 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
51 import org.opendaylight.controller.cluster.access.concepts.MemberName;
52 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
53 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
54 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
55 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
56 import org.opendaylight.controller.cluster.datastore.messages.AbortTransaction;
57 import org.opendaylight.controller.cluster.datastore.messages.AbortTransactionReply;
58 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
59 import org.opendaylight.controller.cluster.datastore.messages.BatchedModificationsReply;
60 import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransaction;
61 import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransactionReply;
62 import org.opendaylight.controller.cluster.datastore.messages.CloseDataTreeNotificationListenerRegistration;
63 import org.opendaylight.controller.cluster.datastore.messages.CloseDataTreeNotificationListenerRegistrationReply;
64 import org.opendaylight.controller.cluster.datastore.messages.CommitTransaction;
65 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
66 import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
67 import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
68 import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved;
69 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
70 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
71 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
72 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
73 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener;
74 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListener;
75 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeNotificationListenerReply;
76 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
77 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
78 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
79 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
80 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
81 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
82 import org.opendaylight.controller.cluster.datastore.utils.MockDataChangeListener;
83 import org.opendaylight.controller.cluster.datastore.utils.MockDataTreeChangeListener;
84 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
85 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListenerReply;
86 import org.opendaylight.controller.cluster.raft.RaftActorContext;
87 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
88 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
89 import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout;
90 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
91 import org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow;
92 import org.opendaylight.controller.cluster.raft.client.messages.FindLeader;
93 import org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply;
94 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
95 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
96 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
97 import org.opendaylight.controller.cluster.raft.messages.ServerRemoved;
98 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
99 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
100 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
101 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
102 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
103 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
104 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
105 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
106 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
107 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker;
108 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
109 import org.opendaylight.yangtools.concepts.Identifier;
110 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
111 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
112 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
113 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
114 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
115 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
116 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
117 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
118 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
119 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
120 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
121 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
122 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
123 import scala.concurrent.Await;
124 import scala.concurrent.Future;
125 import scala.concurrent.duration.FiniteDuration;
127 public class ShardTest extends AbstractShardTest {
128 private static final String DUMMY_DATA = "Dummy data as snapshot sequence number is set to 0 in "
129 + "InMemorySnapshotStore and journal recovery seq number will start from 1";
132 public void testRegisterChangeListener() throws Exception {
133 new ShardTestKit(getSystem()) {
135 final TestActorRef<Shard> shard = actorFactory.createTestActor(
136 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
137 "testRegisterChangeListener");
139 waitUntilLeader(shard);
141 shard.tell(new UpdateSchemaContext(SchemaContextHelper.full()), ActorRef.noSender());
143 final MockDataChangeListener listener = new MockDataChangeListener(1);
144 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener,
145 TestModel.TEST_PATH), "testRegisterChangeListener-DataChangeListener");
147 shard.tell(new RegisterChangeListener(TestModel.TEST_PATH, dclActor,
148 AsyncDataBroker.DataChangeScope.BASE, true), getRef());
150 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("3 seconds"),
151 RegisterDataTreeNotificationListenerReply.class);
152 final String replyPath = reply.getListenerRegistrationPath().toString();
153 assertTrue("Incorrect reply path: " + replyPath,
154 replyPath.matches("akka:\\/\\/test\\/user\\/testRegisterChangeListener\\/\\$.*"));
156 final YangInstanceIdentifier path = TestModel.TEST_PATH;
157 writeToStore(shard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
159 listener.waitForChangeEvents(path);
164 @SuppressWarnings("serial")
166 public void testChangeListenerNotifiedWhenNotTheLeaderOnRegistration() throws Exception {
167 // This test tests the timing window in which a change listener is registered before the
168 // shard becomes the leader. We verify that the listener is registered and notified of the
169 // existing data when the shard becomes the leader.
170 // For this test, we want to send the RegisterChangeListener message after the shard
171 // has recovered from persistence and before it becomes the leader. So we subclass
172 // Shard to override onReceiveCommand and, when the first ElectionTimeout is received,
173 // we know that the shard has been initialized to a follower and has started the
174 // election process. The following 2 CountDownLatches are used to coordinate the
175 // ElectionTimeout with the sending of the RegisterChangeListener message.
176 final CountDownLatch onFirstElectionTimeout = new CountDownLatch(1);
177 final CountDownLatch onChangeListenerRegistered = new CountDownLatch(1);
178 final Creator<Shard> creator = new Creator<Shard>() {
179 boolean firstElectionTimeout = true;
182 public Shard create() throws Exception {
183 // Use a non persistent provider because this test actually invokes persist on the journal
184 // this will cause all other messages to not be queued properly after that.
185 // The basic issue is that you cannot use TestActorRef with a persistent actor (at least when
186 // it does do a persist)
187 return new Shard(newShardBuilder()) {
189 public void handleCommand(final Object message) {
190 if (message instanceof ElectionTimeout && firstElectionTimeout) {
191 // Got the first ElectionTimeout. We don't forward it to the
192 // base Shard yet until we've sent the RegisterChangeListener
193 // message. So we signal the onFirstElectionTimeout latch to tell
194 // the main thread to send the RegisterChangeListener message and
195 // start a thread to wait on the onChangeListenerRegistered latch,
196 // which the main thread signals after it has sent the message.
197 // After the onChangeListenerRegistered is triggered, we send the
198 // original ElectionTimeout message to proceed with the election.
199 firstElectionTimeout = false;
200 final ActorRef self = getSelf();
202 Uninterruptibles.awaitUninterruptibly(
203 onChangeListenerRegistered, 5, TimeUnit.SECONDS);
204 self.tell(message, self);
207 onFirstElectionTimeout.countDown();
209 super.handleCommand(message);
216 setupInMemorySnapshotStore();
218 final YangInstanceIdentifier path = TestModel.TEST_PATH;
219 final MockDataChangeListener listener = new MockDataChangeListener(1);
220 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener, path),
221 "testRegisterChangeListenerWhenNotLeaderInitially-DataChangeListener");
223 final TestActorRef<Shard> shard = actorFactory.createTestActor(
224 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
225 "testRegisterChangeListenerWhenNotLeaderInitially");
227 new ShardTestKit(getSystem()) {
229 // Wait until the shard receives the first ElectionTimeout
231 assertEquals("Got first ElectionTimeout", true, onFirstElectionTimeout.await(5, TimeUnit.SECONDS));
233 // Now send the RegisterChangeListener and wait for the reply.
234 shard.tell(new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.SUBTREE, false),
237 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
238 RegisterDataTreeNotificationListenerReply.class);
239 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
241 // Sanity check - verify the shard is not the leader yet.
242 shard.tell(FindLeader.INSTANCE, getRef());
243 final FindLeaderReply findLeadeReply = expectMsgClass(duration("5 seconds"), FindLeaderReply.class);
244 assertFalse("Expected the shard not to be the leader", findLeadeReply.getLeaderActor().isPresent());
246 // Signal the onChangeListenerRegistered latch to tell the
247 // thread above to proceed
248 // with the election process.
249 onChangeListenerRegistered.countDown();
251 // Wait for the shard to become the leader and notify our
252 // listener with the existing
253 // data in the store.
254 listener.waitForChangeEvents(path);
260 public void testRegisterDataTreeChangeListener() throws Exception {
261 new ShardTestKit(getSystem()) {
263 final TestActorRef<Shard> shard = actorFactory.createTestActor(
264 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
265 "testRegisterDataTreeChangeListener");
267 waitUntilLeader(shard);
269 shard.tell(new UpdateSchemaContext(SchemaContextHelper.full()), ActorRef.noSender());
271 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
272 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener,
273 TestModel.TEST_PATH), "testRegisterDataTreeChangeListener-DataTreeChangeListener");
275 shard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, false), getRef());
277 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("3 seconds"),
278 RegisterDataTreeNotificationListenerReply.class);
279 final String replyPath = reply.getListenerRegistrationPath().toString();
280 assertTrue("Incorrect reply path: " + replyPath,
281 replyPath.matches("akka:\\/\\/test\\/user\\/testRegisterDataTreeChangeListener\\/\\$.*"));
283 final YangInstanceIdentifier path = TestModel.TEST_PATH;
284 writeToStore(shard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
286 listener.waitForChangeEvents();
291 @SuppressWarnings("serial")
293 public void testDataTreeChangeListenerNotifiedWhenNotTheLeaderOnRegistration() throws Exception {
294 final CountDownLatch onFirstElectionTimeout = new CountDownLatch(1);
295 final CountDownLatch onChangeListenerRegistered = new CountDownLatch(1);
296 final Creator<Shard> creator = new Creator<Shard>() {
297 boolean firstElectionTimeout = true;
300 public Shard create() throws Exception {
301 return new Shard(newShardBuilder()) {
303 public void handleCommand(final Object message) {
304 if (message instanceof ElectionTimeout && firstElectionTimeout) {
305 firstElectionTimeout = false;
306 final ActorRef self = getSelf();
308 Uninterruptibles.awaitUninterruptibly(
309 onChangeListenerRegistered, 5, TimeUnit.SECONDS);
310 self.tell(message, self);
313 onFirstElectionTimeout.countDown();
315 super.handleCommand(message);
322 setupInMemorySnapshotStore();
324 final YangInstanceIdentifier path = TestModel.TEST_PATH;
325 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
326 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener, path),
327 "testDataTreeChangeListenerNotifiedWhenNotTheLeaderOnRegistration-DataChangeListener");
329 final TestActorRef<Shard> shard = actorFactory.createTestActor(
330 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
331 "testDataTreeChangeListenerNotifiedWhenNotTheLeaderOnRegistration");
333 new ShardTestKit(getSystem()) {
335 assertEquals("Got first ElectionTimeout", true, onFirstElectionTimeout.await(5, TimeUnit.SECONDS));
337 shard.tell(new RegisterDataTreeChangeListener(path, dclActor, false), getRef());
338 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
339 RegisterDataTreeNotificationListenerReply.class);
340 assertNotNull("getListenerRegistratioznPath", reply.getListenerRegistrationPath());
342 shard.tell(FindLeader.INSTANCE, getRef());
343 final FindLeaderReply findLeadeReply = expectMsgClass(duration("5 seconds"), FindLeaderReply.class);
344 assertFalse("Expected the shard not to be the leader", findLeadeReply.getLeaderActor().isPresent());
346 onChangeListenerRegistered.countDown();
348 // TODO: investigate why we do not receive data chage events
349 listener.waitForChangeEvents();
355 public void testCreateTransaction() {
356 new ShardTestKit(getSystem()) {
358 final ActorRef shard = actorFactory.createActor(newShardProps(), "testCreateTransaction");
360 waitUntilLeader(shard);
362 shard.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
364 shard.tell(new CreateTransaction(nextTransactionId(), TransactionType.READ_ONLY.ordinal(),
365 DataStoreVersions.CURRENT_VERSION).toSerializable(), getRef());
367 final CreateTransactionReply reply = expectMsgClass(duration("3 seconds"),
368 CreateTransactionReply.class);
370 final String path = reply.getTransactionPath().toString();
371 assertTrue("Unexpected transaction path " + path, path.startsWith(String.format(
372 "akka://test/user/testCreateTransaction/shard-%s-%s:ShardTransactionTest@0:",
373 shardID.getShardName(), shardID.getMemberName().getName())));
379 public void testCreateTransactionOnChain() {
380 new ShardTestKit(getSystem()) {
382 final ActorRef shard = actorFactory.createActor(newShardProps(), "testCreateTransactionOnChain");
384 waitUntilLeader(shard);
386 shard.tell(new CreateTransaction(nextTransactionId(), TransactionType.READ_ONLY.ordinal(),
387 DataStoreVersions.CURRENT_VERSION).toSerializable(), getRef());
389 final CreateTransactionReply reply = expectMsgClass(duration("3 seconds"),
390 CreateTransactionReply.class);
392 final String path = reply.getTransactionPath().toString();
393 assertTrue("Unexpected transaction path " + path, path.startsWith(String.format(
394 "akka://test/user/testCreateTransactionOnChain/shard-%s-%s:ShardTransactionTest@0:",
395 shardID.getShardName(), shardID.getMemberName().getName())));
401 public void testPeerAddressResolved() throws Exception {
402 new ShardTestKit(getSystem()) {
404 final ShardIdentifier peerID = ShardIdentifier.create("inventory", MemberName.forName("member-2"),
406 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardBuilder()
407 .peerAddresses(Collections.<String, String>singletonMap(peerID.toString(), null))
408 .props().withDispatcher(Dispatchers.DefaultDispatcherId()), "testPeerAddressResolved");
410 final String address = "akka://foobar";
411 shard.tell(new PeerAddressResolved(peerID.toString(), address), ActorRef.noSender());
413 shard.tell(GetOnDemandRaftState.INSTANCE, getRef());
414 final OnDemandRaftState state = expectMsgClass(OnDemandRaftState.class);
415 assertEquals("getPeerAddress", address, state.getPeerAddresses().get(peerID.toString()));
421 public void testApplySnapshot() throws Exception {
423 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardProps()
424 .withDispatcher(Dispatchers.DefaultDispatcherId()), "testApplySnapshot");
426 ShardTestKit.waitUntilLeader(shard);
428 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
429 store.setSchemaContext(SCHEMA_CONTEXT);
431 final ContainerNode container = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
432 new YangInstanceIdentifier.NodeIdentifier(TestModel.TEST_QNAME))
433 .withChild(ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).addChild(
434 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)).build()).build();
436 writeToStore(store, TestModel.TEST_PATH, container);
438 final YangInstanceIdentifier root = YangInstanceIdentifier.EMPTY;
439 final NormalizedNode<?,?> expected = readStore(store, root);
441 final Snapshot snapshot = Snapshot.create(
442 new ShardSnapshotState(new MetadataShardDataTreeSnapshot(expected)),
443 Collections.<ReplicatedLogEntry>emptyList(), 1, 2, 3, 4, -1, null, null);
445 shard.tell(new ApplySnapshot(snapshot), ActorRef.noSender());
447 final Stopwatch sw = Stopwatch.createStarted();
448 while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
449 Uninterruptibles.sleepUninterruptibly(75, TimeUnit.MILLISECONDS);
452 assertEquals("Root node", expected, readStore(shard, root));
454 } catch (final AssertionError e) {
459 fail("Snapshot was not applied");
463 public void testApplyState() throws Exception {
464 final TestActorRef<Shard> shard = actorFactory.createTestActor(
465 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testApplyState");
467 ShardTestKit.waitUntilLeader(shard);
469 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
470 store.setSchemaContext(SCHEMA_CONTEXT);
472 final DataTreeModification writeMod = store.takeSnapshot().newModification();
473 final ContainerNode node = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
474 writeMod.write(TestModel.TEST_PATH, node);
477 final TransactionIdentifier tx = nextTransactionId();
478 shard.underlyingActor().applyState(null, null, payloadForModification(store, writeMod, tx));
480 final Stopwatch sw = Stopwatch.createStarted();
481 while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
482 Uninterruptibles.sleepUninterruptibly(75, TimeUnit.MILLISECONDS);
484 final NormalizedNode<?,?> actual = readStore(shard, TestModel.TEST_PATH);
485 if (actual != null) {
486 assertEquals("Applied state", node, actual);
491 fail("State was not applied");
495 public void testDataTreeCandidateRecovery() throws Exception {
496 // Set up the InMemorySnapshotStore.
497 final DataTree source = setupInMemorySnapshotStore();
499 final DataTreeModification writeMod = source.takeSnapshot().newModification();
500 writeMod.write(TestModel.OUTER_LIST_PATH, ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build());
502 InMemoryJournal.addEntry(shardID.toString(), 0, DUMMY_DATA);
504 // Set up the InMemoryJournal.
505 InMemoryJournal.addEntry(shardID.toString(), 1, new SimpleReplicatedLogEntry(0, 1,
506 payloadForModification(source, writeMod, nextTransactionId())));
508 final int nListEntries = 16;
509 final Set<Integer> listEntryKeys = new HashSet<>();
511 // Add some ModificationPayload entries
512 for (int i = 1; i <= nListEntries; i++) {
513 listEntryKeys.add(Integer.valueOf(i));
515 final YangInstanceIdentifier path = YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
516 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, i).build();
518 final DataTreeModification mod = source.takeSnapshot().newModification();
519 mod.merge(path, ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, i));
522 InMemoryJournal.addEntry(shardID.toString(), i + 1, new SimpleReplicatedLogEntry(i, 1,
523 payloadForModification(source, mod, nextTransactionId())));
526 InMemoryJournal.addEntry(shardID.toString(), nListEntries + 2,
527 new ApplyJournalEntries(nListEntries));
529 testRecovery(listEntryKeys);
533 @SuppressWarnings("checkstyle:IllegalCatch")
534 public void testConcurrentThreePhaseCommits() throws Exception {
535 final AtomicReference<Throwable> caughtEx = new AtomicReference<>();
536 final CountDownLatch commitLatch = new CountDownLatch(2);
538 final long timeoutSec = 5;
539 final FiniteDuration duration = FiniteDuration.create(timeoutSec, TimeUnit.SECONDS);
540 final Timeout timeout = new Timeout(duration);
542 final TestActorRef<Shard> shard = actorFactory.createTestActor(
543 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
544 "testConcurrentThreePhaseCommits");
546 class OnFutureComplete extends OnComplete<Object> {
547 private final Class<?> expRespType;
549 OnFutureComplete(final Class<?> expRespType) {
550 this.expRespType = expRespType;
554 public void onComplete(final Throwable error, final Object resp) {
556 caughtEx.set(new AssertionError(getClass().getSimpleName() + " failure", error));
559 assertEquals("Commit response type", expRespType, resp.getClass());
561 } catch (final Exception e) {
567 void onSuccess(final Object resp) throws Exception {
571 class OnCommitFutureComplete extends OnFutureComplete {
572 OnCommitFutureComplete() {
573 super(CommitTransactionReply.class);
577 public void onComplete(final Throwable error, final Object resp) {
578 super.onComplete(error, resp);
579 commitLatch.countDown();
583 class OnCanCommitFutureComplete extends OnFutureComplete {
584 private final TransactionIdentifier transactionID;
586 OnCanCommitFutureComplete(final TransactionIdentifier transactionID) {
587 super(CanCommitTransactionReply.class);
588 this.transactionID = transactionID;
592 void onSuccess(final Object resp) throws Exception {
593 final CanCommitTransactionReply canCommitReply =
594 CanCommitTransactionReply.fromSerializable(resp);
595 assertEquals("Can commit", true, canCommitReply.getCanCommit());
597 final Future<Object> commitFuture = Patterns.ask(shard,
598 new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), timeout);
599 commitFuture.onComplete(new OnCommitFutureComplete(), getSystem().dispatcher());
603 new ShardTestKit(getSystem()) {
605 waitUntilLeader(shard);
607 final TransactionIdentifier transactionID1 = nextTransactionId();
608 final TransactionIdentifier transactionID2 = nextTransactionId();
609 final TransactionIdentifier transactionID3 = nextTransactionId();
611 final Map<TransactionIdentifier, CapturingShardDataTreeCohort> cohortMap = setupCohortDecorator(
612 shard.underlyingActor(), transactionID1, transactionID2, transactionID3);
613 final CapturingShardDataTreeCohort cohort1 = cohortMap.get(transactionID1);
614 final CapturingShardDataTreeCohort cohort2 = cohortMap.get(transactionID2);
615 final CapturingShardDataTreeCohort cohort3 = cohortMap.get(transactionID3);
617 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
618 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
619 final ReadyTransactionReply readyReply = ReadyTransactionReply
620 .fromSerializable(expectMsgClass(duration, ReadyTransactionReply.class));
621 assertEquals("Cohort path", shard.path().toString(), readyReply.getCohortPath());
622 // Send the CanCommitTransaction message for the first Tx.
624 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
625 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
626 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
627 assertEquals("Can commit", true, canCommitReply.getCanCommit());
629 // Ready 2 more Tx's.
631 shard.tell(prepareBatchedModifications(transactionID2, TestModel.OUTER_LIST_PATH,
632 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), false), getRef());
633 expectMsgClass(duration, ReadyTransactionReply.class);
636 prepareBatchedModifications(transactionID3,
637 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
638 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
639 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), false),
641 expectMsgClass(duration, ReadyTransactionReply.class);
643 // Send the CanCommitTransaction message for the next 2 Tx's.
644 // These should get queued and
645 // processed after the first Tx completes.
647 final Future<Object> canCommitFuture1 = Patterns.ask(shard,
648 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
650 final Future<Object> canCommitFuture2 = Patterns.ask(shard,
651 new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), timeout);
653 // Send the CommitTransaction message for the first Tx. After it
654 // completes, it should
655 // trigger the 2nd Tx to proceed which should in turn then
658 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
659 expectMsgClass(duration, CommitTransactionReply.class);
661 // Wait for the next 2 Tx's to complete.
663 canCommitFuture1.onComplete(new OnCanCommitFutureComplete(transactionID2), getSystem().dispatcher());
665 canCommitFuture2.onComplete(new OnCanCommitFutureComplete(transactionID3), getSystem().dispatcher());
667 final boolean done = commitLatch.await(timeoutSec, TimeUnit.SECONDS);
669 if (caughtEx.get() != null) {
670 Throwables.propagateIfInstanceOf(caughtEx.get(), Exception.class);
671 Throwables.propagate(caughtEx.get());
674 assertEquals("Commits complete", true, done);
676 // final InOrder inOrder = inOrder(cohort1.getCanCommit(), cohort1.getPreCommit(), cohort1.getCommit(),
677 // cohort2.getCanCommit(), cohort2.getPreCommit(), cohort2.getCommit(), cohort3.getCanCommit(),
678 // cohort3.getPreCommit(), cohort3.getCommit());
679 // inOrder.verify(cohort1.getCanCommit()).onSuccess(any(Void.class));
680 // inOrder.verify(cohort1.getPreCommit()).onSuccess(any(DataTreeCandidate.class));
681 // inOrder.verify(cohort2.getCanCommit()).onSuccess(any(Void.class));
682 // inOrder.verify(cohort2.getPreCommit()).onSuccess(any(DataTreeCandidate.class));
683 // inOrder.verify(cohort3.getCanCommit()).onSuccess(any(Void.class));
684 // inOrder.verify(cohort3.getPreCommit()).onSuccess(any(DataTreeCandidate.class));
685 // inOrder.verify(cohort1.getCommit()).onSuccess(any(UnsignedLong.class));
686 // inOrder.verify(cohort2.getCommit()).onSuccess(any(UnsignedLong.class));
687 // inOrder.verify(cohort3.getCommit()).onSuccess(any(UnsignedLong.class));
689 // Verify data in the data store.
691 verifyOuterListEntry(shard, 1);
693 verifyLastApplied(shard, 2);
699 public void testBatchedModificationsWithNoCommitOnReady() throws Exception {
700 new ShardTestKit(getSystem()) {
702 final TestActorRef<Shard> shard = actorFactory.createTestActor(
703 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
704 "testBatchedModificationsWithNoCommitOnReady");
706 waitUntilLeader(shard);
708 final TransactionIdentifier transactionID = nextTransactionId();
709 final FiniteDuration duration = duration("5 seconds");
711 // Send a BatchedModifications to start a transaction.
713 shard.tell(newBatchedModifications(transactionID, TestModel.TEST_PATH,
714 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false, false, 1), getRef());
715 expectMsgClass(duration, BatchedModificationsReply.class);
717 // Send a couple more BatchedModifications.
720 newBatchedModifications(transactionID, TestModel.OUTER_LIST_PATH,
721 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), false, false, 2),
723 expectMsgClass(duration, BatchedModificationsReply.class);
725 shard.tell(newBatchedModifications(transactionID,
726 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
727 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
728 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), true, false, 3),
730 expectMsgClass(duration, ReadyTransactionReply.class);
732 // Send the CanCommitTransaction message.
734 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
735 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
736 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
737 assertEquals("Can commit", true, canCommitReply.getCanCommit());
739 // Send the CommitTransaction message.
741 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
742 expectMsgClass(duration, CommitTransactionReply.class);
744 // Verify data in the data store.
746 verifyOuterListEntry(shard, 1);
752 public void testBatchedModificationsWithCommitOnReady() throws Exception {
753 new ShardTestKit(getSystem()) {
755 final TestActorRef<Shard> shard = actorFactory.createTestActor(
756 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
757 "testBatchedModificationsWithCommitOnReady");
759 waitUntilLeader(shard);
761 final TransactionIdentifier transactionID = nextTransactionId();
762 final FiniteDuration duration = duration("5 seconds");
764 // Send a BatchedModifications to start a transaction.
766 shard.tell(newBatchedModifications(transactionID, TestModel.TEST_PATH,
767 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false, false, 1), getRef());
768 expectMsgClass(duration, BatchedModificationsReply.class);
770 // Send a couple more BatchedModifications.
772 shard.tell(newBatchedModifications(transactionID, TestModel.OUTER_LIST_PATH,
773 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), false, false, 2),
775 expectMsgClass(duration, BatchedModificationsReply.class);
777 shard.tell(newBatchedModifications(transactionID,
778 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
779 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
780 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), true, true, 3),
783 expectMsgClass(duration, CommitTransactionReply.class);
785 // Verify data in the data store.
787 verifyOuterListEntry(shard, 1);
792 @Test(expected = IllegalStateException.class)
793 public void testBatchedModificationsReadyWithIncorrectTotalMessageCount() throws Exception {
794 new ShardTestKit(getSystem()) {
796 final TestActorRef<Shard> shard = actorFactory.createTestActor(
797 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
798 "testBatchedModificationsReadyWithIncorrectTotalMessageCount");
800 waitUntilLeader(shard);
802 final TransactionIdentifier transactionID = nextTransactionId();
803 final BatchedModifications batched = new BatchedModifications(transactionID,
804 DataStoreVersions.CURRENT_VERSION);
805 batched.setReady(true);
806 batched.setTotalMessagesSent(2);
808 shard.tell(batched, getRef());
810 final Failure failure = expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
812 if (failure != null) {
813 Throwables.propagateIfInstanceOf(failure.cause(), Exception.class);
814 Throwables.propagate(failure.cause());
821 public void testBatchedModificationsWithOperationFailure() throws Exception {
822 new ShardTestKit(getSystem()) {
824 final TestActorRef<Shard> shard = actorFactory.createTestActor(
825 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
826 "testBatchedModificationsWithOperationFailure");
828 waitUntilLeader(shard);
830 // Test merge with invalid data. An exception should occur when
831 // the merge is applied. Note that
832 // write will not validate the children for performance reasons.
834 final TransactionIdentifier transactionID = nextTransactionId();
836 final ContainerNode invalidData = ImmutableContainerNodeBuilder.create()
837 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TestModel.TEST_QNAME))
838 .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
840 BatchedModifications batched = new BatchedModifications(transactionID, CURRENT_VERSION);
841 batched.addModification(new MergeModification(TestModel.TEST_PATH, invalidData));
842 shard.tell(batched, getRef());
843 Failure failure = expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
845 final Throwable cause = failure.cause();
847 batched = new BatchedModifications(transactionID, DataStoreVersions.CURRENT_VERSION);
848 batched.setReady(true);
849 batched.setTotalMessagesSent(2);
851 shard.tell(batched, getRef());
853 failure = expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
854 assertEquals("Failure cause", cause, failure.cause());
860 public void testBatchedModificationsOnTransactionChain() throws Exception {
861 new ShardTestKit(getSystem()) {
863 final TestActorRef<Shard> shard = actorFactory.createTestActor(
864 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
865 "testBatchedModificationsOnTransactionChain");
867 waitUntilLeader(shard);
869 final LocalHistoryIdentifier historyId = nextHistoryId();
870 final TransactionIdentifier transactionID1 = new TransactionIdentifier(historyId, 0);
871 final TransactionIdentifier transactionID2 = new TransactionIdentifier(historyId, 1);
873 final FiniteDuration duration = duration("5 seconds");
875 // Send a BatchedModifications to start a chained write
876 // transaction and ready it.
878 final ContainerNode containerNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
879 final YangInstanceIdentifier path = TestModel.TEST_PATH;
880 shard.tell(newBatchedModifications(transactionID1, path, containerNode, true, false, 1), getRef());
881 expectMsgClass(duration, ReadyTransactionReply.class);
883 // Create a read Tx on the same chain.
885 shard.tell(new CreateTransaction(transactionID2, TransactionType.READ_ONLY.ordinal(),
886 DataStoreVersions.CURRENT_VERSION).toSerializable(), getRef());
888 final CreateTransactionReply createReply = expectMsgClass(duration("3 seconds"),
889 CreateTransactionReply.class);
891 getSystem().actorSelection(createReply.getTransactionPath())
892 .tell(new ReadData(path, DataStoreVersions.CURRENT_VERSION), getRef());
893 final ReadDataReply readReply = expectMsgClass(duration("3 seconds"), ReadDataReply.class);
894 assertEquals("Read node", containerNode, readReply.getNormalizedNode());
896 // Commit the write transaction.
898 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
899 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
900 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
901 assertEquals("Can commit", true, canCommitReply.getCanCommit());
903 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
904 expectMsgClass(duration, CommitTransactionReply.class);
906 // Verify data in the data store.
908 final NormalizedNode<?, ?> actualNode = readStore(shard, path);
909 assertEquals("Stored node", containerNode, actualNode);
915 public void testOnBatchedModificationsWhenNotLeader() {
916 final AtomicBoolean overrideLeaderCalls = new AtomicBoolean();
917 new ShardTestKit(getSystem()) {
919 final Creator<Shard> creator = new Creator<Shard>() {
920 private static final long serialVersionUID = 1L;
923 public Shard create() throws Exception {
924 return new Shard(newShardBuilder()) {
926 protected boolean isLeader() {
927 return overrideLeaderCalls.get() ? false : super.isLeader();
931 public ActorSelection getLeader() {
932 return overrideLeaderCalls.get() ? getSystem().actorSelection(getRef().path())
939 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
940 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
941 "testOnBatchedModificationsWhenNotLeader");
943 waitUntilLeader(shard);
945 overrideLeaderCalls.set(true);
947 final BatchedModifications batched = new BatchedModifications(nextTransactionId(),
948 DataStoreVersions.CURRENT_VERSION);
950 shard.tell(batched, ActorRef.noSender());
952 expectMsgEquals(batched);
958 public void testTransactionMessagesWithNoLeader() {
959 new ShardTestKit(getSystem()) {
961 dataStoreContextBuilder.customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
962 .shardHeartbeatIntervalInMillis(50).shardElectionTimeoutFactor(1);
963 final TestActorRef<Shard> shard = actorFactory.createTestActor(
964 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
965 "testTransactionMessagesWithNoLeader");
967 waitUntilNoLeader(shard);
969 final TransactionIdentifier txId = nextTransactionId();
970 shard.tell(new BatchedModifications(txId, DataStoreVersions.CURRENT_VERSION), getRef());
971 Failure failure = expectMsgClass(Failure.class);
972 assertEquals("Failure cause type", NoShardLeaderException.class, failure.cause().getClass());
974 shard.tell(prepareForwardedReadyTransaction(shard, txId, TestModel.TEST_PATH,
975 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
976 failure = expectMsgClass(Failure.class);
977 assertEquals("Failure cause type", NoShardLeaderException.class, failure.cause().getClass());
979 shard.tell(new ReadyLocalTransaction(txId, mock(DataTreeModification.class), true), getRef());
980 failure = expectMsgClass(Failure.class);
981 assertEquals("Failure cause type", NoShardLeaderException.class, failure.cause().getClass());
987 public void testReadyWithReadWriteImmediateCommit() throws Exception {
988 testReadyWithImmediateCommit(true);
992 public void testReadyWithWriteOnlyImmediateCommit() throws Exception {
993 testReadyWithImmediateCommit(false);
996 private void testReadyWithImmediateCommit(final boolean readWrite) throws Exception {
997 new ShardTestKit(getSystem()) {
999 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1000 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1001 "testReadyWithImmediateCommit-" + readWrite);
1003 waitUntilLeader(shard);
1005 final TransactionIdentifier transactionID = nextTransactionId();
1006 final NormalizedNode<?, ?> containerNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1008 shard.tell(prepareForwardedReadyTransaction(shard, transactionID, TestModel.TEST_PATH,
1009 containerNode, true), getRef());
1011 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH, containerNode, true),
1015 expectMsgClass(duration("5 seconds"), CommitTransactionReply.class);
1017 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.TEST_PATH);
1018 assertEquals(TestModel.TEST_QNAME.getLocalName(), containerNode, actualNode);
1024 public void testReadyLocalTransactionWithImmediateCommit() throws Exception {
1025 new ShardTestKit(getSystem()) {
1027 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1028 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1029 "testReadyLocalTransactionWithImmediateCommit");
1031 waitUntilLeader(shard);
1033 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1035 final DataTreeModification modification = dataStore.newModification();
1037 final ContainerNode writeData = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1038 new WriteModification(TestModel.TEST_PATH, writeData).apply(modification);
1039 final MapNode mergeData = ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build();
1040 new MergeModification(TestModel.OUTER_LIST_PATH, mergeData).apply(modification);
1042 final TransactionIdentifier txId = nextTransactionId();
1043 modification.ready();
1044 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(txId, modification, true);
1046 shard.tell(readyMessage, getRef());
1048 expectMsgClass(CommitTransactionReply.class);
1050 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.OUTER_LIST_PATH);
1051 assertEquals(TestModel.OUTER_LIST_QNAME.getLocalName(), mergeData, actualNode);
1057 public void testReadyLocalTransactionWithThreePhaseCommit() throws Exception {
1058 new ShardTestKit(getSystem()) {
1060 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1061 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1062 "testReadyLocalTransactionWithThreePhaseCommit");
1064 waitUntilLeader(shard);
1066 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1068 final DataTreeModification modification = dataStore.newModification();
1070 final ContainerNode writeData = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1071 new WriteModification(TestModel.TEST_PATH, writeData).apply(modification);
1072 final MapNode mergeData = ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build();
1073 new MergeModification(TestModel.OUTER_LIST_PATH, mergeData).apply(modification);
1075 final TransactionIdentifier txId = nextTransactionId();
1076 modification.ready();
1077 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(txId, modification, false);
1079 shard.tell(readyMessage, getRef());
1081 expectMsgClass(ReadyTransactionReply.class);
1083 // Send the CanCommitTransaction message.
1085 shard.tell(new CanCommitTransaction(txId, CURRENT_VERSION).toSerializable(), getRef());
1086 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1087 .fromSerializable(expectMsgClass(CanCommitTransactionReply.class));
1088 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1090 // Send the CanCommitTransaction message.
1092 shard.tell(new CommitTransaction(txId, CURRENT_VERSION).toSerializable(), getRef());
1093 expectMsgClass(CommitTransactionReply.class);
1095 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.OUTER_LIST_PATH);
1096 assertEquals(TestModel.OUTER_LIST_QNAME.getLocalName(), mergeData, actualNode);
1102 public void testReadWriteCommitWithPersistenceDisabled() throws Exception {
1103 dataStoreContextBuilder.persistent(false);
1104 new ShardTestKit(getSystem()) {
1106 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1107 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1108 "testCommitWithPersistenceDisabled");
1110 waitUntilLeader(shard);
1112 // Setup a simulated transactions with a mock cohort.
1114 final FiniteDuration duration = duration("5 seconds");
1116 final TransactionIdentifier transactionID = nextTransactionId();
1117 final NormalizedNode<?, ?> containerNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1118 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH, containerNode, false),
1120 expectMsgClass(duration, ReadyTransactionReply.class);
1122 // Send the CanCommitTransaction message.
1124 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1125 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1126 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1127 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1129 // Send the CanCommitTransaction message.
1131 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1132 expectMsgClass(duration, CommitTransactionReply.class);
1134 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.TEST_PATH);
1135 assertEquals(TestModel.TEST_QNAME.getLocalName(), containerNode, actualNode);
1141 public void testReadWriteCommitWhenTransactionHasModifications() throws Exception {
1142 testCommitWhenTransactionHasModifications(true);
1146 public void testWriteOnlyCommitWhenTransactionHasModifications() throws Exception {
1147 testCommitWhenTransactionHasModifications(false);
1150 private void testCommitWhenTransactionHasModifications(final boolean readWrite) throws Exception {
1151 new ShardTestKit(getSystem()) {
1153 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1154 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1155 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1156 "testCommitWhenTransactionHasModifications-" + readWrite);
1158 waitUntilLeader(shard);
1160 final FiniteDuration duration = duration("5 seconds");
1161 final TransactionIdentifier transactionID = nextTransactionId();
1164 shard.tell(prepareForwardedReadyTransaction(shard, transactionID, TestModel.TEST_PATH,
1165 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1167 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH,
1168 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1171 expectMsgClass(duration, ReadyTransactionReply.class);
1173 // Send the CanCommitTransaction message.
1175 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1176 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1177 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1178 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1180 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1181 expectMsgClass(duration, CommitTransactionReply.class);
1183 final InOrder inOrder = inOrder(dataTree);
1184 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1185 inOrder.verify(dataTree).prepare(any(DataTreeModification.class));
1186 inOrder.verify(dataTree).commit(any(DataTreeCandidate.class));
1188 shard.tell(Shard.GET_SHARD_MBEAN_MESSAGE, getRef());
1189 final ShardStats shardStats = expectMsgClass(duration, ShardStats.class);
1191 // Use MBean for verification
1192 // Committed transaction count should increase as usual
1193 assertEquals(1, shardStats.getCommittedTransactionsCount());
1195 // Commit index should advance as we do not have an empty
1197 assertEquals(0, shardStats.getCommitIndex());
1203 public void testCommitPhaseFailure() throws Exception {
1204 new ShardTestKit(getSystem()) {
1206 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1207 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1208 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1209 "testCommitPhaseFailure");
1211 waitUntilLeader(shard);
1213 final FiniteDuration duration = duration("5 seconds");
1214 final Timeout timeout = new Timeout(duration);
1216 // Setup 2 simulated transactions with mock cohorts. The first
1220 doThrow(new RuntimeException("mock commit failure")).when(dataTree)
1221 .commit(any(DataTreeCandidate.class));
1223 final TransactionIdentifier transactionID1 = nextTransactionId();
1224 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1225 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1226 expectMsgClass(duration, ReadyTransactionReply.class);
1228 final TransactionIdentifier transactionID2 = nextTransactionId();
1229 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1230 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1231 expectMsgClass(duration, ReadyTransactionReply.class);
1233 // Send the CanCommitTransaction message for the first Tx.
1235 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1236 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1237 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1238 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1240 // Send the CanCommitTransaction message for the 2nd Tx. This
1241 // should get queued and
1242 // processed after the first Tx completes.
1244 final Future<Object> canCommitFuture = Patterns.ask(shard,
1245 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1247 // Send the CommitTransaction message for the first Tx. This
1248 // should send back an error
1249 // and trigger the 2nd Tx to proceed.
1251 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1252 expectMsgClass(duration, akka.actor.Status.Failure.class);
1254 // Wait for the 2nd Tx to complete the canCommit phase.
1256 final CountDownLatch latch = new CountDownLatch(1);
1257 canCommitFuture.onComplete(new OnComplete<Object>() {
1259 public void onComplete(final Throwable failure, final Object resp) {
1262 }, getSystem().dispatcher());
1264 assertEquals("2nd CanCommit complete", true, latch.await(5, TimeUnit.SECONDS));
1266 final InOrder inOrder = inOrder(dataTree);
1267 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1268 inOrder.verify(dataTree).prepare(any(DataTreeModification.class));
1270 // FIXME: this invocation is done on the result of validate(). To test it, we need to make sure mock
1271 // validate performs wrapping and we capture that mock
1272 // inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1274 inOrder.verify(dataTree).commit(any(DataTreeCandidate.class));
1280 public void testPreCommitPhaseFailure() throws Exception {
1281 new ShardTestKit(getSystem()) {
1283 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1284 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1285 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1286 "testPreCommitPhaseFailure");
1288 waitUntilLeader(shard);
1290 final FiniteDuration duration = duration("5 seconds");
1291 final Timeout timeout = new Timeout(duration);
1293 doThrow(new RuntimeException("mock preCommit failure")).when(dataTree)
1294 .prepare(any(DataTreeModification.class));
1296 final TransactionIdentifier transactionID1 = nextTransactionId();
1297 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1298 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1299 expectMsgClass(duration, ReadyTransactionReply.class);
1301 final TransactionIdentifier transactionID2 = nextTransactionId();
1302 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1303 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1304 expectMsgClass(duration, ReadyTransactionReply.class);
1306 // Send the CanCommitTransaction message for the first Tx.
1308 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1309 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1310 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1311 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1313 // Send the CanCommitTransaction message for the 2nd Tx. This
1314 // should get queued and
1315 // processed after the first Tx completes.
1317 final Future<Object> canCommitFuture = Patterns.ask(shard,
1318 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1320 // Send the CommitTransaction message for the first Tx. This
1321 // should send back an error
1322 // and trigger the 2nd Tx to proceed.
1324 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1325 expectMsgClass(duration, akka.actor.Status.Failure.class);
1327 // Wait for the 2nd Tx to complete the canCommit phase.
1329 final CountDownLatch latch = new CountDownLatch(1);
1330 canCommitFuture.onComplete(new OnComplete<Object>() {
1332 public void onComplete(final Throwable failure, final Object resp) {
1335 }, getSystem().dispatcher());
1337 assertEquals("2nd CanCommit complete", true, latch.await(5, TimeUnit.SECONDS));
1339 final InOrder inOrder = inOrder(dataTree);
1340 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1341 inOrder.verify(dataTree).prepare(any(DataTreeModification.class));
1342 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1348 public void testCanCommitPhaseFailure() throws Exception {
1349 new ShardTestKit(getSystem()) {
1351 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1352 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1353 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1354 "testCanCommitPhaseFailure");
1356 waitUntilLeader(shard);
1358 final FiniteDuration duration = duration("5 seconds");
1359 final TransactionIdentifier transactionID1 = nextTransactionId();
1361 doThrow(new DataValidationFailedException(YangInstanceIdentifier.EMPTY, "mock canCommit failure"))
1362 .doNothing().when(dataTree).validate(any(DataTreeModification.class));
1364 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1365 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1366 expectMsgClass(duration, ReadyTransactionReply.class);
1368 // Send the CanCommitTransaction message.
1370 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1371 expectMsgClass(duration, akka.actor.Status.Failure.class);
1373 // Send another can commit to ensure the failed one got cleaned
1376 final TransactionIdentifier transactionID2 = nextTransactionId();
1377 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1378 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1379 expectMsgClass(duration, ReadyTransactionReply.class);
1381 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1382 final CanCommitTransactionReply reply = CanCommitTransactionReply
1383 .fromSerializable(expectMsgClass(CanCommitTransactionReply.class));
1384 assertEquals("getCanCommit", true, reply.getCanCommit());
1390 public void testImmediateCommitWithCanCommitPhaseFailure() throws Exception {
1391 testImmediateCommitWithCanCommitPhaseFailure(true);
1392 testImmediateCommitWithCanCommitPhaseFailure(false);
1395 private void testImmediateCommitWithCanCommitPhaseFailure(final boolean readWrite) throws Exception {
1396 new ShardTestKit(getSystem()) {
1398 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1399 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1400 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1401 "testImmediateCommitWithCanCommitPhaseFailure-" + readWrite);
1403 waitUntilLeader(shard);
1405 doThrow(new DataValidationFailedException(YangInstanceIdentifier.EMPTY, "mock canCommit failure"))
1406 .doNothing().when(dataTree).validate(any(DataTreeModification.class));
1408 final FiniteDuration duration = duration("5 seconds");
1410 final TransactionIdentifier transactionID1 = nextTransactionId();
1413 shard.tell(prepareForwardedReadyTransaction(shard, transactionID1, TestModel.TEST_PATH,
1414 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1416 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
1417 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1420 expectMsgClass(duration, akka.actor.Status.Failure.class);
1422 // Send another can commit to ensure the failed one got cleaned
1425 final TransactionIdentifier transactionID2 = nextTransactionId();
1427 shard.tell(prepareForwardedReadyTransaction(shard, transactionID2, TestModel.TEST_PATH,
1428 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1430 shard.tell(prepareBatchedModifications(transactionID2, TestModel.TEST_PATH,
1431 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1434 expectMsgClass(duration, CommitTransactionReply.class);
1440 public void testAbortWithCommitPending() throws Exception {
1441 new ShardTestKit(getSystem()) {
1443 final Creator<Shard> creator = () -> new Shard(newShardBuilder()) {
1445 void persistPayload(final Identifier id, final Payload payload,
1446 final boolean batchHint) {
1447 // Simulate an AbortTransaction message occurring during
1448 // replication, after
1449 // persisting and before finishing the commit to the
1452 doAbortTransaction(id, null);
1453 super.persistPayload(id, payload, batchHint);
1457 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
1458 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
1459 "testAbortWithCommitPending");
1461 waitUntilLeader(shard);
1463 final FiniteDuration duration = duration("5 seconds");
1465 final TransactionIdentifier transactionID = nextTransactionId();
1467 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH,
1468 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1469 expectMsgClass(duration, ReadyTransactionReply.class);
1471 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1472 expectMsgClass(duration, CanCommitTransactionReply.class);
1474 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1475 expectMsgClass(duration, CommitTransactionReply.class);
1477 final NormalizedNode<?, ?> node = readStore(shard, TestModel.TEST_PATH);
1479 // Since we're simulating an abort occurring during replication
1480 // and before finish commit,
1481 // the data should still get written to the in-memory store
1482 // since we've gotten past
1483 // canCommit and preCommit and persisted the data.
1484 assertNotNull(TestModel.TEST_QNAME.getLocalName() + " not found", node);
1490 public void testTransactionCommitTimeout() throws Exception {
1491 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1492 new ShardTestKit(getSystem()) {
1494 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1495 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1496 "testTransactionCommitTimeout");
1498 waitUntilLeader(shard);
1500 final FiniteDuration duration = duration("5 seconds");
1502 writeToStore(shard, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
1503 writeToStore(shard, TestModel.OUTER_LIST_PATH,
1504 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build());
1506 // Ready 2 Tx's - the first will timeout
1508 final TransactionIdentifier transactionID1 = nextTransactionId();
1510 prepareBatchedModifications(transactionID1,
1511 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
1512 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
1513 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), false),
1515 expectMsgClass(duration, ReadyTransactionReply.class);
1517 final TransactionIdentifier transactionID2 = nextTransactionId();
1518 final YangInstanceIdentifier listNodePath = YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
1519 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2).build();
1521 prepareBatchedModifications(transactionID2, listNodePath,
1522 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2), false),
1524 expectMsgClass(duration, ReadyTransactionReply.class);
1526 // canCommit 1st Tx. We don't send the commit so it should
1529 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1530 expectMsgClass(duration, CanCommitTransactionReply.class);
1532 // canCommit the 2nd Tx - it should complete after the 1st Tx
1535 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1536 expectMsgClass(duration, CanCommitTransactionReply.class);
1538 // Try to commit the 1st Tx - should fail as it's not the
1541 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1542 expectMsgClass(duration, akka.actor.Status.Failure.class);
1544 // Commit the 2nd Tx.
1546 shard.tell(new CommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1547 expectMsgClass(duration, CommitTransactionReply.class);
1549 final NormalizedNode<?, ?> node = readStore(shard, listNodePath);
1550 assertNotNull(listNodePath + " not found", node);
1557 // public void testTransactionCommitQueueCapacityExceeded() throws Throwable {
1558 // dataStoreContextBuilder.shardTransactionCommitQueueCapacity(2);
1560 // new ShardTestKit(getSystem()) {{
1561 // final TestActorRef<Shard> shard = actorFactory.createTestActor(
1562 // newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1563 // "testTransactionCommitQueueCapacityExceeded");
1565 // waitUntilLeader(shard);
1567 // final FiniteDuration duration = duration("5 seconds");
1569 // final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1571 // final TransactionIdentifier transactionID1 = nextTransactionId();
1572 // final MutableCompositeModification modification1 = new MutableCompositeModification();
1573 // final ShardDataTreeCohort cohort1 = setupMockWriteTransaction("cohort1", dataStore,
1574 // TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME), transactionID1,
1577 // final TransactionIdentifier transactionID2 = nextTransactionId();
1578 // final MutableCompositeModification modification2 = new MutableCompositeModification();
1579 // final ShardDataTreeCohort cohort2 = setupMockWriteTransaction("cohort2", dataStore,
1580 // TestModel.OUTER_LIST_PATH,
1581 // ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), transactionID2,
1584 // final TransactionIdentifier transactionID3 = nextTransactionId();
1585 // final MutableCompositeModification modification3 = new MutableCompositeModification();
1586 // final ShardDataTreeCohort cohort3 = setupMockWriteTransaction("cohort3", dataStore,
1587 // TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME), transactionID3,
1590 // // Ready the Tx's
1592 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort1, transactionID1,
1593 // modification1), getRef());
1594 // expectMsgClass(duration, ReadyTransactionReply.class);
1596 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort2, transactionID2,
1597 // modification2), getRef());
1598 // expectMsgClass(duration, ReadyTransactionReply.class);
1600 // // The 3rd Tx should exceed queue capacity and fail.
1602 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort3, transactionID3,
1603 // modification3), getRef());
1604 // expectMsgClass(duration, akka.actor.Status.Failure.class);
1606 // // canCommit 1st Tx.
1608 // shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1609 // expectMsgClass(duration, CanCommitTransactionReply.class);
1611 // // canCommit the 2nd Tx - it should get queued.
1613 // shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1615 // // canCommit the 3rd Tx - should exceed queue capacity and fail.
1617 // shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1618 // expectMsgClass(duration, akka.actor.Status.Failure.class);
1623 public void testTransactionCommitWithPriorExpiredCohortEntries() throws Exception {
1624 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1625 new ShardTestKit(getSystem()) {
1627 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1628 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1629 "testTransactionCommitWithPriorExpiredCohortEntries");
1631 waitUntilLeader(shard);
1633 final FiniteDuration duration = duration("5 seconds");
1635 final TransactionIdentifier transactionID1 = nextTransactionId();
1636 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1637 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1638 expectMsgClass(duration, ReadyTransactionReply.class);
1640 final TransactionIdentifier transactionID2 = nextTransactionId();
1641 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1642 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1643 expectMsgClass(duration, ReadyTransactionReply.class);
1645 final TransactionIdentifier transactionID3 = nextTransactionId();
1646 shard.tell(newBatchedModifications(transactionID3, TestModel.TEST_PATH,
1647 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1648 expectMsgClass(duration, ReadyTransactionReply.class);
1650 // All Tx's are readied. We'll send canCommit for the last one
1651 // but not the others. The others
1652 // should expire from the queue and the last one should be
1655 shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1656 expectMsgClass(duration, CanCommitTransactionReply.class);
1662 public void testTransactionCommitWithSubsequentExpiredCohortEntry() throws Exception {
1663 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1664 new ShardTestKit(getSystem()) {
1666 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1667 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1668 "testTransactionCommitWithSubsequentExpiredCohortEntry");
1670 waitUntilLeader(shard);
1672 final FiniteDuration duration = duration("5 seconds");
1674 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1676 final TransactionIdentifier transactionID1 = nextTransactionId();
1677 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
1678 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1679 expectMsgClass(duration, ReadyTransactionReply.class);
1681 // CanCommit the first Tx so it's the current in-progress Tx.
1683 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1684 expectMsgClass(duration, CanCommitTransactionReply.class);
1686 // Ready the second Tx.
1688 final TransactionIdentifier transactionID2 = nextTransactionId();
1689 shard.tell(prepareBatchedModifications(transactionID2, TestModel.TEST_PATH,
1690 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1691 expectMsgClass(duration, ReadyTransactionReply.class);
1693 // Ready the third Tx.
1695 final TransactionIdentifier transactionID3 = nextTransactionId();
1696 final DataTreeModification modification3 = dataStore.newModification();
1697 new WriteModification(TestModel.TEST2_PATH, ImmutableNodes.containerNode(TestModel.TEST2_QNAME))
1698 .apply(modification3);
1699 modification3.ready();
1700 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(transactionID3, modification3,
1702 shard.tell(readyMessage, getRef());
1704 // Commit the first Tx. After completing, the second should
1705 // expire from the queue and the third
1708 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1709 expectMsgClass(duration, CommitTransactionReply.class);
1711 // Expect commit reply from the third Tx.
1713 expectMsgClass(duration, CommitTransactionReply.class);
1715 final NormalizedNode<?, ?> node = readStore(shard, TestModel.TEST2_PATH);
1716 assertNotNull(TestModel.TEST2_PATH + " not found", node);
1722 public void testCanCommitBeforeReadyFailure() throws Exception {
1723 new ShardTestKit(getSystem()) {
1725 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1726 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1727 "testCanCommitBeforeReadyFailure");
1729 shard.tell(new CanCommitTransaction(nextTransactionId(), CURRENT_VERSION).toSerializable(), getRef());
1730 expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
1736 public void testAbortAfterCanCommit() throws Exception {
1737 new ShardTestKit(getSystem()) {
1739 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1740 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterCanCommit");
1742 waitUntilLeader(shard);
1744 final FiniteDuration duration = duration("5 seconds");
1745 final Timeout timeout = new Timeout(duration);
1747 // Ready 2 transactions - the first one will be aborted.
1749 final TransactionIdentifier transactionID1 = nextTransactionId();
1750 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1751 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1752 expectMsgClass(duration, ReadyTransactionReply.class);
1754 final TransactionIdentifier transactionID2 = nextTransactionId();
1755 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1756 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1757 expectMsgClass(duration, ReadyTransactionReply.class);
1759 // Send the CanCommitTransaction message for the first Tx.
1761 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1762 CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1763 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1764 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1766 // Send the CanCommitTransaction message for the 2nd Tx. This
1767 // should get queued and
1768 // processed after the first Tx completes.
1770 final Future<Object> canCommitFuture = Patterns.ask(shard,
1771 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1773 // Send the AbortTransaction message for the first Tx. This
1774 // should trigger the 2nd
1777 shard.tell(new AbortTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1778 expectMsgClass(duration, AbortTransactionReply.class);
1780 // Wait for the 2nd Tx to complete the canCommit phase.
1782 canCommitReply = (CanCommitTransactionReply) Await.result(canCommitFuture, duration);
1783 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1789 public void testAbortAfterReady() throws Exception {
1790 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1791 new ShardTestKit(getSystem()) {
1793 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1794 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterReady");
1796 waitUntilLeader(shard);
1798 final FiniteDuration duration = duration("5 seconds");
1802 final TransactionIdentifier transactionID1 = nextTransactionId();
1803 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1804 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1805 expectMsgClass(duration, ReadyTransactionReply.class);
1807 // Send the AbortTransaction message.
1809 shard.tell(new AbortTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1810 expectMsgClass(duration, AbortTransactionReply.class);
1812 assertEquals("getPendingTxCommitQueueSize", 0, shard.underlyingActor().getPendingTxCommitQueueSize());
1814 // Now send CanCommitTransaction - should fail.
1816 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1817 final Throwable failure = expectMsgClass(duration, akka.actor.Status.Failure.class).cause();
1818 assertTrue("Failure type", failure instanceof IllegalStateException);
1820 // Ready and CanCommit another and verify success.
1822 final TransactionIdentifier transactionID2 = nextTransactionId();
1823 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1824 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1825 expectMsgClass(duration, ReadyTransactionReply.class);
1827 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1828 expectMsgClass(duration, CanCommitTransactionReply.class);
1834 public void testAbortQueuedTransaction() throws Exception {
1835 new ShardTestKit(getSystem()) {
1837 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1838 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterReady");
1840 waitUntilLeader(shard);
1842 final FiniteDuration duration = duration("5 seconds");
1846 final TransactionIdentifier transactionID1 = nextTransactionId();
1847 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1848 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1849 expectMsgClass(duration, ReadyTransactionReply.class);
1851 final TransactionIdentifier transactionID2 = nextTransactionId();
1852 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1853 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1854 expectMsgClass(duration, ReadyTransactionReply.class);
1856 final TransactionIdentifier transactionID3 = nextTransactionId();
1858 newBatchedModifications(transactionID3, TestModel.OUTER_LIST_PATH,
1859 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), true, false, 1),
1861 expectMsgClass(duration, ReadyTransactionReply.class);
1863 // Abort the second tx while it's queued.
1865 shard.tell(new AbortTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1866 expectMsgClass(duration, AbortTransactionReply.class);
1868 // Commit the other 2.
1870 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1871 expectMsgClass(duration, CanCommitTransactionReply.class);
1873 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1874 expectMsgClass(duration, CommitTransactionReply.class);
1876 shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1877 expectMsgClass(duration, CanCommitTransactionReply.class);
1879 shard.tell(new CommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1880 expectMsgClass(duration, CommitTransactionReply.class);
1882 assertEquals("getPendingTxCommitQueueSize", 0, shard.underlyingActor().getPendingTxCommitQueueSize());
1888 public void testCreateSnapshotWithNonPersistentData() throws Exception {
1889 testCreateSnapshot(false, "testCreateSnapshotWithNonPersistentData");
1893 public void testCreateSnapshot() throws Exception {
1894 testCreateSnapshot(true, "testCreateSnapshot");
1897 private void testCreateSnapshot(final boolean persistent, final String shardActorName) throws Exception {
1898 final AtomicReference<CountDownLatch> latch = new AtomicReference<>(new CountDownLatch(1));
1900 final AtomicReference<Object> savedSnapshot = new AtomicReference<>();
1901 class TestPersistentDataProvider extends DelegatingPersistentDataProvider {
1902 TestPersistentDataProvider(final DataPersistenceProvider delegate) {
1907 public void saveSnapshot(final Object obj) {
1908 savedSnapshot.set(obj);
1909 super.saveSnapshot(obj);
1913 dataStoreContextBuilder.persistent(persistent);
1915 class TestShard extends Shard {
1917 protected TestShard(final AbstractBuilder<?, ?> builder) {
1919 setPersistence(new TestPersistentDataProvider(super.persistence()));
1923 public void handleCommand(final Object message) {
1924 super.handleCommand(message);
1926 // XXX: commit_snapshot equality check references RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT
1927 if (message instanceof SaveSnapshotSuccess || "commit_snapshot".equals(message.toString())) {
1928 latch.get().countDown();
1933 public RaftActorContext getRaftActorContext() {
1934 return super.getRaftActorContext();
1938 new ShardTestKit(getSystem()) {
1940 final Creator<Shard> creator = () -> new TestShard(newShardBuilder());
1942 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
1943 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
1946 waitUntilLeader(shard);
1947 writeToStore(shard, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
1949 final NormalizedNode<?, ?> expectedRoot = readStore(shard, YangInstanceIdentifier.EMPTY);
1951 // Trigger creation of a snapshot by ensuring
1952 final RaftActorContext raftActorContext = ((TestShard) shard.underlyingActor()).getRaftActorContext();
1953 raftActorContext.getSnapshotManager().capture(mock(ReplicatedLogEntry.class), -1);
1954 awaitAndValidateSnapshot(expectedRoot);
1956 raftActorContext.getSnapshotManager().capture(mock(ReplicatedLogEntry.class), -1);
1957 awaitAndValidateSnapshot(expectedRoot);
1960 private void awaitAndValidateSnapshot(final NormalizedNode<?, ?> expectedRoot)
1961 throws InterruptedException, IOException {
1962 assertEquals("Snapshot saved", true, latch.get().await(5, TimeUnit.SECONDS));
1964 assertTrue("Invalid saved snapshot " + savedSnapshot.get(), savedSnapshot.get() instanceof Snapshot);
1966 verifySnapshot((Snapshot) savedSnapshot.get(), expectedRoot);
1968 latch.set(new CountDownLatch(1));
1969 savedSnapshot.set(null);
1972 private void verifySnapshot(final Snapshot snapshot, final NormalizedNode<?, ?> expectedRoot)
1973 throws IOException {
1974 final NormalizedNode<?, ?> actual = ((ShardSnapshotState)snapshot.getState()).getSnapshot()
1975 .getRootNode().get();
1976 assertEquals("Root node", expectedRoot, actual);
1982 * This test simply verifies that the applySnapShot logic will work.
1985 public void testInMemoryDataTreeRestore() throws ReadFailedException, DataValidationFailedException {
1986 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
1987 store.setSchemaContext(SCHEMA_CONTEXT);
1989 final DataTreeModification putTransaction = store.takeSnapshot().newModification();
1990 putTransaction.write(TestModel.TEST_PATH,
1991 ImmutableNodes.containerNode(TestModel.TEST_QNAME));
1992 commitTransaction(store, putTransaction);
1995 final NormalizedNode<?, ?> expected = readStore(store, YangInstanceIdentifier.EMPTY);
1997 final DataTreeModification writeTransaction = store.takeSnapshot().newModification();
1999 writeTransaction.delete(YangInstanceIdentifier.EMPTY);
2000 writeTransaction.write(YangInstanceIdentifier.EMPTY, expected);
2002 commitTransaction(store, writeTransaction);
2004 final NormalizedNode<?, ?> actual = readStore(store, YangInstanceIdentifier.EMPTY);
2006 assertEquals(expected, actual);
2010 public void testRecoveryApplicable() {
2012 final DatastoreContext persistentContext = DatastoreContext.newBuilder()
2013 .shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).persistent(true).build();
2015 final Props persistentProps = Shard.builder().id(shardID).datastoreContext(persistentContext)
2016 .schemaContext(SCHEMA_CONTEXT).props();
2018 final DatastoreContext nonPersistentContext = DatastoreContext.newBuilder()
2019 .shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).persistent(false).build();
2021 final Props nonPersistentProps = Shard.builder().id(shardID).datastoreContext(nonPersistentContext)
2022 .schemaContext(SCHEMA_CONTEXT).props();
2024 new ShardTestKit(getSystem()) {
2026 final TestActorRef<Shard> shard1 = actorFactory.createTestActor(persistentProps, "testPersistence1");
2028 assertTrue("Recovery Applicable", shard1.underlyingActor().persistence().isRecoveryApplicable());
2030 final TestActorRef<Shard> shard2 = actorFactory.createTestActor(nonPersistentProps, "testPersistence2");
2032 assertFalse("Recovery Not Applicable", shard2.underlyingActor().persistence().isRecoveryApplicable());
2038 public void testOnDatastoreContext() {
2039 new ShardTestKit(getSystem()) {
2041 dataStoreContextBuilder.persistent(true);
2043 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardProps(),
2044 "testOnDatastoreContext");
2046 assertEquals("isRecoveryApplicable", true,
2047 shard.underlyingActor().persistence().isRecoveryApplicable());
2049 waitUntilLeader(shard);
2051 shard.tell(dataStoreContextBuilder.persistent(false).build(), ActorRef.noSender());
2053 assertEquals("isRecoveryApplicable", false,
2054 shard.underlyingActor().persistence().isRecoveryApplicable());
2056 shard.tell(dataStoreContextBuilder.persistent(true).build(), ActorRef.noSender());
2058 assertEquals("isRecoveryApplicable", true,
2059 shard.underlyingActor().persistence().isRecoveryApplicable());
2065 public void testRegisterRoleChangeListener() throws Exception {
2066 new ShardTestKit(getSystem()) {
2068 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2069 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
2070 "testRegisterRoleChangeListener");
2072 waitUntilLeader(shard);
2074 final TestActorRef<MessageCollectorActor> listener =
2075 TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class));
2077 shard.tell(new RegisterRoleChangeListener(), listener);
2079 MessageCollectorActor.expectFirstMatching(listener, RegisterRoleChangeListenerReply.class);
2081 ShardLeaderStateChanged leaderStateChanged = MessageCollectorActor.expectFirstMatching(listener,
2082 ShardLeaderStateChanged.class);
2083 assertEquals("getLocalShardDataTree present", true,
2084 leaderStateChanged.getLocalShardDataTree().isPresent());
2085 assertSame("getLocalShardDataTree", shard.underlyingActor().getDataStore().getDataTree(),
2086 leaderStateChanged.getLocalShardDataTree().get());
2088 MessageCollectorActor.clearMessages(listener);
2090 // Force a leader change
2092 shard.tell(new RequestVote(10000, "member2", 50, 50), getRef());
2094 leaderStateChanged = MessageCollectorActor.expectFirstMatching(listener,
2095 ShardLeaderStateChanged.class);
2096 assertEquals("getLocalShardDataTree present", false,
2097 leaderStateChanged.getLocalShardDataTree().isPresent());
2103 public void testFollowerInitialSyncStatus() throws Exception {
2104 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2105 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
2106 "testFollowerInitialSyncStatus");
2108 shard.underlyingActor().handleNonRaftCommand(new FollowerInitialSyncUpStatus(false,
2109 "member-1-shard-inventory-operational"));
2111 assertEquals(false, shard.underlyingActor().getShardMBean().getFollowerInitialSyncStatus());
2113 shard.underlyingActor().handleNonRaftCommand(new FollowerInitialSyncUpStatus(true,
2114 "member-1-shard-inventory-operational"));
2116 assertEquals(true, shard.underlyingActor().getShardMBean().getFollowerInitialSyncStatus());
2120 public void testClusteredDataChangeListenerWithDelayedRegistration() throws Exception {
2121 new ShardTestKit(getSystem()) {
2123 final String testName = "testClusteredDataChangeListenerWithDelayedRegistration";
2124 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2125 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2127 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2128 final MockDataChangeListener listener = new MockDataChangeListener(1);
2129 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener, path),
2130 actorFactory.generateActorId(testName + "-DataChangeListener"));
2132 setupInMemorySnapshotStore();
2134 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2135 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2136 actorFactory.generateActorId(testName + "-shard"));
2138 waitUntilNoLeader(shard);
2140 shard.tell(new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.BASE, true),
2142 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
2143 RegisterDataTreeNotificationListenerReply.class);
2144 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2146 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2147 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2149 listener.waitForChangeEvents();
2155 public void testClusteredDataChangeListenerRegistration() throws Exception {
2156 new ShardTestKit(getSystem()) {
2158 final String testName = "testClusteredDataChangeListenerRegistration";
2159 final ShardIdentifier followerShardID = ShardIdentifier.create("inventory",
2160 MemberName.forName(actorFactory.generateActorId(testName + "-follower")), "config");
2162 final ShardIdentifier leaderShardID = ShardIdentifier.create("inventory",
2163 MemberName.forName(actorFactory.generateActorId(testName + "-leader")), "config");
2165 final TestActorRef<Shard> followerShard = actorFactory
2166 .createTestActor(Shard.builder().id(followerShardID)
2167 .datastoreContext(dataStoreContextBuilder.shardElectionTimeoutFactor(1000).build())
2168 .peerAddresses(Collections.singletonMap(leaderShardID.toString(),
2169 "akka://test/user/" + leaderShardID.toString()))
2170 .schemaContext(SCHEMA_CONTEXT).props()
2171 .withDispatcher(Dispatchers.DefaultDispatcherId()), followerShardID.toString());
2173 final TestActorRef<Shard> leaderShard = actorFactory
2174 .createTestActor(Shard.builder().id(leaderShardID).datastoreContext(newDatastoreContext())
2175 .peerAddresses(Collections.singletonMap(followerShardID.toString(),
2176 "akka://test/user/" + followerShardID.toString()))
2177 .schemaContext(SCHEMA_CONTEXT).props()
2178 .withDispatcher(Dispatchers.DefaultDispatcherId()), leaderShardID.toString());
2180 leaderShard.tell(TimeoutNow.INSTANCE, ActorRef.noSender());
2181 final String leaderPath = waitUntilLeader(followerShard);
2182 assertEquals("Shard leader path", leaderShard.path().toString(), leaderPath);
2184 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2185 final MockDataChangeListener listener = new MockDataChangeListener(1);
2186 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener, path),
2187 actorFactory.generateActorId(testName + "-DataChangeListener"));
2190 new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.BASE, true),
2192 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
2193 RegisterDataTreeNotificationListenerReply.class);
2194 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2196 writeToStore(followerShard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2198 listener.waitForChangeEvents();
2204 public void testClusteredDataTreeChangeListenerWithDelayedRegistration() throws Exception {
2205 new ShardTestKit(getSystem()) {
2207 final String testName = "testClusteredDataTreeChangeListenerWithDelayedRegistration";
2208 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2209 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2211 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
2212 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener,
2213 TestModel.TEST_PATH), actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2215 setupInMemorySnapshotStore();
2217 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2218 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2219 actorFactory.generateActorId(testName + "-shard"));
2221 waitUntilNoLeader(shard);
2223 shard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2224 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
2225 RegisterDataTreeNotificationListenerReply.class);
2226 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2228 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2229 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2231 listener.waitForChangeEvents();
2237 public void testClusteredDataTreeChangeListenerWithDelayedRegistrationClosed() throws Exception {
2238 new ShardTestKit(getSystem()) {
2240 final String testName = "testClusteredDataTreeChangeListenerWithDelayedRegistrationClosed";
2241 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2242 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2244 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(0);
2245 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener,
2246 TestModel.TEST_PATH), actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2248 setupInMemorySnapshotStore();
2250 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2251 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2252 actorFactory.generateActorId(testName + "-shard"));
2254 waitUntilNoLeader(shard);
2256 shard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2257 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
2258 RegisterDataTreeNotificationListenerReply.class);
2259 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2261 final ActorSelection regActor = getSystem().actorSelection(reply.getListenerRegistrationPath());
2262 regActor.tell(CloseDataTreeNotificationListenerRegistration.getInstance(), getRef());
2263 expectMsgClass(CloseDataTreeNotificationListenerRegistrationReply.class);
2265 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2266 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2268 listener.expectNoMoreChanges("Received unexpected change after close");
2274 public void testClusteredDataTreeChangeListenerRegistration() throws Exception {
2275 new ShardTestKit(getSystem()) {
2277 final String testName = "testClusteredDataTreeChangeListenerRegistration";
2278 final ShardIdentifier followerShardID = ShardIdentifier.create("inventory",
2279 MemberName.forName(actorFactory.generateActorId(testName + "-follower")), "config");
2281 final ShardIdentifier leaderShardID = ShardIdentifier.create("inventory",
2282 MemberName.forName(actorFactory.generateActorId(testName + "-leader")), "config");
2284 final TestActorRef<Shard> followerShard = actorFactory
2285 .createTestActor(Shard.builder().id(followerShardID)
2286 .datastoreContext(dataStoreContextBuilder.shardElectionTimeoutFactor(1000).build())
2287 .peerAddresses(Collections.singletonMap(leaderShardID.toString(),
2288 "akka://test/user/" + leaderShardID.toString()))
2289 .schemaContext(SCHEMA_CONTEXT).props()
2290 .withDispatcher(Dispatchers.DefaultDispatcherId()), followerShardID.toString());
2292 final TestActorRef<Shard> leaderShard = actorFactory
2293 .createTestActor(Shard.builder().id(leaderShardID).datastoreContext(newDatastoreContext())
2294 .peerAddresses(Collections.singletonMap(followerShardID.toString(),
2295 "akka://test/user/" + followerShardID.toString()))
2296 .schemaContext(SCHEMA_CONTEXT).props()
2297 .withDispatcher(Dispatchers.DefaultDispatcherId()), leaderShardID.toString());
2299 leaderShard.tell(TimeoutNow.INSTANCE, ActorRef.noSender());
2300 final String leaderPath = waitUntilLeader(followerShard);
2301 assertEquals("Shard leader path", leaderShard.path().toString(), leaderPath);
2303 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2304 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
2305 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener, path),
2306 actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2308 followerShard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2309 final RegisterDataTreeNotificationListenerReply reply = expectMsgClass(duration("5 seconds"),
2310 RegisterDataTreeNotificationListenerReply.class);
2311 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2313 writeToStore(followerShard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2315 listener.waitForChangeEvents();
2321 public void testServerRemoved() throws Exception {
2322 final TestActorRef<MessageCollectorActor> parent = actorFactory.createTestActor(MessageCollectorActor.props());
2324 final ActorRef shard = parent.underlyingActor().context().actorOf(
2325 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2326 "testServerRemoved");
2328 shard.tell(new ServerRemoved("test"), ActorRef.noSender());
2330 MessageCollectorActor.expectFirstMatching(parent, ServerRemoved.class);