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.CommitTransaction;
63 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
64 import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
65 import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
66 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
67 import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved;
68 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
69 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
70 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
71 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
72 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener;
73 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListenerReply;
74 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListener;
75 import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListenerReply;
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.MutableCompositeModification;
80 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
81 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
82 import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshot;
83 import org.opendaylight.controller.cluster.datastore.utils.MockDataChangeListener;
84 import org.opendaylight.controller.cluster.datastore.utils.MockDataTreeChangeListener;
85 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
86 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListenerReply;
87 import org.opendaylight.controller.cluster.raft.RaftActorContext;
88 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
89 import org.opendaylight.controller.cluster.raft.Snapshot;
90 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
91 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
92 import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout;
93 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
94 import org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow;
95 import org.opendaylight.controller.cluster.raft.client.messages.FindLeader;
96 import org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply;
97 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
98 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
99 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
100 import org.opendaylight.controller.cluster.raft.messages.ServerRemoved;
101 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
102 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
103 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
104 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
105 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
106 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
107 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
108 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
109 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker;
110 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
111 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
112 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
113 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
114 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
115 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
116 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
117 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
118 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
119 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
120 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
121 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
122 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
123 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
124 import scala.concurrent.Await;
125 import scala.concurrent.Future;
126 import scala.concurrent.duration.FiniteDuration;
128 public class ShardTest extends AbstractShardTest {
129 private static final String DUMMY_DATA = "Dummy data as snapshot sequence number is set to 0 in "
130 + "InMemorySnapshotStore and journal recovery seq number will start from 1";
133 public void testRegisterChangeListener() throws Exception {
134 new ShardTestKit(getSystem()) {
136 final TestActorRef<Shard> shard = actorFactory.createTestActor(
137 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
138 "testRegisterChangeListener");
140 waitUntilLeader(shard);
142 shard.tell(new UpdateSchemaContext(SchemaContextHelper.full()), ActorRef.noSender());
144 final MockDataChangeListener listener = new MockDataChangeListener(1);
145 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener),
146 "testRegisterChangeListener-DataChangeListener");
148 shard.tell(new RegisterChangeListener(TestModel.TEST_PATH, dclActor,
149 AsyncDataBroker.DataChangeScope.BASE, true), getRef());
151 final RegisterChangeListenerReply reply = expectMsgClass(duration("3 seconds"),
152 RegisterChangeListenerReply.class);
153 final String replyPath = reply.getListenerRegistrationPath().toString();
154 assertTrue("Incorrect reply path: " + replyPath,
155 replyPath.matches("akka:\\/\\/test\\/user\\/testRegisterChangeListener\\/\\$.*"));
157 final YangInstanceIdentifier path = TestModel.TEST_PATH;
158 writeToStore(shard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
160 listener.waitForChangeEvents(path);
165 @SuppressWarnings("serial")
167 public void testChangeListenerNotifiedWhenNotTheLeaderOnRegistration() throws Exception {
168 // This test tests the timing window in which a change listener is registered before the
169 // shard becomes the leader. We verify that the listener is registered and notified of the
170 // existing data when the shard becomes the leader.
171 // For this test, we want to send the RegisterChangeListener message after the shard
172 // has recovered from persistence and before it becomes the leader. So we subclass
173 // Shard to override onReceiveCommand and, when the first ElectionTimeout is received,
174 // we know that the shard has been initialized to a follower and has started the
175 // election process. The following 2 CountDownLatches are used to coordinate the
176 // ElectionTimeout with the sending of the RegisterChangeListener message.
177 final CountDownLatch onFirstElectionTimeout = new CountDownLatch(1);
178 final CountDownLatch onChangeListenerRegistered = new CountDownLatch(1);
179 final Creator<Shard> creator = new Creator<Shard>() {
180 boolean firstElectionTimeout = true;
183 public Shard create() throws Exception {
184 // Use a non persistent provider because this test actually invokes persist on the journal
185 // this will cause all other messages to not be queued properly after that.
186 // The basic issue is that you cannot use TestActorRef with a persistent actor (at least when
187 // it does do a persist)
188 return new Shard(newShardBuilder()) {
190 public void handleCommand(final Object message) {
191 if (message instanceof ElectionTimeout && firstElectionTimeout) {
192 // Got the first ElectionTimeout. We don't forward it to the
193 // base Shard yet until we've sent the RegisterChangeListener
194 // message. So we signal the onFirstElectionTimeout latch to tell
195 // the main thread to send the RegisterChangeListener message and
196 // start a thread to wait on the onChangeListenerRegistered latch,
197 // which the main thread signals after it has sent the message.
198 // After the onChangeListenerRegistered is triggered, we send the
199 // original ElectionTimeout message to proceed with the election.
200 firstElectionTimeout = false;
201 final ActorRef self = getSelf();
205 Uninterruptibles.awaitUninterruptibly(
206 onChangeListenerRegistered, 5, TimeUnit.SECONDS);
207 self.tell(message, self);
211 onFirstElectionTimeout.countDown();
213 super.handleCommand(message);
220 setupInMemorySnapshotStore();
222 final MockDataChangeListener listener = new MockDataChangeListener(1);
223 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener),
224 "testRegisterChangeListenerWhenNotLeaderInitially-DataChangeListener");
226 final TestActorRef<Shard> shard = actorFactory.createTestActor(
227 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
228 "testRegisterChangeListenerWhenNotLeaderInitially");
230 new ShardTestKit(getSystem()) {
232 final YangInstanceIdentifier path = TestModel.TEST_PATH;
234 // Wait until the shard receives the first ElectionTimeout
236 assertEquals("Got first ElectionTimeout", true, onFirstElectionTimeout.await(5, TimeUnit.SECONDS));
238 // Now send the RegisterChangeListener and wait for the reply.
239 shard.tell(new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.SUBTREE, false),
242 final RegisterChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
243 RegisterChangeListenerReply.class);
244 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
246 // Sanity check - verify the shard is not the leader yet.
247 shard.tell(FindLeader.INSTANCE, getRef());
248 final FindLeaderReply findLeadeReply = expectMsgClass(duration("5 seconds"), FindLeaderReply.class);
249 assertFalse("Expected the shard not to be the leader", findLeadeReply.getLeaderActor().isPresent());
251 // Signal the onChangeListenerRegistered latch to tell the
252 // thread above to proceed
253 // with the election process.
254 onChangeListenerRegistered.countDown();
256 // Wait for the shard to become the leader and notify our
257 // listener with the existing
258 // data in the store.
259 listener.waitForChangeEvents(path);
265 public void testRegisterDataTreeChangeListener() throws Exception {
266 new ShardTestKit(getSystem()) {
268 final TestActorRef<Shard> shard = actorFactory.createTestActor(
269 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
270 "testRegisterDataTreeChangeListener");
272 waitUntilLeader(shard);
274 shard.tell(new UpdateSchemaContext(SchemaContextHelper.full()), ActorRef.noSender());
276 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
277 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener),
278 "testRegisterDataTreeChangeListener-DataTreeChangeListener");
280 shard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, false), getRef());
282 final RegisterDataTreeChangeListenerReply reply = expectMsgClass(duration("3 seconds"),
283 RegisterDataTreeChangeListenerReply.class);
284 final String replyPath = reply.getListenerRegistrationPath().toString();
285 assertTrue("Incorrect reply path: " + replyPath,
286 replyPath.matches("akka:\\/\\/test\\/user\\/testRegisterDataTreeChangeListener\\/\\$.*"));
288 final YangInstanceIdentifier path = TestModel.TEST_PATH;
289 writeToStore(shard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
291 listener.waitForChangeEvents();
296 @SuppressWarnings("serial")
298 public void testDataTreeChangeListenerNotifiedWhenNotTheLeaderOnRegistration() throws Exception {
299 final CountDownLatch onFirstElectionTimeout = new CountDownLatch(1);
300 final CountDownLatch onChangeListenerRegistered = new CountDownLatch(1);
301 final Creator<Shard> creator = new Creator<Shard>() {
302 boolean firstElectionTimeout = true;
305 public Shard create() throws Exception {
306 return new Shard(newShardBuilder()) {
308 public void handleCommand(final Object message) {
309 if (message instanceof ElectionTimeout && firstElectionTimeout) {
310 firstElectionTimeout = false;
311 final ActorRef self = getSelf();
315 Uninterruptibles.awaitUninterruptibly(
316 onChangeListenerRegistered, 5, TimeUnit.SECONDS);
317 self.tell(message, self);
321 onFirstElectionTimeout.countDown();
323 super.handleCommand(message);
330 setupInMemorySnapshotStore();
332 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
333 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener),
334 "testDataTreeChangeListenerNotifiedWhenNotTheLeaderOnRegistration-DataChangeListener");
336 final TestActorRef<Shard> shard = actorFactory.createTestActor(
337 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
338 "testDataTreeChangeListenerNotifiedWhenNotTheLeaderOnRegistration");
340 final YangInstanceIdentifier path = TestModel.TEST_PATH;
342 new ShardTestKit(getSystem()) {
344 assertEquals("Got first ElectionTimeout", true, onFirstElectionTimeout.await(5, TimeUnit.SECONDS));
346 shard.tell(new RegisterDataTreeChangeListener(path, dclActor, false), getRef());
347 final RegisterDataTreeChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
348 RegisterDataTreeChangeListenerReply.class);
349 assertNotNull("getListenerRegistratioznPath", reply.getListenerRegistrationPath());
351 shard.tell(FindLeader.INSTANCE, getRef());
352 final FindLeaderReply findLeadeReply = expectMsgClass(duration("5 seconds"), FindLeaderReply.class);
353 assertFalse("Expected the shard not to be the leader", findLeadeReply.getLeaderActor().isPresent());
355 onChangeListenerRegistered.countDown();
357 // TODO: investigate why we do not receive data chage events
358 listener.waitForChangeEvents();
364 public void testCreateTransaction() {
365 new ShardTestKit(getSystem()) {
367 final ActorRef shard = actorFactory.createActor(newShardProps(), "testCreateTransaction");
369 waitUntilLeader(shard);
371 shard.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
373 shard.tell(new CreateTransaction(nextTransactionId(), TransactionType.READ_ONLY.ordinal(),
374 DataStoreVersions.CURRENT_VERSION).toSerializable(), getRef());
376 final CreateTransactionReply reply = expectMsgClass(duration("3 seconds"),
377 CreateTransactionReply.class);
379 final String path = reply.getTransactionPath().toString();
380 assertTrue("Unexpected transaction path " + path, path
381 .startsWith("akka://test/user/testCreateTransaction/shard-member-1:ShardTransactionTest@0:"));
387 public void testCreateTransactionOnChain() {
388 new ShardTestKit(getSystem()) {
390 final ActorRef shard = actorFactory.createActor(newShardProps(), "testCreateTransactionOnChain");
392 waitUntilLeader(shard);
394 shard.tell(new CreateTransaction(nextTransactionId(), TransactionType.READ_ONLY.ordinal(),
395 DataStoreVersions.CURRENT_VERSION).toSerializable(), getRef());
397 final CreateTransactionReply reply = expectMsgClass(duration("3 seconds"),
398 CreateTransactionReply.class);
400 final String path = reply.getTransactionPath().toString();
401 assertTrue("Unexpected transaction path " + path, path.startsWith(
402 "akka://test/user/testCreateTransactionOnChain/shard-member-1:ShardTransactionTest@0:"));
408 public void testPeerAddressResolved() throws Exception {
409 new ShardTestKit(getSystem()) {
411 final ShardIdentifier peerID = ShardIdentifier.create("inventory", MemberName.forName("member-2"),
413 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardBuilder()
414 .peerAddresses(Collections.<String, String>singletonMap(peerID.toString(), null))
415 .props().withDispatcher(Dispatchers.DefaultDispatcherId()), "testPeerAddressResolved");
417 final String address = "akka://foobar";
418 shard.tell(new PeerAddressResolved(peerID.toString(), address), ActorRef.noSender());
420 shard.tell(GetOnDemandRaftState.INSTANCE, getRef());
421 final OnDemandRaftState state = expectMsgClass(OnDemandRaftState.class);
422 assertEquals("getPeerAddress", address, state.getPeerAddresses().get(peerID.toString()));
428 public void testApplySnapshot() throws Exception {
430 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardProps()
431 .withDispatcher(Dispatchers.DefaultDispatcherId()), "testApplySnapshot");
433 ShardTestKit.waitUntilLeader(shard);
435 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
436 store.setSchemaContext(SCHEMA_CONTEXT);
438 final ContainerNode container = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
439 new YangInstanceIdentifier.NodeIdentifier(TestModel.TEST_QNAME))
440 .withChild(ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).addChild(
441 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1)).build()).build();
443 writeToStore(store, TestModel.TEST_PATH, container);
445 final YangInstanceIdentifier root = YangInstanceIdentifier.EMPTY;
446 final NormalizedNode<?,?> expected = readStore(store, root);
448 final Snapshot snapshot = Snapshot.create(new MetadataShardDataTreeSnapshot(expected).serialize(),
449 Collections.<ReplicatedLogEntry>emptyList(), 1, 2, 3, 4);
451 shard.tell(new ApplySnapshot(snapshot), ActorRef.noSender());
453 final Stopwatch sw = Stopwatch.createStarted();
454 while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
455 Uninterruptibles.sleepUninterruptibly(75, TimeUnit.MILLISECONDS);
458 assertEquals("Root node", expected, readStore(shard, root));
460 } catch (final AssertionError e) {
465 fail("Snapshot was not applied");
469 public void testApplyState() throws Exception {
470 final TestActorRef<Shard> shard = actorFactory.createTestActor(
471 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testApplyState");
473 ShardTestKit.waitUntilLeader(shard);
475 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
476 store.setSchemaContext(SCHEMA_CONTEXT);
477 writeToStore(store, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
479 final NormalizedNode<?, ?> root = readStore(store, YangInstanceIdentifier.EMPTY);
480 final Snapshot snapshot = Snapshot.create(new MetadataShardDataTreeSnapshot(root).serialize(),
481 Collections.<ReplicatedLogEntry>emptyList(), 1, 2, 3, 4);
483 shard.tell(new ApplySnapshot(snapshot), ActorRef.noSender());
485 final DataTreeModification writeMod = store.takeSnapshot().newModification();
486 final ContainerNode node = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
487 writeMod.write(TestModel.TEST_PATH, node);
490 final TransactionIdentifier tx = nextTransactionId();
491 final ApplyState applyState = new ApplyState(null, tx,
492 new SimpleReplicatedLogEntry(1, 2, payloadForModification(store, writeMod, tx)));
494 shard.tell(applyState, shard);
496 final Stopwatch sw = Stopwatch.createStarted();
497 while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
498 Uninterruptibles.sleepUninterruptibly(75, TimeUnit.MILLISECONDS);
500 final NormalizedNode<?,?> actual = readStore(shard, TestModel.TEST_PATH);
501 if (actual != null) {
502 assertEquals("Applied state", node, actual);
507 fail("State was not applied");
511 public void testDataTreeCandidateRecovery() throws Exception {
512 // Set up the InMemorySnapshotStore.
513 final DataTree source = setupInMemorySnapshotStore();
515 final DataTreeModification writeMod = source.takeSnapshot().newModification();
516 writeMod.write(TestModel.OUTER_LIST_PATH, ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build());
518 InMemoryJournal.addEntry(shardID.toString(), 0, DUMMY_DATA);
520 // Set up the InMemoryJournal.
521 InMemoryJournal.addEntry(shardID.toString(), 1, new SimpleReplicatedLogEntry(0, 1,
522 payloadForModification(source, writeMod, nextTransactionId())));
524 final int nListEntries = 16;
525 final Set<Integer> listEntryKeys = new HashSet<>();
527 // Add some ModificationPayload entries
528 for (int i = 1; i <= nListEntries; i++) {
529 listEntryKeys.add(Integer.valueOf(i));
531 final YangInstanceIdentifier path = YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
532 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, i).build();
534 final DataTreeModification mod = source.takeSnapshot().newModification();
535 mod.merge(path, ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, i));
538 InMemoryJournal.addEntry(shardID.toString(), i + 1, new SimpleReplicatedLogEntry(i, 1,
539 payloadForModification(source, mod, nextTransactionId())));
542 InMemoryJournal.addEntry(shardID.toString(), nListEntries + 2,
543 new ApplyJournalEntries(nListEntries));
545 testRecovery(listEntryKeys);
549 @SuppressWarnings("checkstyle:IllegalCatch")
550 public void testConcurrentThreePhaseCommits() throws Exception {
551 final AtomicReference<Throwable> caughtEx = new AtomicReference<>();
552 final CountDownLatch commitLatch = new CountDownLatch(2);
554 final long timeoutSec = 5;
555 final FiniteDuration duration = FiniteDuration.create(timeoutSec, TimeUnit.SECONDS);
556 final Timeout timeout = new Timeout(duration);
558 final TestActorRef<Shard> shard = actorFactory.createTestActor(
559 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
560 "testConcurrentThreePhaseCommits");
562 class OnFutureComplete extends OnComplete<Object> {
563 private final Class<?> expRespType;
565 OnFutureComplete(final Class<?> expRespType) {
566 this.expRespType = expRespType;
570 public void onComplete(final Throwable error, final Object resp) {
572 caughtEx.set(new AssertionError(getClass().getSimpleName() + " failure", error));
575 assertEquals("Commit response type", expRespType, resp.getClass());
577 } catch (final Exception e) {
583 void onSuccess(final Object resp) throws Exception {
587 class OnCommitFutureComplete extends OnFutureComplete {
588 OnCommitFutureComplete() {
589 super(CommitTransactionReply.class);
593 public void onComplete(final Throwable error, final Object resp) {
594 super.onComplete(error, resp);
595 commitLatch.countDown();
599 class OnCanCommitFutureComplete extends OnFutureComplete {
600 private final TransactionIdentifier transactionID;
602 OnCanCommitFutureComplete(final TransactionIdentifier transactionID) {
603 super(CanCommitTransactionReply.class);
604 this.transactionID = transactionID;
608 void onSuccess(final Object resp) throws Exception {
609 final CanCommitTransactionReply canCommitReply =
610 CanCommitTransactionReply.fromSerializable(resp);
611 assertEquals("Can commit", true, canCommitReply.getCanCommit());
613 final Future<Object> commitFuture = Patterns.ask(shard,
614 new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), timeout);
615 commitFuture.onComplete(new OnCommitFutureComplete(), getSystem().dispatcher());
619 new ShardTestKit(getSystem()) {
621 waitUntilLeader(shard);
623 final TransactionIdentifier transactionID1 = nextTransactionId();
624 final TransactionIdentifier transactionID2 = nextTransactionId();
625 final TransactionIdentifier transactionID3 = nextTransactionId();
627 final Map<TransactionIdentifier, CapturingShardDataTreeCohort> cohortMap = setupCohortDecorator(
628 shard.underlyingActor(), transactionID1, transactionID2, transactionID3);
629 final CapturingShardDataTreeCohort cohort1 = cohortMap.get(transactionID1);
630 final CapturingShardDataTreeCohort cohort2 = cohortMap.get(transactionID2);
631 final CapturingShardDataTreeCohort cohort3 = cohortMap.get(transactionID3);
633 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
634 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
635 final ReadyTransactionReply readyReply = ReadyTransactionReply
636 .fromSerializable(expectMsgClass(duration, ReadyTransactionReply.class));
637 assertEquals("Cohort path", shard.path().toString(), readyReply.getCohortPath());
639 // Send the CanCommitTransaction message for the first Tx.
641 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
642 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
643 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
644 assertEquals("Can commit", true, canCommitReply.getCanCommit());
646 // Ready 2 more Tx's.
648 shard.tell(prepareBatchedModifications(transactionID2, TestModel.OUTER_LIST_PATH,
649 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), false), getRef());
650 expectMsgClass(duration, ReadyTransactionReply.class);
653 prepareBatchedModifications(transactionID3,
654 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
655 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
656 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), false),
658 expectMsgClass(duration, ReadyTransactionReply.class);
660 // Send the CanCommitTransaction message for the next 2 Tx's.
661 // These should get queued and
662 // processed after the first Tx completes.
664 final Future<Object> canCommitFuture1 = Patterns.ask(shard,
665 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
667 final Future<Object> canCommitFuture2 = Patterns.ask(shard,
668 new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), timeout);
670 // Send the CommitTransaction message for the first Tx. After it
671 // completes, it should
672 // trigger the 2nd Tx to proceed which should in turn then
675 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
676 expectMsgClass(duration, CommitTransactionReply.class);
678 // Wait for the next 2 Tx's to complete.
680 canCommitFuture1.onComplete(new OnCanCommitFutureComplete(transactionID2), getSystem().dispatcher());
682 canCommitFuture2.onComplete(new OnCanCommitFutureComplete(transactionID3), getSystem().dispatcher());
684 final boolean done = commitLatch.await(timeoutSec, TimeUnit.SECONDS);
686 if (caughtEx.get() != null) {
687 Throwables.propagateIfInstanceOf(caughtEx.get(), Exception.class);
688 Throwables.propagate(caughtEx.get());
691 assertEquals("Commits complete", true, done);
693 // final InOrder inOrder = inOrder(cohort1.getCanCommit(), cohort1.getPreCommit(), cohort1.getCommit(),
694 // cohort2.getCanCommit(), cohort2.getPreCommit(), cohort2.getCommit(), cohort3.getCanCommit(),
695 // cohort3.getPreCommit(), cohort3.getCommit());
696 // inOrder.verify(cohort1.getCanCommit()).onSuccess(any(Void.class));
697 // inOrder.verify(cohort1.getPreCommit()).onSuccess(any(DataTreeCandidate.class));
698 // inOrder.verify(cohort2.getCanCommit()).onSuccess(any(Void.class));
699 // inOrder.verify(cohort2.getPreCommit()).onSuccess(any(DataTreeCandidate.class));
700 // inOrder.verify(cohort3.getCanCommit()).onSuccess(any(Void.class));
701 // inOrder.verify(cohort3.getPreCommit()).onSuccess(any(DataTreeCandidate.class));
702 // inOrder.verify(cohort1.getCommit()).onSuccess(any(UnsignedLong.class));
703 // inOrder.verify(cohort2.getCommit()).onSuccess(any(UnsignedLong.class));
704 // inOrder.verify(cohort3.getCommit()).onSuccess(any(UnsignedLong.class));
706 // Verify data in the data store.
708 verifyOuterListEntry(shard, 1);
710 verifyLastApplied(shard, 2);
716 public void testBatchedModificationsWithNoCommitOnReady() throws Exception {
717 new ShardTestKit(getSystem()) {
719 final TestActorRef<Shard> shard = actorFactory.createTestActor(
720 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
721 "testBatchedModificationsWithNoCommitOnReady");
723 waitUntilLeader(shard);
725 final TransactionIdentifier transactionID = nextTransactionId();
726 final FiniteDuration duration = duration("5 seconds");
728 // Send a BatchedModifications to start a transaction.
730 shard.tell(newBatchedModifications(transactionID, TestModel.TEST_PATH,
731 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false, false, 1), getRef());
732 expectMsgClass(duration, BatchedModificationsReply.class);
734 // Send a couple more BatchedModifications.
737 newBatchedModifications(transactionID, TestModel.OUTER_LIST_PATH,
738 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), false, false, 2),
740 expectMsgClass(duration, BatchedModificationsReply.class);
742 shard.tell(newBatchedModifications(transactionID,
743 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
744 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
745 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), true, false, 3),
747 expectMsgClass(duration, ReadyTransactionReply.class);
749 // Send the CanCommitTransaction message.
751 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
752 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
753 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
754 assertEquals("Can commit", true, canCommitReply.getCanCommit());
756 // Send the CommitTransaction message.
758 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
759 expectMsgClass(duration, CommitTransactionReply.class);
761 // Verify data in the data store.
763 verifyOuterListEntry(shard, 1);
769 public void testBatchedModificationsWithCommitOnReady() throws Exception {
770 new ShardTestKit(getSystem()) {
772 final TestActorRef<Shard> shard = actorFactory.createTestActor(
773 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
774 "testBatchedModificationsWithCommitOnReady");
776 waitUntilLeader(shard);
778 final TransactionIdentifier transactionID = nextTransactionId();
779 final FiniteDuration duration = duration("5 seconds");
781 // Send a BatchedModifications to start a transaction.
783 shard.tell(newBatchedModifications(transactionID, TestModel.TEST_PATH,
784 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false, false, 1), getRef());
785 expectMsgClass(duration, BatchedModificationsReply.class);
787 // Send a couple more BatchedModifications.
789 shard.tell(newBatchedModifications(transactionID, TestModel.OUTER_LIST_PATH,
790 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), false, false, 2),
792 expectMsgClass(duration, BatchedModificationsReply.class);
794 shard.tell(newBatchedModifications(transactionID,
795 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
796 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
797 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), true, true, 3),
800 expectMsgClass(duration, CommitTransactionReply.class);
802 // Verify data in the data store.
804 verifyOuterListEntry(shard, 1);
809 @Test(expected = IllegalStateException.class)
810 public void testBatchedModificationsReadyWithIncorrectTotalMessageCount() throws Exception {
811 new ShardTestKit(getSystem()) {
813 final TestActorRef<Shard> shard = actorFactory.createTestActor(
814 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
815 "testBatchedModificationsReadyWithIncorrectTotalMessageCount");
817 waitUntilLeader(shard);
819 final TransactionIdentifier transactionID = nextTransactionId();
820 final BatchedModifications batched = new BatchedModifications(transactionID,
821 DataStoreVersions.CURRENT_VERSION);
822 batched.setReady(true);
823 batched.setTotalMessagesSent(2);
825 shard.tell(batched, getRef());
827 final Failure failure = expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
829 if (failure != null) {
830 Throwables.propagateIfInstanceOf(failure.cause(), Exception.class);
831 Throwables.propagate(failure.cause());
838 public void testBatchedModificationsWithOperationFailure() throws Exception {
839 new ShardTestKit(getSystem()) {
841 final TestActorRef<Shard> shard = actorFactory.createTestActor(
842 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
843 "testBatchedModificationsWithOperationFailure");
845 waitUntilLeader(shard);
847 // Test merge with invalid data. An exception should occur when
848 // the merge is applied. Note that
849 // write will not validate the children for performance reasons.
851 final TransactionIdentifier transactionID = nextTransactionId();
853 final ContainerNode invalidData = ImmutableContainerNodeBuilder.create()
854 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TestModel.TEST_QNAME))
855 .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
857 BatchedModifications batched = new BatchedModifications(transactionID, CURRENT_VERSION);
858 batched.addModification(new MergeModification(TestModel.TEST_PATH, invalidData));
859 shard.tell(batched, getRef());
860 Failure failure = expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
862 final Throwable cause = failure.cause();
864 batched = new BatchedModifications(transactionID, DataStoreVersions.CURRENT_VERSION);
865 batched.setReady(true);
866 batched.setTotalMessagesSent(2);
868 shard.tell(batched, getRef());
870 failure = expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
871 assertEquals("Failure cause", cause, failure.cause());
877 public void testBatchedModificationsOnTransactionChain() throws Exception {
878 new ShardTestKit(getSystem()) {
880 final TestActorRef<Shard> shard = actorFactory.createTestActor(
881 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
882 "testBatchedModificationsOnTransactionChain");
884 waitUntilLeader(shard);
886 final LocalHistoryIdentifier historyId = nextHistoryId();
887 final TransactionIdentifier transactionID1 = new TransactionIdentifier(historyId, 0);
888 final TransactionIdentifier transactionID2 = new TransactionIdentifier(historyId, 1);
890 final FiniteDuration duration = duration("5 seconds");
892 // Send a BatchedModifications to start a chained write
893 // transaction and ready it.
895 final ContainerNode containerNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
896 final YangInstanceIdentifier path = TestModel.TEST_PATH;
897 shard.tell(newBatchedModifications(transactionID1, path, containerNode, true, false, 1), getRef());
898 expectMsgClass(duration, ReadyTransactionReply.class);
900 // Create a read Tx on the same chain.
902 shard.tell(new CreateTransaction(transactionID2, TransactionType.READ_ONLY.ordinal(),
903 DataStoreVersions.CURRENT_VERSION).toSerializable(), getRef());
905 final CreateTransactionReply createReply = expectMsgClass(duration("3 seconds"),
906 CreateTransactionReply.class);
908 getSystem().actorSelection(createReply.getTransactionPath())
909 .tell(new ReadData(path, DataStoreVersions.CURRENT_VERSION), getRef());
910 final ReadDataReply readReply = expectMsgClass(duration("3 seconds"), ReadDataReply.class);
911 assertEquals("Read node", containerNode, readReply.getNormalizedNode());
913 // Commit the write transaction.
915 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
916 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
917 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
918 assertEquals("Can commit", true, canCommitReply.getCanCommit());
920 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
921 expectMsgClass(duration, CommitTransactionReply.class);
923 // Verify data in the data store.
925 final NormalizedNode<?, ?> actualNode = readStore(shard, path);
926 assertEquals("Stored node", containerNode, actualNode);
932 public void testOnBatchedModificationsWhenNotLeader() {
933 final AtomicBoolean overrideLeaderCalls = new AtomicBoolean();
934 new ShardTestKit(getSystem()) {
936 final Creator<Shard> creator = new Creator<Shard>() {
937 private static final long serialVersionUID = 1L;
940 public Shard create() throws Exception {
941 return new Shard(newShardBuilder()) {
943 protected boolean isLeader() {
944 return overrideLeaderCalls.get() ? false : super.isLeader();
948 public ActorSelection getLeader() {
949 return overrideLeaderCalls.get() ? getSystem().actorSelection(getRef().path())
956 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
957 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
958 "testOnBatchedModificationsWhenNotLeader");
960 waitUntilLeader(shard);
962 overrideLeaderCalls.set(true);
964 final BatchedModifications batched = new BatchedModifications(nextTransactionId(),
965 DataStoreVersions.CURRENT_VERSION);
967 shard.tell(batched, ActorRef.noSender());
969 expectMsgEquals(batched);
975 public void testTransactionMessagesWithNoLeader() {
976 new ShardTestKit(getSystem()) {
978 dataStoreContextBuilder.customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
979 .shardHeartbeatIntervalInMillis(50).shardElectionTimeoutFactor(1);
980 final TestActorRef<Shard> shard = actorFactory.createTestActor(
981 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
982 "testTransactionMessagesWithNoLeader");
984 waitUntilNoLeader(shard);
986 final TransactionIdentifier txId = nextTransactionId();
987 shard.tell(new BatchedModifications(txId, DataStoreVersions.CURRENT_VERSION), getRef());
988 Failure failure = expectMsgClass(Failure.class);
989 assertEquals("Failure cause type", NoShardLeaderException.class, failure.cause().getClass());
991 shard.tell(prepareForwardedReadyTransaction(shard, txId, TestModel.TEST_PATH,
992 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
993 failure = expectMsgClass(Failure.class);
994 assertEquals("Failure cause type", NoShardLeaderException.class, failure.cause().getClass());
996 shard.tell(new ReadyLocalTransaction(txId, mock(DataTreeModification.class), true), getRef());
997 failure = expectMsgClass(Failure.class);
998 assertEquals("Failure cause type", NoShardLeaderException.class, failure.cause().getClass());
1004 public void testReadyWithReadWriteImmediateCommit() throws Exception {
1005 testReadyWithImmediateCommit(true);
1009 public void testReadyWithWriteOnlyImmediateCommit() throws Exception {
1010 testReadyWithImmediateCommit(false);
1013 private void testReadyWithImmediateCommit(final boolean readWrite) throws Exception {
1014 new ShardTestKit(getSystem()) {
1016 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1017 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1018 "testReadyWithImmediateCommit-" + readWrite);
1020 waitUntilLeader(shard);
1022 final TransactionIdentifier transactionID = nextTransactionId();
1023 final NormalizedNode<?, ?> containerNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1025 shard.tell(prepareForwardedReadyTransaction(shard, transactionID, TestModel.TEST_PATH,
1026 containerNode, true), getRef());
1028 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH, containerNode, true),
1032 expectMsgClass(duration("5 seconds"), CommitTransactionReply.class);
1034 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.TEST_PATH);
1035 assertEquals(TestModel.TEST_QNAME.getLocalName(), containerNode, actualNode);
1041 public void testReadyLocalTransactionWithImmediateCommit() throws Exception {
1042 new ShardTestKit(getSystem()) {
1044 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1045 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1046 "testReadyLocalTransactionWithImmediateCommit");
1048 waitUntilLeader(shard);
1050 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1052 final DataTreeModification modification = dataStore.newModification();
1054 final ContainerNode writeData = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1055 new WriteModification(TestModel.TEST_PATH, writeData).apply(modification);
1056 final MapNode mergeData = ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build();
1057 new MergeModification(TestModel.OUTER_LIST_PATH, mergeData).apply(modification);
1059 final TransactionIdentifier txId = nextTransactionId();
1060 modification.ready();
1061 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(txId, modification, true);
1063 shard.tell(readyMessage, getRef());
1065 expectMsgClass(CommitTransactionReply.class);
1067 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.OUTER_LIST_PATH);
1068 assertEquals(TestModel.OUTER_LIST_QNAME.getLocalName(), mergeData, actualNode);
1074 public void testReadyLocalTransactionWithThreePhaseCommit() throws Exception {
1075 new ShardTestKit(getSystem()) {
1077 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1078 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1079 "testReadyLocalTransactionWithThreePhaseCommit");
1081 waitUntilLeader(shard);
1083 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1085 final DataTreeModification modification = dataStore.newModification();
1087 final ContainerNode writeData = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1088 new WriteModification(TestModel.TEST_PATH, writeData).apply(modification);
1089 final MapNode mergeData = ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build();
1090 new MergeModification(TestModel.OUTER_LIST_PATH, mergeData).apply(modification);
1092 final TransactionIdentifier txId = nextTransactionId();
1093 modification.ready();
1094 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(txId, modification, false);
1096 shard.tell(readyMessage, getRef());
1098 expectMsgClass(ReadyTransactionReply.class);
1100 // Send the CanCommitTransaction message.
1102 shard.tell(new CanCommitTransaction(txId, CURRENT_VERSION).toSerializable(), getRef());
1103 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1104 .fromSerializable(expectMsgClass(CanCommitTransactionReply.class));
1105 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1107 // Send the CanCommitTransaction message.
1109 shard.tell(new CommitTransaction(txId, CURRENT_VERSION).toSerializable(), getRef());
1110 expectMsgClass(CommitTransactionReply.class);
1112 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.OUTER_LIST_PATH);
1113 assertEquals(TestModel.OUTER_LIST_QNAME.getLocalName(), mergeData, actualNode);
1119 public void testReadWriteCommitWithPersistenceDisabled() throws Exception {
1120 dataStoreContextBuilder.persistent(false);
1121 new ShardTestKit(getSystem()) {
1123 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1124 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1125 "testCommitWithPersistenceDisabled");
1127 waitUntilLeader(shard);
1129 // Setup a simulated transactions with a mock cohort.
1131 final FiniteDuration duration = duration("5 seconds");
1133 final TransactionIdentifier transactionID = nextTransactionId();
1134 final NormalizedNode<?, ?> containerNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1135 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH, containerNode, false),
1137 expectMsgClass(duration, ReadyTransactionReply.class);
1139 // Send the CanCommitTransaction message.
1141 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1142 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1143 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1144 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1146 // Send the CanCommitTransaction message.
1148 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1149 expectMsgClass(duration, CommitTransactionReply.class);
1151 final NormalizedNode<?, ?> actualNode = readStore(shard, TestModel.TEST_PATH);
1152 assertEquals(TestModel.TEST_QNAME.getLocalName(), containerNode, actualNode);
1158 public void testReadWriteCommitWhenTransactionHasNoModifications() {
1159 testCommitWhenTransactionHasNoModifications(true);
1163 public void testWriteOnlyCommitWhenTransactionHasNoModifications() {
1164 testCommitWhenTransactionHasNoModifications(false);
1167 private void testCommitWhenTransactionHasNoModifications(final boolean readWrite) {
1168 // Note that persistence is enabled which would normally result in the
1169 // entry getting written to the journal
1170 // but here that need not happen
1171 new ShardTestKit(getSystem()) {
1173 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1174 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1175 "testCommitWhenTransactionHasNoModifications-" + readWrite);
1177 waitUntilLeader(shard);
1179 final TransactionIdentifier transactionID = nextTransactionId();
1181 final FiniteDuration duration = duration("5 seconds");
1184 final ReadWriteShardDataTreeTransaction rwTx = shard.underlyingActor().getDataStore()
1185 .newReadWriteTransaction(transactionID);
1186 shard.tell(new ForwardedReadyTransaction(transactionID, CURRENT_VERSION, rwTx, false), getRef());
1188 shard.tell(prepareBatchedModifications(transactionID, new MutableCompositeModification()),
1192 expectMsgClass(duration, ReadyTransactionReply.class);
1194 // Send the CanCommitTransaction message.
1196 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1197 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1198 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1199 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1201 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1202 expectMsgClass(duration, CommitTransactionReply.class);
1204 shard.tell(Shard.GET_SHARD_MBEAN_MESSAGE, getRef());
1205 final ShardStats shardStats = expectMsgClass(duration, ShardStats.class);
1207 // Use MBean for verification
1208 // Committed transaction count should increase as usual
1209 assertEquals(1, shardStats.getCommittedTransactionsCount());
1211 // Commit index should not advance because this does not go into
1213 assertEquals(-1, shardStats.getCommitIndex());
1219 public void testReadWriteCommitWhenTransactionHasModifications() throws Exception {
1220 testCommitWhenTransactionHasModifications(true);
1224 public void testWriteOnlyCommitWhenTransactionHasModifications() throws Exception {
1225 testCommitWhenTransactionHasModifications(false);
1228 private void testCommitWhenTransactionHasModifications(final boolean readWrite) throws Exception {
1229 new ShardTestKit(getSystem()) {
1231 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1232 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1233 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1234 "testCommitWhenTransactionHasModifications-" + readWrite);
1236 waitUntilLeader(shard);
1238 final FiniteDuration duration = duration("5 seconds");
1239 final TransactionIdentifier transactionID = nextTransactionId();
1242 shard.tell(prepareForwardedReadyTransaction(shard, transactionID, TestModel.TEST_PATH,
1243 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1245 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH,
1246 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1249 expectMsgClass(duration, ReadyTransactionReply.class);
1251 // Send the CanCommitTransaction message.
1253 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1254 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1255 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1256 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1258 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1259 expectMsgClass(duration, CommitTransactionReply.class);
1261 final InOrder inOrder = inOrder(dataTree);
1262 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1263 inOrder.verify(dataTree).prepare(any(DataTreeModification.class));
1264 inOrder.verify(dataTree).commit(any(DataTreeCandidate.class));
1266 shard.tell(Shard.GET_SHARD_MBEAN_MESSAGE, getRef());
1267 final ShardStats shardStats = expectMsgClass(duration, ShardStats.class);
1269 // Use MBean for verification
1270 // Committed transaction count should increase as usual
1271 assertEquals(1, shardStats.getCommittedTransactionsCount());
1273 // Commit index should advance as we do not have an empty
1275 assertEquals(0, shardStats.getCommitIndex());
1281 public void testCommitPhaseFailure() throws Exception {
1282 new ShardTestKit(getSystem()) {
1284 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1285 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1286 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1287 "testCommitPhaseFailure");
1289 waitUntilLeader(shard);
1291 final FiniteDuration duration = duration("5 seconds");
1292 final Timeout timeout = new Timeout(duration);
1294 // Setup 2 simulated transactions with mock cohorts. The first
1298 doThrow(new RuntimeException("mock commit failure")).when(dataTree)
1299 .commit(any(DataTreeCandidate.class));
1301 final TransactionIdentifier transactionID1 = nextTransactionId();
1302 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1303 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1304 expectMsgClass(duration, ReadyTransactionReply.class);
1306 final TransactionIdentifier transactionID2 = nextTransactionId();
1307 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1308 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1309 expectMsgClass(duration, ReadyTransactionReply.class);
1311 // Send the CanCommitTransaction message for the first Tx.
1313 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1314 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1315 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1316 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1318 // Send the CanCommitTransaction message for the 2nd Tx. This
1319 // should get queued and
1320 // processed after the first Tx completes.
1322 final Future<Object> canCommitFuture = Patterns.ask(shard,
1323 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1325 // Send the CommitTransaction message for the first Tx. This
1326 // should send back an error
1327 // and trigger the 2nd Tx to proceed.
1329 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1330 expectMsgClass(duration, akka.actor.Status.Failure.class);
1332 // Wait for the 2nd Tx to complete the canCommit phase.
1334 final CountDownLatch latch = new CountDownLatch(1);
1335 canCommitFuture.onComplete(new OnComplete<Object>() {
1337 public void onComplete(final Throwable failure, final Object resp) {
1340 }, getSystem().dispatcher());
1342 assertEquals("2nd CanCommit complete", true, latch.await(5, TimeUnit.SECONDS));
1344 final InOrder inOrder = inOrder(dataTree);
1345 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1346 inOrder.verify(dataTree).prepare(any(DataTreeModification.class));
1348 // FIXME: this invocation is done on the result of validate(). To test it, we need to make sure mock
1349 // validate performs wrapping and we capture that mock
1350 // inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1352 inOrder.verify(dataTree).commit(any(DataTreeCandidate.class));
1358 public void testPreCommitPhaseFailure() throws Exception {
1359 new ShardTestKit(getSystem()) {
1361 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1362 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1363 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1364 "testPreCommitPhaseFailure");
1366 waitUntilLeader(shard);
1368 final FiniteDuration duration = duration("5 seconds");
1369 final Timeout timeout = new Timeout(duration);
1371 doThrow(new RuntimeException("mock preCommit failure")).when(dataTree)
1372 .prepare(any(DataTreeModification.class));
1374 final TransactionIdentifier transactionID1 = nextTransactionId();
1375 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1376 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1377 expectMsgClass(duration, ReadyTransactionReply.class);
1379 final TransactionIdentifier transactionID2 = nextTransactionId();
1380 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1381 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1382 expectMsgClass(duration, ReadyTransactionReply.class);
1384 // Send the CanCommitTransaction message for the first Tx.
1386 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1387 final CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1388 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1389 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1391 // Send the CanCommitTransaction message for the 2nd Tx. This
1392 // should get queued and
1393 // processed after the first Tx completes.
1395 final Future<Object> canCommitFuture = Patterns.ask(shard,
1396 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1398 // Send the CommitTransaction message for the first Tx. This
1399 // should send back an error
1400 // and trigger the 2nd Tx to proceed.
1402 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1403 expectMsgClass(duration, akka.actor.Status.Failure.class);
1405 // Wait for the 2nd Tx to complete the canCommit phase.
1407 final CountDownLatch latch = new CountDownLatch(1);
1408 canCommitFuture.onComplete(new OnComplete<Object>() {
1410 public void onComplete(final Throwable failure, final Object resp) {
1413 }, getSystem().dispatcher());
1415 assertEquals("2nd CanCommit complete", true, latch.await(5, TimeUnit.SECONDS));
1417 final InOrder inOrder = inOrder(dataTree);
1418 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1419 inOrder.verify(dataTree).prepare(any(DataTreeModification.class));
1420 inOrder.verify(dataTree).validate(any(DataTreeModification.class));
1426 public void testCanCommitPhaseFailure() throws Exception {
1427 new ShardTestKit(getSystem()) {
1429 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1430 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1431 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1432 "testCanCommitPhaseFailure");
1434 waitUntilLeader(shard);
1436 final FiniteDuration duration = duration("5 seconds");
1437 final TransactionIdentifier transactionID1 = nextTransactionId();
1439 doThrow(new DataValidationFailedException(YangInstanceIdentifier.EMPTY, "mock canCommit failure"))
1440 .doNothing().when(dataTree).validate(any(DataTreeModification.class));
1442 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1443 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1444 expectMsgClass(duration, ReadyTransactionReply.class);
1446 // Send the CanCommitTransaction message.
1448 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1449 expectMsgClass(duration, akka.actor.Status.Failure.class);
1451 // Send another can commit to ensure the failed one got cleaned
1454 final TransactionIdentifier transactionID2 = nextTransactionId();
1455 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1456 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1457 expectMsgClass(duration, ReadyTransactionReply.class);
1459 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1460 final CanCommitTransactionReply reply = CanCommitTransactionReply
1461 .fromSerializable(expectMsgClass(CanCommitTransactionReply.class));
1462 assertEquals("getCanCommit", true, reply.getCanCommit());
1468 public void testImmediateCommitWithCanCommitPhaseFailure() throws Exception {
1469 testImmediateCommitWithCanCommitPhaseFailure(true);
1470 testImmediateCommitWithCanCommitPhaseFailure(false);
1473 private void testImmediateCommitWithCanCommitPhaseFailure(final boolean readWrite) throws Exception {
1474 new ShardTestKit(getSystem()) {
1476 final TipProducingDataTree dataTree = createDelegatingMockDataTree();
1477 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1478 newShardBuilder().dataTree(dataTree).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1479 "testImmediateCommitWithCanCommitPhaseFailure-" + readWrite);
1481 waitUntilLeader(shard);
1483 doThrow(new DataValidationFailedException(YangInstanceIdentifier.EMPTY, "mock canCommit failure"))
1484 .doNothing().when(dataTree).validate(any(DataTreeModification.class));
1486 final FiniteDuration duration = duration("5 seconds");
1488 final TransactionIdentifier transactionID1 = nextTransactionId();
1491 shard.tell(prepareForwardedReadyTransaction(shard, transactionID1, TestModel.TEST_PATH,
1492 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1494 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
1495 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1498 expectMsgClass(duration, akka.actor.Status.Failure.class);
1500 // Send another can commit to ensure the failed one got cleaned
1503 final TransactionIdentifier transactionID2 = nextTransactionId();
1505 shard.tell(prepareForwardedReadyTransaction(shard, transactionID2, TestModel.TEST_PATH,
1506 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1508 shard.tell(prepareBatchedModifications(transactionID2, TestModel.TEST_PATH,
1509 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true), getRef());
1512 expectMsgClass(duration, CommitTransactionReply.class);
1518 public void testAbortWithCommitPending() throws Exception {
1519 new ShardTestKit(getSystem()) {
1521 final Creator<Shard> creator = () -> new Shard(newShardBuilder()) {
1523 void persistPayload(final TransactionIdentifier transactionId, final Payload payload,
1524 boolean batchHint) {
1525 // Simulate an AbortTransaction message occurring during
1526 // replication, after
1527 // persisting and before finishing the commit to the
1530 doAbortTransaction(transactionId, null);
1531 super.persistPayload(transactionId, payload, batchHint);
1535 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
1536 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
1537 "testAbortWithCommitPending");
1539 waitUntilLeader(shard);
1541 final FiniteDuration duration = duration("5 seconds");
1543 final TransactionIdentifier transactionID = nextTransactionId();
1545 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH,
1546 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1547 expectMsgClass(duration, ReadyTransactionReply.class);
1549 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1550 expectMsgClass(duration, CanCommitTransactionReply.class);
1552 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1553 expectMsgClass(duration, CommitTransactionReply.class);
1555 final NormalizedNode<?, ?> node = readStore(shard, TestModel.TEST_PATH);
1557 // Since we're simulating an abort occurring during replication
1558 // and before finish commit,
1559 // the data should still get written to the in-memory store
1560 // since we've gotten past
1561 // canCommit and preCommit and persisted the data.
1562 assertNotNull(TestModel.TEST_QNAME.getLocalName() + " not found", node);
1568 public void testTransactionCommitTimeout() throws Exception {
1569 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1570 new ShardTestKit(getSystem()) {
1572 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1573 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1574 "testTransactionCommitTimeout");
1576 waitUntilLeader(shard);
1578 final FiniteDuration duration = duration("5 seconds");
1580 writeToStore(shard, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
1581 writeToStore(shard, TestModel.OUTER_LIST_PATH,
1582 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build());
1584 // Ready 2 Tx's - the first will timeout
1586 final TransactionIdentifier transactionID1 = nextTransactionId();
1588 prepareBatchedModifications(transactionID1,
1589 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
1590 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
1591 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), false),
1593 expectMsgClass(duration, ReadyTransactionReply.class);
1595 final TransactionIdentifier transactionID2 = nextTransactionId();
1596 final YangInstanceIdentifier listNodePath = YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
1597 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2).build();
1599 prepareBatchedModifications(transactionID2, listNodePath,
1600 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2), false),
1602 expectMsgClass(duration, ReadyTransactionReply.class);
1604 // canCommit 1st Tx. We don't send the commit so it should
1607 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1608 expectMsgClass(duration, CanCommitTransactionReply.class);
1610 // canCommit the 2nd Tx - it should complete after the 1st Tx
1613 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1614 expectMsgClass(duration, CanCommitTransactionReply.class);
1616 // Try to commit the 1st Tx - should fail as it's not the
1619 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1620 expectMsgClass(duration, akka.actor.Status.Failure.class);
1622 // Commit the 2nd Tx.
1624 shard.tell(new CommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1625 expectMsgClass(duration, CommitTransactionReply.class);
1627 final NormalizedNode<?, ?> node = readStore(shard, listNodePath);
1628 assertNotNull(listNodePath + " not found", node);
1635 // public void testTransactionCommitQueueCapacityExceeded() throws Throwable {
1636 // dataStoreContextBuilder.shardTransactionCommitQueueCapacity(2);
1638 // new ShardTestKit(getSystem()) {{
1639 // final TestActorRef<Shard> shard = actorFactory.createTestActor(
1640 // newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1641 // "testTransactionCommitQueueCapacityExceeded");
1643 // waitUntilLeader(shard);
1645 // final FiniteDuration duration = duration("5 seconds");
1647 // final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1649 // final TransactionIdentifier transactionID1 = nextTransactionId();
1650 // final MutableCompositeModification modification1 = new MutableCompositeModification();
1651 // final ShardDataTreeCohort cohort1 = setupMockWriteTransaction("cohort1", dataStore,
1652 // TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME), transactionID1,
1655 // final TransactionIdentifier transactionID2 = nextTransactionId();
1656 // final MutableCompositeModification modification2 = new MutableCompositeModification();
1657 // final ShardDataTreeCohort cohort2 = setupMockWriteTransaction("cohort2", dataStore,
1658 // TestModel.OUTER_LIST_PATH,
1659 // ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), transactionID2,
1662 // final TransactionIdentifier transactionID3 = nextTransactionId();
1663 // final MutableCompositeModification modification3 = new MutableCompositeModification();
1664 // final ShardDataTreeCohort cohort3 = setupMockWriteTransaction("cohort3", dataStore,
1665 // TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME), transactionID3,
1668 // // Ready the Tx's
1670 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort1, transactionID1,
1671 // modification1), getRef());
1672 // expectMsgClass(duration, ReadyTransactionReply.class);
1674 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort2, transactionID2,
1675 // modification2), getRef());
1676 // expectMsgClass(duration, ReadyTransactionReply.class);
1678 // // The 3rd Tx should exceed queue capacity and fail.
1680 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort3, transactionID3,
1681 // modification3), getRef());
1682 // expectMsgClass(duration, akka.actor.Status.Failure.class);
1684 // // canCommit 1st Tx.
1686 // shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1687 // expectMsgClass(duration, CanCommitTransactionReply.class);
1689 // // canCommit the 2nd Tx - it should get queued.
1691 // shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1693 // // canCommit the 3rd Tx - should exceed queue capacity and fail.
1695 // shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1696 // expectMsgClass(duration, akka.actor.Status.Failure.class);
1701 public void testTransactionCommitWithPriorExpiredCohortEntries() throws Exception {
1702 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1703 new ShardTestKit(getSystem()) {
1705 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1706 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1707 "testTransactionCommitWithPriorExpiredCohortEntries");
1709 waitUntilLeader(shard);
1711 final FiniteDuration duration = duration("5 seconds");
1713 final TransactionIdentifier transactionID1 = nextTransactionId();
1714 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1715 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1716 expectMsgClass(duration, ReadyTransactionReply.class);
1718 final TransactionIdentifier transactionID2 = nextTransactionId();
1719 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1720 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1721 expectMsgClass(duration, ReadyTransactionReply.class);
1723 final TransactionIdentifier transactionID3 = nextTransactionId();
1724 shard.tell(newBatchedModifications(transactionID3, TestModel.TEST_PATH,
1725 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1726 expectMsgClass(duration, ReadyTransactionReply.class);
1728 // All Tx's are readied. We'll send canCommit for the last one
1729 // but not the others. The others
1730 // should expire from the queue and the last one should be
1733 shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1734 expectMsgClass(duration, CanCommitTransactionReply.class);
1740 public void testTransactionCommitWithSubsequentExpiredCohortEntry() throws Exception {
1741 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1742 new ShardTestKit(getSystem()) {
1744 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1745 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1746 "testTransactionCommitWithSubsequentExpiredCohortEntry");
1748 waitUntilLeader(shard);
1750 final FiniteDuration duration = duration("5 seconds");
1752 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1754 final TransactionIdentifier transactionID1 = nextTransactionId();
1755 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
1756 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1757 expectMsgClass(duration, ReadyTransactionReply.class);
1759 // CanCommit the first Tx so it's the current in-progress Tx.
1761 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1762 expectMsgClass(duration, CanCommitTransactionReply.class);
1764 // Ready the second Tx.
1766 final TransactionIdentifier transactionID2 = nextTransactionId();
1767 shard.tell(prepareBatchedModifications(transactionID2, TestModel.TEST_PATH,
1768 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1769 expectMsgClass(duration, ReadyTransactionReply.class);
1771 // Ready the third Tx.
1773 final TransactionIdentifier transactionID3 = nextTransactionId();
1774 final DataTreeModification modification3 = dataStore.newModification();
1775 new WriteModification(TestModel.TEST2_PATH, ImmutableNodes.containerNode(TestModel.TEST2_QNAME))
1776 .apply(modification3);
1777 modification3.ready();
1778 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(transactionID3, modification3,
1780 shard.tell(readyMessage, getRef());
1782 // Commit the first Tx. After completing, the second should
1783 // expire from the queue and the third
1786 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1787 expectMsgClass(duration, CommitTransactionReply.class);
1789 // Expect commit reply from the third Tx.
1791 expectMsgClass(duration, CommitTransactionReply.class);
1793 final NormalizedNode<?, ?> node = readStore(shard, TestModel.TEST2_PATH);
1794 assertNotNull(TestModel.TEST2_PATH + " not found", node);
1800 public void testCanCommitBeforeReadyFailure() throws Exception {
1801 new ShardTestKit(getSystem()) {
1803 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1804 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1805 "testCanCommitBeforeReadyFailure");
1807 shard.tell(new CanCommitTransaction(nextTransactionId(), CURRENT_VERSION).toSerializable(), getRef());
1808 expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
1814 public void testAbortAfterCanCommit() throws Exception {
1815 new ShardTestKit(getSystem()) {
1817 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1818 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterCanCommit");
1820 waitUntilLeader(shard);
1822 final FiniteDuration duration = duration("5 seconds");
1823 final Timeout timeout = new Timeout(duration);
1825 // Ready 2 transactions - the first one will be aborted.
1827 final TransactionIdentifier transactionID1 = nextTransactionId();
1828 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1829 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1830 expectMsgClass(duration, ReadyTransactionReply.class);
1832 final TransactionIdentifier transactionID2 = nextTransactionId();
1833 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1834 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1835 expectMsgClass(duration, ReadyTransactionReply.class);
1837 // Send the CanCommitTransaction message for the first Tx.
1839 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1840 CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1841 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1842 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1844 // Send the CanCommitTransaction message for the 2nd Tx. This
1845 // should get queued and
1846 // processed after the first Tx completes.
1848 final Future<Object> canCommitFuture = Patterns.ask(shard,
1849 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1851 // Send the AbortTransaction message for the first Tx. This
1852 // should trigger the 2nd
1855 shard.tell(new AbortTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1856 expectMsgClass(duration, AbortTransactionReply.class);
1858 // Wait for the 2nd Tx to complete the canCommit phase.
1860 canCommitReply = (CanCommitTransactionReply) Await.result(canCommitFuture, duration);
1861 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1867 public void testAbortAfterReady() throws Exception {
1868 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1869 new ShardTestKit(getSystem()) {
1871 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1872 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterReady");
1874 waitUntilLeader(shard);
1876 final FiniteDuration duration = duration("5 seconds");
1880 final TransactionIdentifier transactionID1 = nextTransactionId();
1881 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1882 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1883 expectMsgClass(duration, ReadyTransactionReply.class);
1885 // Send the AbortTransaction message.
1887 shard.tell(new AbortTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1888 expectMsgClass(duration, AbortTransactionReply.class);
1890 assertEquals("getPendingTxCommitQueueSize", 0, shard.underlyingActor().getPendingTxCommitQueueSize());
1892 // Now send CanCommitTransaction - should fail.
1894 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1895 final Throwable failure = expectMsgClass(duration, akka.actor.Status.Failure.class).cause();
1896 assertTrue("Failure type", failure instanceof IllegalStateException);
1898 // Ready and CanCommit another and verify success.
1900 final TransactionIdentifier transactionID2 = nextTransactionId();
1901 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1902 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1903 expectMsgClass(duration, ReadyTransactionReply.class);
1905 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1906 expectMsgClass(duration, CanCommitTransactionReply.class);
1912 public void testAbortQueuedTransaction() throws Exception {
1913 new ShardTestKit(getSystem()) {
1915 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1916 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterReady");
1918 waitUntilLeader(shard);
1920 final FiniteDuration duration = duration("5 seconds");
1924 final TransactionIdentifier transactionID1 = nextTransactionId();
1925 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1926 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1927 expectMsgClass(duration, ReadyTransactionReply.class);
1929 final TransactionIdentifier transactionID2 = nextTransactionId();
1930 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1931 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1932 expectMsgClass(duration, ReadyTransactionReply.class);
1934 final TransactionIdentifier transactionID3 = nextTransactionId();
1936 newBatchedModifications(transactionID3, TestModel.OUTER_LIST_PATH,
1937 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), true, false, 1),
1939 expectMsgClass(duration, ReadyTransactionReply.class);
1941 // Abort the second tx while it's queued.
1943 shard.tell(new AbortTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1944 expectMsgClass(duration, AbortTransactionReply.class);
1946 // Commit the other 2.
1948 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1949 expectMsgClass(duration, CanCommitTransactionReply.class);
1951 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1952 expectMsgClass(duration, CommitTransactionReply.class);
1954 shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1955 expectMsgClass(duration, CanCommitTransactionReply.class);
1957 shard.tell(new CommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1958 expectMsgClass(duration, CommitTransactionReply.class);
1960 assertEquals("getPendingTxCommitQueueSize", 0, shard.underlyingActor().getPendingTxCommitQueueSize());
1966 public void testCreateSnapshotWithNonPersistentData() throws Exception {
1967 testCreateSnapshot(false, "testCreateSnapshotWithNonPersistentData");
1971 public void testCreateSnapshot() throws Exception {
1972 testCreateSnapshot(true, "testCreateSnapshot");
1975 private void testCreateSnapshot(final boolean persistent, final String shardActorName) throws Exception {
1976 final AtomicReference<CountDownLatch> latch = new AtomicReference<>(new CountDownLatch(1));
1978 final AtomicReference<Object> savedSnapshot = new AtomicReference<>();
1979 class TestPersistentDataProvider extends DelegatingPersistentDataProvider {
1980 TestPersistentDataProvider(final DataPersistenceProvider delegate) {
1985 public void saveSnapshot(final Object obj) {
1986 savedSnapshot.set(obj);
1987 super.saveSnapshot(obj);
1991 dataStoreContextBuilder.persistent(persistent);
1993 class TestShard extends Shard {
1995 protected TestShard(final AbstractBuilder<?, ?> builder) {
1997 setPersistence(new TestPersistentDataProvider(super.persistence()));
2001 public void handleCommand(final Object message) {
2002 super.handleCommand(message);
2004 // XXX: commit_snapshot equality check references RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT
2005 if (message instanceof SaveSnapshotSuccess || "commit_snapshot".equals(message.toString())) {
2006 latch.get().countDown();
2011 public RaftActorContext getRaftActorContext() {
2012 return super.getRaftActorContext();
2016 new ShardTestKit(getSystem()) {
2018 final Creator<Shard> creator = () -> new TestShard(newShardBuilder());
2020 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
2021 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
2024 waitUntilLeader(shard);
2025 writeToStore(shard, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2027 final NormalizedNode<?, ?> expectedRoot = readStore(shard, YangInstanceIdentifier.EMPTY);
2029 // Trigger creation of a snapshot by ensuring
2030 final RaftActorContext raftActorContext = ((TestShard) shard.underlyingActor()).getRaftActorContext();
2031 raftActorContext.getSnapshotManager().capture(mock(ReplicatedLogEntry.class), -1);
2032 awaitAndValidateSnapshot(expectedRoot);
2034 raftActorContext.getSnapshotManager().capture(mock(ReplicatedLogEntry.class), -1);
2035 awaitAndValidateSnapshot(expectedRoot);
2038 private void awaitAndValidateSnapshot(final NormalizedNode<?, ?> expectedRoot)
2039 throws InterruptedException, IOException {
2040 assertEquals("Snapshot saved", true, latch.get().await(5, TimeUnit.SECONDS));
2042 assertTrue("Invalid saved snapshot " + savedSnapshot.get(), savedSnapshot.get() instanceof Snapshot);
2044 verifySnapshot((Snapshot) savedSnapshot.get(), expectedRoot);
2046 latch.set(new CountDownLatch(1));
2047 savedSnapshot.set(null);
2050 private void verifySnapshot(final Snapshot snapshot, final NormalizedNode<?, ?> expectedRoot)
2051 throws IOException {
2052 final NormalizedNode<?, ?> actual = ShardDataTreeSnapshot.deserialize(snapshot.getState()).getRootNode()
2054 assertEquals("Root node", expectedRoot, actual);
2060 * This test simply verifies that the applySnapShot logic will work.
2063 public void testInMemoryDataTreeRestore() throws ReadFailedException, DataValidationFailedException {
2064 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
2065 store.setSchemaContext(SCHEMA_CONTEXT);
2067 final DataTreeModification putTransaction = store.takeSnapshot().newModification();
2068 putTransaction.write(TestModel.TEST_PATH,
2069 ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2070 commitTransaction(store, putTransaction);
2073 final NormalizedNode<?, ?> expected = readStore(store, YangInstanceIdentifier.EMPTY);
2075 final DataTreeModification writeTransaction = store.takeSnapshot().newModification();
2077 writeTransaction.delete(YangInstanceIdentifier.EMPTY);
2078 writeTransaction.write(YangInstanceIdentifier.EMPTY, expected);
2080 commitTransaction(store, writeTransaction);
2082 final NormalizedNode<?, ?> actual = readStore(store, YangInstanceIdentifier.EMPTY);
2084 assertEquals(expected, actual);
2088 public void testRecoveryApplicable() {
2090 final DatastoreContext persistentContext = DatastoreContext.newBuilder()
2091 .shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).persistent(true).build();
2093 final Props persistentProps = Shard.builder().id(shardID).datastoreContext(persistentContext)
2094 .schemaContext(SCHEMA_CONTEXT).props();
2096 final DatastoreContext nonPersistentContext = DatastoreContext.newBuilder()
2097 .shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).persistent(false).build();
2099 final Props nonPersistentProps = Shard.builder().id(shardID).datastoreContext(nonPersistentContext)
2100 .schemaContext(SCHEMA_CONTEXT).props();
2102 new ShardTestKit(getSystem()) {
2104 final TestActorRef<Shard> shard1 = actorFactory.createTestActor(persistentProps, "testPersistence1");
2106 assertTrue("Recovery Applicable", shard1.underlyingActor().persistence().isRecoveryApplicable());
2108 final TestActorRef<Shard> shard2 = actorFactory.createTestActor(nonPersistentProps, "testPersistence2");
2110 assertFalse("Recovery Not Applicable", shard2.underlyingActor().persistence().isRecoveryApplicable());
2116 public void testOnDatastoreContext() {
2117 new ShardTestKit(getSystem()) {
2119 dataStoreContextBuilder.persistent(true);
2121 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardProps(),
2122 "testOnDatastoreContext");
2124 assertEquals("isRecoveryApplicable", true,
2125 shard.underlyingActor().persistence().isRecoveryApplicable());
2127 waitUntilLeader(shard);
2129 shard.tell(dataStoreContextBuilder.persistent(false).build(), ActorRef.noSender());
2131 assertEquals("isRecoveryApplicable", false,
2132 shard.underlyingActor().persistence().isRecoveryApplicable());
2134 shard.tell(dataStoreContextBuilder.persistent(true).build(), ActorRef.noSender());
2136 assertEquals("isRecoveryApplicable", true,
2137 shard.underlyingActor().persistence().isRecoveryApplicable());
2143 public void testRegisterRoleChangeListener() throws Exception {
2144 new ShardTestKit(getSystem()) {
2146 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2147 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
2148 "testRegisterRoleChangeListener");
2150 waitUntilLeader(shard);
2152 final TestActorRef<MessageCollectorActor> listener =
2153 TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class));
2155 shard.tell(new RegisterRoleChangeListener(), listener);
2157 MessageCollectorActor.expectFirstMatching(listener, RegisterRoleChangeListenerReply.class);
2159 ShardLeaderStateChanged leaderStateChanged = MessageCollectorActor.expectFirstMatching(listener,
2160 ShardLeaderStateChanged.class);
2161 assertEquals("getLocalShardDataTree present", true,
2162 leaderStateChanged.getLocalShardDataTree().isPresent());
2163 assertSame("getLocalShardDataTree", shard.underlyingActor().getDataStore().getDataTree(),
2164 leaderStateChanged.getLocalShardDataTree().get());
2166 MessageCollectorActor.clearMessages(listener);
2168 // Force a leader change
2170 shard.tell(new RequestVote(10000, "member2", 50, 50), getRef());
2172 leaderStateChanged = MessageCollectorActor.expectFirstMatching(listener,
2173 ShardLeaderStateChanged.class);
2174 assertEquals("getLocalShardDataTree present", false,
2175 leaderStateChanged.getLocalShardDataTree().isPresent());
2181 public void testFollowerInitialSyncStatus() throws Exception {
2182 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2183 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
2184 "testFollowerInitialSyncStatus");
2186 shard.underlyingActor().handleNonRaftCommand(new FollowerInitialSyncUpStatus(false,
2187 "member-1-shard-inventory-operational"));
2189 assertEquals(false, shard.underlyingActor().getShardMBean().getFollowerInitialSyncStatus());
2191 shard.underlyingActor().handleNonRaftCommand(new FollowerInitialSyncUpStatus(true,
2192 "member-1-shard-inventory-operational"));
2194 assertEquals(true, shard.underlyingActor().getShardMBean().getFollowerInitialSyncStatus());
2198 public void testClusteredDataChangeListenerDelayedRegistration() throws Exception {
2199 new ShardTestKit(getSystem()) {
2201 final String testName = "testClusteredDataChangeListenerDelayedRegistration";
2202 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2203 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2205 final MockDataChangeListener listener = new MockDataChangeListener(1);
2206 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener),
2207 actorFactory.generateActorId(testName + "-DataChangeListener"));
2209 setupInMemorySnapshotStore();
2211 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2212 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2213 actorFactory.generateActorId(testName + "-shard"));
2215 waitUntilNoLeader(shard);
2217 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2219 shard.tell(new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.BASE, true),
2221 final RegisterChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2222 RegisterChangeListenerReply.class);
2223 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2225 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2226 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2228 listener.waitForChangeEvents();
2234 public void testClusteredDataChangeListenerRegistration() throws Exception {
2235 new ShardTestKit(getSystem()) {
2237 final String testName = "testClusteredDataChangeListenerRegistration";
2238 final ShardIdentifier followerShardID = ShardIdentifier.create("inventory",
2239 MemberName.forName(actorFactory.generateActorId(testName + "-follower")), "config");
2241 final ShardIdentifier leaderShardID = ShardIdentifier.create("inventory",
2242 MemberName.forName(actorFactory.generateActorId(testName + "-leader")), "config");
2244 final TestActorRef<Shard> followerShard = actorFactory
2245 .createTestActor(Shard.builder().id(followerShardID)
2246 .datastoreContext(dataStoreContextBuilder.shardElectionTimeoutFactor(1000).build())
2247 .peerAddresses(Collections.singletonMap(leaderShardID.toString(),
2248 "akka://test/user/" + leaderShardID.toString()))
2249 .schemaContext(SCHEMA_CONTEXT).props()
2250 .withDispatcher(Dispatchers.DefaultDispatcherId()), followerShardID.toString());
2252 final TestActorRef<Shard> leaderShard = actorFactory
2253 .createTestActor(Shard.builder().id(leaderShardID).datastoreContext(newDatastoreContext())
2254 .peerAddresses(Collections.singletonMap(followerShardID.toString(),
2255 "akka://test/user/" + followerShardID.toString()))
2256 .schemaContext(SCHEMA_CONTEXT).props()
2257 .withDispatcher(Dispatchers.DefaultDispatcherId()), leaderShardID.toString());
2259 leaderShard.tell(TimeoutNow.INSTANCE, ActorRef.noSender());
2260 final String leaderPath = waitUntilLeader(followerShard);
2261 assertEquals("Shard leader path", leaderShard.path().toString(), leaderPath);
2263 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2264 final MockDataChangeListener listener = new MockDataChangeListener(1);
2265 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener),
2266 actorFactory.generateActorId(testName + "-DataChangeListener"));
2269 new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.BASE, true),
2271 final RegisterChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2272 RegisterChangeListenerReply.class);
2273 assertNotNull("getListenerRegistratioznPath", reply.getListenerRegistrationPath());
2275 writeToStore(followerShard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2277 listener.waitForChangeEvents();
2283 public void testClusteredDataTreeChangeListenerDelayedRegistration() throws Exception {
2284 new ShardTestKit(getSystem()) {
2286 final String testName = "testClusteredDataTreeChangeListenerDelayedRegistration";
2287 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2288 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2290 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
2291 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener),
2292 actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2294 setupInMemorySnapshotStore();
2296 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2297 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2298 actorFactory.generateActorId(testName + "-shard"));
2300 waitUntilNoLeader(shard);
2302 shard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2303 final RegisterDataTreeChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2304 RegisterDataTreeChangeListenerReply.class);
2305 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2307 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2308 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2310 listener.waitForChangeEvents();
2316 public void testClusteredDataTreeChangeListenerRegistration() throws Exception {
2317 new ShardTestKit(getSystem()) {
2319 final String testName = "testClusteredDataTreeChangeListenerRegistration";
2320 final ShardIdentifier followerShardID = ShardIdentifier.create("inventory",
2321 MemberName.forName(actorFactory.generateActorId(testName + "-follower")), "config");
2323 final ShardIdentifier leaderShardID = ShardIdentifier.create("inventory",
2324 MemberName.forName(actorFactory.generateActorId(testName + "-leader")), "config");
2326 final TestActorRef<Shard> followerShard = actorFactory
2327 .createTestActor(Shard.builder().id(followerShardID)
2328 .datastoreContext(dataStoreContextBuilder.shardElectionTimeoutFactor(1000).build())
2329 .peerAddresses(Collections.singletonMap(leaderShardID.toString(),
2330 "akka://test/user/" + leaderShardID.toString()))
2331 .schemaContext(SCHEMA_CONTEXT).props()
2332 .withDispatcher(Dispatchers.DefaultDispatcherId()), followerShardID.toString());
2334 final TestActorRef<Shard> leaderShard = actorFactory
2335 .createTestActor(Shard.builder().id(leaderShardID).datastoreContext(newDatastoreContext())
2336 .peerAddresses(Collections.singletonMap(followerShardID.toString(),
2337 "akka://test/user/" + followerShardID.toString()))
2338 .schemaContext(SCHEMA_CONTEXT).props()
2339 .withDispatcher(Dispatchers.DefaultDispatcherId()), leaderShardID.toString());
2341 leaderShard.tell(TimeoutNow.INSTANCE, ActorRef.noSender());
2342 final String leaderPath = waitUntilLeader(followerShard);
2343 assertEquals("Shard leader path", leaderShard.path().toString(), leaderPath);
2345 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2346 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
2347 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener),
2348 actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2350 followerShard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2351 final RegisterDataTreeChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2352 RegisterDataTreeChangeListenerReply.class);
2353 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2355 writeToStore(followerShard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2357 listener.waitForChangeEvents();
2363 public void testServerRemoved() throws Exception {
2364 final TestActorRef<MessageCollectorActor> parent = actorFactory.createTestActor(MessageCollectorActor.props());
2366 final ActorRef shard = parent.underlyingActor().context().actorOf(
2367 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2368 "testServerRemoved");
2370 shard.tell(new ServerRemoved("test"), ActorRef.noSender());
2372 MessageCollectorActor.expectFirstMatching(parent, ServerRemoved.class);