Akkaでもテストを実施したい

はじめに

あけましておめでとうございます。どうも弊社です。

今年の目標も前年と同様に「生き抜く」を主軸としてなんかいい感じに頑張ります。

今回はAkkaのテストについてです。

今回の内容はほとんどAkka実践バイブル(翔泳社 2017年)からパクった参考にさせて頂いた*1のですが、ActorSystemのシャットダウン方法が2.4でdeprecated入りしたActorSystem.shutdownを使っている所に若干の不安を抱きますがまぁ英語版の書籍が出て日本語訳が出るまでにタイムラグが発生すんだからまぁ仕方ないよねと言った感じです。

最終的に何が言いたいのかというと、素晴らしい本をありがとうございます。

概要

Akka(というよりはアクターモデル)ではActorにメッセージを送信し、メッセージを受け取ったActorは自身の内部状態を変化させたり受信したメッセージをそのままもしくは改変して別のActorに送信します。(データベースやKafkaのようなメッセージシステムに出力する場合もありますが、今回はその辺はやりません。) 逆に言うとActorはメッセージを送らない限り何もしません。

そこで、テスト用のActorSystemを作成し、そのActorSystem内でActorにメッセージを送信し返信メッセージもしくは内部状態を捕捉してAssertするのが基本戦略になるっぽいです。

f:id:jyuch:20180101201509p:plain

ヘルパトレイト

ここではテストケースが終了したタイミングをフックしてActorSystemを終了するトレイトをあらかじめ定義しておきます。

import org.scalatest.{Suite, BeforeAndAfterAll}
import akka.testkit.TestKit

trait StopSystemAfterAll extends BeforeAndAfterAll {
  this :TestKit with Suite =>

  override protected def afterAll(): Unit = {
    super.afterAll()
    system.terminate()
  }
}

内部状態のアサート

ここではSumActorという、受信した値の合計をひたすら加算するActorのテストを想定します。

import akka.actor.{Actor, ActorRef}
import jyuch.SumActor.{GetSum, Operand}

class SumActor extends Actor {
  var sum: Int = 0

  override def receive: Receive = {
    case Operand(value) => {
      sum += value
    }
    case GetSum(sender) => sender ! sum
  }

  def currentSum = sum
}

object SumActor {

  case class Operand(value: Int)

  case class GetSum(sender: ActorRef)

}
import akka.actor.{ActorSystem, Props}
import akka.testkit.{TestActorRef, TestKit}
import jyuch.SumActor.{GetSum, Operand}
import org.scalatest.{MustMatchers, WordSpecLike}

class SumActorTest extends TestKit(ActorSystem("testsystem"))
  with WordSpecLike
  with MustMatchers
  with StopSystemAfterAll {

  "SumActor" must {
    "change internal value when receives a message" in {
      val sumActor = TestActorRef[SumActor]
      sumActor ! Operand(10)
      sumActor.underlyingActor.sum must be (10)
    }

    "change internal value when receives a message, multi" in {
      val sumActor = system.actorOf(Props[SumActor])
      sumActor ! Operand(10)
      sumActor ! Operand(20)
      sumActor ! GetSum(testActor)
      expectMsg(30)
    }
  }
}

内部状態の直接参照

TestActorRefでActorをラップすると不思議な力でActorの内部に触れるようになるので*2、メッセージを送信した後目的の内部状態になっているかをアサートできるようになります。

val sumActor = TestActorRef[SumActor]
sumActor ! Operand(10)
sumActor.underlyingActor.sum must be (10)

メッセージ経由での内部状態の参照

case GetSum(sender) => sender ! sumのようにActorが処理するメッセージの中に内部状態をエクスポートするハンドラを用意することでメッセージ経由で内部状態をアサートできるようになります。

val sumActor = system.actorOf(Props[SumActor])
sumActor ! Operand(10)
sumActor ! Operand(20)
sumActor ! GetSum(testActor)
expectMsg(30)

どちらの方法でもActorに本来必要のないロジックを追加することになるのでなんだかなぁという感じになりますが、まぁこの辺は妥協が必要なところってことでしょうか。

メッセージのアサート

ここでは特定の条件でメッセージをフィルタしつつ送信者に送り返すActorのテストを想定します。

import akka.actor.Actor
import jyuch.FilterEchoActor.Message

class FilterEchoActor(filter: String) extends Actor {
  override def receive: Receive = {
    case Message(msg) => {
      if (msg.startsWith(filter)) {
        sender() ! Message(msg)
      }
    }
  }
}

object FilterEchoActor {

  def props(filter: String) = {
    akka.actor.Props(new FilterEchoActor(filter))
  }

  case class Message(msg: String)

}
import akka.actor.ActorSystem
import akka.testkit.{ImplicitSender, TestKit}
import jyuch.FilterEchoActor.Message
import org.scalatest.{MustMatchers, WordSpecLike}

class FilterEchoActorTest extends TestKit(ActorSystem("testsystem"))
  with WordSpecLike
  with MustMatchers
  with ImplicitSender
  with StopSystemAfterAll {

  "FilterEchoActor" must {
    "return message when message starts with provided string" in {
      val echoActor = system.actorOf(FilterEchoActor.props("Hello"))

      echoActor ! Message("Hello world")
      echoActor ! Message("Hello jyuch")
      echoActor ! Message("Hoge world")
      echoActor ! Message("Hoge jyuch")
      echoActor ! Message("Hello world")

      val msg = receiveN(3)

      msg must be(Vector(Message("Hello world"), Message("Hello jyuch"), Message("Hello world")))
    }
  }
}

ImplicitSenderトレイトをmix-inするとメッセージの送信者を暗黙的にtestActorにしてくれます。

フィルタの条件を指定してActorを生成しメッセージを送信し、送り返されたメッセージが望んだ結果かをアサートしています。

おわりに

余談ってほど余談ではないのですが、Actorにコンストラクタ引数で何かしらのパラメータを渡したいときはコンパニオンオブジェクトにファクトリメソッドを定義する方法が推奨されているようです。

また、この記事を書いているときに思いついたのですが、今年の目標に「しょうもない小ネタを挟むために時間を使わない」も付け加えておきます。

元旦

github.com

*1:というよりこのブログを読むよりそちらを買って読んだほうがいいです

*2:ついでに不思議な力でシングルスレッドで動作するようになる