squbs支持Scala的ScalaTest 3.X，TestNG和Java测试框架的JUnit。
依赖
要使用文档中提到的测试工具，只需简单的添加如下依赖在你的build.sbt文件或者Scala构建脚本：
"org.squbs" %% "squbs-testkit" % squbsVersion
此外，你还应当根据测试是否需要添加如下依赖：
// Testing RouteDefinition...
"com.typesafe.akka" %% "akka-http-testkit" % akkaHttpVersion % "test",
// Using JUnit...
"junit" % "junit" % junitV % "test",
"com.novocode" % "junit-interface" % junitInterfaceV % "test->default",
// Using TestNG
"org.testng" % "testng" % testngV % "test",
CustomTestKit
CustomTestKit用于启动一个完整的squbs实例以便测试零碎的应用。CustomTestKit使用简单，默认情况下不需要配置，但允许自定义和灵活的测试。通过CustomTestKit，可以使用不同配置启动任意数量的ActorSystem和Unicomplex实例（一个ActorSystem一个）——都在相同的JVM。一些特性如下：
- 它自动将actor系统名称设置为 "规范/测试类名称", 以确保 ActorSystem 实例不发生冲突。但是, 它还允许在构- 造函数中传递actor系统名称。
- 继承CustomTestKit的测试可以在同一 JVM 中并行运行。
- 自动启动和关闭squbs。
- 默认启动在src/main/resources/META-INF/squbs-meta.conf和src/test/resources/META-INF/squbs-meta.conf中的well-known actor和服务。但是， 允许传递资源给构造函数。
- 允许传递自定义配置给构造器。
以下是 CustomTestKit 在 Scala测试中的应用实例：
import org.squbs.testkit.CustomTestKit
class SampleSpec extends CustomTestKit with FlatSpecLike with Matchers {
it should "start the system" in {
system.startTime should be > 0L
}
}
TestNG和JUnit用于Java用户：
import org.squbs.testkit.japi.CustomTestKit
public class SampleTest extends CustomTestKit {
@Test
public void testSystemStartTime() {
Assert.assertTrue(system().startTime() > 0L);
}
}
传递配置给CustomTestKit
如果你想要自定义actor系统配置，你可以传递一个Config对象给CustomTestKit：
object SampleSpec {
val config = ConfigFactory.parseString {
"""
|akka {
| loglevel = "DEBUG"
|}
""".stripMargin
}
}
class SampleSpec extends CustomTestKit(SampleSpec.config) with FlatSpecLike with Matchers {
it should "set akka log level to the value defined in config" in {
system.settings.config.getString("akka.loglevel") shouldEqual "DEBUG"
}
}
用CustomTestKit启动well-known actor和服务
CustomTestKit 自动启动src/test/resources/META-INF/squbs-meta.conf中配置的well-known actor和服务。然而，你想要提供不同的资源路径，你可以传递一个资源的Seq()给构造器。withClassPath控制是否扫描META-INF/squbs-meta.conf整个测试路径。
object SampleSpec {
val resources = Seq(getClass.getClassLoader.getResource("").getPath + "/SampleSpec/META-INF/squbs-meta.conf")
}
class SampleSpec extends CustomTestKit(SampleSpec.resources, withClassPath = false)
with FlatSpecLike with Matchers {
// Write tests here
}
请注意，CustomTestKit允许一起传递config和resources。
测试中的端口绑定
启动服务需要端口绑定。为了防止端口冲突，应当让系统挑选端口，通过设置监听器的bind-port到0，例如default-listener.bind-port = 0（CustomTestKit如果使用默认配置，对所有监听器设置bind-port = 0）。squbs-testkit来于名为PortGetter的特质，允许提取系统选取端口。CustomTestKit已经混入了PortGetter，所以可以使用port值。
class SampleSpec extends CustomTestKit(SampleSpec.resources)
"PortGetter" should "retrieve the port" in {
port should be > 0
}
}
默认，PortGetter返回default-listener的端口，最常见的一个。如果你需要提取其它监听器绑定的端口，可以覆盖listener方法或者传递监听器名称给port方法：
class SampleSpec extends CustomTestKit(SampleSpec.resources)
override def listener = "my-listener"
"PortGetter" should "return the specified listener's port" in {
port should not equal port("default-listener")
port shouldEqual port("my-listener")
}
}
手工UnicomplexBoot初始化
CustomTestKit也允许传入一个UnicomplexBoot实例。这允许引导的完整自定义。请看squbs引导章节查看详细信息。
object SampleSpec {
val config = ConfigFactory.parseString(
s"""
|squbs {
| actorsystem-name = SampleSpec # should be unique to prevent collision with other tests running in parallel
| ${JMX.prefixConfig} = true # to prevent JMX name collision, if you are doing any JMX testing
|}
""".stripMargin
)
val resource = getClass.getClassLoader.getResource("").getPath + "/SampleSpec/META-INF/squbs-meta.conf"
val boot = UnicomplexBoot(config)
.createUsing {(name, config) => ActorSystem(name, config)}
.scanResources(resource)
.initExtensions.start()
}
class SampleSpec extends CustomTestKit(SampleSpec.boot) with FunSpecLike with Matchers {
// Write your tests here.
}
关闭
对于具有多个并行运行的 CustomTestKit 实例的大型测试, 在测试后正确关机很重要。关机机制取决于测试框架以及如何构造 CustomTestKit, 如下所示：
对于ScalaTest
CustomTestKit自动关闭，除非你覆盖了afterAll() 方法。不需要采取进一步的行动。
使用Akka Http TestKit测试Akka Http路由
为了测试路由，akka-http-testkit需要添加到依赖中。请增加如下依赖：
"com.typesafe.akka" %% "akka-http-testkit" % akkaHttpV % "test"
squbs testkit提供工具从RouteDefinition特质构造路由并且有工具有独立的和整个系统模式，在这里基础结构和cube可以提出一部分来测试。
TestRoute用于从RouteDefinition构造和获得路由。为了使用它，仅需将RouteDefinition作为一个类型参数传递给TestRoute。这将为测试 DSL 获得一个完全配置和功能的路由, 如下面的示例所示。
指定RouteDefinition
import org.squbs.unicomplex.RouteDefinition
class MyRoute extends RouteDefinition {
val route =
path("ping") {
get {
complete {
"pong"
}
}
}
}
实现测试，从TestRoute[MyRoute]获取路由：
import akka.http.scaladsl.testkit.ScalatestRouteTest
import org.scalatest.{Matchers, FlatSpecLike}
import org.squbs.testkit.TestRoute
class MyRouteTest extends FlatSpecLike with Matchers with ScalatestRouteTest {
val route = TestRoute[MyRoute]
it should "return pong on a ping" in {
Get("/ping") ~> route ~> check {
responseAs[String] should be ("pong")
}
}
}
或者, 你也可能希望将 web 上下文传递到你的路由。这可以通过将其传递给 TestRoute, 如下所示：
val route = TestRoute[MyRoute](webContext = "mycontext")
或者仅传递"mycontext"不带参数名称。没有参数的 TestRoute 签名等同于传递根上下文 ""。
使用 TestRoute 与 CustomTestKit
在使用 TestRoute 测试时, 可能会出现对引导 Unicomplex 的需求, 如以下情况：
- 一个 squbs 的well-known actor参与了请求处理。
- 在请求处理时使用了Actor注册。
将Akka的 TestKit 与 ScalatestRouteTest 一起使用可能会很棘手, 因为它们初始化冲突。squbs提供了名为CustomRouteTestKit 的测试工具解决这个问题。CustomRouteTestKit支持由CustomTestKit提供的所有API。下面是通过CustomRouteTestKit使用TestRoute的例子：
class MyRouteTest extends CustomRouteTestKit with FlatSpecLike with Matchers {
it should "return response from well-known actor" in {
val route = TestRoute[ReverserRoute]
Get("/msg/hello") ~> route ~> check {
responseAs[String] should be ("hello".reverse)
}
}
}
class ReverserRoute extends RouteDefinition {
import akka.pattern.ask
import Timeouts._
import context.dispatcher
val route =
path("msg" / Segment) { msg =>
get {
onComplete((context.actorSelection("/user/mycube/reverser") ? msg).mapTo[String]) {
case Success(value) => complete(value)
case Failure(ex) => complete(s"An error occurred: ${ex.getMessage}")
}
}
}
}
关闭
CustomRouteTestKit特质是特定于测试框架的，因此它们已经用测试框架钩子预先测试了，以便正确地开始和关闭。因此，没有必要使用任何风格的CustomRouteTestKit测试关闭Unicomplex。
