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%2FDataTreeCohortIntegrationTest.java;h=4ec8bc36657875a3fadfb68cae43df4bc5387c25;hp=21c8497db6042584aa4f03f14f4526eaf1c4baa4;hb=HEAD;hpb=5464f50be733df1bbbe31cf05665d542d3b7c5e7 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DataTreeCohortIntegrationTest.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DataTreeCohortIntegrationTest.java index 21c8497db6..7eb534c334 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DataTreeCohortIntegrationTest.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DataTreeCohortIntegrationTest.java @@ -5,53 +5,64 @@ * 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.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertSame; import static org.junit.Assert.fail; -import static org.mockito.Matchers.any; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyCollection; +import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoMoreInteractions; import akka.actor.ActorSystem; import akka.actor.Address; import akka.actor.AddressFromURIString; import akka.cluster.Cluster; -import akka.testkit.JavaTestKit; +import akka.testkit.javadsl.TestKit; import com.google.common.base.Throwables; -import com.google.common.util.concurrent.CheckedFuture; -import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.FluentFuture; import com.typesafe.config.ConfigFactory; -import java.io.IOException; +import java.util.Collection; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Ignore; import org.junit.Test; import org.mockito.ArgumentCaptor; -import org.mockito.Mockito; +import org.opendaylight.controller.cluster.databroker.ClientBackedDataStore; +import org.opendaylight.controller.md.cluster.datastore.model.CarsModel; import org.opendaylight.controller.md.cluster.datastore.model.TestModel; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; import org.opendaylight.mdsal.common.api.DataValidationFailedException; import org.opendaylight.mdsal.common.api.LogicalDatastoreType; import org.opendaylight.mdsal.common.api.PostCanCommitStep; +import org.opendaylight.mdsal.common.api.PostPreCommitStep; import org.opendaylight.mdsal.common.api.ThreePhaseCommitStep; import org.opendaylight.mdsal.dom.api.DOMDataTreeCandidate; import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort; import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier; -import org.opendaylight.yangtools.concepts.ObjectRegistration; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction; +import org.opendaylight.yangtools.util.concurrent.FluentFutures; +import org.opendaylight.yangtools.yang.common.Uint64; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.data.tree.api.ModificationType; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; public class DataTreeCohortIntegrationTest { private static final DataValidationFailedException FAILED_CAN_COMMIT = new DataValidationFailedException(YangInstanceIdentifier.class, TestModel.TEST_PATH, "Test failure."); - private static final CheckedFuture FAILED_CAN_COMMIT_FUTURE = - Futures.immediateFailedCheckedFuture(FAILED_CAN_COMMIT); + private static final FluentFuture FAILED_CAN_COMMIT_FUTURE = + FluentFutures.immediateFailedFluentFuture(FAILED_CAN_COMMIT); private static final DOMDataTreeIdentifier TEST_ID = new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, TestModel.TEST_PATH); @@ -62,15 +73,15 @@ public class DataTreeCohortIntegrationTest { DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100); @BeforeClass - public static void setUpClass() throws IOException { + public static void setUpClass() { system = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1")); - final Address member1Address = AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"); + final Address member1Address = AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"); Cluster.get(system).join(member1Address); } @AfterClass - public static void tearDownClass() throws IOException { - JavaTestKit.shutdownActorSystem(system); + public static void tearDownClass() { + TestKit.shutdownActorSystem(system); system = null; } @@ -78,99 +89,227 @@ public class DataTreeCohortIntegrationTest { return system; } + @SuppressWarnings({ "unchecked", "rawtypes" }) + @Test + public void testSuccessfulCanCommitWithNoopPostStep() throws Exception { + final var cohort = mock(DOMDataTreeCommitCohort.class); + doReturn(PostCanCommitStep.NOOP_SUCCESSFUL_FUTURE).when(cohort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + ArgumentCaptor candidateCapt = ArgumentCaptor.forClass(Collection.class); + IntegrationTestKit kit = new IntegrationTestKit(getSystem(), datastoreContextBuilder); + + try (var dataStore = kit.setupDataStore(ClientBackedDataStore.class, "testSuccessfulCanCommitWithNoopPostStep", + "test-1")) { + + final var cohortReg = dataStore.registerCommitCohort(TEST_ID, cohort); + assertNotNull(cohortReg); + + IntegrationTestKit.verifyShardState(dataStore, "test-1", + state -> assertEquals("Cohort registrations", 1, state.getCommitCohortActors().size())); + + final var node = ImmutableNodes.containerNode(TestModel.TEST_QNAME); + kit.testWriteTransaction(dataStore, TestModel.TEST_PATH, node); + verify(cohort).canCommit(any(Object.class), any(EffectiveModelContext.class), candidateCapt.capture()); + assertDataTreeCandidate((DOMDataTreeCandidate) candidateCapt.getValue().iterator().next(), TEST_ID, + ModificationType.WRITE, node, null); + + reset(cohort); + doReturn(PostCanCommitStep.NOOP_SUCCESSFUL_FUTURE).when(cohort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + + kit.testWriteTransaction(dataStore, TestModel.OUTER_LIST_PATH, + ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME) + .withChild(ImmutableNodes.mapEntry(TestModel.OUTER_LIST_QNAME, TestModel.ID_QNAME, 42)) + .build()); + verify(cohort).canCommit(any(Object.class), any(EffectiveModelContext.class), anyCollection()); + + cohortReg.close(); + + IntegrationTestKit.verifyShardState(dataStore, "test-1", + state -> assertEquals("Cohort registrations", 0, state.getCommitCohortActors().size())); + + kit.testWriteTransaction(dataStore, TestModel.TEST_PATH, node); + verifyNoMoreInteractions(cohort); + } + } + @Test - public void registerNoopCohortTest() throws Exception { - final DOMDataTreeCommitCohort cohort = mock(DOMDataTreeCommitCohort.class); - Mockito.doReturn(PostCanCommitStep.NOOP_SUCCESS_FUTURE).when(cohort).canCommit(any(Object.class), - any(DOMDataTreeCandidate.class), any(SchemaContext.class)); - ArgumentCaptor candidateCapt = ArgumentCaptor.forClass(DOMDataTreeCandidate.class); - new IntegrationTestKit(getSystem(), datastoreContextBuilder) { - { - try (final DistributedDataStore dataStore = setupDistributedDataStore("transactionIntegrationTest", - "test-1")) { - final ObjectRegistration cohortReg = - dataStore.registerCommitCohort(TEST_ID, cohort); - Thread.sleep(1000); // Registration is asynchronous - assertNotNull(cohortReg); - testWriteTransaction(dataStore, TestModel.TEST_PATH, - ImmutableNodes.containerNode(TestModel.TEST_QNAME)); - Mockito.verify(cohort).canCommit(any(Object.class), candidateCapt.capture(), - any(SchemaContext.class)); - DOMDataTreeCandidate candidate = candidateCapt.getValue(); - assertNotNull(candidate); - assertEquals(TEST_ID, candidate.getRootPath()); - testWriteTransaction(dataStore, TestModel.OUTER_LIST_PATH, - ImmutableNodes.mapNodeBuilder(TestModel.OUTER_LIST_QNAME).build()); - Mockito.verify(cohort, Mockito.times(2)).canCommit(any(Object.class), - any(DOMDataTreeCandidate.class), any(SchemaContext.class)); - cohortReg.close(); - testWriteTransaction(dataStore, TestModel.TEST_PATH, - ImmutableNodes.containerNode(TestModel.TEST_QNAME)); - Mockito.verifyNoMoreInteractions(cohort); - } + public void testFailedCanCommit() throws Exception { + final var failedCohort = mock(DOMDataTreeCommitCohort.class); + + doReturn(FAILED_CAN_COMMIT_FUTURE).when(failedCohort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + + final var kit = new IntegrationTestKit(getSystem(), datastoreContextBuilder); + try (var dataStore = kit.setupDataStore(ClientBackedDataStore.class, "testFailedCanCommit", "test-1")) { + dataStore.registerCommitCohort(TEST_ID, failedCohort); + + IntegrationTestKit.verifyShardState(dataStore, "test-1", + state -> assertEquals("Cohort registrations", 1, state.getCommitCohortActors().size())); + + DOMStoreWriteTransaction writeTx = dataStore.newWriteOnlyTransaction(); + writeTx.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME)); + DOMStoreThreePhaseCommitCohort dsCohort = writeTx.ready(); + try { + dsCohort.canCommit().get(5, TimeUnit.SECONDS); + fail("Exception should be raised."); + } catch (ExecutionException e) { + assertSame(FAILED_CAN_COMMIT, Throwables.getRootCause(e)); } - }; + } } + @SuppressWarnings({ "unchecked", "rawtypes" }) @Test - @SuppressWarnings("checkstyle:IllegalCatch") - public void failCanCommitTest() throws Exception { - final DOMDataTreeCommitCohort failedCohort = mock(DOMDataTreeCommitCohort.class); - - Mockito.doReturn(FAILED_CAN_COMMIT_FUTURE).when(failedCohort).canCommit(any(Object.class), - any(DOMDataTreeCandidate.class), any(SchemaContext.class)); - - new IntegrationTestKit(getSystem(), datastoreContextBuilder) { - { - try (final DistributedDataStore dataStore = - setupDistributedDataStore("transactionIntegrationTest", "test-1")) { - dataStore.registerCommitCohort(TEST_ID, failedCohort); - Thread.sleep(1000); // Registration is asynchronous - - DOMStoreWriteTransaction writeTx = dataStore.newWriteOnlyTransaction(); - writeTx.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME)); - DOMStoreThreePhaseCommitCohort dsCohort = writeTx.ready(); - try { - // FIXME: Weird thing is that invoking canCommit on front-end invokes also - // preCommit on backend. - dsCohort.canCommit().get(); - fail("Exception should be raised."); - } catch (Exception e) { - assertSame(FAILED_CAN_COMMIT, Throwables.getRootCause(e)); - } - } + public void testCanCommitWithListEntries() throws Exception { + final var cohort = mock(DOMDataTreeCommitCohort.class); + doReturn(PostCanCommitStep.NOOP_SUCCESSFUL_FUTURE).when(cohort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + final var kit = new IntegrationTestKit(getSystem(), datastoreContextBuilder); + + try (var dataStore = kit.setupDataStore(ClientBackedDataStore.class, "testCanCommitWithMultipleListEntries", + "cars-1")) { + + final var cohortReg = dataStore.registerCommitCohort( + new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, CarsModel.CAR_LIST_PATH + .node(CarsModel.CAR_QNAME)), cohort); + assertNotNull(cohortReg); + + IntegrationTestKit.verifyShardState(dataStore, "cars-1", + state -> assertEquals("Cohort registrations", 1, state.getCommitCohortActors().size())); + + // First write an empty base container and verify the cohort isn't invoked. + + DOMStoreWriteTransaction writeTx = dataStore.newWriteOnlyTransaction(); + writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer()); + writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()); + kit.doCommit(writeTx.ready()); + verifyNoMoreInteractions(cohort); + + // Write a single car entry and verify the cohort is invoked. + + writeTx = dataStore.newWriteOnlyTransaction(); + final YangInstanceIdentifier optimaPath = CarsModel.newCarPath("optima"); + final MapEntryNode optimaNode = CarsModel.newCarEntry("optima", Uint64.valueOf(20000)); + writeTx.write(optimaPath, optimaNode); + kit.doCommit(writeTx.ready()); + + ArgumentCaptor candidateCapture = ArgumentCaptor.forClass(Collection.class); + verify(cohort).canCommit(any(Object.class), any(EffectiveModelContext.class), candidateCapture.capture()); + assertDataTreeCandidate((DOMDataTreeCandidate) candidateCapture.getValue().iterator().next(), + new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, optimaPath), ModificationType.WRITE, + optimaNode, null); + + // Write replace the cars container with 2 new car entries. The cohort should get invoked with 3 + // DOMDataTreeCandidates: once for each of the 2 new car entries (WRITE mod) and once for the deleted prior + // car entry (DELETE mod). + + reset(cohort); + doReturn(PostCanCommitStep.NOOP_SUCCESSFUL_FUTURE).when(cohort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + + writeTx = dataStore.newWriteOnlyTransaction(); + final YangInstanceIdentifier sportagePath = CarsModel.newCarPath("sportage"); + final MapEntryNode sportageNode = CarsModel.newCarEntry("sportage", Uint64.valueOf(20000)); + final YangInstanceIdentifier soulPath = CarsModel.newCarPath("soul"); + final MapEntryNode soulNode = CarsModel.newCarEntry("soul", Uint64.valueOf(20000)); + writeTx.write(CarsModel.BASE_PATH, CarsModel.newCarsNode(CarsModel.newCarsMapNode(sportageNode,soulNode))); + kit.doCommit(writeTx.ready()); + + candidateCapture = ArgumentCaptor.forClass(Collection.class); + verify(cohort).canCommit(any(Object.class), any(EffectiveModelContext.class), candidateCapture.capture()); + + assertDataTreeCandidate(findCandidate(candidateCapture, sportagePath), new DOMDataTreeIdentifier( + LogicalDatastoreType.CONFIGURATION, sportagePath), ModificationType.WRITE, + sportageNode, null); + + assertDataTreeCandidate(findCandidate(candidateCapture, soulPath), new DOMDataTreeIdentifier( + LogicalDatastoreType.CONFIGURATION, soulPath), ModificationType.WRITE, + soulNode, null); + + assertDataTreeCandidate(findCandidate(candidateCapture, optimaPath), new DOMDataTreeIdentifier( + LogicalDatastoreType.CONFIGURATION, optimaPath), ModificationType.DELETE, + null, optimaNode); + + // Delete the cars container - cohort should be invoked for the 2 deleted car entries. + + reset(cohort); + doReturn(PostCanCommitStep.NOOP_SUCCESSFUL_FUTURE).when(cohort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + + writeTx = dataStore.newWriteOnlyTransaction(); + writeTx.delete(CarsModel.BASE_PATH); + kit.doCommit(writeTx.ready()); + + candidateCapture = ArgumentCaptor.forClass(Collection.class); + verify(cohort).canCommit(any(Object.class), any(EffectiveModelContext.class), candidateCapture.capture()); + + assertDataTreeCandidate(findCandidate(candidateCapture, sportagePath), new DOMDataTreeIdentifier( + LogicalDatastoreType.CONFIGURATION, sportagePath), ModificationType.DELETE, + null, sportageNode); + + assertDataTreeCandidate(findCandidate(candidateCapture, soulPath), new DOMDataTreeIdentifier( + LogicalDatastoreType.CONFIGURATION, soulPath), ModificationType.DELETE, + null, soulNode); + + } + } + + @SuppressWarnings("rawtypes") + private static DOMDataTreeCandidate findCandidate(final ArgumentCaptor candidateCapture, + final YangInstanceIdentifier rootPath) { + for (Object obj: candidateCapture.getValue()) { + DOMDataTreeCandidate candidate = (DOMDataTreeCandidate)obj; + if (rootPath.equals(candidate.getRootPath().getRootIdentifier())) { + return candidate; } - }; + } + + return null; } /** - * FIXME: Weird thing is that invoking canCommit on front-end invokes also preCommit on backend - * so we can not test abort after can commit. + * FIXME: Since we invoke DOMDataTreeCommitCohort#canCommit on preCommit (as that's when we generate a + * DataTreeCandidate) and since currently preCommit is a noop in the Shard backend (it is combined with commit), + * we can't actually test abort after canCommit. */ @Test @Ignore - public void canCommitSuccessExternallyAborted() throws Exception { - final DOMDataTreeCommitCohort cohortToAbort = mock(DOMDataTreeCommitCohort.class); - final PostCanCommitStep stepToAbort = mock(PostCanCommitStep.class); - Mockito.doReturn(Futures.immediateCheckedFuture(stepToAbort)).when(cohortToAbort).canCommit(any(Object.class), - any(DOMDataTreeCandidate.class), any(SchemaContext.class)); - Mockito.doReturn(ThreePhaseCommitStep.NOOP_ABORT_FUTURE).when(stepToAbort).abort(); - new IntegrationTestKit(getSystem(), datastoreContextBuilder) { - { - try (final DistributedDataStore dataStore = - setupDistributedDataStore("transactionIntegrationTest", "test-1")) { - dataStore.registerCommitCohort(TEST_ID, cohortToAbort); - Thread.sleep(1000); // Registration is asynchronous - - DOMStoreWriteTransaction writeTx = dataStore.newWriteOnlyTransaction(); - writeTx.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME)); - DOMStoreThreePhaseCommitCohort dsCohort = writeTx.ready(); - - dsCohort.canCommit().get(); - dsCohort.abort().get(); - Mockito.verify(stepToAbort, Mockito.times(1)).abort(); - } - } - }; + public void testAbortAfterCanCommit() throws Exception { + final var cohortToAbort = mock(DOMDataTreeCommitCohort.class); + final var stepToAbort = mock(PostCanCommitStep.class); + doReturn(ThreePhaseCommitStep.NOOP_ABORT_FUTURE).when(stepToAbort).abort(); + doReturn(PostPreCommitStep.NOOP_FUTURE).when(stepToAbort).preCommit(); + doReturn(FluentFutures.immediateFluentFuture(stepToAbort)).when(cohortToAbort).canCommit(any(Object.class), + any(EffectiveModelContext.class), anyCollection()); + + var kit = new IntegrationTestKit(getSystem(), datastoreContextBuilder); + try (var dataStore = kit.setupDataStore(ClientBackedDataStore.class, "testAbortAfterCanCommit", + "test-1", "cars-1")) { + dataStore.registerCommitCohort(TEST_ID, cohortToAbort); + + IntegrationTestKit.verifyShardState(dataStore, "test-1", + state -> assertEquals("Cohort registrations", 1, state.getCommitCohortActors().size())); + + var writeTx = dataStore.newWriteOnlyTransaction(); + writeTx.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME)); + writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer()); + var dsCohort = writeTx.ready(); + + dsCohort.canCommit().get(5, TimeUnit.SECONDS); + dsCohort.preCommit().get(5, TimeUnit.SECONDS); + dsCohort.abort().get(5, TimeUnit.SECONDS); + verify(stepToAbort).abort(); + } + } + + private static void assertDataTreeCandidate(final DOMDataTreeCandidate candidate, + final DOMDataTreeIdentifier expTreeId, final ModificationType expType, + final NormalizedNode expDataAfter, final NormalizedNode expDataBefore) { + assertNotNull("Expected candidate for path " + expTreeId.getRootIdentifier(), candidate); + assertEquals("rootPath", expTreeId, candidate.getRootPath()); + assertEquals("modificationType", expType, candidate.getRootNode().modificationType()); + assertEquals("dataAfter", expDataAfter, candidate.getRootNode().dataAfter()); + assertEquals("dataBefore", expDataBefore, candidate.getRootNode().dataBefore()); } }