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.yang.data.api.YangInstanceIdentifier;
67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
68 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
69 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
70 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
71 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
72 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
73 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
74 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
75 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
76 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
77 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
78 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
79 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
80 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
81 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
82 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
83 import scala.concurrent.Await;
84 import scala.concurrent.Future;
85 import scala.concurrent.duration.Duration;
88 * Abstract base for shard unit tests.
90 * @author Thomas Pantelis
92 public abstract class AbstractShardTest extends AbstractActorTest{
93 protected static final SchemaContext SCHEMA_CONTEXT = TestModel.createTestContext();
95 private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger();
97 protected final ShardIdentifier shardID = ShardIdentifier.create("inventory", MemberName.forName("member-1"),
98 "config" + NEXT_SHARD_NUM.getAndIncrement());
100 protected final Builder dataStoreContextBuilder = DatastoreContext.newBuilder().
101 shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).
102 shardHeartbeatIntervalInMillis(100);
104 protected final TestActorFactory actorFactory = new TestActorFactory(getSystem());
107 public void setUp() {
108 InMemorySnapshotStore.clear();
109 InMemoryJournal.clear();
113 public void tearDown() {
114 InMemorySnapshotStore.clear();
115 InMemoryJournal.clear();
116 actorFactory.close();
119 protected DatastoreContext newDatastoreContext() {
120 return dataStoreContextBuilder.build();
123 protected Props newShardProps() {
124 return newShardBuilder().props();
127 protected Shard.Builder newShardBuilder() {
128 return Shard.builder().id(shardID).datastoreContext(newDatastoreContext()).schemaContext(SCHEMA_CONTEXT);
131 protected void testRecovery(final Set<Integer> listEntryKeys) throws Exception {
132 // Create the actor and wait for recovery complete.
134 final int nListEntries = listEntryKeys.size();
136 final CountDownLatch recoveryComplete = new CountDownLatch(1);
138 @SuppressWarnings("serial")
139 final Creator<Shard> creator = () -> new Shard(newShardBuilder()) {
141 protected void onRecoveryComplete() {
143 super.onRecoveryComplete();
145 recoveryComplete.countDown();
150 final TestActorRef<Shard> shard = TestActorRef.create(getSystem(),
151 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()), "testRecovery");
153 assertEquals("Recovery complete", true, recoveryComplete.await(5, TimeUnit.SECONDS));
155 // Verify data in the data store.
157 final NormalizedNode<?, ?> outerList = readStore(shard, TestModel.OUTER_LIST_PATH);
158 assertNotNull(TestModel.OUTER_LIST_QNAME.getLocalName() + " not found", outerList);
159 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " value is not Iterable",
160 outerList.getValue() instanceof Iterable);
161 for(final Object entry: (Iterable<?>) outerList.getValue()) {
162 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " entry is not MapEntryNode",
163 entry instanceof MapEntryNode);
164 final MapEntryNode mapEntry = (MapEntryNode)entry;
165 final Optional<DataContainerChild<? extends PathArgument, ?>> idLeaf =
166 mapEntry.getChild(new YangInstanceIdentifier.NodeIdentifier(TestModel.ID_QNAME));
167 assertTrue("Missing leaf " + TestModel.ID_QNAME.getLocalName(), idLeaf.isPresent());
168 final Object value = idLeaf.get().getValue();
169 assertTrue("Unexpected value for leaf "+ TestModel.ID_QNAME.getLocalName() + ": " + value,
170 listEntryKeys.remove(value));
173 if(!listEntryKeys.isEmpty()) {
174 fail("Missing " + TestModel.OUTER_LIST_QNAME.getLocalName() + " entries with keys: " +
178 assertEquals("Last log index", nListEntries,
179 shard.underlyingActor().getShardMBean().getLastLogIndex());
180 assertEquals("Commit index", nListEntries,
181 shard.underlyingActor().getShardMBean().getCommitIndex());
182 assertEquals("Last applied", nListEntries,
183 shard.underlyingActor().getShardMBean().getLastApplied());
185 shard.tell(PoisonPill.getInstance(), ActorRef.noSender());
188 protected void verifyLastApplied(final TestActorRef<Shard> shard, final long expectedValue) {
189 long lastApplied = -1;
190 for(int i = 0; i < 20 * 5; i++) {
191 lastApplied = shard.underlyingActor().getShardMBean().getLastApplied();
192 if(lastApplied == expectedValue) {
195 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
198 Assert.fail(String.format("Expected last applied: %d, Actual: %d", expectedValue, lastApplied));
201 protected TipProducingDataTree createDelegatingMockDataTree() throws Exception {
202 TipProducingDataTree actual = InMemoryDataTreeFactory.getInstance().create(TreeType.CONFIGURATION);
203 final TipProducingDataTree mock = mock(TipProducingDataTree.class);
205 doAnswer(invocation -> {
206 actual.validate(invocation.getArgumentAt(0, DataTreeModification.class));
208 }).when(mock).validate(any(DataTreeModification.class));
210 doAnswer(invocation -> {
211 return actual.prepare(invocation.getArgumentAt(0, DataTreeModification.class));
212 }).when(mock).prepare(any(DataTreeModification.class));
214 doAnswer(invocation -> {
215 actual.commit(invocation.getArgumentAt(0, DataTreeCandidate.class));
217 }).when(mock).commit(any(DataTreeCandidate.class));
219 doAnswer(invocation -> {
220 actual.setSchemaContext(invocation.getArgumentAt(0, SchemaContext.class));
222 }).when(mock).setSchemaContext(any(SchemaContext.class));
224 doAnswer(invocation -> {
225 return actual.takeSnapshot();
226 }).when(mock).takeSnapshot();
228 doAnswer(invocation -> {
229 return actual.getRootPath();
230 }).when(mock).getRootPath();
235 protected ShardDataTreeCohort mockShardDataTreeCohort() {
236 ShardDataTreeCohort cohort = mock(ShardDataTreeCohort.class);
237 DataTreeCandidate candidate = mockCandidate("candidate");
238 successfulCanCommit(cohort);
239 successfulPreCommit(cohort, candidate);
240 successfulCommit(cohort);
241 doReturn(candidate).when(cohort).getCandidate();
245 protected Map<TransactionIdentifier, CapturingShardDataTreeCohort> setupCohortDecorator(final Shard shard,
246 final TransactionIdentifier... transactionIDs) {
247 final Map<TransactionIdentifier, CapturingShardDataTreeCohort> cohortMap = new HashMap<>();
248 for(TransactionIdentifier id: transactionIDs) {
249 cohortMap.put(id, new CapturingShardDataTreeCohort());
252 shard.getCommitCoordinator().setCohortDecorator((transactionID, actual) -> {
253 CapturingShardDataTreeCohort cohort = cohortMap.get(transactionID);
254 cohort.setDelegate(actual);
261 protected BatchedModifications prepareBatchedModifications(final TransactionIdentifier transactionID,
262 final MutableCompositeModification modification) {
263 return prepareBatchedModifications(transactionID, modification, false);
266 protected static BatchedModifications prepareBatchedModifications(final TransactionIdentifier transactionID,
267 final MutableCompositeModification modification,
268 final boolean doCommitOnReady) {
269 final BatchedModifications batchedModifications = new BatchedModifications(transactionID, CURRENT_VERSION);
270 batchedModifications.addModification(modification);
271 batchedModifications.setReady(true);
272 batchedModifications.setDoCommitOnReady(doCommitOnReady);
273 batchedModifications.setTotalMessagesSent(1);
274 return batchedModifications;
277 protected static BatchedModifications prepareBatchedModifications(final TransactionIdentifier transactionID,
278 final YangInstanceIdentifier path, final NormalizedNode<?, ?> data, final boolean doCommitOnReady) {
279 final MutableCompositeModification modification = new MutableCompositeModification();
280 modification.addModification(new WriteModification(path, data));
281 return prepareBatchedModifications(transactionID, modification, doCommitOnReady);
284 protected static ForwardedReadyTransaction prepareForwardedReadyTransaction(final TestActorRef<Shard> shard,
285 final TransactionIdentifier transactionID, final YangInstanceIdentifier path,
286 final NormalizedNode<?, ?> data, final boolean doCommitOnReady) {
287 ReadWriteShardDataTreeTransaction rwTx = shard.underlyingActor().getDataStore().
288 newReadWriteTransaction(transactionID);
289 rwTx.getSnapshot().write(path, data);
290 return new ForwardedReadyTransaction(transactionID, CURRENT_VERSION, rwTx, doCommitOnReady);
293 public static NormalizedNode<?,?> readStore(final TestActorRef<? extends Shard> shard, final YangInstanceIdentifier id)
294 throws ExecutionException, InterruptedException {
295 return shard.underlyingActor().getDataStore().readNode(id).orNull();
298 public static NormalizedNode<?,?> readStore(final DataTree store, final YangInstanceIdentifier id) {
299 return store.takeSnapshot().readNode(id).orNull();
302 public void writeToStore(final TestActorRef<Shard> shard, final YangInstanceIdentifier id,
303 final NormalizedNode<?,?> node) throws InterruptedException, ExecutionException {
304 Future<Object> future = Patterns.ask(shard, newBatchedModifications(nextTransactionId(), id, node, true, true, 1),
305 new Timeout(5, TimeUnit.SECONDS));
307 Await.ready(future, Duration.create(5, TimeUnit.SECONDS));
308 } catch(TimeoutException e) {
309 throw new ExecutionException(e);
313 public static void writeToStore(final ShardDataTree store, final YangInstanceIdentifier id,
314 final NormalizedNode<?,?> node) throws Exception {
315 BatchedModifications batched = newBatchedModifications(nextTransactionId(), id, node, true, true, 1);
316 DataTreeModification modification = store.getDataTree().takeSnapshot().newModification();
317 batched.apply(modification);
318 store.commit(modification);
321 public void mergeToStore(final ShardDataTree store, final YangInstanceIdentifier id,
322 final NormalizedNode<?,?> node) throws Exception {
323 final BatchedModifications batched = new BatchedModifications(nextTransactionId(), CURRENT_VERSION);
324 batched.addModification(new MergeModification(id, node));
325 batched.setReady(true);
326 batched.setDoCommitOnReady(true);
327 batched.setTotalMessagesSent(1);
329 DataTreeModification modification = store.getDataTree().takeSnapshot().newModification();
330 batched.apply(modification);
331 store.commit(modification);
334 public static void writeToStore(final DataTree store, final YangInstanceIdentifier id,
335 final NormalizedNode<?,?> node) throws DataValidationFailedException {
336 final DataTreeModification transaction = store.takeSnapshot().newModification();
338 transaction.write(id, node);
340 store.validate(transaction);
341 final DataTreeCandidate candidate = store.prepare(transaction);
342 store.commit(candidate);
345 DataTree setupInMemorySnapshotStore() throws DataValidationFailedException {
346 final DataTree testStore = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
347 testStore.setSchemaContext(SCHEMA_CONTEXT);
349 writeToStore(testStore, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
351 final NormalizedNode<?, ?> root = readStore(testStore, YangInstanceIdentifier.EMPTY);
353 InMemorySnapshotStore.addSnapshot(shardID.toString(), Snapshot.create(
354 new PreBoronShardDataTreeSnapshot(root).serialize(),
355 Collections.<ReplicatedLogEntry>emptyList(), 0, 1, -1, -1));
359 static CommitTransactionPayload payloadForModification(final DataTree source, final DataTreeModification mod,
360 final TransactionIdentifier transactionId) throws DataValidationFailedException, IOException {
361 source.validate(mod);
362 final DataTreeCandidate candidate = source.prepare(mod);
363 source.commit(candidate);
364 return CommitTransactionPayload.create(transactionId, candidate);
367 static BatchedModifications newBatchedModifications(final TransactionIdentifier transactionID,
368 final YangInstanceIdentifier path, final NormalizedNode<?, ?> data, final boolean ready, final boolean doCommitOnReady,
369 final int messagesSent) {
370 final BatchedModifications batched = new BatchedModifications(transactionID, CURRENT_VERSION);
371 batched.addModification(new WriteModification(path, data));
372 batched.setReady(ready);
373 batched.setDoCommitOnReady(doCommitOnReady);
374 batched.setTotalMessagesSent(messagesSent);
378 @SuppressWarnings("unchecked")
379 static void verifyOuterListEntry(final TestActorRef<Shard> shard, final Object expIDValue) throws Exception {
380 final NormalizedNode<?, ?> outerList = readStore(shard, TestModel.OUTER_LIST_PATH);
381 assertNotNull(TestModel.OUTER_LIST_QNAME.getLocalName() + " not found", outerList);
382 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " value is not Iterable",
383 outerList.getValue() instanceof Iterable);
384 final Object entry = ((Iterable<Object>)outerList.getValue()).iterator().next();
385 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " entry is not MapEntryNode",
386 entry instanceof MapEntryNode);
387 final MapEntryNode mapEntry = (MapEntryNode)entry;
388 final Optional<DataContainerChild<? extends PathArgument, ?>> idLeaf =
389 mapEntry.getChild(new YangInstanceIdentifier.NodeIdentifier(TestModel.ID_QNAME));
390 assertTrue("Missing leaf " + TestModel.ID_QNAME.getLocalName(), idLeaf.isPresent());
391 assertEquals(TestModel.ID_QNAME.getLocalName() + " value", expIDValue, idLeaf.get().getValue());
394 public static DataTreeCandidateTip mockCandidate(final String name) {
395 final DataTreeCandidateTip mockCandidate = mock(DataTreeCandidateTip.class, name);
396 final DataTreeCandidateNode mockCandidateNode = mock(DataTreeCandidateNode.class, name + "-node");
397 doReturn(ModificationType.WRITE).when(mockCandidateNode).getModificationType();
398 doReturn(Optional.of(ImmutableNodes.containerNode(CarsModel.CARS_QNAME))).when(mockCandidateNode).getDataAfter();
399 doReturn(CarsModel.BASE_PATH).when(mockCandidate).getRootPath();
400 doReturn(mockCandidateNode).when(mockCandidate).getRootNode();
401 return mockCandidate;
404 static DataTreeCandidateTip mockUnmodifiedCandidate(final String name) {
405 final DataTreeCandidateTip mockCandidate = mock(DataTreeCandidateTip.class, name);
406 final DataTreeCandidateNode mockCandidateNode = mock(DataTreeCandidateNode.class, name + "-node");
407 doReturn(ModificationType.UNMODIFIED).when(mockCandidateNode).getModificationType();
408 doReturn(YangInstanceIdentifier.EMPTY).when(mockCandidate).getRootPath();
409 doReturn(mockCandidateNode).when(mockCandidate).getRootNode();
410 return mockCandidate;
413 static void commitTransaction(final DataTree store, final DataTreeModification modification) throws DataValidationFailedException {
414 modification.ready();
415 store.validate(modification);
416 store.commit(store.prepare(modification));
419 @SuppressWarnings("serial")
420 public static final class DelegatingShardCreator implements Creator<Shard> {
421 private final Creator<Shard> delegate;
423 DelegatingShardCreator(final Creator<Shard> delegate) {
424 this.delegate = delegate;
428 public Shard create() throws Exception {
429 return delegate.create();
433 public static class CapturingShardDataTreeCohort extends ShardDataTreeCohort {
434 private volatile ShardDataTreeCohort delegate;
435 private FutureCallback<Void> canCommit;
436 private FutureCallback<DataTreeCandidate> preCommit;
437 private FutureCallback<UnsignedLong> commit;
439 public void setDelegate(ShardDataTreeCohort delegate) {
440 this.delegate = delegate;
443 public FutureCallback<Void> getCanCommit() {
444 assertNotNull("canCommit was not invoked", canCommit);
448 public FutureCallback<DataTreeCandidate> getPreCommit() {
449 assertNotNull("preCommit was not invoked", preCommit);
453 public FutureCallback<UnsignedLong> getCommit() {
454 assertNotNull("commit was not invoked", commit);
459 public TransactionIdentifier getIdentifier() {
460 return delegate.getIdentifier();
464 DataTreeCandidateTip getCandidate() {
465 return delegate.getCandidate();
469 DataTreeModification getDataTreeModification() {
470 return delegate.getDataTreeModification();
474 public void canCommit(FutureCallback<Void> callback) {
475 canCommit = mockFutureCallback(callback);
476 delegate.canCommit(canCommit);
480 public void preCommit(FutureCallback<DataTreeCandidate> callback) {
481 preCommit = mockFutureCallback(callback);
482 delegate.preCommit(preCommit);
486 public void commit(FutureCallback<UnsignedLong> callback) {
487 commit = mockFutureCallback(callback);
488 delegate.commit(commit);
491 @SuppressWarnings("unchecked")
492 private <T> FutureCallback<T> mockFutureCallback(final FutureCallback<T> actual ) {
493 FutureCallback<T> mock = mock(FutureCallback.class);
494 doAnswer(invocation -> {
495 actual.onFailure(invocation.getArgumentAt(0, Throwable.class));
497 }).when(mock).onFailure(any(Throwable.class));
499 doAnswer(invocation -> {
500 actual.onSuccess((T) invocation.getArgumentAt(0, Throwable.class));
502 }).when(mock).onSuccess((T) any(Object.class));
508 public ListenableFuture<Void> abort() {
509 return delegate.abort();
513 public boolean isFailed() {
514 return delegate.isFailed();
518 public State getState() {
519 return delegate.getState();