X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FTransactionChainProxyTest.java;h=e4ad8fd054c8d808afaabe68836592fbf38abbd7;hp=23c3a82a38255e9bfff2708583c4370ccb6ccf9a;hb=2fd1fa721510a30f58b3bc277deb05fce58badd6;hpb=03cbc1c8d5e08fd1f3001f8d0c30c6348c8c5778 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/TransactionChainProxyTest.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/TransactionChainProxyTest.java index 23c3a82a38..e4ad8fd054 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/TransactionChainProxyTest.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/TransactionChainProxyTest.java @@ -1,117 +1,272 @@ /* + * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved. * - * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.controller.cluster.datastore; -import static org.mockito.Matchers.anyObject; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.ArgumentMatchers.isA; import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.timeout; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; +import static org.opendaylight.controller.cluster.datastore.TransactionType.READ_WRITE; +import static org.opendaylight.controller.cluster.datastore.TransactionType.WRITE_ONLY; + +import akka.actor.ActorRef; +import akka.util.Timeout; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.Function; import org.junit.Assert; -import org.junit.Before; import org.junit.Test; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; -import org.opendaylight.controller.cluster.datastore.utils.ActorContext; -import org.opendaylight.controller.cluster.datastore.utils.MockActorContext; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; - -public class TransactionChainProxyTest extends AbstractActorTest{ - ActorContext actorContext = null; - SchemaContext schemaContext = mock(SchemaContext.class); - - @Mock - ActorContext mockActorContext; - - @Before - public void setUp() { - MockitoAnnotations.initMocks(this); +import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier; +import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications; +import org.opendaylight.controller.cluster.datastore.modification.WriteModification; +import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy; +import org.opendaylight.controller.md.cluster.datastore.model.TestModel; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransaction; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; +import scala.concurrent.Promise; - actorContext = new MockActorContext(getSystem()); - actorContext.setSchemaContext(schemaContext); +public class TransactionChainProxyTest extends AbstractTransactionProxyTest { + private LocalHistoryIdentifier historyId; - doReturn(schemaContext).when(mockActorContext).getSchemaContext(); + @Override + public void setUp() { + super.setUp(); + historyId = MockIdentifiers.historyIdentifier(TransactionChainProxyTest.class, memberName); } @SuppressWarnings("resource") @Test - public void testNewReadOnlyTransaction() throws Exception { + public void testNewReadOnlyTransaction() { - DOMStoreTransaction dst = new TransactionChainProxy(actorContext).newReadOnlyTransaction(); - Assert.assertTrue(dst instanceof DOMStoreReadTransaction); + DOMStoreTransaction dst = new TransactionChainProxy(mockComponentFactory, historyId).newReadOnlyTransaction(); + Assert.assertTrue(dst instanceof DOMStoreReadTransaction); } @SuppressWarnings("resource") @Test - public void testNewReadWriteTransaction() throws Exception { - DOMStoreTransaction dst = new TransactionChainProxy(actorContext).newReadWriteTransaction(); + public void testNewReadWriteTransaction() { + DOMStoreTransaction dst = new TransactionChainProxy(mockComponentFactory, historyId).newReadWriteTransaction(); Assert.assertTrue(dst instanceof DOMStoreReadWriteTransaction); } @SuppressWarnings("resource") @Test - public void testNewWriteOnlyTransaction() throws Exception { - DOMStoreTransaction dst = new TransactionChainProxy(actorContext).newWriteOnlyTransaction(); + public void testNewWriteOnlyTransaction() { + DOMStoreTransaction dst = new TransactionChainProxy(mockComponentFactory, historyId).newWriteOnlyTransaction(); Assert.assertTrue(dst instanceof DOMStoreWriteTransaction); } + @SuppressWarnings("unchecked") @Test - public void testClose() throws Exception { - ActorContext context = mock(ActorContext.class); - - new TransactionChainProxy(context).close(); + public void testClose() { + new TransactionChainProxy(mockComponentFactory, historyId).close(); - verify(context, times(1)).broadcast(anyObject()); + verify(mockActorContext, times(1)).broadcast(any(Function.class), any(Class.class)); } @Test - public void testTransactionChainsHaveUniqueId(){ - TransactionChainProxy one = new TransactionChainProxy(mock(ActorContext.class)); - TransactionChainProxy two = new TransactionChainProxy(mock(ActorContext.class)); + public void testRateLimitingUsedInReadWriteTxCreation() { + try (TransactionChainProxy txChainProxy = new TransactionChainProxy(mockComponentFactory, historyId)) { + + txChainProxy.newReadWriteTransaction(); - Assert.assertNotEquals(one.getTransactionChainId(), two.getTransactionChainId()); + verify(mockActorContext, times(1)).acquireTxCreationPermit(); + } } @Test - public void testRateLimitingUsedInReadWriteTxCreation(){ - TransactionChainProxy txChainProxy = new TransactionChainProxy(mockActorContext); + public void testRateLimitingUsedInWriteOnlyTxCreation() { + try (TransactionChainProxy txChainProxy = new TransactionChainProxy(mockComponentFactory, historyId)) { - txChainProxy.newReadWriteTransaction(); + txChainProxy.newWriteOnlyTransaction(); - verify(mockActorContext, times(1)).acquireTxCreationPermit(); + verify(mockActorContext, times(1)).acquireTxCreationPermit(); + } } @Test - public void testRateLimitingUsedInWriteOnlyTxCreation(){ - TransactionChainProxy txChainProxy = new TransactionChainProxy(mockActorContext); + public void testRateLimitingNotUsedInReadOnlyTxCreation() { + try (TransactionChainProxy txChainProxy = new TransactionChainProxy(mockComponentFactory, historyId)) { - txChainProxy.newWriteOnlyTransaction(); + txChainProxy.newReadOnlyTransaction(); - verify(mockActorContext, times(1)).acquireTxCreationPermit(); + verify(mockActorContext, times(0)).acquireTxCreationPermit(); + } } + /** + * Tests 2 successive chained write-only transactions and verifies the second transaction isn't + * initiated until the first one completes its read future. + */ + @Test + @SuppressWarnings("checkstyle:IllegalCatch") + public void testChainedWriteOnlyTransactions() throws Exception { + dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true); + + try (TransactionChainProxy txChainProxy = new TransactionChainProxy(mockComponentFactory, historyId)) { + + ActorRef txActorRef1 = setupActorContextWithoutInitialCreateTransaction(getSystem()); + + Promise batchedReplyPromise1 = akka.dispatch.Futures.promise(); + doReturn(batchedReplyPromise1.future()).when(mockActorContext).executeOperationAsync( + eq(actorSelection(txActorRef1)), isA(BatchedModifications.class), any(Timeout.class)); + + DOMStoreWriteTransaction writeTx1 = txChainProxy.newWriteOnlyTransaction(); + + NormalizedNode writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME); + writeTx1.write(TestModel.TEST_PATH, writeNode1); + + writeTx1.ready(); + + verify(mockActorContext, times(1)).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD)); + + verifyOneBatchedModification(txActorRef1, new WriteModification(TestModel.TEST_PATH, writeNode1), true); + + ActorRef txActorRef2 = setupActorContextWithoutInitialCreateTransaction(getSystem()); + + expectBatchedModifications(txActorRef2, 1); + + final NormalizedNode writeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME); + + final DOMStoreWriteTransaction writeTx2 = txChainProxy.newWriteOnlyTransaction(); + + final AtomicReference caughtEx = new AtomicReference<>(); + final CountDownLatch write2Complete = new CountDownLatch(1); + new Thread(() -> { + try { + writeTx2.write(TestModel.OUTER_LIST_PATH, writeNode2); + } catch (Exception e) { + caughtEx.set(e); + } finally { + write2Complete.countDown(); + } + }).start(); + + assertTrue("Tx 2 write should've completed", write2Complete.await(5, TimeUnit.SECONDS)); + + if (caughtEx.get() != null) { + throw caughtEx.get(); + } + + try { + verify(mockActorContext, times(1)).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD)); + } catch (AssertionError e) { + fail("Tx 2 should not have initiated until the Tx 1's ready future completed"); + } + + batchedReplyPromise1.success(readyTxReply(txActorRef1.path().toString()).value().get().get()); + // Tx 2 should've proceeded to find the primary shard. + verify(mockActorContext, timeout(5000).times(2)).findPrimaryShardAsync( + eq(DefaultShardStrategy.DEFAULT_SHARD)); + } + } + + /** + * Tests 2 successive chained read-write transactions and verifies the second transaction isn't + * initiated until the first one completes its read future. + */ @Test - public void testRateLimitingNotUsedInReadOnlyTxCreation(){ - TransactionChainProxy txChainProxy = new TransactionChainProxy(mockActorContext); + @SuppressWarnings("checkstyle:IllegalCatch") + public void testChainedReadWriteTransactions() throws Exception { + try (TransactionChainProxy txChainProxy = new TransactionChainProxy(mockComponentFactory, historyId)) { + + ActorRef txActorRef1 = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE); + + expectBatchedModifications(txActorRef1, 1); + + Promise readyReplyPromise1 = akka.dispatch.Futures.promise(); + doReturn(readyReplyPromise1.future()).when(mockActorContext).executeOperationAsync( + eq(actorSelection(txActorRef1)), isA(BatchedModifications.class), any(Timeout.class)); + + DOMStoreWriteTransaction writeTx1 = txChainProxy.newReadWriteTransaction(); + + NormalizedNode writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME); + writeTx1.write(TestModel.TEST_PATH, writeNode1); + + writeTx1.ready(); + + verifyOneBatchedModification(txActorRef1, new WriteModification(TestModel.TEST_PATH, writeNode1), true); + + String tx2MemberName = "mock-member"; + ActorRef shardActorRef2 = setupActorContextWithoutInitialCreateTransaction(getSystem()); + ActorRef txActorRef2 = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE, + DataStoreVersions.CURRENT_VERSION, tx2MemberName, shardActorRef2); + + expectBatchedModifications(txActorRef2, 1); + + final NormalizedNode writeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME); + + final DOMStoreWriteTransaction writeTx2 = txChainProxy.newReadWriteTransaction(); + + final AtomicReference caughtEx = new AtomicReference<>(); + final CountDownLatch write2Complete = new CountDownLatch(1); + new Thread(() -> { + try { + writeTx2.write(TestModel.OUTER_LIST_PATH, writeNode2); + } catch (Exception e) { + caughtEx.set(e); + } finally { + write2Complete.countDown(); + } + }).start(); + + assertTrue("Tx 2 write should've completed", write2Complete.await(5, TimeUnit.SECONDS)); + + if (caughtEx.get() != null) { + throw caughtEx.get(); + } + + try { + verify(mockActorContext, never()).executeOperationAsync( + eq(getSystem().actorSelection(shardActorRef2.path())), + eqCreateTransaction(tx2MemberName, READ_WRITE)); + } catch (AssertionError e) { + fail("Tx 2 should not have initiated until the Tx 1's ready future completed"); + } + + readyReplyPromise1.success(readyTxReply(txActorRef1.path().toString()).value().get().get()); + + verify(mockActorContext, timeout(5000)).executeOperationAsync( + eq(getSystem().actorSelection(shardActorRef2.path())), + eqCreateTransaction(tx2MemberName, READ_WRITE), any(Timeout.class)); + } + } + + @Test(expected = IllegalStateException.class) + public void testChainedWriteTransactionsWithPreviousTxNotReady() { + ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY); + + expectBatchedModifications(actorRef, 1); + + try (TransactionChainProxy txChainProxy = new TransactionChainProxy(mockComponentFactory, historyId)) { + + DOMStoreWriteTransaction writeTx1 = txChainProxy.newWriteOnlyTransaction(); - txChainProxy.newReadOnlyTransaction(); + NormalizedNode writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME); + writeTx1.write(TestModel.TEST_PATH, writeNode1); - verify(mockActorContext, times(0)).acquireTxCreationPermit(); + txChainProxy.newWriteOnlyTransaction(); + } } }