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%2FShardManagerTest.java;h=8c56efd41325e70911dfa644746803b4a8aae61a;hp=87d257a3f217bf0bfac0b3c8ade1cbe8d4555b04;hb=c0f6720408b40b4ba0649bec18231b31ba8af702;hpb=c222e37f2a0f0f3f6266242fbea2d3b018f4e6e3 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardManagerTest.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardManagerTest.java index 87d257a3f2..8c56efd413 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardManagerTest.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardManagerTest.java @@ -1,152 +1,478 @@ package org.opendaylight.controller.cluster.datastore; -import akka.actor.ActorSystem; +import akka.actor.ActorRef; import akka.actor.Props; +import akka.japi.Creator; +import akka.pattern.Patterns; +import akka.persistence.RecoveryCompleted; import akka.testkit.JavaTestKit; import akka.testkit.TestActorRef; -import junit.framework.Assert; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import akka.util.Timeout; +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Sets; +import com.google.common.util.concurrent.Uninterruptibles; +import org.junit.After; +import org.junit.Before; import org.junit.Test; +import org.opendaylight.controller.cluster.DataPersistenceProvider; +import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; +import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized; +import org.opendaylight.controller.cluster.datastore.messages.ActorNotInitialized; +import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard; import org.opendaylight.controller.cluster.datastore.messages.FindPrimary; +import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound; +import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound; import org.opendaylight.controller.cluster.datastore.messages.PrimaryFound; import org.opendaylight.controller.cluster.datastore.messages.PrimaryNotFound; +import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext; +import org.opendaylight.controller.cluster.datastore.utils.DoNothingActor; +import org.opendaylight.controller.cluster.datastore.utils.InMemoryJournal; import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper; import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration; -import scala.concurrent.duration.Duration; - -public class ShardManagerTest { - private static ActorSystem system; +import org.opendaylight.controller.md.cluster.datastore.model.TestModel; +import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import scala.concurrent.Await; +import scala.concurrent.Future; + +import java.net.URI; +import java.util.Collection; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class ShardManagerTest extends AbstractActorTest { + private static int ID_COUNTER = 1; + + private final String shardMrgIDSuffix = "config" + ID_COUNTER++; + private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix; + + private static ActorRef mockShardActor; + + @Before + public void setUp() { + InMemoryJournal.clear(); + + if(mockShardActor == null) { + String name = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1","config").toString(); + mockShardActor = getSystem().actorOf(Props.create(DoNothingActor.class), name); + } + } - @BeforeClass - public static void setUp() { - system = ActorSystem.create("test"); + @After + public void tearDown() { + InMemoryJournal.clear(); } - @AfterClass - public static void tearDown() { - JavaTestKit.shutdownActorSystem(system); - system = null; + private Props newShardMgrProps() { + return ShardManager.props(shardMrgIDSuffix, new MockClusterWrapper(), new MockConfiguration(), + DatastoreContext.newBuilder().build()); } @Test public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - new JavaTestKit(system) {{ - final Props props = ShardManager - .props("config", new MockClusterWrapper(), - new MockConfiguration()); - final TestActorRef subject = - TestActorRef.create(system, props); + shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef()); - new Within(duration("1 seconds")) { - protected void run() { + shardManager.tell(new FindPrimary("non-existent", false).toSerializable(), getRef()); + + expectMsgEquals(duration("5 seconds"), + new PrimaryNotFound("non-existent").toSerializable()); + }}; + } - subject.tell(new FindPrimary("inventory").toSerializable(), getRef()); + @Test + public void testOnReceiveFindPrimaryForExistentShard() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - expectMsgEquals(Duration.Zero(), - new PrimaryNotFound("inventory").toSerializable()); + shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef()); + shardManager.tell(new ActorInitialized(), mockShardActor); - // Will wait for the rest of the 3 seconds - expectNoMsg(); - } - }; + shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef()); + + expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS); }}; } @Test - public void testOnReceiveFindPrimaryForExistentShard() throws Exception { + public void testOnReceiveFindPrimaryForNotInitializedShard() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - new JavaTestKit(system) {{ - final Props props = ShardManager - .props("config", new MockClusterWrapper(), - new MockConfiguration()); - final TestActorRef subject = - TestActorRef.create(system, props); + shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef()); - // the run() method needs to finish within 3 seconds - new Within(duration("1 seconds")) { - protected void run() { + expectMsgClass(duration("5 seconds"), ActorNotInitialized.class); + }}; + } - subject.tell(new FindPrimary(Shard.DEFAULT_NAME).toSerializable(), getRef()); + @Test + public void testOnReceiveFindPrimaryWaitForShardInitialized() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - expectMsgClass(PrimaryFound.SERIALIZABLE_CLASS); + shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef()); - expectNoMsg(); - } - }; + // We're passing waitUntilInitialized = true to FindPrimary so the response should be + // delayed until we send ActorInitialized. + Future future = Patterns.ask(shardManager, new FindPrimary(Shard.DEFAULT_NAME, true), + new Timeout(5, TimeUnit.SECONDS)); + + shardManager.tell(new ActorInitialized(), mockShardActor); + + Object resp = Await.result(future, duration("5 seconds")); + assertTrue("Expected: PrimaryFound, Actual: " + resp, resp instanceof PrimaryFound); }}; } @Test - public void testOnReceiveMemberUp() throws Exception { + public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - new JavaTestKit(system) {{ - final Props props = ShardManager - .props("config", new MockClusterWrapper(), - new MockConfiguration()); - final TestActorRef subject = - TestActorRef.create(system, props); + shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef()); - // the run() method needs to finish within 3 seconds - new Within(duration("1 seconds")) { - protected void run() { + shardManager.tell(new FindLocalShard("non-existent", false), getRef()); - MockClusterWrapper.sendMemberUp(subject, "member-2", getRef().path().toString()); + LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class); - subject.tell(new FindPrimary("astronauts").toSerializable(), getRef()); + assertEquals("getShardName", "non-existent", notFound.getShardName()); + }}; + } - final String out = new ExpectMsg("primary found") { - // do not put code outside this method, will run afterwards - protected String match(Object in) { - if (in.getClass().equals(PrimaryFound.SERIALIZABLE_CLASS)) { - PrimaryFound f = PrimaryFound.fromSerializable(in); - return f.getPrimaryPath(); - } else { - throw noMatch(); - } - } - }.get(); // this extracts the received message + @Test + public void testOnReceiveFindLocalShardForExistentShard() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - Assert.assertTrue(out, out.contains("member-2-shard-astronauts-config")); + shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef()); + shardManager.tell(new ActorInitialized(), mockShardActor); - expectNoMsg(); - } - }; + shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef()); + + LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class); + + assertTrue("Found path contains " + found.getPath().path().toString(), + found.getPath().path().toString().contains("member-1-shard-default-config")); + }}; + } + + @Test + public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); + + shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef()); + + expectMsgClass(duration("5 seconds"), ActorNotInitialized.class); + }}; + } + + @Test + public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); + + shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef()); + + // We're passing waitUntilInitialized = true to FindLocalShard so the response should be + // delayed until we send ActorInitialized. + Future future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true), + new Timeout(5, TimeUnit.SECONDS)); + + shardManager.tell(new ActorInitialized(), mockShardActor); + + Object resp = Await.result(future, duration("5 seconds")); + assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound); + }}; + } + + @Test + public void testOnReceiveMemberUp() throws Exception { + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); + + MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString()); + + shardManager.tell(new FindPrimary("astronauts", false).toSerializable(), getRef()); + + PrimaryFound found = PrimaryFound.fromSerializable(expectMsgClass(duration("5 seconds"), + PrimaryFound.SERIALIZABLE_CLASS)); + String path = found.getPrimaryPath(); + assertTrue("Found path contains " + path, path.contains("member-2-shard-astronauts-config")); }}; } @Test public void testOnReceiveMemberDown() throws Exception { - new JavaTestKit(system) {{ - final Props props = ShardManager - .props("config", new MockClusterWrapper(), - new MockConfiguration()); - final TestActorRef subject = - TestActorRef.create(system, props); + new JavaTestKit(getSystem()) {{ + final ActorRef shardManager = getSystem().actorOf(newShardMgrProps()); - // the run() method needs to finish within 3 seconds - new Within(duration("1 seconds")) { - protected void run() { + MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString()); - MockClusterWrapper.sendMemberUp(subject, "member-2", getRef().path().toString()); + shardManager.tell(new FindPrimary("astronauts", false).toSerializable(), getRef()); - subject.tell(new FindPrimary("astronauts").toSerializable(), getRef()); + expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS); - expectMsgClass(PrimaryFound.SERIALIZABLE_CLASS); + MockClusterWrapper.sendMemberRemoved(shardManager, "member-2", getRef().path().toString()); - MockClusterWrapper.sendMemberRemoved(subject, "member-2", getRef().path().toString()); + shardManager.tell(new FindPrimary("astronauts", false).toSerializable(), getRef()); - subject.tell(new FindPrimary("astronauts").toSerializable(), getRef()); + expectMsgClass(duration("5 seconds"), PrimaryNotFound.SERIALIZABLE_CLASS); + }}; + } - expectMsgClass(PrimaryNotFound.SERIALIZABLE_CLASS); + @Test + public void testOnRecoveryJournalIsCleaned() { + InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules( + ImmutableSet.of("foo"))); + InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules( + ImmutableSet.of("bar"))); + InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID); + + new JavaTestKit(getSystem()) {{ + TestActorRef shardManager = TestActorRef.create(getSystem(), + Props.create(new TestShardManagerCreator(shardMrgIDSuffix))); + + shardManager.underlyingActor().waitForRecoveryComplete(); + InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID); + + // Journal entries up to the last one should've been deleted + Map journal = InMemoryJournal.get(shardMgrID); + synchronized (journal) { + assertEquals("Journal size", 1, journal.size()); + assertEquals("Journal entry seq #", Long.valueOf(2), journal.keySet().iterator().next()); + } + }}; + } - expectNoMsg(); - } - }; + @Test + public void testOnRecoveryPreviouslyKnownModulesAreDiscovered() throws Exception { + final ImmutableSet persistedModules = ImmutableSet.of("foo", "bar"); + InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules( + persistedModules)); + new JavaTestKit(getSystem()) {{ + TestActorRef shardManager = TestActorRef.create(getSystem(), + Props.create(new TestShardManagerCreator(shardMrgIDSuffix))); + + shardManager.underlyingActor().waitForRecoveryComplete(); + + Collection knownModules = shardManager.underlyingActor().getKnownModules(); + + assertEquals("getKnownModules", persistedModules, Sets.newHashSet(knownModules)); }}; } + @Test + public void testOnUpdateSchemaContextUpdateKnownModulesIfTheyContainASuperSetOfTheKnownModules() + throws Exception { + new JavaTestKit(getSystem()) {{ + final TestActorRef shardManager = + TestActorRef.create(getSystem(), newShardMgrProps()); + + assertEquals("getKnownModules size", 0, shardManager.underlyingActor().getKnownModules().size()); + + ModuleIdentifier foo = mock(ModuleIdentifier.class); + when(foo.getNamespace()).thenReturn(new URI("foo")); + Set moduleIdentifierSet = new HashSet<>(); + moduleIdentifierSet.add(foo); + + SchemaContext schemaContext = mock(SchemaContext.class); + when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet); + + shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext)); + + assertEquals("getKnownModules", Sets.newHashSet("foo"), + Sets.newHashSet(shardManager.underlyingActor().getKnownModules())); + + ModuleIdentifier bar = mock(ModuleIdentifier.class); + when(bar.getNamespace()).thenReturn(new URI("bar")); + + moduleIdentifierSet.add(bar); + + shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext)); + + assertEquals("getKnownModules", Sets.newHashSet("foo", "bar"), + Sets.newHashSet(shardManager.underlyingActor().getKnownModules())); + }}; + } + + @Test + public void testOnUpdateSchemaContextDoNotUpdateKnownModulesIfTheyDoNotContainASuperSetOfKnownModules() + throws Exception { + new JavaTestKit(getSystem()) {{ + final TestActorRef shardManager = + TestActorRef.create(getSystem(), newShardMgrProps()); + + SchemaContext schemaContext = mock(SchemaContext.class); + Set moduleIdentifierSet = new HashSet<>(); + + ModuleIdentifier foo = mock(ModuleIdentifier.class); + when(foo.getNamespace()).thenReturn(new URI("foo")); + + moduleIdentifierSet.add(foo); + + when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet); + + shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext)); + + assertEquals("getKnownModules", Sets.newHashSet("foo"), + Sets.newHashSet(shardManager.underlyingActor().getKnownModules())); + + //Create a completely different SchemaContext with only the bar module in it + //schemaContext = mock(SchemaContext.class); + moduleIdentifierSet.clear(); + ModuleIdentifier bar = mock(ModuleIdentifier.class); + when(bar.getNamespace()).thenReturn(new URI("bar")); + + moduleIdentifierSet.add(bar); + + shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext)); + + assertEquals("getKnownModules", Sets.newHashSet("foo"), + Sets.newHashSet(shardManager.underlyingActor().getKnownModules())); + + }}; + } + + @Test + public void testRecoveryApplicable(){ + new JavaTestKit(getSystem()) { + { + final Props persistentProps = ShardManager.props(shardMrgIDSuffix, + new MockClusterWrapper(), + new MockConfiguration(), + DatastoreContext.newBuilder().persistent(true).build()); + final TestActorRef persistentShardManager = + TestActorRef.create(getSystem(), persistentProps); + + DataPersistenceProvider dataPersistenceProvider1 = persistentShardManager.underlyingActor().getDataPersistenceProvider(); + + assertTrue("Recovery Applicable", dataPersistenceProvider1.isRecoveryApplicable()); + + final Props nonPersistentProps = ShardManager.props(shardMrgIDSuffix, + new MockClusterWrapper(), + new MockConfiguration(), + DatastoreContext.newBuilder().persistent(false).build()); + final TestActorRef nonPersistentShardManager = + TestActorRef.create(getSystem(), nonPersistentProps); + + DataPersistenceProvider dataPersistenceProvider2 = nonPersistentShardManager.underlyingActor().getDataPersistenceProvider(); + + assertFalse("Recovery Not Applicable", dataPersistenceProvider2.isRecoveryApplicable()); + + + }}; + + } + + @Test + public void testOnUpdateSchemaContextUpdateKnownModulesCallsDataPersistenceProvider() + throws Exception { + final CountDownLatch persistLatch = new CountDownLatch(1); + final Creator creator = new Creator() { + private static final long serialVersionUID = 1L; + @Override + public ShardManager create() throws Exception { + return new ShardManager(shardMrgIDSuffix, new MockClusterWrapper(), new MockConfiguration(), DatastoreContext.newBuilder().build()) { + @Override + protected DataPersistenceProvider createDataPersistenceProvider(boolean persistent) { + DataPersistenceProviderMonitor dataPersistenceProviderMonitor + = new DataPersistenceProviderMonitor(); + dataPersistenceProviderMonitor.setPersistLatch(persistLatch); + return dataPersistenceProviderMonitor; + } + }; + } + }; + + new JavaTestKit(getSystem()) {{ + + final TestActorRef shardManager = + TestActorRef.create(getSystem(), Props.create(new DelegatingShardManagerCreator(creator))); + + ModuleIdentifier foo = mock(ModuleIdentifier.class); + when(foo.getNamespace()).thenReturn(new URI("foo")); + + Set moduleIdentifierSet = new HashSet<>(); + moduleIdentifierSet.add(foo); + + SchemaContext schemaContext = mock(SchemaContext.class); + when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet); + + shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext)); + + assertEquals("Persisted", true, + Uninterruptibles.awaitUninterruptibly(persistLatch, 5, TimeUnit.SECONDS)); + + }}; + } + + + + private static class TestShardManager extends ShardManager { + private final CountDownLatch recoveryComplete = new CountDownLatch(1); + + TestShardManager(String shardMrgIDSuffix) { + super(shardMrgIDSuffix, new MockClusterWrapper(), new MockConfiguration(), + DatastoreContext.newBuilder().build()); + } + + @Override + public void handleRecover(Object message) throws Exception { + try { + super.handleRecover(message); + } finally { + if(message instanceof RecoveryCompleted) { + recoveryComplete.countDown(); + } + } + } + + void waitForRecoveryComplete() { + assertEquals("Recovery complete", true, + Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS)); + } + } + + @SuppressWarnings("serial") + static class TestShardManagerCreator implements Creator { + String shardMrgIDSuffix; + + TestShardManagerCreator(String shardMrgIDSuffix) { + this.shardMrgIDSuffix = shardMrgIDSuffix; + } + + @Override + public TestShardManager create() throws Exception { + return new TestShardManager(shardMrgIDSuffix); + } + + } + + private static class DelegatingShardManagerCreator implements Creator { + private static final long serialVersionUID = 1L; + private Creator delegate; + + public DelegatingShardManagerCreator(Creator delegate) { + this.delegate = delegate; + } + + @Override + public ShardManager create() throws Exception { + return delegate.create(); + } + } }