2 * Copyright (c) 2014 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
8 package org.opendaylight.mdsal.dom.broker;
10 import static org.junit.Assert.assertNotNull;
11 import static org.junit.Assert.assertTrue;
12 import static org.junit.Assert.fail;
13 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION;
14 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.OPERATIONAL;
16 import com.google.common.base.Optional;
17 import com.google.common.collect.ImmutableMap;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import com.google.common.util.concurrent.ListeningExecutorService;
20 import com.google.common.util.concurrent.MoreExecutors;
21 import java.util.concurrent.ExecutionException;
22 import java.util.concurrent.Executors;
23 import java.util.concurrent.TimeUnit;
24 import java.util.concurrent.TimeoutException;
25 import org.junit.Before;
26 import org.junit.Test;
27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
30 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
31 import org.opendaylight.mdsal.dom.broker.util.TestModel;
32 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
33 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStore;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
38 public class DOMTransactionChainTest {
40 private SchemaContext schemaContext;
41 private AbstractDOMDataBroker domBroker;
44 public void setupStore() throws Exception {
45 final InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER",
46 MoreExecutors.newDirectExecutorService());
47 final InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG",
48 MoreExecutors.newDirectExecutorService());
49 schemaContext = TestModel.createTestContext();
51 operStore.onGlobalContextUpdated(schemaContext);
52 configStore.onGlobalContextUpdated(schemaContext);
54 final ImmutableMap<LogicalDatastoreType, DOMStore> stores =
55 ImmutableMap.<LogicalDatastoreType, DOMStore>builder()
56 .put(CONFIGURATION, configStore)
57 .put(OPERATIONAL, operStore)
60 final ListeningExecutorService executor = MoreExecutors.listeningDecorator(
61 Executors.newSingleThreadExecutor());
62 domBroker = new SerializedDOMDataBroker(stores, executor);
66 public void testTransactionChainNoConflict() throws InterruptedException, ExecutionException, TimeoutException {
67 final BlockingTransactionChainListener listener = new BlockingTransactionChainListener();
68 final DOMTransactionChain txChain = domBroker.createTransactionChain(listener);
69 assertNotNull(txChain);
72 * We alocate new read-write transaction and write /test.
74 final DOMDataTreeWriteTransaction firstTx = allocateAndWrite(txChain);
77 * First transaction is marked as ready, we are able to allocate chained
80 final ListenableFuture<Void> firstWriteTxFuture = firstTx.submit();
83 * We alocate chained transaction - read transaction.
85 final DOMDataTreeReadTransaction secondReadTx = txChain.newReadOnlyTransaction();
89 * We test if we are able to read data from tx, read should not fail
90 * since we are using chained transaction.
94 assertTestContainerExists(secondReadTx);
97 * We alocate next transaction, which is still based on first one, but
101 final DOMDataTreeWriteTransaction thirdDeleteTx = allocateAndDelete(txChain);
104 * We commit first transaction
107 assertCommitSuccessful(firstWriteTxFuture);
110 * Allocates transaction from data store.
113 final DOMDataTreeReadTransaction storeReadTx = domBroker.newReadOnlyTransaction();
116 * We verify transaction is commited to store, container should exists
119 assertTestContainerExists(storeReadTx);
122 * third transaction is sealed and commited.
124 final ListenableFuture<Void> thirdDeleteTxFuture = thirdDeleteTx.submit();
125 assertCommitSuccessful(thirdDeleteTxFuture);
128 * We close transaction chain.
132 listener.getSuccessFuture().get(1000, TimeUnit.MILLISECONDS);
135 @SuppressWarnings("checkstyle:IllegalCatch")
137 public void testTransactionChainNotSealed() throws InterruptedException, ExecutionException, TimeoutException {
138 final BlockingTransactionChainListener listener = new BlockingTransactionChainListener();
139 final DOMTransactionChain txChain = domBroker.createTransactionChain(listener);
140 assertNotNull(txChain);
143 * We alocate new read-write transaction and write /test
145 allocateAndWrite(txChain);
148 * We alocate chained transaction - read transaction, note first one is
149 * still not commited to datastore, so this allocation should fail with
150 * IllegalStateException.
153 txChain.newReadOnlyTransaction();
154 fail("Allocation of secondReadTx should fail with IllegalStateException");
155 } catch (final Exception e) {
156 assertTrue(e instanceof IllegalStateException);
160 private static DOMDataTreeWriteTransaction allocateAndDelete(final DOMTransactionChain txChain)
161 throws InterruptedException, ExecutionException {
162 final DOMDataTreeWriteTransaction tx = txChain.newWriteOnlyTransaction();
164 * We delete node in third transaction
166 tx.delete(LogicalDatastoreType.OPERATIONAL, TestModel.TEST_PATH);
170 private static DOMDataTreeWriteTransaction allocateAndWrite(final DOMTransactionChain txChain)
171 throws InterruptedException, ExecutionException {
172 final DOMDataTreeWriteTransaction tx = txChain.newWriteOnlyTransaction();
173 writeTestContainer(tx);
177 private static void assertCommitSuccessful(final ListenableFuture<Void> future)
178 throws InterruptedException, ExecutionException {
182 private static void assertTestContainerExists(final DOMDataTreeReadTransaction readTx)
183 throws InterruptedException, ExecutionException {
184 final ListenableFuture<Optional<NormalizedNode<?, ?>>> readFuture =
185 readTx.read(OPERATIONAL, TestModel.TEST_PATH);
186 final Optional<NormalizedNode<?, ?>> readedData = readFuture.get();
187 assertTrue(readedData.isPresent());
190 private static void writeTestContainer(final DOMDataTreeWriteTransaction tx) throws InterruptedException,
192 tx.put(OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));