2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.datastore;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertTrue;
13 import static org.junit.Assert.fail;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Mockito.doAnswer;
16 import static org.mockito.Mockito.doReturn;
17 import static org.mockito.Mockito.mock;
18 import static org.opendaylight.controller.cluster.datastore.DataStoreVersions.CURRENT_VERSION;
19 import static org.opendaylight.controller.cluster.datastore.ShardDataTreeMocking.successfulCanCommit;
20 import static org.opendaylight.controller.cluster.datastore.ShardDataTreeMocking.successfulCommit;
21 import static org.opendaylight.controller.cluster.datastore.ShardDataTreeMocking.successfulPreCommit;
22 import akka.actor.ActorRef;
23 import akka.actor.PoisonPill;
24 import akka.actor.Props;
25 import akka.dispatch.Dispatchers;
26 import akka.japi.Creator;
27 import akka.pattern.Patterns;
28 import akka.testkit.TestActorRef;
29 import akka.util.Timeout;
30 import com.google.common.base.Optional;
31 import com.google.common.primitives.UnsignedLong;
32 import com.google.common.util.concurrent.FutureCallback;
33 import com.google.common.util.concurrent.ListenableFuture;
34 import com.google.common.util.concurrent.Uninterruptibles;
35 import java.io.IOException;
36 import java.util.Collections;
37 import java.util.HashMap;
40 import java.util.concurrent.CountDownLatch;
41 import java.util.concurrent.ExecutionException;
42 import java.util.concurrent.TimeUnit;
43 import java.util.concurrent.TimeoutException;
44 import java.util.concurrent.atomic.AtomicInteger;
45 import org.junit.After;
46 import org.junit.Assert;
47 import org.junit.Before;
48 import org.opendaylight.controller.cluster.access.concepts.MemberName;
49 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
50 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
51 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
52 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
53 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
54 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
55 import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification;
56 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
57 import org.opendaylight.controller.cluster.datastore.persisted.CommitTransactionPayload;
58 import org.opendaylight.controller.cluster.datastore.persisted.PreBoronShardDataTreeSnapshot;
59 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
60 import org.opendaylight.controller.cluster.raft.Snapshot;
61 import org.opendaylight.controller.cluster.raft.TestActorFactory;
62 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
63 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
64 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
65 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
66 import org.opendaylight.yangtools.concepts.Identifier;
67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
68 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
69 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
70 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
71 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
72 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
73 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
74 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
75 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
76 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
77 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
78 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
79 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
80 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
81 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
82 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
83 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
84 import scala.concurrent.Await;
85 import scala.concurrent.Future;
86 import scala.concurrent.duration.Duration;
89 * Abstract base for shard unit tests.
91 * @author Thomas Pantelis
93 public abstract class AbstractShardTest extends AbstractActorTest{
94 protected static final SchemaContext SCHEMA_CONTEXT = TestModel.createTestContext();
96 private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger();
98 protected final ShardIdentifier shardID = ShardIdentifier.create("inventory", MemberName.forName("member-1"),
99 "config" + NEXT_SHARD_NUM.getAndIncrement());
101 protected final Builder dataStoreContextBuilder = DatastoreContext.newBuilder().
102 shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).
103 shardHeartbeatIntervalInMillis(100);
105 protected final TestActorFactory actorFactory = new TestActorFactory(getSystem());
108 public void setUp() {
109 InMemorySnapshotStore.clear();
110 InMemoryJournal.clear();
114 public void tearDown() {
115 InMemorySnapshotStore.clear();
116 InMemoryJournal.clear();
117 actorFactory.close();
120 protected DatastoreContext newDatastoreContext() {
121 return dataStoreContextBuilder.build();
124 protected Props newShardProps() {
125 return newShardBuilder().props();
128 protected Shard.Builder newShardBuilder() {
129 return Shard.builder().id(shardID).datastoreContext(newDatastoreContext()).schemaContext(SCHEMA_CONTEXT);
132 protected void testRecovery(final Set<Integer> listEntryKeys) throws Exception {
133 // Create the actor and wait for recovery complete.
135 final int nListEntries = listEntryKeys.size();
137 final CountDownLatch recoveryComplete = new CountDownLatch(1);
139 @SuppressWarnings("serial")
140 final Creator<Shard> creator = new Creator<Shard>() {
142 public Shard create() throws Exception {
143 return new Shard(newShardBuilder()) {
145 protected void onRecoveryComplete() {
147 super.onRecoveryComplete();
149 recoveryComplete.countDown();
156 final TestActorRef<Shard> shard = TestActorRef.create(getSystem(),
157 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()), "testRecovery");
159 assertEquals("Recovery complete", true, recoveryComplete.await(5, TimeUnit.SECONDS));
161 // Verify data in the data store.
163 final NormalizedNode<?, ?> outerList = readStore(shard, TestModel.OUTER_LIST_PATH);
164 assertNotNull(TestModel.OUTER_LIST_QNAME.getLocalName() + " not found", outerList);
165 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " value is not Iterable",
166 outerList.getValue() instanceof Iterable);
167 for(final Object entry: (Iterable<?>) outerList.getValue()) {
168 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " entry is not MapEntryNode",
169 entry instanceof MapEntryNode);
170 final MapEntryNode mapEntry = (MapEntryNode)entry;
171 final Optional<DataContainerChild<? extends PathArgument, ?>> idLeaf =
172 mapEntry.getChild(new YangInstanceIdentifier.NodeIdentifier(TestModel.ID_QNAME));
173 assertTrue("Missing leaf " + TestModel.ID_QNAME.getLocalName(), idLeaf.isPresent());
174 final Object value = idLeaf.get().getValue();
175 assertTrue("Unexpected value for leaf "+ TestModel.ID_QNAME.getLocalName() + ": " + value,
176 listEntryKeys.remove(value));
179 if(!listEntryKeys.isEmpty()) {
180 fail("Missing " + TestModel.OUTER_LIST_QNAME.getLocalName() + " entries with keys: " +
184 assertEquals("Last log index", nListEntries,
185 shard.underlyingActor().getShardMBean().getLastLogIndex());
186 assertEquals("Commit index", nListEntries,
187 shard.underlyingActor().getShardMBean().getCommitIndex());
188 assertEquals("Last applied", nListEntries,
189 shard.underlyingActor().getShardMBean().getLastApplied());
191 shard.tell(PoisonPill.getInstance(), ActorRef.noSender());
194 protected void verifyLastApplied(final TestActorRef<Shard> shard, final long expectedValue) {
195 long lastApplied = -1;
196 for(int i = 0; i < 20 * 5; i++) {
197 lastApplied = shard.underlyingActor().getShardMBean().getLastApplied();
198 if(lastApplied == expectedValue) {
201 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
204 Assert.fail(String.format("Expected last applied: %d, Actual: %d", expectedValue, lastApplied));
207 protected TipProducingDataTree createDelegatingMockDataTree() throws Exception {
208 TipProducingDataTree actual = InMemoryDataTreeFactory.getInstance().create(TreeType.CONFIGURATION);
209 final TipProducingDataTree mock = mock(TipProducingDataTree.class);
211 doAnswer(invocation -> {
212 actual.validate(invocation.getArgumentAt(0, DataTreeModification.class));
214 }).when(mock).validate(any(DataTreeModification.class));
216 doAnswer(invocation -> {
217 return actual.prepare(invocation.getArgumentAt(0, DataTreeModification.class));
218 }).when(mock).prepare(any(DataTreeModification.class));
220 doAnswer(invocation -> {
221 actual.commit(invocation.getArgumentAt(0, DataTreeCandidate.class));
223 }).when(mock).commit(any(DataTreeCandidate.class));
225 doAnswer(invocation -> {
226 actual.setSchemaContext(invocation.getArgumentAt(0, SchemaContext.class));
228 }).when(mock).setSchemaContext(any(SchemaContext.class));
230 doAnswer(invocation -> {
231 return actual.takeSnapshot();
232 }).when(mock).takeSnapshot();
234 doAnswer(invocation -> {
235 return actual.getRootPath();
236 }).when(mock).getRootPath();
241 protected ShardDataTreeCohort mockShardDataTreeCohort() {
242 ShardDataTreeCohort cohort = mock(ShardDataTreeCohort.class);
243 DataTreeCandidate candidate = mockCandidate("candidate");
244 successfulCanCommit(cohort);
245 successfulPreCommit(cohort, candidate);
246 successfulCommit(cohort);
247 doReturn(candidate).when(cohort).getCandidate();
251 protected Map<TransactionIdentifier, CapturingShardDataTreeCohort> setupCohortDecorator(final Shard shard,
252 final TransactionIdentifier... transactionIDs) {
253 final Map<TransactionIdentifier, CapturingShardDataTreeCohort> cohortMap = new HashMap<>();
254 for(TransactionIdentifier id: transactionIDs) {
255 cohortMap.put(id, new CapturingShardDataTreeCohort());
258 shard.getCommitCoordinator().setCohortDecorator(new ShardCommitCoordinator.CohortDecorator() {
260 public ShardDataTreeCohort decorate(final Identifier transactionID, final ShardDataTreeCohort actual) {
261 CapturingShardDataTreeCohort cohort = cohortMap.get(transactionID);
262 cohort.setDelegate(actual);
270 protected BatchedModifications prepareBatchedModifications(final TransactionIdentifier transactionID,
271 final MutableCompositeModification modification) {
272 return prepareBatchedModifications(transactionID, modification, false);
275 protected static BatchedModifications prepareBatchedModifications(final TransactionIdentifier transactionID,
276 final MutableCompositeModification modification,
277 final boolean doCommitOnReady) {
278 final BatchedModifications batchedModifications = new BatchedModifications(transactionID, CURRENT_VERSION);
279 batchedModifications.addModification(modification);
280 batchedModifications.setReady(true);
281 batchedModifications.setDoCommitOnReady(doCommitOnReady);
282 batchedModifications.setTotalMessagesSent(1);
283 return batchedModifications;
286 protected static BatchedModifications prepareBatchedModifications(final TransactionIdentifier transactionID,
287 final YangInstanceIdentifier path, final NormalizedNode<?, ?> data, final boolean doCommitOnReady) {
288 final MutableCompositeModification modification = new MutableCompositeModification();
289 modification.addModification(new WriteModification(path, data));
290 return prepareBatchedModifications(transactionID, modification, doCommitOnReady);
293 protected static ForwardedReadyTransaction prepareForwardedReadyTransaction(final TestActorRef<Shard> shard,
294 final TransactionIdentifier transactionID, final YangInstanceIdentifier path,
295 final NormalizedNode<?, ?> data, final boolean doCommitOnReady) {
296 ReadWriteShardDataTreeTransaction rwTx = shard.underlyingActor().getDataStore().
297 newReadWriteTransaction(transactionID);
298 rwTx.getSnapshot().write(path, data);
299 return new ForwardedReadyTransaction(transactionID, CURRENT_VERSION, rwTx, doCommitOnReady);
302 public static NormalizedNode<?,?> readStore(final TestActorRef<? extends Shard> shard, final YangInstanceIdentifier id)
303 throws ExecutionException, InterruptedException {
304 return shard.underlyingActor().getDataStore().readNode(id).orNull();
307 public static NormalizedNode<?,?> readStore(final DataTree store, final YangInstanceIdentifier id) {
308 return store.takeSnapshot().readNode(id).orNull();
311 public void writeToStore(final TestActorRef<Shard> shard, final YangInstanceIdentifier id,
312 final NormalizedNode<?,?> node) throws InterruptedException, ExecutionException {
313 Future<Object> future = Patterns.ask(shard, newBatchedModifications(nextTransactionId(), id, node, true, true, 1),
314 new Timeout(5, TimeUnit.SECONDS));
316 Await.ready(future, Duration.create(5, TimeUnit.SECONDS));
317 } catch(TimeoutException e) {
318 throw new ExecutionException(e);
322 public static void writeToStore(final ShardDataTree store, final YangInstanceIdentifier id,
323 final NormalizedNode<?,?> node) throws Exception {
324 BatchedModifications batched = newBatchedModifications(nextTransactionId(), id, node, true, true, 1);
325 DataTreeModification modification = store.getDataTree().takeSnapshot().newModification();
326 batched.apply(modification);
327 modification.ready();
328 store.applyForeignCandidate(batched.getTransactionID(), store.getDataTree().prepare(modification));
331 public void mergeToStore(final ShardDataTree store, final YangInstanceIdentifier id,
332 final NormalizedNode<?,?> node) throws Exception {
333 final BatchedModifications batched = new BatchedModifications(nextTransactionId(), CURRENT_VERSION);
334 batched.addModification(new MergeModification(id, node));
335 batched.setReady(true);
336 batched.setDoCommitOnReady(true);
337 batched.setTotalMessagesSent(1);
339 DataTreeModification modification = store.getDataTree().takeSnapshot().newModification();
340 batched.apply(modification);
341 modification.ready();
342 store.applyForeignCandidate(batched.getTransactionID(), store.getDataTree().prepare(modification));
345 public static void writeToStore(final DataTree store, final YangInstanceIdentifier id,
346 final NormalizedNode<?,?> node) throws DataValidationFailedException {
347 final DataTreeModification transaction = store.takeSnapshot().newModification();
349 transaction.write(id, node);
351 store.validate(transaction);
352 final DataTreeCandidate candidate = store.prepare(transaction);
353 store.commit(candidate);
356 DataTree setupInMemorySnapshotStore() throws DataValidationFailedException {
357 final DataTree testStore = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
358 testStore.setSchemaContext(SCHEMA_CONTEXT);
360 writeToStore(testStore, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
362 final NormalizedNode<?, ?> root = readStore(testStore, YangInstanceIdentifier.EMPTY);
364 InMemorySnapshotStore.addSnapshot(shardID.toString(), Snapshot.create(
365 new PreBoronShardDataTreeSnapshot(root).serialize(),
366 Collections.<ReplicatedLogEntry>emptyList(), 0, 1, -1, -1));
370 static CommitTransactionPayload payloadForModification(final DataTree source, final DataTreeModification mod,
371 final TransactionIdentifier transactionId) throws DataValidationFailedException, IOException {
372 source.validate(mod);
373 final DataTreeCandidate candidate = source.prepare(mod);
374 source.commit(candidate);
375 return CommitTransactionPayload.create(transactionId, candidate);
378 static BatchedModifications newBatchedModifications(final TransactionIdentifier transactionID,
379 final YangInstanceIdentifier path, final NormalizedNode<?, ?> data, final boolean ready, final boolean doCommitOnReady,
380 final int messagesSent) {
381 final BatchedModifications batched = new BatchedModifications(transactionID, CURRENT_VERSION);
382 batched.addModification(new WriteModification(path, data));
383 batched.setReady(ready);
384 batched.setDoCommitOnReady(doCommitOnReady);
385 batched.setTotalMessagesSent(messagesSent);
389 @SuppressWarnings("unchecked")
390 static void verifyOuterListEntry(final TestActorRef<Shard> shard, final Object expIDValue) throws Exception {
391 final NormalizedNode<?, ?> outerList = readStore(shard, TestModel.OUTER_LIST_PATH);
392 assertNotNull(TestModel.OUTER_LIST_QNAME.getLocalName() + " not found", outerList);
393 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " value is not Iterable",
394 outerList.getValue() instanceof Iterable);
395 final Object entry = ((Iterable<Object>)outerList.getValue()).iterator().next();
396 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " entry is not MapEntryNode",
397 entry instanceof MapEntryNode);
398 final MapEntryNode mapEntry = (MapEntryNode)entry;
399 final Optional<DataContainerChild<? extends PathArgument, ?>> idLeaf =
400 mapEntry.getChild(new YangInstanceIdentifier.NodeIdentifier(TestModel.ID_QNAME));
401 assertTrue("Missing leaf " + TestModel.ID_QNAME.getLocalName(), idLeaf.isPresent());
402 assertEquals(TestModel.ID_QNAME.getLocalName() + " value", expIDValue, idLeaf.get().getValue());
405 public static DataTreeCandidateTip mockCandidate(final String name) {
406 final DataTreeCandidateTip mockCandidate = mock(DataTreeCandidateTip.class, name);
407 final DataTreeCandidateNode mockCandidateNode = mock(DataTreeCandidateNode.class, name + "-node");
408 doReturn(ModificationType.WRITE).when(mockCandidateNode).getModificationType();
409 doReturn(Optional.of(ImmutableNodes.containerNode(CarsModel.CARS_QNAME))).when(mockCandidateNode).getDataAfter();
410 doReturn(CarsModel.BASE_PATH).when(mockCandidate).getRootPath();
411 doReturn(mockCandidateNode).when(mockCandidate).getRootNode();
412 return mockCandidate;
415 static DataTreeCandidateTip mockUnmodifiedCandidate(final String name) {
416 final DataTreeCandidateTip mockCandidate = mock(DataTreeCandidateTip.class, name);
417 final DataTreeCandidateNode mockCandidateNode = mock(DataTreeCandidateNode.class, name + "-node");
418 doReturn(ModificationType.UNMODIFIED).when(mockCandidateNode).getModificationType();
419 doReturn(YangInstanceIdentifier.EMPTY).when(mockCandidate).getRootPath();
420 doReturn(mockCandidateNode).when(mockCandidate).getRootNode();
421 return mockCandidate;
424 static void commitTransaction(final DataTree store, final DataTreeModification modification) throws DataValidationFailedException {
425 modification.ready();
426 store.validate(modification);
427 store.commit(store.prepare(modification));
430 @SuppressWarnings("serial")
431 public static final class DelegatingShardCreator implements Creator<Shard> {
432 private final Creator<Shard> delegate;
434 DelegatingShardCreator(final Creator<Shard> delegate) {
435 this.delegate = delegate;
439 public Shard create() throws Exception {
440 return delegate.create();
444 public static class CapturingShardDataTreeCohort extends ShardDataTreeCohort {
445 private volatile ShardDataTreeCohort delegate;
446 private FutureCallback<Void> canCommit;
447 private FutureCallback<DataTreeCandidate> preCommit;
448 private FutureCallback<UnsignedLong> commit;
450 public void setDelegate(ShardDataTreeCohort delegate) {
451 this.delegate = delegate;
454 public FutureCallback<Void> getCanCommit() {
455 assertNotNull("canCommit was not invoked", canCommit);
459 public FutureCallback<DataTreeCandidate> getPreCommit() {
460 assertNotNull("preCommit was not invoked", preCommit);
464 public FutureCallback<UnsignedLong> getCommit() {
465 assertNotNull("commit was not invoked", commit);
470 public TransactionIdentifier getIdentifier() {
471 return delegate.getIdentifier();
475 DataTreeCandidateTip getCandidate() {
476 return delegate.getCandidate();
480 DataTreeModification getDataTreeModification() {
481 return delegate.getDataTreeModification();
485 public void canCommit(FutureCallback<Void> callback) {
486 canCommit = mockFutureCallback(callback);
487 delegate.canCommit(canCommit);
491 public void preCommit(FutureCallback<DataTreeCandidate> callback) {
492 preCommit = mockFutureCallback(callback);
493 delegate.preCommit(preCommit);
497 public void commit(FutureCallback<UnsignedLong> callback) {
498 commit = mockFutureCallback(callback);
499 delegate.commit(commit);
502 @SuppressWarnings("unchecked")
503 private <T> FutureCallback<T> mockFutureCallback(final FutureCallback<T> actual ) {
504 FutureCallback<T> mock = mock(FutureCallback.class);
505 doAnswer(invocation -> {
506 actual.onFailure(invocation.getArgumentAt(0, Throwable.class));
508 }).when(mock).onFailure(any(Throwable.class));
510 doAnswer(invocation -> {
511 actual.onSuccess((T) invocation.getArgumentAt(0, Throwable.class));
513 }).when(mock).onSuccess((T) any(Object.class));
519 public ListenableFuture<Void> abort() {
520 return delegate.abort();
524 public boolean isFailed() {
525 return delegate.isFailed();
529 public State getState() {
530 return delegate.getState();