a882ff33ccec109a29e001cae30772a1fc369329
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / IntegrationTestKit.java
1 /*
2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.cluster.datastore;
9
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.fail;
13 import akka.actor.ActorRef;
14 import akka.actor.ActorSystem;
15 import akka.actor.PoisonPill;
16 import com.google.common.base.Optional;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import com.google.common.util.concurrent.Uninterruptibles;
19 import java.util.concurrent.Callable;
20 import java.util.concurrent.TimeUnit;
21 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
22 import org.opendaylight.controller.cluster.datastore.config.Configuration;
23 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
24 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
25 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
26 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
27 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
28 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
29 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
33
34 class IntegrationTestKit extends ShardTestKit {
35
36     DatastoreContext.Builder datastoreContextBuilder;
37
38     IntegrationTestKit(ActorSystem actorSystem, Builder datastoreContextBuilder) {
39         super(actorSystem);
40         this.datastoreContextBuilder = datastoreContextBuilder;
41     }
42
43     DistributedDataStore setupDistributedDataStore(String typeName, String... shardNames) {
44         return setupDistributedDataStore(typeName, true, shardNames);
45     }
46
47     DistributedDataStore setupDistributedDataStore(String typeName, boolean waitUntilLeader,
48             String... shardNames) {
49         return setupDistributedDataStore(typeName, "module-shards.conf", waitUntilLeader, shardNames);
50     }
51
52     DistributedDataStore setupDistributedDataStore(String typeName, String moduleShardsConfig, boolean waitUntilLeader,
53             String... shardNames) {
54         ClusterWrapper cluster = new ClusterWrapperImpl(getSystem());
55         Configuration config = new ConfigurationImpl(moduleShardsConfig, "modules.conf");
56
57         datastoreContextBuilder.dataStoreType(typeName);
58
59         DatastoreContext datastoreContext = datastoreContextBuilder.build();
60
61         DistributedDataStore dataStore = new DistributedDataStore(getSystem(), cluster, config, datastoreContext);
62
63         SchemaContext schemaContext = SchemaContextHelper.full();
64         dataStore.onGlobalContextUpdated(schemaContext);
65
66         if(waitUntilLeader) {
67             waitUntilLeader(dataStore.getActorContext(), shardNames);
68         }
69
70         return dataStore;
71     }
72
73     void waitUntilLeader(ActorContext actorContext, String... shardNames) {
74         for(String shardName: shardNames) {
75             ActorRef shard = findLocalShard(actorContext, shardName);
76
77             assertNotNull("Shard was not created", shard);
78
79             waitUntilLeader(shard);
80         }
81     }
82
83     void waitUntilNoLeader(ActorContext actorContext, String... shardNames) {
84         for(String shardName: shardNames) {
85             ActorRef shard = findLocalShard(actorContext, shardName);
86             assertNotNull("No local shard found", shard);
87
88             waitUntilNoLeader(shard);
89         }
90     }
91
92     private ActorRef findLocalShard(ActorContext actorContext, String shardName) {
93         ActorRef shard = null;
94         for(int i = 0; i < 20 * 5 && shard == null; i++) {
95             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
96             Optional<ActorRef> shardReply = actorContext.findLocalShard(shardName);
97             if(shardReply.isPresent()) {
98                 shard = shardReply.get();
99             }
100         }
101         return shard;
102     }
103
104     void testWriteTransaction(DistributedDataStore dataStore, YangInstanceIdentifier nodePath,
105             NormalizedNode<?, ?> nodeToWrite) throws Exception {
106
107         // 1. Create a write-only Tx
108
109         DOMStoreWriteTransaction writeTx = dataStore.newWriteOnlyTransaction();
110         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
111
112         // 2. Write some data
113
114         writeTx.write(nodePath, nodeToWrite);
115
116         // 3. Ready the Tx for commit
117
118         DOMStoreThreePhaseCommitCohort cohort = writeTx.ready();
119
120         // 4. Commit the Tx
121
122         doCommit(cohort);
123
124         // 5. Verify the data in the store
125
126         DOMStoreReadTransaction readTx = dataStore.newReadOnlyTransaction();
127
128         Optional<NormalizedNode<?, ?>> optional = readTx.read(nodePath).get(5, TimeUnit.SECONDS);
129         assertEquals("isPresent", true, optional.isPresent());
130         assertEquals("Data node", nodeToWrite, optional.get());
131     }
132
133     void doCommit(final DOMStoreThreePhaseCommitCohort cohort) throws Exception {
134         Boolean canCommit = cohort.canCommit().get(7, TimeUnit.SECONDS);
135         assertEquals("canCommit", true, canCommit);
136         cohort.preCommit().get(5, TimeUnit.SECONDS);
137         cohort.commit().get(5, TimeUnit.SECONDS);
138     }
139
140     void doCommit(final ListenableFuture<Boolean> canCommitFuture, final DOMStoreThreePhaseCommitCohort cohort) throws Exception {
141         Boolean canCommit = canCommitFuture.get(7, TimeUnit.SECONDS);
142         assertEquals("canCommit", true, canCommit);
143         cohort.preCommit().get(5, TimeUnit.SECONDS);
144         cohort.commit().get(5, TimeUnit.SECONDS);
145     }
146
147     void cleanup(DistributedDataStore dataStore) {
148         if(dataStore != null) {
149             dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), null);
150         }
151     }
152
153     void assertExceptionOnCall(Callable<Void> callable, Class<? extends Exception> expType)
154             throws Exception {
155         try {
156             callable.call();
157             fail("Expected " + expType.getSimpleName());
158         } catch(Exception e) {
159             assertEquals("Exception type", expType, e.getClass());
160         }
161     }
162
163     void assertExceptionOnTxChainCreates(final DOMStoreTransactionChain txChain,
164             Class<? extends Exception> expType) throws Exception {
165         assertExceptionOnCall(new Callable<Void>() {
166             @Override
167             public Void call() throws Exception {
168                 txChain.newWriteOnlyTransaction();
169                 return null;
170             }
171         }, expType);
172
173         assertExceptionOnCall(new Callable<Void>() {
174             @Override
175             public Void call() throws Exception {
176                 txChain.newReadWriteTransaction();
177                 return null;
178             }
179         }, expType);
180
181         assertExceptionOnCall(new Callable<Void>() {
182             @Override
183             public Void call() throws Exception {
184                 txChain.newReadOnlyTransaction();
185                 return null;
186             }
187         }, expType);
188     }
189 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.