Merge pull request #175 from lerna-stack/refactor-snapshot-store-failure-spec

Refactor `ShardSnapshotStore` failure specs

Author: negokaz

src/test/scala/lerna/akka/entityreplication/raft/snapshot/ShardSnapshotStoreFailureSpec.scala

@@ -2,77 +2,96 @@ package lerna.akka.entityreplication.raft.snapshot
 
 import java.util.concurrent.atomic.AtomicInteger
 import akka.actor.{ ActorRef, ActorSystem }
+import akka.persistence.testkit.scaladsl.SnapshotTestKit
+import akka.persistence.testkit.{ PersistenceTestKitPlugin, PersistenceTestKitSnapshotPlugin }
 import akka.testkit.TestKit
 import com.typesafe.config.{ Config, ConfigFactory }
 import lerna.akka.entityreplication.model.{ NormalizedEntityId, TypeName }
 import lerna.akka.entityreplication.raft.model.LogEntryIndex
 import lerna.akka.entityreplication.raft.routing.MemberIndex
-import lerna.akka.entityreplication.raft.snapshot.ShardSnapshotStoreFailureSpecBase._
+import lerna.akka.entityreplication.raft.snapshot.ShardSnapshotStoreFailureSpec._
 import lerna.akka.entityreplication.raft.snapshot.SnapshotProtocol._
 import lerna.akka.entityreplication.raft.{ ActorSpec, RaftSettings }
 import lerna.akka.entityreplication.testkit.KryoSerializable
 
-// snapshot-store のスタブを利用して snapshot の読み込みを失敗させる
-class ShardSnapshotStoreLoadingFailureSpec
-    extends ShardSnapshotStoreFailureSpecBase(
-      SnapshotPluginStub.brokenLoadingSnapshotConfig.withFallback(ConfigFactory.load()),
-    ) {
+object ShardSnapshotStoreFailureSpec {
+  final case object DummyState extends KryoSerializable
+
+  def configWithPersistenceTestKits: Config = {
+    PersistenceTestKitPlugin.config
+      .withFallback(PersistenceTestKitSnapshotPlugin.config)
+      .withFallback(raftPersistenceConfigWithPersistenceTestKits)
+      .withFallback(ConfigFactory.load())
+  }
+
+  private val raftPersistenceConfigWithPersistenceTestKits: Config = ConfigFactory.parseString(
+    s"""
+       |lerna.akka.entityreplication.raft.persistence {
+       |  journal.plugin = ${PersistenceTestKitPlugin.PluginId}
+       |  snapshot-store.plugin = ${PersistenceTestKitSnapshotPlugin.PluginId}
+       |  # Might be possible to use PersistenceTestKitReadJournal
+       |  // query.plugin = ""
+       |}
+       |""".stripMargin,
+  )
+
+}
+
+class ShardSnapshotStoreFailureSpec
+    extends TestKit(
+      ActorSystem("ShardSnapshotStoreFailureSpec", ShardSnapshotStoreFailureSpec.configWithPersistenceTestKits),
+    )
+    with ActorSpec {
+
+  private val snapshotTestKit = SnapshotTestKit(system)
+
+  override def beforeEach(): Unit = {
+    super.beforeEach()
+    snapshotTestKit.clearAll()
+    snapshotTestKit.resetPolicy()
+  }
+
+  def createShardSnapshotStore(): ActorRef =
+    planAutoKill {
+      childActorOf(
+        ShardSnapshotStore.props(
+          TypeName.from("test"),
+          RaftSettings(system.settings.config),
+          MemberIndex("test-role"),
+        ),
+      )
+    }
+
+  val entityIdSeq = new AtomicInteger(0)
+
+  def generateUniqueEntityId(): NormalizedEntityId =
+    NormalizedEntityId.from(s"test-entity-${entityIdSeq.incrementAndGet()}")
 
   "ShardSnapshotStore（読み込みの異常）" should {
 
     "FetchSnapshot に失敗した場合は応答無し（クライアント側でタイムアウトの実装が必要）" in {
       val entityId           = generateUniqueEntityId()
       val shardSnapshotStore = createShardSnapshotStore()
 
+      snapshotTestKit.failNextRead()
       shardSnapshotStore ! FetchSnapshot(entityId, replyTo = testActor)
       expectNoMessage()
     }
   }
-}
-
-// snapshot-store のスタブを利用して snapshot の永続化を失敗させる
-class ShardSnapshotStoreSavingFailureSpec
-    extends ShardSnapshotStoreFailureSpecBase(
-      SnapshotPluginStub.brokenSavingSnapshotConfig.withFallback(ConfigFactory.load()),
-    ) {
-
-  private[this] val dummyEntityState = EntityState(DummyState)
 
   "ShardSnapshotStore（書き込みの異常）" should {
 
     "SaveSnapshot に失敗した場合は SaveSnapshotFailure が返信される" in {
       val entityId           = generateUniqueEntityId()
       val shardSnapshotStore = createShardSnapshotStore()
       val metadata           = EntitySnapshotMetadata(entityId, LogEntryIndex.initial())
+      val dummyEntityState   = EntityState(DummyState)
       val snapshot           = EntitySnapshot(metadata, dummyEntityState)
 
+      snapshotTestKit.failNextPersisted()
       shardSnapshotStore ! SaveSnapshot(snapshot, replyTo = testActor)
       expectMsg(SaveSnapshotFailure(metadata))
     }
   }
-}
 
-object ShardSnapshotStoreFailureSpecBase {
-  final case object DummyState extends KryoSerializable
-}
-
-abstract class ShardSnapshotStoreFailureSpecBase(config: Config)
-    extends TestKit(ActorSystem("ShardSnapshotStoreFailureSpec", config))
-    with ActorSpec {
-
-  def createShardSnapshotStore(): ActorRef =
-    planAutoKill {
-      childActorOf(
-        ShardSnapshotStore.props(
-          TypeName.from("test"),
-          RaftSettings(system.settings.config),
-          MemberIndex("test-role"),
-        ),
-      )
-    }
-
-  val entityIdSeq = new AtomicInteger(0)
-
-  def generateUniqueEntityId(): NormalizedEntityId =
-    NormalizedEntityId.from(s"test-entity-${entityIdSeq.incrementAndGet()}")
 }