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%2FIntegrationTestKit.java;h=72cfdceeeaff415dd86d189bef84dae0b33ed207;hp=9cc6d838c8c547a59384b97a63ea36fbb26e1909;hb=8fb36ccaa52066b016e648ef75d6e652fd47d990;hpb=769ef0f950f2ed6cfc14d274e6a8edc583a36a96 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/IntegrationTestKit.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/IntegrationTestKit.java index 9cc6d838c8..72cfdceeea 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/IntegrationTestKit.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/IntegrationTestKit.java @@ -9,118 +9,326 @@ package org.opendaylight.controller.cluster.datastore; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertThrows; import static org.junit.Assert.fail; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; + import akka.actor.ActorRef; import akka.actor.ActorSystem; -import akka.actor.PoisonPill; -import com.google.common.base.Optional; +import akka.cluster.Cluster; +import akka.cluster.ClusterEvent.CurrentClusterState; +import akka.cluster.Member; +import akka.cluster.MemberStatus; +import com.google.common.base.Stopwatch; +import com.google.common.collect.Sets; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.Uninterruptibles; -import java.util.concurrent.Callable; +import java.lang.reflect.Constructor; +import java.util.Optional; +import java.util.Set; import java.util.concurrent.TimeUnit; -import org.mockito.Mockito; +import java.util.function.Consumer; +import org.opendaylight.controller.cluster.databroker.ClientBackedDataStore; import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder; import org.opendaylight.controller.cluster.datastore.config.Configuration; import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl; -import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot; -import org.opendaylight.controller.cluster.datastore.utils.ActorContext; +import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider; +import org.opendaylight.controller.cluster.datastore.messages.OnDemandShardState; +import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot; +import org.opendaylight.controller.cluster.datastore.utils.ActorUtils; +import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState; import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; +import org.opendaylight.mdsal.common.api.LogicalDatastoreType; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import scala.concurrent.Await; +import scala.concurrent.Future; +import scala.concurrent.duration.FiniteDuration; public class IntegrationTestKit extends ShardTestKit { + private static final Logger LOG = LoggerFactory.getLogger(IntegrationTestKit.class); + protected DatastoreContext.Builder datastoreContextBuilder; protected DatastoreSnapshot restoreFromSnapshot; + private final int commitTimeout; - public IntegrationTestKit(ActorSystem actorSystem, Builder datastoreContextBuilder) { + public IntegrationTestKit(final ActorSystem actorSystem, final Builder datastoreContextBuilder) { + this(actorSystem, datastoreContextBuilder, 7); + } + + public IntegrationTestKit(final ActorSystem actorSystem, final Builder datastoreContextBuilder, + final int commitTimeout) { super(actorSystem); this.datastoreContextBuilder = datastoreContextBuilder; + this.commitTimeout = commitTimeout; } public DatastoreContext.Builder getDatastoreContextBuilder() { return datastoreContextBuilder; } - public DistributedDataStore setupDistributedDataStore(String typeName, String... shardNames) { - return setupDistributedDataStore(typeName, "module-shards.conf", true, SchemaContextHelper.full(), shardNames); + public DistributedDataStore setupDistributedDataStore(final String typeName, final String moduleShardsConfig, + final boolean waitUntilLeader, + final EffectiveModelContext schemaContext) throws Exception { + return setupDistributedDataStore(typeName, moduleShardsConfig, "modules.conf", waitUntilLeader, schemaContext); + } + + public DistributedDataStore setupDistributedDataStore(final String typeName, final String moduleShardsConfig, + final String modulesConfig, + final boolean waitUntilLeader, + final EffectiveModelContext schemaContext, + final String... shardNames) throws Exception { + return (DistributedDataStore) setupAbstractDataStore(DistributedDataStore.class, typeName, moduleShardsConfig, + modulesConfig, waitUntilLeader, schemaContext, shardNames); } - public DistributedDataStore setupDistributedDataStore(String typeName, boolean waitUntilLeader, - String... shardNames) { - return setupDistributedDataStore(typeName, "module-shards.conf", waitUntilLeader, + public AbstractDataStore setupAbstractDataStore(final Class implementation, + final String typeName, final String... shardNames) + throws Exception { + return setupAbstractDataStore(implementation, typeName, "module-shards.conf", true, SchemaContextHelper.full(), shardNames); } - public DistributedDataStore setupDistributedDataStore(String typeName, String moduleShardsConfig, - boolean waitUntilLeader, String... shardNames) { - return setupDistributedDataStore(typeName, moduleShardsConfig, waitUntilLeader, + public AbstractDataStore setupAbstractDataStore(final Class implementation, + final String typeName, final boolean waitUntilLeader, + final String... shardNames) throws Exception { + return setupAbstractDataStore(implementation, typeName, "module-shards.conf", waitUntilLeader, SchemaContextHelper.full(), shardNames); } - public DistributedDataStore setupDistributedDataStore(String typeName, String moduleShardsConfig, - boolean waitUntilLeader, SchemaContext schemaContext, String... shardNames) { - ClusterWrapper cluster = new ClusterWrapperImpl(getSystem()); - Configuration config = new ConfigurationImpl(moduleShardsConfig, "modules.conf"); + public AbstractDataStore setupAbstractDataStore(final Class implementation, + final String typeName, final String moduleShardsConfig, + final boolean waitUntilLeader, final String... shardNames) + throws Exception { + return setupAbstractDataStore(implementation, typeName, moduleShardsConfig, waitUntilLeader, + SchemaContextHelper.full(), shardNames); + } - datastoreContextBuilder.dataStoreType(typeName); + public AbstractDataStore setupAbstractDataStore(final Class implementation, + final String typeName, final String moduleShardsConfig, + final boolean waitUntilLeader, + final EffectiveModelContext schemaContext, + final String... shardNames) throws Exception { + return setupAbstractDataStore(implementation, typeName, moduleShardsConfig, "modules.conf", waitUntilLeader, + schemaContext, shardNames); + } + + private AbstractDataStore setupAbstractDataStore(final Class implementation, + final String typeName, final String moduleShardsConfig, + final String modulesConfig, final boolean waitUntilLeader, + final EffectiveModelContext schemaContext, + final String... shardNames) + throws Exception { + final ClusterWrapper cluster = new ClusterWrapperImpl(getSystem()); + final Configuration config = new ConfigurationImpl(moduleShardsConfig, modulesConfig); + + setDataStoreName(typeName); + + // Make sure we set up datastore context correctly + datastoreContextBuilder.useTellBasedProtocol(ClientBackedDataStore.class.isAssignableFrom(implementation)); - DatastoreContext datastoreContext = datastoreContextBuilder.build(); - DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class); - Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext(); - Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString()); + final DatastoreContext datastoreContext = datastoreContextBuilder.build(); + final DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class); + doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext(); + doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(anyString()); - DistributedDataStore dataStore = new DistributedDataStore(getSystem(), cluster, config, mockContextFactory, - restoreFromSnapshot); + final Constructor constructor = implementation.getDeclaredConstructor( + ActorSystem.class, ClusterWrapper.class, Configuration.class, + DatastoreContextFactory.class, DatastoreSnapshot.class); + + final AbstractDataStore dataStore = constructor.newInstance(getSystem(), cluster, config, mockContextFactory, + restoreFromSnapshot); + + dataStore.onModelContextUpdated(schemaContext); + + if (waitUntilLeader) { + waitUntilLeader(dataStore.getActorUtils(), shardNames); + } - dataStore.onGlobalContextUpdated(schemaContext); + datastoreContextBuilder = DatastoreContext.newBuilderFrom(datastoreContext); + return dataStore; + } - if(waitUntilLeader) { - waitUntilLeader(dataStore.getActorContext(), shardNames); + private void setDataStoreName(final String typeName) { + if ("config".equals(typeName)) { + datastoreContextBuilder.logicalStoreType(LogicalDatastoreType.CONFIGURATION); + } else if ("operational".equals(typeName)) { + datastoreContextBuilder.logicalStoreType(LogicalDatastoreType.OPERATIONAL); + } else { + datastoreContextBuilder.dataStoreName(typeName); } + } + + public DistributedDataStore setupDistributedDataStoreWithoutConfig(final String typeName, + final EffectiveModelContext schemaContext) { + final ClusterWrapper cluster = new ClusterWrapperImpl(getSystem()); + final ConfigurationImpl configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()); + + setDataStoreName(typeName); + + final DatastoreContext datastoreContext = getDatastoreContextBuilder().build(); + + final DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class); + doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext(); + doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(anyString()); + + final DistributedDataStore dataStore = new DistributedDataStore(getSystem(), cluster, + configuration, mockContextFactory, restoreFromSnapshot); + + dataStore.onModelContextUpdated(schemaContext); datastoreContextBuilder = DatastoreContext.newBuilderFrom(datastoreContext); return dataStore; } - public void waitUntilLeader(ActorContext actorContext, String... shardNames) { - for(String shardName: shardNames) { - ActorRef shard = findLocalShard(actorContext, shardName); + public DistributedDataStore setupDistributedDataStoreWithoutConfig(final String typeName, + final EffectiveModelContext schemaContext, + final LogicalDatastoreType storeType) { + final ClusterWrapper cluster = new ClusterWrapperImpl(getSystem()); + final ConfigurationImpl configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()); + + setDataStoreName(typeName); + + final DatastoreContext datastoreContext = + getDatastoreContextBuilder().logicalStoreType(storeType).build(); + + final DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class); + doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext(); + doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(anyString()); + + final DistributedDataStore dataStore = new DistributedDataStore(getSystem(), cluster, + configuration, mockContextFactory, restoreFromSnapshot); + + dataStore.onModelContextUpdated(schemaContext); + + datastoreContextBuilder = DatastoreContext.newBuilderFrom(datastoreContext); + return dataStore; + } - assertNotNull("Shard was not created", shard); + public void waitUntilLeader(final ActorUtils actorUtils, final String... shardNames) { + for (String shardName: shardNames) { + ActorRef shard = findLocalShard(actorUtils, shardName); + + assertNotNull("Shard was not created for " + shardName, shard); waitUntilLeader(shard); } } - public void waitUntilNoLeader(ActorContext actorContext, String... shardNames) { - for(String shardName: shardNames) { - ActorRef shard = findLocalShard(actorContext, shardName); - assertNotNull("No local shard found", shard); + public void waitUntilNoLeader(final ActorUtils actorUtils, final String... shardNames) { + for (String shardName: shardNames) { + ActorRef shard = findLocalShard(actorUtils, shardName); + assertNotNull("No local shard found for " + shardName, shard); waitUntilNoLeader(shard); } } - private static ActorRef findLocalShard(ActorContext actorContext, String shardName) { + public void waitForMembersUp(final String... otherMembers) { + Set otherMembersSet = Sets.newHashSet(otherMembers); + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.SECONDS) <= 10) { + CurrentClusterState state = Cluster.get(getSystem()).state(); + for (Member m: state.getMembers()) { + if (m.status() == MemberStatus.up() && otherMembersSet.remove(m.getRoles().iterator().next()) + && otherMembersSet.isEmpty()) { + return; + } + } + + Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS); + } + + fail("Member(s) " + otherMembersSet + " are not Up"); + } + + public static ActorRef findLocalShard(final ActorUtils actorUtils, final String shardName) { ActorRef shard = null; - for(int i = 0; i < 20 * 5 && shard == null; i++) { + for (int i = 0; i < 20 * 5 && shard == null; i++) { Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS); - Optional shardReply = actorContext.findLocalShard(shardName); - if(shardReply.isPresent()) { + Optional shardReply = actorUtils.findLocalShard(shardName); + if (shardReply.isPresent()) { shard = shardReply.get(); } } return shard; } - void testWriteTransaction(DistributedDataStore dataStore, YangInstanceIdentifier nodePath, - NormalizedNode nodeToWrite) throws Exception { + public static void waitUntilShardIsDown(final ActorUtils actorUtils, final String shardName) { + for (int i = 0; i < 20 * 5 ; i++) { + LOG.debug("Waiting for shard down {}", shardName); + Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS); + Optional shardReply = actorUtils.findLocalShard(shardName); + if (!shardReply.isPresent()) { + return; + } + } + + throw new IllegalStateException("Shard[" + shardName + " did not shutdown in time"); + } + + public static void verifyShardStats(final AbstractDataStore datastore, final String shardName, + final ShardStatsVerifier verifier) throws Exception { + ActorUtils actorUtils = datastore.getActorUtils(); + + Future future = actorUtils.findLocalShardAsync(shardName); + ActorRef shardActor = Await.result(future, FiniteDuration.create(10, TimeUnit.SECONDS)); + + AssertionError lastError = null; + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.SECONDS) <= 5) { + ShardStats shardStats = (ShardStats)actorUtils + .executeOperation(shardActor, Shard.GET_SHARD_MBEAN_MESSAGE); + + try { + verifier.verify(shardStats); + return; + } catch (AssertionError e) { + lastError = e; + Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS); + } + } + + throw lastError; + } + + public static void verifyShardState(final AbstractDataStore datastore, final String shardName, + final Consumer verifier) throws Exception { + ActorUtils actorUtils = datastore.getActorUtils(); + + Future future = actorUtils.findLocalShardAsync(shardName); + ActorRef shardActor = Await.result(future, FiniteDuration.create(10, TimeUnit.SECONDS)); + + AssertionError lastError = null; + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.SECONDS) <= 5) { + OnDemandShardState shardState = (OnDemandShardState)actorUtils + .executeOperation(shardActor, GetOnDemandRaftState.INSTANCE); + + try { + verifier.accept(shardState); + return; + } catch (AssertionError e) { + lastError = e; + Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS); + } + } + + throw lastError; + } + + void testWriteTransaction(final AbstractDataStore dataStore, final YangInstanceIdentifier nodePath, + final NormalizedNode nodeToWrite) throws Exception { // 1. Create a write-only Tx @@ -142,66 +350,32 @@ public class IntegrationTestKit extends ShardTestKit { // 5. Verify the data in the store DOMStoreReadTransaction readTx = dataStore.newReadOnlyTransaction(); - - Optional> optional = readTx.read(nodePath).get(5, TimeUnit.SECONDS); - assertEquals("isPresent", true, optional.isPresent()); - assertEquals("Data node", nodeToWrite, optional.get()); + assertEquals(Optional.of(nodeToWrite), readTx.read(nodePath).get(5, TimeUnit.SECONDS)); } public void doCommit(final DOMStoreThreePhaseCommitCohort cohort) throws Exception { - Boolean canCommit = cohort.canCommit().get(7, TimeUnit.SECONDS); - assertEquals("canCommit", true, canCommit); + Boolean canCommit = cohort.canCommit().get(commitTimeout, TimeUnit.SECONDS); + assertEquals("canCommit", Boolean.TRUE, canCommit); cohort.preCommit().get(5, TimeUnit.SECONDS); cohort.commit().get(5, TimeUnit.SECONDS); } - void doCommit(final ListenableFuture canCommitFuture, final DOMStoreThreePhaseCommitCohort cohort) throws Exception { - Boolean canCommit = canCommitFuture.get(7, TimeUnit.SECONDS); - assertEquals("canCommit", true, canCommit); + void doCommit(final ListenableFuture canCommitFuture, final DOMStoreThreePhaseCommitCohort cohort) + throws Exception { + Boolean canCommit = canCommitFuture.get(commitTimeout, TimeUnit.SECONDS); + assertEquals("canCommit", Boolean.TRUE, canCommit); cohort.preCommit().get(5, TimeUnit.SECONDS); cohort.commit().get(5, TimeUnit.SECONDS); } - public void cleanup(DistributedDataStore dataStore) { - if(dataStore != null) { - dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), null); - } - } - - void assertExceptionOnCall(Callable callable, Class expType) - throws Exception { - try { - callable.call(); - fail("Expected " + expType.getSimpleName()); - } catch(Exception e) { - assertEquals("Exception type", expType, e.getClass()); - } - } - void assertExceptionOnTxChainCreates(final DOMStoreTransactionChain txChain, - Class expType) throws Exception { - assertExceptionOnCall(new Callable() { - @Override - public Void call() throws Exception { - txChain.newWriteOnlyTransaction(); - return null; - } - }, expType); - - assertExceptionOnCall(new Callable() { - @Override - public Void call() throws Exception { - txChain.newReadWriteTransaction(); - return null; - } - }, expType); + final Class expType) { + assertThrows(expType, () -> txChain.newWriteOnlyTransaction()); + assertThrows(expType, () -> txChain.newReadWriteTransaction()); + assertThrows(expType, () -> txChain.newReadOnlyTransaction()); + } - assertExceptionOnCall(new Callable() { - @Override - public Void call() throws Exception { - txChain.newReadOnlyTransaction(); - return null; - } - }, expType); + public interface ShardStatsVerifier { + void verify(ShardStats stats); } }