opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/databroker/ConcurrentDOMDataBrokerTest.java

   1 /*
   2  * Copyright (c) 2014 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.databroker;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertSame;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.junit.Assert.fail;
  15 import static org.mockito.Mockito.doAnswer;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.inOrder;
  18 import static org.mockito.Mockito.mock;
  19 import static org.mockito.Mockito.never;
  20 import static org.mockito.Mockito.times;
  21 import static org.mockito.Mockito.verify;
  22
  23 import com.google.common.base.Throwables;
  24 import com.google.common.collect.ImmutableMap;
  25 import com.google.common.util.concurrent.CheckedFuture;
  26 import com.google.common.util.concurrent.FutureCallback;
  27 import com.google.common.util.concurrent.Futures;
  28 import com.google.common.util.concurrent.ListenableFuture;
  29 import com.google.common.util.concurrent.MoreExecutors;
  30 import com.google.common.util.concurrent.SettableFuture;
  31 import com.google.common.util.concurrent.Uninterruptibles;
  32 import java.util.ArrayList;
  33 import java.util.Arrays;
  34 import java.util.Collection;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.concurrent.CountDownLatch;
  38 import java.util.concurrent.ExecutionException;
  39 import java.util.concurrent.SynchronousQueue;
  40 import java.util.concurrent.ThreadPoolExecutor;
  41 import java.util.concurrent.TimeUnit;
  42 import java.util.concurrent.TimeoutException;
  43 import java.util.concurrent.atomic.AtomicReference;
  44 import org.junit.After;
  45 import org.junit.Before;
  46 import org.junit.Test;
  47 import org.mockito.InOrder;
  48 import org.mockito.stubbing.Answer;
  49 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  50 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  51 import org.opendaylight.mdsal.common.api.DataStoreUnavailableException;
  52 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  53 import org.opendaylight.mdsal.common.api.TransactionChainListener;
  54 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  55 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
  56 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
  57 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
  58 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry;
  59 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  60 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  61 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  62 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  63 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  64 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  65 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  66 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  67 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  68 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  69 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  70 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStore;
  71 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  72 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  73
  74 /**
  75  * Unit tests for DOMConcurrentDataCommitCoordinator.
  76  *
  77  * @author Thomas Pantelis
  78  */
  79 public class ConcurrentDOMDataBrokerTest {
  80
  81     private final DOMDataTreeWriteTransaction transaction = mock(DOMDataTreeWriteTransaction.class);
  82     private final DOMStoreThreePhaseCommitCohort mockCohort1 = mock(DOMStoreThreePhaseCommitCohort.class);
  83     private final DOMStoreThreePhaseCommitCohort mockCohort2 = mock(DOMStoreThreePhaseCommitCohort.class);
  84     private final ThreadPoolExecutor futureExecutor =
  85             new ThreadPoolExecutor(0, 1, 5, TimeUnit.SECONDS, new SynchronousQueue<>());
  86     private ConcurrentDOMDataBroker coordinator;
  87
  88     @Before
  89     public void setup() {
  90         doReturn("tx").when(transaction).getIdentifier();
  91
  92         DOMStore store = new InMemoryDOMDataStore("OPER", MoreExecutors.newDirectExecutorService());
  93
  94         coordinator = new ConcurrentDOMDataBroker(ImmutableMap.of(LogicalDatastoreType.OPERATIONAL, store),
  95                 futureExecutor);
  96     }
  97
  98     @After
  99     public void tearDown() {
 100         futureExecutor.shutdownNow();
 101     }
 102
 103     @Test
 104     public void testSuccessfulSubmitAsync() throws Exception {
 105         testSuccessfulSubmit(true);
 106     }
 107
 108     @Test
 109     public void testSuccessfulSubmitSync() throws Exception {
 110         testSuccessfulSubmit(false);
 111     }
 112
 113     private void testSuccessfulSubmit(final boolean doAsync) throws InterruptedException {
 114         final CountDownLatch asyncCanCommitContinue = new CountDownLatch(1);
 115         Answer<ListenableFuture<Boolean>> asyncCanCommit = invocation -> {
 116             final SettableFuture<Boolean> future = SettableFuture.create();
 117             if (doAsync) {
 118                 new Thread(() -> {
 119                     Uninterruptibles.awaitUninterruptibly(asyncCanCommitContinue,
 120                             10, TimeUnit.SECONDS);
 121                     future.set(true);
 122                 }).start();
 123             } else {
 124                 future.set(true);
 125             }
 126
 127             return future;
 128         };
 129
 130         doAnswer(asyncCanCommit).when(mockCohort1).canCommit();
 131         doReturn(Futures.immediateFuture(null)).when(mockCohort1).preCommit();
 132         doReturn(Futures.immediateFuture(null)).when(mockCohort1).commit();
 133
 134         doReturn(Futures.immediateFuture(true)).when(mockCohort2).canCommit();
 135         doReturn(Futures.immediateFuture(null)).when(mockCohort2).preCommit();
 136         doReturn(Futures.immediateFuture(null)).when(mockCohort2).commit();
 137
 138         ListenableFuture<Void> future = coordinator.submit(transaction, Arrays.asList(mockCohort1, mockCohort2));
 139
 140         final CountDownLatch doneLatch = new CountDownLatch(1);
 141         final AtomicReference<Throwable> caughtEx = new AtomicReference<>();
 142         Futures.addCallback(future, new FutureCallback<Void>() {
 143             @Override
 144             public void onSuccess(final Void result) {
 145                 doneLatch.countDown();
 146             }
 147
 148             @Override
 149             public void onFailure(final Throwable failure) {
 150                 caughtEx.set(failure);
 151                 doneLatch.countDown();
 152             }
 153         }, MoreExecutors.directExecutor());
 154
 155         asyncCanCommitContinue.countDown();
 156
 157         assertEquals("Submit complete", true, doneLatch.await(5, TimeUnit.SECONDS));
 158
 159         if (caughtEx.get() != null) {
 160             Throwables.throwIfUnchecked(caughtEx.get());
 161             throw new RuntimeException(caughtEx.get());
 162         }
 163
 164         assertEquals("Task count", doAsync ? 1 : 0, futureExecutor.getTaskCount());
 165
 166         InOrder inOrder = inOrder(mockCohort1, mockCohort2);
 167         inOrder.verify(mockCohort1).canCommit();
 168         inOrder.verify(mockCohort2).canCommit();
 169         inOrder.verify(mockCohort1).preCommit();
 170         inOrder.verify(mockCohort2).preCommit();
 171         inOrder.verify(mockCohort1).commit();
 172         inOrder.verify(mockCohort2).commit();
 173     }
 174
 175     @Test
 176     public void testSubmitWithNegativeCanCommitResponse() throws Exception {
 177         doReturn(Futures.immediateFuture(true)).when(mockCohort1).canCommit();
 178         doReturn(Futures.immediateFuture(null)).when(mockCohort1).abort();
 179
 180         doReturn(Futures.immediateFuture(false)).when(mockCohort2).canCommit();
 181         doReturn(Futures.immediateFuture(null)).when(mockCohort2).abort();
 182
 183         DOMStoreThreePhaseCommitCohort mockCohort3 = mock(DOMStoreThreePhaseCommitCohort.class);
 184         doReturn(Futures.immediateFuture(false)).when(mockCohort3).canCommit();
 185         doReturn(Futures.immediateFuture(null)).when(mockCohort3).abort();
 186
 187         CheckedFuture<Void, TransactionCommitFailedException> future = coordinator.submit(
 188                 transaction, Arrays.asList(mockCohort1, mockCohort2, mockCohort3));
 189
 190         assertFailure(future, null, mockCohort1, mockCohort2, mockCohort3);
 191     }
 192
 193     private static void assertFailure(final CheckedFuture<Void, TransactionCommitFailedException> future,
 194             final Exception expCause, final DOMStoreThreePhaseCommitCohort... mockCohorts)
 195                     throws Exception {
 196         try {
 197             future.checkedGet(5, TimeUnit.SECONDS);
 198             fail("Expected TransactionCommitFailedException");
 199         } catch (TransactionCommitFailedException e) {
 200             if (expCause != null) {
 201                 assertSame("Expected cause", expCause.getClass(), e.getCause().getClass());
 202             }
 203
 204             InOrder inOrder = inOrder((Object[])mockCohorts);
 205             for (DOMStoreThreePhaseCommitCohort c: mockCohorts) {
 206                 inOrder.verify(c).abort();
 207             }
 208         } catch (TimeoutException e) {
 209             throw e;
 210         }
 211     }
 212
 213     @Test
 214     public void testSubmitWithCanCommitException() throws Exception {
 215         doReturn(Futures.immediateFuture(true)).when(mockCohort1).canCommit();
 216         doReturn(Futures.immediateFuture(null)).when(mockCohort1).abort();
 217
 218         IllegalStateException cause = new IllegalStateException("mock");
 219         doReturn(Futures.immediateFailedFuture(cause)).when(mockCohort2).canCommit();
 220         doReturn(Futures.immediateFuture(null)).when(mockCohort2).abort();
 221
 222         CheckedFuture<Void, TransactionCommitFailedException> future = coordinator.submit(
 223                 transaction, Arrays.asList(mockCohort1, mockCohort2));
 224
 225         assertFailure(future, cause, mockCohort1, mockCohort2);
 226     }
 227
 228     @Test
 229     public void testSubmitWithCanCommitDataStoreUnavailableException() throws Exception {
 230         doReturn(Futures.immediateFuture(true)).when(mockCohort1).canCommit();
 231         doReturn(Futures.immediateFuture(null)).when(mockCohort1).abort();
 232         NoShardLeaderException rootCause = new NoShardLeaderException("mock");
 233         DataStoreUnavailableException cause = new DataStoreUnavailableException(rootCause.getMessage(), rootCause);
 234         doReturn(Futures.immediateFailedFuture(rootCause)).when(mockCohort2).canCommit();
 235         doReturn(Futures.immediateFuture(null)).when(mockCohort2).abort();
 236
 237         CheckedFuture<Void, TransactionCommitFailedException> future = coordinator.submit(
 238             transaction, Arrays.asList(mockCohort1, mockCohort2));
 239
 240         assertFailure(future, cause, mockCohort1, mockCohort2);
 241     }
 242
 243     @Test
 244     public void testSubmitWithPreCommitException() throws Exception {
 245         doReturn(Futures.immediateFuture(true)).when(mockCohort1).canCommit();
 246         doReturn(Futures.immediateFuture(null)).when(mockCohort1).preCommit();
 247         doReturn(Futures.immediateFuture(null)).when(mockCohort1).abort();
 248
 249         doReturn(Futures.immediateFuture(true)).when(mockCohort2).canCommit();
 250         IllegalStateException cause = new IllegalStateException("mock");
 251         doReturn(Futures.immediateFailedFuture(cause)).when(mockCohort2).preCommit();
 252         doReturn(Futures.immediateFuture(null)).when(mockCohort2).abort();
 253
 254         DOMStoreThreePhaseCommitCohort mockCohort3 = mock(DOMStoreThreePhaseCommitCohort.class);
 255         doReturn(Futures.immediateFuture(true)).when(mockCohort3).canCommit();
 256         doReturn(Futures.immediateFailedFuture(new IllegalStateException("mock2")))
 257                 .when(mockCohort3).preCommit();
 258         doReturn(Futures.immediateFuture(null)).when(mockCohort3).abort();
 259
 260         CheckedFuture<Void, TransactionCommitFailedException> future = coordinator.submit(
 261                 transaction, Arrays.asList(mockCohort1, mockCohort2, mockCohort3));
 262
 263         assertFailure(future, cause, mockCohort1, mockCohort2, mockCohort3);
 264     }
 265
 266     @Test
 267     public void testSubmitWithCommitException() throws Exception {
 268         doReturn(Futures.immediateFuture(true)).when(mockCohort1).canCommit();
 269         doReturn(Futures.immediateFuture(null)).when(mockCohort1).preCommit();
 270         doReturn(Futures.immediateFuture(null)).when(mockCohort1).commit();
 271         doReturn(Futures.immediateFuture(null)).when(mockCohort1).abort();
 272
 273         doReturn(Futures.immediateFuture(true)).when(mockCohort2).canCommit();
 274         doReturn(Futures.immediateFuture(null)).when(mockCohort2).preCommit();
 275         IllegalStateException cause = new IllegalStateException("mock");
 276         doReturn(Futures.immediateFailedFuture(cause)).when(mockCohort2).commit();
 277         doReturn(Futures.immediateFuture(null)).when(mockCohort2).abort();
 278
 279         DOMStoreThreePhaseCommitCohort mockCohort3 = mock(DOMStoreThreePhaseCommitCohort.class);
 280         doReturn(Futures.immediateFuture(true)).when(mockCohort3).canCommit();
 281         doReturn(Futures.immediateFuture(null)).when(mockCohort3).preCommit();
 282         doReturn(Futures.immediateFailedFuture(new IllegalStateException("mock2")))
 283                 .when(mockCohort3).commit();
 284         doReturn(Futures.immediateFuture(null)).when(mockCohort3).abort();
 285
 286         CheckedFuture<Void, TransactionCommitFailedException> future = coordinator.submit(
 287                 transaction, Arrays.asList(mockCohort1, mockCohort2, mockCohort3));
 288
 289         assertFailure(future, cause, mockCohort1, mockCohort2, mockCohort3);
 290     }
 291
 292     @Test
 293     public void testSubmitWithAbortException() throws Exception {
 294         doReturn(Futures.immediateFuture(true)).when(mockCohort1).canCommit();
 295         doReturn(Futures.immediateFailedFuture(new IllegalStateException("mock abort error")))
 296                 .when(mockCohort1).abort();
 297
 298         IllegalStateException cause = new IllegalStateException("mock canCommit error");
 299         doReturn(Futures.immediateFailedFuture(cause)).when(mockCohort2).canCommit();
 300         doReturn(Futures.immediateFuture(null)).when(mockCohort2).abort();
 301
 302         CheckedFuture<Void, TransactionCommitFailedException> future = coordinator.submit(
 303                 transaction, Arrays.asList(mockCohort1, mockCohort2));
 304
 305         assertFailure(future, cause, mockCohort1, mockCohort2);
 306     }
 307
 308     @Test
 309     public void testCreateReadWriteTransaction() {
 310         DOMStore domStore = mock(DOMStore.class);
 311         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 312                 LogicalDatastoreType.OPERATIONAL, domStore, LogicalDatastoreType.CONFIGURATION, domStore),
 313                 futureExecutor)) {
 314             dataBroker.newReadWriteTransaction();
 315
 316             verify(domStore, never()).newReadWriteTransaction();
 317         }
 318     }
 319
 320     @Test
 321     public void testCreateWriteOnlyTransaction() {
 322         DOMStore domStore = mock(DOMStore.class);
 323         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 324                 LogicalDatastoreType.OPERATIONAL, domStore, LogicalDatastoreType.CONFIGURATION, domStore),
 325                 futureExecutor)) {
 326             dataBroker.newWriteOnlyTransaction();
 327
 328             verify(domStore, never()).newWriteOnlyTransaction();
 329         }
 330     }
 331
 332     @Test
 333     public void testCreateReadOnlyTransaction() {
 334         DOMStore domStore = mock(DOMStore.class);
 335         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 336                 LogicalDatastoreType.OPERATIONAL, domStore, LogicalDatastoreType.CONFIGURATION, domStore),
 337                 futureExecutor)) {
 338             dataBroker.newReadOnlyTransaction();
 339
 340             verify(domStore, never()).newReadOnlyTransaction();
 341         }
 342     }
 343
 344     @Test
 345     public void testLazySubTransactionCreationForReadWriteTransactions() {
 346         DOMStore configDomStore = mock(DOMStore.class);
 347         DOMStore operationalDomStore = mock(DOMStore.class);
 348         DOMStoreReadWriteTransaction storeTxn = mock(DOMStoreReadWriteTransaction.class);
 349
 350         doReturn(storeTxn).when(operationalDomStore).newReadWriteTransaction();
 351         doReturn(storeTxn).when(configDomStore).newReadWriteTransaction();
 352
 353         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 354                 LogicalDatastoreType.OPERATIONAL, operationalDomStore, LogicalDatastoreType.CONFIGURATION,
 355                 configDomStore), futureExecutor)) {
 356             DOMDataTreeReadWriteTransaction dataTxn = dataBroker.newReadWriteTransaction();
 357
 358             dataTxn.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY, mock(NormalizedNode.class));
 359             dataTxn.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY, mock(NormalizedNode.class));
 360             dataTxn.read(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY);
 361
 362             verify(configDomStore, never()).newReadWriteTransaction();
 363             verify(operationalDomStore, times(1)).newReadWriteTransaction();
 364
 365             dataTxn.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.EMPTY, mock(NormalizedNode.class));
 366
 367             verify(configDomStore, times(1)).newReadWriteTransaction();
 368             verify(operationalDomStore, times(1)).newReadWriteTransaction();
 369         }
 370
 371     }
 372
 373     @Test
 374     public void testLazySubTransactionCreationForWriteOnlyTransactions() {
 375         DOMStore configDomStore = mock(DOMStore.class);
 376         DOMStore operationalDomStore = mock(DOMStore.class);
 377         DOMStoreWriteTransaction storeTxn = mock(DOMStoreWriteTransaction.class);
 378
 379         doReturn(storeTxn).when(operationalDomStore).newWriteOnlyTransaction();
 380         doReturn(storeTxn).when(configDomStore).newWriteOnlyTransaction();
 381
 382         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 383                 LogicalDatastoreType.OPERATIONAL, operationalDomStore, LogicalDatastoreType.CONFIGURATION,
 384                 configDomStore), futureExecutor)) {
 385             DOMDataTreeWriteTransaction dataTxn = dataBroker.newWriteOnlyTransaction();
 386
 387             dataTxn.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY, mock(NormalizedNode.class));
 388             dataTxn.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY, mock(NormalizedNode.class));
 389
 390             verify(configDomStore, never()).newWriteOnlyTransaction();
 391             verify(operationalDomStore, times(1)).newWriteOnlyTransaction();
 392
 393             dataTxn.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.EMPTY, mock(NormalizedNode.class));
 394
 395             verify(configDomStore, times(1)).newWriteOnlyTransaction();
 396             verify(operationalDomStore, times(1)).newWriteOnlyTransaction();
 397         }
 398     }
 399
 400     @Test
 401     public void testLazySubTransactionCreationForReadOnlyTransactions() {
 402         DOMStore configDomStore = mock(DOMStore.class);
 403         DOMStore operationalDomStore = mock(DOMStore.class);
 404         DOMStoreReadTransaction storeTxn = mock(DOMStoreReadTransaction.class);
 405
 406         doReturn(storeTxn).when(operationalDomStore).newReadOnlyTransaction();
 407         doReturn(storeTxn).when(configDomStore).newReadOnlyTransaction();
 408
 409         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 410                 LogicalDatastoreType.OPERATIONAL, operationalDomStore, LogicalDatastoreType.CONFIGURATION,
 411                 configDomStore), futureExecutor)) {
 412             DOMDataTreeReadTransaction dataTxn = dataBroker.newReadOnlyTransaction();
 413
 414             dataTxn.read(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY);
 415             dataTxn.read(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY);
 416
 417             verify(configDomStore, never()).newReadOnlyTransaction();
 418             verify(operationalDomStore, times(1)).newReadOnlyTransaction();
 419
 420             dataTxn.read(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.EMPTY);
 421
 422             verify(configDomStore, times(1)).newReadOnlyTransaction();
 423             verify(operationalDomStore, times(1)).newReadOnlyTransaction();
 424         }
 425     }
 426
 427     @Test
 428     public void testSubmitWithOnlyOneSubTransaction() throws InterruptedException {
 429         DOMStore configDomStore = mock(DOMStore.class);
 430         DOMStore operationalDomStore = mock(DOMStore.class);
 431         DOMStoreReadWriteTransaction mockStoreReadWriteTransaction = mock(DOMStoreReadWriteTransaction.class);
 432         DOMStoreThreePhaseCommitCohort mockCohort = mock(DOMStoreThreePhaseCommitCohort.class);
 433
 434         doReturn(mockStoreReadWriteTransaction).when(operationalDomStore).newReadWriteTransaction();
 435         doReturn(mockCohort).when(mockStoreReadWriteTransaction).ready();
 436         doReturn(Futures.immediateFuture(false)).when(mockCohort).canCommit();
 437         doReturn(Futures.immediateFuture(null)).when(mockCohort).abort();
 438
 439         final CountDownLatch latch = new CountDownLatch(1);
 440         final List<DOMStoreThreePhaseCommitCohort> commitCohorts = new ArrayList<>();
 441
 442         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 443                 LogicalDatastoreType.OPERATIONAL, operationalDomStore, LogicalDatastoreType.CONFIGURATION,
 444                 configDomStore), futureExecutor) {
 445             @Override
 446             public CheckedFuture<Void, TransactionCommitFailedException> submit(DOMDataTreeWriteTransaction writeTx,
 447                     Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
 448                 commitCohorts.addAll(cohorts);
 449                 latch.countDown();
 450                 return super.submit(writeTx, cohorts);
 451             }
 452         }) {
 453             DOMDataTreeReadWriteTransaction domDataReadWriteTransaction = dataBroker.newReadWriteTransaction();
 454
 455             domDataReadWriteTransaction.delete(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY);
 456
 457             domDataReadWriteTransaction.submit();
 458
 459             assertTrue(latch.await(10, TimeUnit.SECONDS));
 460
 461             assertTrue(commitCohorts.size() == 1);
 462         }
 463     }
 464
 465     @Test
 466     public void testSubmitWithOnlyTwoSubTransactions() throws InterruptedException {
 467         DOMStore configDomStore = mock(DOMStore.class);
 468         DOMStore operationalDomStore = mock(DOMStore.class);
 469         DOMStoreReadWriteTransaction operationalTransaction = mock(DOMStoreReadWriteTransaction.class);
 470         DOMStoreReadWriteTransaction configTransaction = mock(DOMStoreReadWriteTransaction.class);
 471         DOMStoreThreePhaseCommitCohort mockCohortOperational = mock(DOMStoreThreePhaseCommitCohort.class);
 472         DOMStoreThreePhaseCommitCohort mockCohortConfig = mock(DOMStoreThreePhaseCommitCohort.class);
 473
 474         doReturn(operationalTransaction).when(operationalDomStore).newReadWriteTransaction();
 475         doReturn(configTransaction).when(configDomStore).newReadWriteTransaction();
 476
 477         doReturn(mockCohortOperational).when(operationalTransaction).ready();
 478         doReturn(Futures.immediateFuture(false)).when(mockCohortOperational).canCommit();
 479         doReturn(Futures.immediateFuture(null)).when(mockCohortOperational).abort();
 480
 481         doReturn(mockCohortConfig).when(configTransaction).ready();
 482         doReturn(Futures.immediateFuture(false)).when(mockCohortConfig).canCommit();
 483         doReturn(Futures.immediateFuture(null)).when(mockCohortConfig).abort();
 484
 485         final CountDownLatch latch = new CountDownLatch(1);
 486         final List<DOMStoreThreePhaseCommitCohort> commitCohorts = new ArrayList<>();
 487
 488         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 489                 LogicalDatastoreType.OPERATIONAL, operationalDomStore, LogicalDatastoreType.CONFIGURATION,
 490                 configDomStore), futureExecutor) {
 491             @Override
 492             @SuppressWarnings("checkstyle:hiddenField")
 493             public CheckedFuture<Void, TransactionCommitFailedException> submit(DOMDataTreeWriteTransaction writeTx,
 494                     Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
 495                 commitCohorts.addAll(cohorts);
 496                 latch.countDown();
 497                 return super.submit(writeTx, cohorts);
 498             }
 499         }) {
 500             DOMDataTreeReadWriteTransaction domDataReadWriteTransaction = dataBroker.newReadWriteTransaction();
 501
 502             domDataReadWriteTransaction.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY,
 503                     mock(NormalizedNode.class));
 504             domDataReadWriteTransaction.merge(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.EMPTY,
 505                     mock(NormalizedNode.class));
 506
 507             domDataReadWriteTransaction.submit();
 508
 509             assertTrue(latch.await(10, TimeUnit.SECONDS));
 510
 511             assertTrue(commitCohorts.size() == 2);
 512         }
 513     }
 514
 515     @Test
 516     public void testCreateTransactionChain() {
 517         DOMStore domStore = mock(DOMStore.class);
 518         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 519                 LogicalDatastoreType.OPERATIONAL, domStore, LogicalDatastoreType.CONFIGURATION, domStore),
 520                 futureExecutor)) {
 521
 522             dataBroker.createTransactionChain(mock(TransactionChainListener.class));
 523
 524             verify(domStore, times(2)).createTransactionChain();
 525         }
 526
 527     }
 528
 529     @Test
 530     public void testCreateTransactionOnChain() {
 531         DOMStore domStore = mock(DOMStore.class);
 532         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 533                 LogicalDatastoreType.OPERATIONAL, domStore, LogicalDatastoreType.CONFIGURATION, domStore),
 534                 futureExecutor)) {
 535
 536             DOMStoreReadWriteTransaction operationalTransaction = mock(DOMStoreReadWriteTransaction.class);
 537             DOMStoreTransactionChain mockChain = mock(DOMStoreTransactionChain.class);
 538
 539             doReturn(mockChain).when(domStore).createTransactionChain();
 540             doReturn(operationalTransaction).when(mockChain).newWriteOnlyTransaction();
 541
 542             DOMTransactionChain transactionChain = dataBroker.createTransactionChain(
 543                     mock(TransactionChainListener.class));
 544
 545             DOMDataTreeWriteTransaction domDataWriteTransaction = transactionChain.newWriteOnlyTransaction();
 546
 547             verify(mockChain, never()).newWriteOnlyTransaction();
 548
 549             domDataWriteTransaction.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.EMPTY,
 550                     mock(NormalizedNode.class));
 551         }
 552     }
 553
 554     @Test
 555     public void testEmptyTransactionSubmitSucceeds() throws ExecutionException, InterruptedException {
 556         DOMStore domStore = mock(DOMStore.class);
 557         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 558                 LogicalDatastoreType.OPERATIONAL, domStore, LogicalDatastoreType.CONFIGURATION, domStore),
 559                 futureExecutor)) {
 560
 561             CheckedFuture<Void, TransactionCommitFailedException> submit1 =
 562                     dataBroker.newWriteOnlyTransaction().submit();
 563
 564             assertNotNull(submit1);
 565
 566             submit1.get();
 567
 568             CheckedFuture<Void, TransactionCommitFailedException> submit2 =
 569                     dataBroker.newReadWriteTransaction().submit();
 570
 571             assertNotNull(submit2);
 572
 573             submit2.get();
 574         }
 575     }
 576
 577     @Test
 578     public void testExtensions() {
 579         DistributedDataStore mockConfigStore = mock(DistributedDataStore.class);
 580         DistributedDataStore mockOperStore = mock(DistributedDataStore.class);
 581         try (ConcurrentDOMDataBroker dataBroker = new ConcurrentDOMDataBroker(ImmutableMap.of(
 582                 LogicalDatastoreType.OPERATIONAL, mockOperStore,
 583                 LogicalDatastoreType.CONFIGURATION, mockConfigStore), futureExecutor)) {
 584
 585             Map<Class<? extends DOMDataBrokerExtension>, DOMDataBrokerExtension> supportedExtensions =
 586                     dataBroker.getSupportedExtensions();
 587             assertNotNull(supportedExtensions.get(DOMDataTreeChangeService.class));
 588
 589             DOMDataTreeCommitCohortRegistry cohortRegistry =
 590                     (DOMDataTreeCommitCohortRegistry) supportedExtensions.get(DOMDataTreeCommitCohortRegistry.class);
 591             assertNotNull(cohortRegistry);
 592
 593             DOMDataTreeCommitCohort mockCohort = mock(DOMDataTreeCommitCohort.class);
 594             DOMDataTreeIdentifier path = new DOMDataTreeIdentifier(
 595                     org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION,
 596                     YangInstanceIdentifier.EMPTY);
 597             cohortRegistry.registerCommitCohort(path, mockCohort);
 598
 599             verify(mockConfigStore).registerCommitCohort(path, mockCohort);
 600         }
 601     }
 602 }