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 // Simulate an AbortTransaction message occurring during
1525 // replication, after
1526 // persisting and before finishing the commit to the
1529 doAbortTransaction(transactionId, null);
1530 super.persistPayload(transactionId, payload);
1534 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
1535 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
1536 "testAbortWithCommitPending");
1538 waitUntilLeader(shard);
1540 final FiniteDuration duration = duration("5 seconds");
1542 final TransactionIdentifier transactionID = nextTransactionId();
1544 shard.tell(prepareBatchedModifications(transactionID, TestModel.TEST_PATH,
1545 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1546 expectMsgClass(duration, ReadyTransactionReply.class);
1548 shard.tell(new CanCommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1549 expectMsgClass(duration, CanCommitTransactionReply.class);
1551 shard.tell(new CommitTransaction(transactionID, CURRENT_VERSION).toSerializable(), getRef());
1552 expectMsgClass(duration, CommitTransactionReply.class);
1554 final NormalizedNode<?, ?> node = readStore(shard, TestModel.TEST_PATH);
1556 // Since we're simulating an abort occurring during replication
1557 // and before finish commit,
1558 // the data should still get written to the in-memory store
1559 // since we've gotten past
1560 // canCommit and preCommit and persisted the data.
1561 assertNotNull(TestModel.TEST_QNAME.getLocalName() + " not found", node);
1567 public void testTransactionCommitTimeout() throws Exception {
1568 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1569 new ShardTestKit(getSystem()) {
1571 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1572 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1573 "testTransactionCommitTimeout");
1575 waitUntilLeader(shard);
1577 final FiniteDuration duration = duration("5 seconds");
1579 writeToStore(shard, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
1580 writeToStore(shard, TestModel.OUTER_LIST_PATH,
1581 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build());
1583 // Ready 2 Tx's - the first will timeout
1585 final TransactionIdentifier transactionID1 = nextTransactionId();
1587 prepareBatchedModifications(transactionID1,
1588 YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
1589 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1).build(),
1590 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1), false),
1592 expectMsgClass(duration, ReadyTransactionReply.class);
1594 final TransactionIdentifier transactionID2 = nextTransactionId();
1595 final YangInstanceIdentifier listNodePath = YangInstanceIdentifier.builder(TestModel.OUTER_LIST_PATH)
1596 .nodeWithKey(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2).build();
1598 prepareBatchedModifications(transactionID2, listNodePath,
1599 ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 2), false),
1601 expectMsgClass(duration, ReadyTransactionReply.class);
1603 // canCommit 1st Tx. We don't send the commit so it should
1606 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1607 expectMsgClass(duration, CanCommitTransactionReply.class);
1609 // canCommit the 2nd Tx - it should complete after the 1st Tx
1612 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1613 expectMsgClass(duration, CanCommitTransactionReply.class);
1615 // Try to commit the 1st Tx - should fail as it's not the
1618 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1619 expectMsgClass(duration, akka.actor.Status.Failure.class);
1621 // Commit the 2nd Tx.
1623 shard.tell(new CommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1624 expectMsgClass(duration, CommitTransactionReply.class);
1626 final NormalizedNode<?, ?> node = readStore(shard, listNodePath);
1627 assertNotNull(listNodePath + " not found", node);
1634 // public void testTransactionCommitQueueCapacityExceeded() throws Throwable {
1635 // dataStoreContextBuilder.shardTransactionCommitQueueCapacity(2);
1637 // new ShardTestKit(getSystem()) {{
1638 // final TestActorRef<Shard> shard = actorFactory.createTestActor(
1639 // newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1640 // "testTransactionCommitQueueCapacityExceeded");
1642 // waitUntilLeader(shard);
1644 // final FiniteDuration duration = duration("5 seconds");
1646 // final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1648 // final TransactionIdentifier transactionID1 = nextTransactionId();
1649 // final MutableCompositeModification modification1 = new MutableCompositeModification();
1650 // final ShardDataTreeCohort cohort1 = setupMockWriteTransaction("cohort1", dataStore,
1651 // TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME), transactionID1,
1654 // final TransactionIdentifier transactionID2 = nextTransactionId();
1655 // final MutableCompositeModification modification2 = new MutableCompositeModification();
1656 // final ShardDataTreeCohort cohort2 = setupMockWriteTransaction("cohort2", dataStore,
1657 // TestModel.OUTER_LIST_PATH,
1658 // ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), transactionID2,
1661 // final TransactionIdentifier transactionID3 = nextTransactionId();
1662 // final MutableCompositeModification modification3 = new MutableCompositeModification();
1663 // final ShardDataTreeCohort cohort3 = setupMockWriteTransaction("cohort3", dataStore,
1664 // TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME), transactionID3,
1667 // // Ready the Tx's
1669 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort1, transactionID1,
1670 // modification1), getRef());
1671 // expectMsgClass(duration, ReadyTransactionReply.class);
1673 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort2, transactionID2,
1674 // modification2), getRef());
1675 // expectMsgClass(duration, ReadyTransactionReply.class);
1677 // // The 3rd Tx should exceed queue capacity and fail.
1679 // shard.tell(prepareReadyTransactionMessage(false, shard.underlyingActor(), cohort3, transactionID3,
1680 // modification3), getRef());
1681 // expectMsgClass(duration, akka.actor.Status.Failure.class);
1683 // // canCommit 1st Tx.
1685 // shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1686 // expectMsgClass(duration, CanCommitTransactionReply.class);
1688 // // canCommit the 2nd Tx - it should get queued.
1690 // shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1692 // // canCommit the 3rd Tx - should exceed queue capacity and fail.
1694 // shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1695 // expectMsgClass(duration, akka.actor.Status.Failure.class);
1700 public void testTransactionCommitWithPriorExpiredCohortEntries() throws Exception {
1701 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1702 new ShardTestKit(getSystem()) {
1704 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1705 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1706 "testTransactionCommitWithPriorExpiredCohortEntries");
1708 waitUntilLeader(shard);
1710 final FiniteDuration duration = duration("5 seconds");
1712 final TransactionIdentifier transactionID1 = nextTransactionId();
1713 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1714 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1715 expectMsgClass(duration, ReadyTransactionReply.class);
1717 final TransactionIdentifier transactionID2 = nextTransactionId();
1718 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1719 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1720 expectMsgClass(duration, ReadyTransactionReply.class);
1722 final TransactionIdentifier transactionID3 = nextTransactionId();
1723 shard.tell(newBatchedModifications(transactionID3, TestModel.TEST_PATH,
1724 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1725 expectMsgClass(duration, ReadyTransactionReply.class);
1727 // All Tx's are readied. We'll send canCommit for the last one
1728 // but not the others. The others
1729 // should expire from the queue and the last one should be
1732 shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1733 expectMsgClass(duration, CanCommitTransactionReply.class);
1739 public void testTransactionCommitWithSubsequentExpiredCohortEntry() throws Exception {
1740 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1741 new ShardTestKit(getSystem()) {
1743 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1744 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1745 "testTransactionCommitWithSubsequentExpiredCohortEntry");
1747 waitUntilLeader(shard);
1749 final FiniteDuration duration = duration("5 seconds");
1751 final ShardDataTree dataStore = shard.underlyingActor().getDataStore();
1753 final TransactionIdentifier transactionID1 = nextTransactionId();
1754 shard.tell(prepareBatchedModifications(transactionID1, TestModel.TEST_PATH,
1755 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1756 expectMsgClass(duration, ReadyTransactionReply.class);
1758 // CanCommit the first Tx so it's the current in-progress Tx.
1760 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1761 expectMsgClass(duration, CanCommitTransactionReply.class);
1763 // Ready the second Tx.
1765 final TransactionIdentifier transactionID2 = nextTransactionId();
1766 shard.tell(prepareBatchedModifications(transactionID2, TestModel.TEST_PATH,
1767 ImmutableNodes.containerNode(TestModel.TEST_QNAME), false), getRef());
1768 expectMsgClass(duration, ReadyTransactionReply.class);
1770 // Ready the third Tx.
1772 final TransactionIdentifier transactionID3 = nextTransactionId();
1773 final DataTreeModification modification3 = dataStore.newModification();
1774 new WriteModification(TestModel.TEST2_PATH, ImmutableNodes.containerNode(TestModel.TEST2_QNAME))
1775 .apply(modification3);
1776 modification3.ready();
1777 final ReadyLocalTransaction readyMessage = new ReadyLocalTransaction(transactionID3, modification3,
1779 shard.tell(readyMessage, getRef());
1781 // Commit the first Tx. After completing, the second should
1782 // expire from the queue and the third
1785 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1786 expectMsgClass(duration, CommitTransactionReply.class);
1788 // Expect commit reply from the third Tx.
1790 expectMsgClass(duration, CommitTransactionReply.class);
1792 final NormalizedNode<?, ?> node = readStore(shard, TestModel.TEST2_PATH);
1793 assertNotNull(TestModel.TEST2_PATH + " not found", node);
1799 public void testCanCommitBeforeReadyFailure() throws Exception {
1800 new ShardTestKit(getSystem()) {
1802 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1803 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
1804 "testCanCommitBeforeReadyFailure");
1806 shard.tell(new CanCommitTransaction(nextTransactionId(), CURRENT_VERSION).toSerializable(), getRef());
1807 expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
1813 public void testAbortAfterCanCommit() throws Exception {
1814 new ShardTestKit(getSystem()) {
1816 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1817 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterCanCommit");
1819 waitUntilLeader(shard);
1821 final FiniteDuration duration = duration("5 seconds");
1822 final Timeout timeout = new Timeout(duration);
1824 // Ready 2 transactions - the first one will be aborted.
1826 final TransactionIdentifier transactionID1 = nextTransactionId();
1827 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1828 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1829 expectMsgClass(duration, ReadyTransactionReply.class);
1831 final TransactionIdentifier transactionID2 = nextTransactionId();
1832 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1833 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1834 expectMsgClass(duration, ReadyTransactionReply.class);
1836 // Send the CanCommitTransaction message for the first Tx.
1838 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1839 CanCommitTransactionReply canCommitReply = CanCommitTransactionReply
1840 .fromSerializable(expectMsgClass(duration, CanCommitTransactionReply.class));
1841 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1843 // Send the CanCommitTransaction message for the 2nd Tx. This
1844 // should get queued and
1845 // processed after the first Tx completes.
1847 final Future<Object> canCommitFuture = Patterns.ask(shard,
1848 new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), timeout);
1850 // Send the AbortTransaction message for the first Tx. This
1851 // should trigger the 2nd
1854 shard.tell(new AbortTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1855 expectMsgClass(duration, AbortTransactionReply.class);
1857 // Wait for the 2nd Tx to complete the canCommit phase.
1859 canCommitReply = (CanCommitTransactionReply) Await.result(canCommitFuture, duration);
1860 assertEquals("Can commit", true, canCommitReply.getCanCommit());
1866 public void testAbortAfterReady() throws Exception {
1867 dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1);
1868 new ShardTestKit(getSystem()) {
1870 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1871 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterReady");
1873 waitUntilLeader(shard);
1875 final FiniteDuration duration = duration("5 seconds");
1879 final TransactionIdentifier transactionID1 = nextTransactionId();
1880 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1881 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1882 expectMsgClass(duration, ReadyTransactionReply.class);
1884 // Send the AbortTransaction message.
1886 shard.tell(new AbortTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1887 expectMsgClass(duration, AbortTransactionReply.class);
1889 assertEquals("getPendingTxCommitQueueSize", 0, shard.underlyingActor().getPendingTxCommitQueueSize());
1891 // Now send CanCommitTransaction - should fail.
1893 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1894 final Throwable failure = expectMsgClass(duration, akka.actor.Status.Failure.class).cause();
1895 assertTrue("Failure type", failure instanceof IllegalStateException);
1897 // Ready and CanCommit another and verify success.
1899 final TransactionIdentifier transactionID2 = nextTransactionId();
1900 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1901 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1902 expectMsgClass(duration, ReadyTransactionReply.class);
1904 shard.tell(new CanCommitTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1905 expectMsgClass(duration, CanCommitTransactionReply.class);
1911 public void testAbortQueuedTransaction() throws Exception {
1912 new ShardTestKit(getSystem()) {
1914 final TestActorRef<Shard> shard = actorFactory.createTestActor(
1915 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()), "testAbortAfterReady");
1917 waitUntilLeader(shard);
1919 final FiniteDuration duration = duration("5 seconds");
1923 final TransactionIdentifier transactionID1 = nextTransactionId();
1924 shard.tell(newBatchedModifications(transactionID1, TestModel.TEST_PATH,
1925 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1926 expectMsgClass(duration, ReadyTransactionReply.class);
1928 final TransactionIdentifier transactionID2 = nextTransactionId();
1929 shard.tell(newBatchedModifications(transactionID2, TestModel.TEST_PATH,
1930 ImmutableNodes.containerNode(TestModel.TEST_QNAME), true, false, 1), getRef());
1931 expectMsgClass(duration, ReadyTransactionReply.class);
1933 final TransactionIdentifier transactionID3 = nextTransactionId();
1935 newBatchedModifications(transactionID3, TestModel.OUTER_LIST_PATH,
1936 ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build(), true, false, 1),
1938 expectMsgClass(duration, ReadyTransactionReply.class);
1940 // Abort the second tx while it's queued.
1942 shard.tell(new AbortTransaction(transactionID2, CURRENT_VERSION).toSerializable(), getRef());
1943 expectMsgClass(duration, AbortTransactionReply.class);
1945 // Commit the other 2.
1947 shard.tell(new CanCommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1948 expectMsgClass(duration, CanCommitTransactionReply.class);
1950 shard.tell(new CommitTransaction(transactionID1, CURRENT_VERSION).toSerializable(), getRef());
1951 expectMsgClass(duration, CommitTransactionReply.class);
1953 shard.tell(new CanCommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1954 expectMsgClass(duration, CanCommitTransactionReply.class);
1956 shard.tell(new CommitTransaction(transactionID3, CURRENT_VERSION).toSerializable(), getRef());
1957 expectMsgClass(duration, CommitTransactionReply.class);
1959 assertEquals("getPendingTxCommitQueueSize", 0, shard.underlyingActor().getPendingTxCommitQueueSize());
1965 public void testCreateSnapshotWithNonPersistentData() throws Exception {
1966 testCreateSnapshot(false, "testCreateSnapshotWithNonPersistentData");
1970 public void testCreateSnapshot() throws Exception {
1971 testCreateSnapshot(true, "testCreateSnapshot");
1974 private void testCreateSnapshot(final boolean persistent, final String shardActorName) throws Exception {
1975 final AtomicReference<CountDownLatch> latch = new AtomicReference<>(new CountDownLatch(1));
1977 final AtomicReference<Object> savedSnapshot = new AtomicReference<>();
1978 class TestPersistentDataProvider extends DelegatingPersistentDataProvider {
1979 TestPersistentDataProvider(final DataPersistenceProvider delegate) {
1984 public void saveSnapshot(final Object obj) {
1985 savedSnapshot.set(obj);
1986 super.saveSnapshot(obj);
1990 dataStoreContextBuilder.persistent(persistent);
1992 class TestShard extends Shard {
1994 protected TestShard(final AbstractBuilder<?, ?> builder) {
1996 setPersistence(new TestPersistentDataProvider(super.persistence()));
2000 public void handleCommand(final Object message) {
2001 super.handleCommand(message);
2003 // XXX: commit_snapshot equality check references RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT
2004 if (message instanceof SaveSnapshotSuccess || "commit_snapshot".equals(message.toString())) {
2005 latch.get().countDown();
2010 public RaftActorContext getRaftActorContext() {
2011 return super.getRaftActorContext();
2015 new ShardTestKit(getSystem()) {
2017 final Creator<Shard> creator = () -> new TestShard(newShardBuilder());
2019 final TestActorRef<Shard> shard = actorFactory.createTestActor(Props
2020 .create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()),
2023 waitUntilLeader(shard);
2024 writeToStore(shard, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2026 final NormalizedNode<?, ?> expectedRoot = readStore(shard, YangInstanceIdentifier.EMPTY);
2028 // Trigger creation of a snapshot by ensuring
2029 final RaftActorContext raftActorContext = ((TestShard) shard.underlyingActor()).getRaftActorContext();
2030 raftActorContext.getSnapshotManager().capture(mock(ReplicatedLogEntry.class), -1);
2031 awaitAndValidateSnapshot(expectedRoot);
2033 raftActorContext.getSnapshotManager().capture(mock(ReplicatedLogEntry.class), -1);
2034 awaitAndValidateSnapshot(expectedRoot);
2037 private void awaitAndValidateSnapshot(final NormalizedNode<?, ?> expectedRoot)
2038 throws InterruptedException, IOException {
2039 assertEquals("Snapshot saved", true, latch.get().await(5, TimeUnit.SECONDS));
2041 assertTrue("Invalid saved snapshot " + savedSnapshot.get(), savedSnapshot.get() instanceof Snapshot);
2043 verifySnapshot((Snapshot) savedSnapshot.get(), expectedRoot);
2045 latch.set(new CountDownLatch(1));
2046 savedSnapshot.set(null);
2049 private void verifySnapshot(final Snapshot snapshot, final NormalizedNode<?, ?> expectedRoot)
2050 throws IOException {
2051 final NormalizedNode<?, ?> actual = ShardDataTreeSnapshot.deserialize(snapshot.getState()).getRootNode()
2053 assertEquals("Root node", expectedRoot, actual);
2059 * This test simply verifies that the applySnapShot logic will work.
2062 public void testInMemoryDataTreeRestore() throws ReadFailedException, DataValidationFailedException {
2063 final DataTree store = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
2064 store.setSchemaContext(SCHEMA_CONTEXT);
2066 final DataTreeModification putTransaction = store.takeSnapshot().newModification();
2067 putTransaction.write(TestModel.TEST_PATH,
2068 ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2069 commitTransaction(store, putTransaction);
2072 final NormalizedNode<?, ?> expected = readStore(store, YangInstanceIdentifier.EMPTY);
2074 final DataTreeModification writeTransaction = store.takeSnapshot().newModification();
2076 writeTransaction.delete(YangInstanceIdentifier.EMPTY);
2077 writeTransaction.write(YangInstanceIdentifier.EMPTY, expected);
2079 commitTransaction(store, writeTransaction);
2081 final NormalizedNode<?, ?> actual = readStore(store, YangInstanceIdentifier.EMPTY);
2083 assertEquals(expected, actual);
2087 public void testRecoveryApplicable() {
2089 final DatastoreContext persistentContext = DatastoreContext.newBuilder()
2090 .shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).persistent(true).build();
2092 final Props persistentProps = Shard.builder().id(shardID).datastoreContext(persistentContext)
2093 .schemaContext(SCHEMA_CONTEXT).props();
2095 final DatastoreContext nonPersistentContext = DatastoreContext.newBuilder()
2096 .shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).persistent(false).build();
2098 final Props nonPersistentProps = Shard.builder().id(shardID).datastoreContext(nonPersistentContext)
2099 .schemaContext(SCHEMA_CONTEXT).props();
2101 new ShardTestKit(getSystem()) {
2103 final TestActorRef<Shard> shard1 = actorFactory.createTestActor(persistentProps, "testPersistence1");
2105 assertTrue("Recovery Applicable", shard1.underlyingActor().persistence().isRecoveryApplicable());
2107 final TestActorRef<Shard> shard2 = actorFactory.createTestActor(nonPersistentProps, "testPersistence2");
2109 assertFalse("Recovery Not Applicable", shard2.underlyingActor().persistence().isRecoveryApplicable());
2115 public void testOnDatastoreContext() {
2116 new ShardTestKit(getSystem()) {
2118 dataStoreContextBuilder.persistent(true);
2120 final TestActorRef<Shard> shard = actorFactory.createTestActor(newShardProps(),
2121 "testOnDatastoreContext");
2123 assertEquals("isRecoveryApplicable", true,
2124 shard.underlyingActor().persistence().isRecoveryApplicable());
2126 waitUntilLeader(shard);
2128 shard.tell(dataStoreContextBuilder.persistent(false).build(), ActorRef.noSender());
2130 assertEquals("isRecoveryApplicable", false,
2131 shard.underlyingActor().persistence().isRecoveryApplicable());
2133 shard.tell(dataStoreContextBuilder.persistent(true).build(), ActorRef.noSender());
2135 assertEquals("isRecoveryApplicable", true,
2136 shard.underlyingActor().persistence().isRecoveryApplicable());
2142 public void testRegisterRoleChangeListener() throws Exception {
2143 new ShardTestKit(getSystem()) {
2145 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2146 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
2147 "testRegisterRoleChangeListener");
2149 waitUntilLeader(shard);
2151 final TestActorRef<MessageCollectorActor> listener =
2152 TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class));
2154 shard.tell(new RegisterRoleChangeListener(), listener);
2156 MessageCollectorActor.expectFirstMatching(listener, RegisterRoleChangeListenerReply.class);
2158 ShardLeaderStateChanged leaderStateChanged = MessageCollectorActor.expectFirstMatching(listener,
2159 ShardLeaderStateChanged.class);
2160 assertEquals("getLocalShardDataTree present", true,
2161 leaderStateChanged.getLocalShardDataTree().isPresent());
2162 assertSame("getLocalShardDataTree", shard.underlyingActor().getDataStore().getDataTree(),
2163 leaderStateChanged.getLocalShardDataTree().get());
2165 MessageCollectorActor.clearMessages(listener);
2167 // Force a leader change
2169 shard.tell(new RequestVote(10000, "member2", 50, 50), getRef());
2171 leaderStateChanged = MessageCollectorActor.expectFirstMatching(listener,
2172 ShardLeaderStateChanged.class);
2173 assertEquals("getLocalShardDataTree present", false,
2174 leaderStateChanged.getLocalShardDataTree().isPresent());
2180 public void testFollowerInitialSyncStatus() throws Exception {
2181 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2182 newShardProps().withDispatcher(Dispatchers.DefaultDispatcherId()),
2183 "testFollowerInitialSyncStatus");
2185 shard.underlyingActor().handleNonRaftCommand(new FollowerInitialSyncUpStatus(false,
2186 "member-1-shard-inventory-operational"));
2188 assertEquals(false, shard.underlyingActor().getShardMBean().getFollowerInitialSyncStatus());
2190 shard.underlyingActor().handleNonRaftCommand(new FollowerInitialSyncUpStatus(true,
2191 "member-1-shard-inventory-operational"));
2193 assertEquals(true, shard.underlyingActor().getShardMBean().getFollowerInitialSyncStatus());
2197 public void testClusteredDataChangeListenerDelayedRegistration() throws Exception {
2198 new ShardTestKit(getSystem()) {
2200 final String testName = "testClusteredDataChangeListenerDelayedRegistration";
2201 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2202 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2204 final MockDataChangeListener listener = new MockDataChangeListener(1);
2205 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener),
2206 actorFactory.generateActorId(testName + "-DataChangeListener"));
2208 setupInMemorySnapshotStore();
2210 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2211 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2212 actorFactory.generateActorId(testName + "-shard"));
2214 waitUntilNoLeader(shard);
2216 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2218 shard.tell(new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.BASE, true),
2220 final RegisterChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2221 RegisterChangeListenerReply.class);
2222 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2224 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2225 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2227 listener.waitForChangeEvents();
2233 public void testClusteredDataChangeListenerRegistration() throws Exception {
2234 new ShardTestKit(getSystem()) {
2236 final String testName = "testClusteredDataChangeListenerRegistration";
2237 final ShardIdentifier followerShardID = ShardIdentifier.create("inventory",
2238 MemberName.forName(actorFactory.generateActorId(testName + "-follower")), "config");
2240 final ShardIdentifier leaderShardID = ShardIdentifier.create("inventory",
2241 MemberName.forName(actorFactory.generateActorId(testName + "-leader")), "config");
2243 final TestActorRef<Shard> followerShard = actorFactory
2244 .createTestActor(Shard.builder().id(followerShardID)
2245 .datastoreContext(dataStoreContextBuilder.shardElectionTimeoutFactor(1000).build())
2246 .peerAddresses(Collections.singletonMap(leaderShardID.toString(),
2247 "akka://test/user/" + leaderShardID.toString()))
2248 .schemaContext(SCHEMA_CONTEXT).props()
2249 .withDispatcher(Dispatchers.DefaultDispatcherId()), followerShardID.toString());
2251 final TestActorRef<Shard> leaderShard = actorFactory
2252 .createTestActor(Shard.builder().id(leaderShardID).datastoreContext(newDatastoreContext())
2253 .peerAddresses(Collections.singletonMap(followerShardID.toString(),
2254 "akka://test/user/" + followerShardID.toString()))
2255 .schemaContext(SCHEMA_CONTEXT).props()
2256 .withDispatcher(Dispatchers.DefaultDispatcherId()), leaderShardID.toString());
2258 leaderShard.tell(TimeoutNow.INSTANCE, ActorRef.noSender());
2259 final String leaderPath = waitUntilLeader(followerShard);
2260 assertEquals("Shard leader path", leaderShard.path().toString(), leaderPath);
2262 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2263 final MockDataChangeListener listener = new MockDataChangeListener(1);
2264 final ActorRef dclActor = actorFactory.createActor(DataChangeListener.props(listener),
2265 actorFactory.generateActorId(testName + "-DataChangeListener"));
2268 new RegisterChangeListener(path, dclActor, AsyncDataBroker.DataChangeScope.BASE, true),
2270 final RegisterChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2271 RegisterChangeListenerReply.class);
2272 assertNotNull("getListenerRegistratioznPath", reply.getListenerRegistrationPath());
2274 writeToStore(followerShard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2276 listener.waitForChangeEvents();
2282 public void testClusteredDataTreeChangeListenerDelayedRegistration() throws Exception {
2283 new ShardTestKit(getSystem()) {
2285 final String testName = "testClusteredDataTreeChangeListenerDelayedRegistration";
2286 dataStoreContextBuilder.shardElectionTimeoutFactor(1000)
2287 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
2289 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
2290 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener),
2291 actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2293 setupInMemorySnapshotStore();
2295 final TestActorRef<Shard> shard = actorFactory.createTestActor(
2296 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2297 actorFactory.generateActorId(testName + "-shard"));
2299 waitUntilNoLeader(shard);
2301 shard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2302 final RegisterDataTreeChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2303 RegisterDataTreeChangeListenerReply.class);
2304 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2306 shard.tell(DatastoreContext.newBuilderFrom(dataStoreContextBuilder.build())
2307 .customRaftPolicyImplementation(null).build(), ActorRef.noSender());
2309 listener.waitForChangeEvents();
2315 public void testClusteredDataTreeChangeListenerRegistration() throws Exception {
2316 new ShardTestKit(getSystem()) {
2318 final String testName = "testClusteredDataTreeChangeListenerRegistration";
2319 final ShardIdentifier followerShardID = ShardIdentifier.create("inventory",
2320 MemberName.forName(actorFactory.generateActorId(testName + "-follower")), "config");
2322 final ShardIdentifier leaderShardID = ShardIdentifier.create("inventory",
2323 MemberName.forName(actorFactory.generateActorId(testName + "-leader")), "config");
2325 final TestActorRef<Shard> followerShard = actorFactory
2326 .createTestActor(Shard.builder().id(followerShardID)
2327 .datastoreContext(dataStoreContextBuilder.shardElectionTimeoutFactor(1000).build())
2328 .peerAddresses(Collections.singletonMap(leaderShardID.toString(),
2329 "akka://test/user/" + leaderShardID.toString()))
2330 .schemaContext(SCHEMA_CONTEXT).props()
2331 .withDispatcher(Dispatchers.DefaultDispatcherId()), followerShardID.toString());
2333 final TestActorRef<Shard> leaderShard = actorFactory
2334 .createTestActor(Shard.builder().id(leaderShardID).datastoreContext(newDatastoreContext())
2335 .peerAddresses(Collections.singletonMap(followerShardID.toString(),
2336 "akka://test/user/" + followerShardID.toString()))
2337 .schemaContext(SCHEMA_CONTEXT).props()
2338 .withDispatcher(Dispatchers.DefaultDispatcherId()), leaderShardID.toString());
2340 leaderShard.tell(TimeoutNow.INSTANCE, ActorRef.noSender());
2341 final String leaderPath = waitUntilLeader(followerShard);
2342 assertEquals("Shard leader path", leaderShard.path().toString(), leaderPath);
2344 final YangInstanceIdentifier path = TestModel.TEST_PATH;
2345 final MockDataTreeChangeListener listener = new MockDataTreeChangeListener(1);
2346 final ActorRef dclActor = actorFactory.createActor(DataTreeChangeListenerActor.props(listener),
2347 actorFactory.generateActorId(testName + "-DataTreeChangeListener"));
2349 followerShard.tell(new RegisterDataTreeChangeListener(TestModel.TEST_PATH, dclActor, true), getRef());
2350 final RegisterDataTreeChangeListenerReply reply = expectMsgClass(duration("5 seconds"),
2351 RegisterDataTreeChangeListenerReply.class);
2352 assertNotNull("getListenerRegistrationPath", reply.getListenerRegistrationPath());
2354 writeToStore(followerShard, path, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
2356 listener.waitForChangeEvents();
2362 public void testServerRemoved() throws Exception {
2363 final TestActorRef<MessageCollectorActor> parent = actorFactory.createTestActor(MessageCollectorActor.props());
2365 final ActorRef shard = parent.underlyingActor().context().actorOf(
2366 newShardBuilder().props().withDispatcher(Dispatchers.DefaultDispatcherId()),
2367 "testServerRemoved");
2369 shard.tell(new ServerRemoved("test"), ActorRef.noSender());
2371 MessageCollectorActor.expectFirstMatching(parent, ServerRemoved.class);