2 * Copyright (c) 2014, 2015 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.assertEquals;
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertTrue;
14 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION;
15 import static org.opendaylight.mdsal.common.api.LogicalDatastoreType.OPERATIONAL;
17 import com.google.common.base.Optional;
18 import com.google.common.collect.ImmutableMap;
19 import com.google.common.util.concurrent.ForwardingExecutorService;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import com.google.common.util.concurrent.ListeningExecutorService;
22 import com.google.common.util.concurrent.MoreExecutors;
23 import java.util.Collections;
24 import java.util.concurrent.ExecutionException;
25 import java.util.concurrent.ExecutorService;
26 import java.util.concurrent.Executors;
27 import java.util.concurrent.RejectedExecutionException;
28 import java.util.concurrent.TimeUnit;
29 import java.util.concurrent.atomic.AtomicReference;
30 import org.junit.After;
31 import org.junit.Before;
32 import org.junit.Test;
33 import org.mockito.Mockito;
34 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
35 import org.opendaylight.mdsal.common.api.ReadFailedException;
36 import org.opendaylight.mdsal.common.api.TransactionCommitDeadlockException;
37 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
38 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
39 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
40 import org.opendaylight.mdsal.dom.broker.util.TestModel;
41 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
42 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStore;
43 import org.opendaylight.yangtools.util.concurrent.DeadlockDetectingListeningExecutorService;
44 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
46 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
48 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
49 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
52 public class DOMBrokerTest {
54 private SchemaContext schemaContext;
55 private AbstractDOMDataBroker domBroker;
56 private ListeningExecutorService executor;
57 private ExecutorService futureExecutor;
58 private CommitExecutorService commitExecutor;
61 public void setupStore() throws Exception {
62 final InMemoryDOMDataStore operStore = new InMemoryDOMDataStore("OPER",
63 MoreExecutors.newDirectExecutorService());
64 final InMemoryDOMDataStore configStore = new InMemoryDOMDataStore("CFG",
65 MoreExecutors.newDirectExecutorService());
66 schemaContext = TestModel.createTestContext();
68 operStore.onGlobalContextUpdated(schemaContext);
69 configStore.onGlobalContextUpdated(schemaContext);
71 final ImmutableMap<LogicalDatastoreType, DOMStore> stores = ImmutableMap.<LogicalDatastoreType, DOMStore> builder()
72 .put(CONFIGURATION, configStore)
73 .put(OPERATIONAL, operStore)
76 commitExecutor = new CommitExecutorService(Executors.newSingleThreadExecutor());
77 futureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(1, 5, "FCB");
78 executor = new DeadlockDetectingListeningExecutorService(commitExecutor,
79 TransactionCommitDeadlockException.DEADLOCK_EXCEPTION_SUPPLIER, futureExecutor);
80 domBroker = new SerializedDOMDataBroker(stores, executor);
84 public void tearDown() {
85 if( executor != null ) {
86 executor.shutdownNow();
89 if(futureExecutor != null) {
90 futureExecutor.shutdownNow();
95 public void testTransactionIsolation() throws InterruptedException, ExecutionException {
96 assertNotNull(domBroker);
98 final DOMDataTreeReadTransaction readTx = domBroker.newReadOnlyTransaction();
99 assertNotNull(readTx);
101 final DOMDataTreeWriteTransaction writeTx = domBroker.newWriteOnlyTransaction();
102 assertNotNull(writeTx);
106 * Writes /test in writeTx
109 writeTx.put(OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
113 * Reads /test from readTx Read should return Absent.
116 final ListenableFuture<Optional<NormalizedNode<?, ?>>> readTxContainer = readTx
117 .read(OPERATIONAL, TestModel.TEST_PATH);
118 assertFalse(readTxContainer.get().isPresent());
122 public void testTransactionCommit() throws InterruptedException, ExecutionException {
123 final DOMDataTreeWriteTransaction writeTx = domBroker.newWriteOnlyTransaction();
124 assertNotNull(writeTx);
127 * Writes /test in writeTx
130 writeTx.put(OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
132 writeTx.submit().get();
134 final Optional<NormalizedNode<?, ?>> afterCommitRead = domBroker.newReadOnlyTransaction()
135 .read(OPERATIONAL, TestModel.TEST_PATH).get();
136 assertTrue(afterCommitRead.isPresent());
139 @Test(expected=TransactionCommitFailedException.class)
140 public void testRejectedCommit() throws Exception {
141 commitExecutor.delegate = Mockito.mock( ExecutorService.class );
142 Mockito.doThrow( new RejectedExecutionException( "mock" ) )
143 .when( commitExecutor.delegate ).execute( Mockito.any( Runnable.class ) );
144 Mockito.doNothing().when( commitExecutor.delegate ).shutdown();
145 Mockito.doReturn( Collections.emptyList() ).when( commitExecutor.delegate ).shutdownNow();
146 Mockito.doReturn( "" ).when( commitExecutor.delegate ).toString();
147 Mockito.doReturn( true ).when( commitExecutor.delegate )
148 .awaitTermination( Mockito.anyLong(), Mockito.any( TimeUnit.class ) );
150 final DOMDataTreeWriteTransaction writeTx = domBroker.newWriteOnlyTransaction();
151 writeTx.put( OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME) );
153 writeTx.submit().checkedGet( 5, TimeUnit.SECONDS );
156 AtomicReference<Throwable> submitTxAsync( final DOMDataTreeWriteTransaction writeTx ) {
157 final AtomicReference<Throwable> caughtEx = new AtomicReference<>();
164 } catch( final Throwable e ) {
174 @Test(expected = ReadFailedException.class)
175 public void basicTests() throws Exception {
176 final DataContainerChild<?, ?> outerList = ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME)
177 .withChild(ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 1))
179 final NormalizedNode<?, ?> testContainer = Builders.containerBuilder()
180 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(TestModel.TEST_QNAME))
181 .withChild(outerList)
184 DOMDataTreeWriteTransaction writeTx = domBroker.newWriteOnlyTransaction();
185 final DOMDataTreeReadTransaction readRx = domBroker.newReadOnlyTransaction();
186 assertNotNull(writeTx);
187 assertNotNull(readRx);
189 writeTx.put(OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
190 writeTx.submit().get();
191 assertFalse(writeTx.cancel());
193 assertEquals(false, domBroker.newReadOnlyTransaction().exists(CONFIGURATION, TestModel.TEST_PATH).get());
194 assertEquals(true, domBroker.newReadOnlyTransaction().exists(OPERATIONAL, TestModel.TEST_PATH).get());
195 assertEquals(false, domBroker.newReadOnlyTransaction().exists(OPERATIONAL, TestModel.TEST2_PATH).get());
197 writeTx = domBroker.newWriteOnlyTransaction();
198 writeTx.put(OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
199 writeTx.delete(OPERATIONAL, TestModel.TEST_PATH);
200 writeTx.submit().get();
201 assertEquals(false, domBroker.newReadOnlyTransaction().exists(OPERATIONAL, TestModel.TEST_PATH).get());
202 assertTrue(domBroker.newWriteOnlyTransaction().cancel());
204 writeTx = domBroker.newWriteOnlyTransaction();
205 writeTx.put(OPERATIONAL, TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
206 writeTx.merge(OPERATIONAL, TestModel.TEST_PATH, testContainer);
207 writeTx.submit().get();
208 assertEquals(true, domBroker.newReadOnlyTransaction().exists(OPERATIONAL, TestModel.TEST_PATH).get());
209 assertEquals(true, domBroker.newReadOnlyTransaction().read(OPERATIONAL, TestModel.TEST_PATH).get()
210 .get().toString().contains(testContainer.toString()));
213 //Expected exception after close call
214 readRx.read(OPERATIONAL, TestModel.TEST_PATH).checkedGet();
218 public void closeTest() throws Exception {
219 final String TEST_EXCEPTION = "TestException";
221 domBroker.setCloseable(() -> { throw new Exception(TEST_EXCEPTION); });
224 }catch(final Exception e){
225 assertTrue(e.getMessage().contains(TEST_EXCEPTION));
229 static class CommitExecutorService extends ForwardingExecutorService {
231 ExecutorService delegate;
233 public CommitExecutorService( final ExecutorService delegate ) {
234 this.delegate = delegate;
238 protected ExecutorService delegate() {