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.Mockito.doAnswer;
15 import static org.mockito.Mockito.mock;
16 import akka.actor.ActorRef;
17 import akka.actor.PoisonPill;
18 import akka.actor.Props;
19 import akka.dispatch.Dispatchers;
20 import akka.japi.Creator;
21 import akka.testkit.TestActorRef;
22 import com.google.common.base.Function;
23 import com.google.common.base.Optional;
24 import com.google.common.util.concurrent.ListenableFuture;
25 import com.google.common.util.concurrent.Uninterruptibles;
26 import java.util.Collections;
28 import java.util.concurrent.CountDownLatch;
29 import java.util.concurrent.ExecutionException;
30 import java.util.concurrent.TimeUnit;
31 import java.util.concurrent.atomic.AtomicInteger;
32 import org.junit.After;
33 import org.junit.Assert;
34 import org.junit.Before;
35 import org.mockito.invocation.InvocationOnMock;
36 import org.mockito.stubbing.Answer;
37 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
38 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
39 import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification;
40 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
41 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
42 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
43 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
46 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
47 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
50 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
51 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
52 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
53 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
54 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
55 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
58 * Abstract base for shard unit tests.
60 * @author Thomas Pantelis
62 public abstract class AbstractShardTest extends AbstractActorTest{
63 protected static final SchemaContext SCHEMA_CONTEXT = TestModel.createTestContext();
65 private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger();
67 protected final ShardIdentifier shardID = ShardIdentifier.builder().memberName("member-1")
68 .shardName("inventory").type("config" + NEXT_SHARD_NUM.getAndIncrement()).build();
70 protected final Builder dataStoreContextBuilder = DatastoreContext.newBuilder().
71 shardJournalRecoveryLogBatchSize(3).shardSnapshotBatchCount(5000).
72 shardHeartbeatIntervalInMillis(100);
76 InMemorySnapshotStore.clear();
77 InMemoryJournal.clear();
81 public void tearDown() {
82 InMemorySnapshotStore.clear();
83 InMemoryJournal.clear();
86 protected DatastoreContext newDatastoreContext() {
87 return dataStoreContextBuilder.build();
90 protected Props newShardProps() {
91 return Shard.props(shardID, Collections.<String,String>emptyMap(),
92 newDatastoreContext(), SCHEMA_CONTEXT);
95 protected void testRecovery(final Set<Integer> listEntryKeys) throws Exception {
96 // Create the actor and wait for recovery complete.
98 final int nListEntries = listEntryKeys.size();
100 final CountDownLatch recoveryComplete = new CountDownLatch(1);
102 @SuppressWarnings("serial")
104 Creator<Shard> creator = new Creator<Shard>() {
106 public Shard create() throws Exception {
107 return new Shard(shardID, Collections.<String,String>emptyMap(),
108 newDatastoreContext(), SCHEMA_CONTEXT) {
110 protected void onRecoveryComplete() {
112 super.onRecoveryComplete();
114 recoveryComplete.countDown();
121 final TestActorRef<Shard> shard = TestActorRef.create(getSystem(),
122 Props.create(new DelegatingShardCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()), "testRecovery");
124 assertEquals("Recovery complete", true, recoveryComplete.await(5, TimeUnit.SECONDS));
126 // Verify data in the data store.
128 final NormalizedNode<?, ?> outerList = readStore(shard, TestModel.OUTER_LIST_PATH);
129 assertNotNull(TestModel.OUTER_LIST_QNAME.getLocalName() + " not found", outerList);
130 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " value is not Iterable",
131 outerList.getValue() instanceof Iterable);
132 for(final Object entry: (Iterable<?>) outerList.getValue()) {
133 assertTrue(TestModel.OUTER_LIST_QNAME.getLocalName() + " entry is not MapEntryNode",
134 entry instanceof MapEntryNode);
135 final MapEntryNode mapEntry = (MapEntryNode)entry;
136 final Optional<DataContainerChild<? extends PathArgument, ?>> idLeaf =
137 mapEntry.getChild(new YangInstanceIdentifier.NodeIdentifier(TestModel.ID_QNAME));
138 assertTrue("Missing leaf " + TestModel.ID_QNAME.getLocalName(), idLeaf.isPresent());
139 final Object value = idLeaf.get().getValue();
140 assertTrue("Unexpected value for leaf "+ TestModel.ID_QNAME.getLocalName() + ": " + value,
141 listEntryKeys.remove(value));
144 if(!listEntryKeys.isEmpty()) {
145 fail("Missing " + TestModel.OUTER_LIST_QNAME.getLocalName() + " entries with keys: " +
149 assertEquals("Last log index", nListEntries,
150 shard.underlyingActor().getShardMBean().getLastLogIndex());
151 assertEquals("Commit index", nListEntries,
152 shard.underlyingActor().getShardMBean().getCommitIndex());
153 assertEquals("Last applied", nListEntries,
154 shard.underlyingActor().getShardMBean().getLastApplied());
156 shard.tell(PoisonPill.getInstance(), ActorRef.noSender());
159 protected void verifyLastApplied(final TestActorRef<Shard> shard, final long expectedValue) {
160 long lastApplied = -1;
161 for(int i = 0; i < 20 * 5; i++) {
162 lastApplied = shard.underlyingActor().getShardMBean().getLastApplied();
163 if(lastApplied == expectedValue) {
166 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
169 Assert.fail(String.format("Expected last applied: %d, Actual: %d", expectedValue, lastApplied));
172 protected ShardDataTreeCohort setupMockWriteTransaction(final String cohortName,
173 final ShardDataTree dataStore, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data,
174 final MutableCompositeModification modification) {
175 return setupMockWriteTransaction(cohortName, dataStore, path, data, modification, null);
178 protected ShardDataTreeCohort setupMockWriteTransaction(final String cohortName,
179 final ShardDataTree dataStore, final YangInstanceIdentifier path, final NormalizedNode<?, ?> data,
180 final MutableCompositeModification modification,
181 final Function<ShardDataTreeCohort, ListenableFuture<Void>> preCommit) {
183 final ReadWriteShardDataTreeTransaction tx = dataStore.newReadWriteTransaction("setup-mock-" + cohortName, null);
184 tx.getSnapshot().write(path, data);
185 final ShardDataTreeCohort cohort = createDelegatingMockCohort(cohortName, dataStore.finishTransaction(tx), preCommit);
187 modification.addModification(new WriteModification(path, data));
192 protected ShardDataTreeCohort createDelegatingMockCohort(final String cohortName,
193 final ShardDataTreeCohort actual) {
194 return createDelegatingMockCohort(cohortName, actual, null);
197 protected ShardDataTreeCohort createDelegatingMockCohort(final String cohortName,
198 final ShardDataTreeCohort actual,
199 final Function<ShardDataTreeCohort, ListenableFuture<Void>> preCommit) {
200 final ShardDataTreeCohort cohort = mock(ShardDataTreeCohort.class, cohortName);
202 doAnswer(new Answer<ListenableFuture<Boolean>>() {
204 public ListenableFuture<Boolean> answer(final InvocationOnMock invocation) {
205 return actual.canCommit();
207 }).when(cohort).canCommit();
209 doAnswer(new Answer<ListenableFuture<Void>>() {
211 public ListenableFuture<Void> answer(final InvocationOnMock invocation) throws Throwable {
212 if(preCommit != null) {
213 return preCommit.apply(actual);
215 return actual.preCommit();
218 }).when(cohort).preCommit();
220 doAnswer(new Answer<ListenableFuture<Void>>() {
222 public ListenableFuture<Void> answer(final InvocationOnMock invocation) throws Throwable {
223 return actual.commit();
225 }).when(cohort).commit();
227 doAnswer(new Answer<ListenableFuture<Void>>() {
229 public ListenableFuture<Void> answer(final InvocationOnMock invocation) throws Throwable {
230 return actual.abort();
232 }).when(cohort).abort();
234 doAnswer(new Answer<DataTreeCandidateTip>() {
236 public DataTreeCandidateTip answer(final InvocationOnMock invocation) {
237 return actual.getCandidate();
239 }).when(cohort).getCandidate();
244 public static NormalizedNode<?,?> readStore(final TestActorRef<? extends Shard> shard, final YangInstanceIdentifier id)
245 throws ExecutionException, InterruptedException {
246 return readStore(shard.underlyingActor().getDataStore().getDataTree(), id);
249 public static NormalizedNode<?,?> readStore(final DataTree store, final YangInstanceIdentifier id) {
250 final DataTreeSnapshot transaction = store.takeSnapshot();
252 final Optional<NormalizedNode<?, ?>> optional = transaction.readNode(id);
253 final NormalizedNode<?, ?> node = optional.isPresent()? optional.get() : null;
258 public static void writeToStore(final TestActorRef<Shard> shard, final YangInstanceIdentifier id,
259 final NormalizedNode<?,?> node) throws InterruptedException, ExecutionException {
260 writeToStore(shard.underlyingActor().getDataStore(), id, node);
263 public static void writeToStore(final ShardDataTree store, final YangInstanceIdentifier id,
264 final NormalizedNode<?,?> node) throws InterruptedException, ExecutionException {
265 final ReadWriteShardDataTreeTransaction transaction = store.newReadWriteTransaction("writeToStore", null);
267 transaction.getSnapshot().write(id, node);
268 final ShardDataTreeCohort cohort = transaction.ready();
269 cohort.canCommit().get();
270 cohort.preCommit().get();
274 public static void writeToStore(final DataTree store, final YangInstanceIdentifier id,
275 final NormalizedNode<?,?> node) throws DataValidationFailedException {
276 final DataTreeModification transaction = store.takeSnapshot().newModification();
278 transaction.write(id, node);
280 store.validate(transaction);
281 final DataTreeCandidate candidate = store.prepare(transaction);
282 store.commit(candidate);
285 @SuppressWarnings("serial")
286 public static final class DelegatingShardCreator implements Creator<Shard> {
287 private final Creator<Shard> delegate;
289 DelegatingShardCreator(final Creator<Shard> delegate) {
290 this.delegate = delegate;
294 public Shard create() throws Exception {
295 return delegate.create();