squbs-8.测试squbs应用

原文地址：Testing squbs Applications

squbs上所有的测试使用ScalaTest 2.x编写，Specs2尚未测试

依赖

使用文档中提到的测试使用类，只需要简单的将以下依赖添加到build.sbt文件或scala构建脚本中：

"org.squbs" %% "squbs-testkit" % squbsVersion

CustomTestKit

CustomTestKit用来启动一个完全成熟的squbs实例，来测试应用程序。CustomTestKit容易上手并且默认不需要配置，同时支持为你的测试用例提供定制和扩展性。通过CustomTestKit和不同配置 ，你可以启动任何数量的ActorSystem 和Unicomplex实例-所有在同一个JVM上。这里有许多特性：

• 为简单起见，它自动将actor system的名称设置为spec/test类名，并且保证 ActorSystem实例不会冲突。然而，它同样允许actor系统名称传递到构造函数内。
• 继承CustomTestKit的测试用例可以在同一个JVM中并发执行。
• 自动化启动和停止squbs
• 默认启动在src/test/resources/META-INF/squbs-meta.conf中的well-known actor和服务。不过，允许在构造函数中传递需要扫描的资源。
• 允许个性化的配置传递到构造函数。

在ScalaTest这里有一个 CustomTestKit 的用法：

class SampleSpec extends CustomTestKit with FlatSpecLike with Matchers {
   it should "start the system" in {
      system.startTime should be > 0L
   }
}

TestNG和JUnit 同时被Java使用者支持：

public class SampleTest extends AbstractCustomTestKit {

    @Test
    public void testSystemStartTime() {
        Assert.assertTrue(system().startTime() > 0L);
    }
}

向 CustomTestKit传递配置信息

如果你想要定制actor system配置，你可以传递一个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"
  }
}

这里有一个 TestNG/JUnit版本的测试：

public class SampleTest extends AbstractCustomTestKit {

    public SampleTest() {
        super(TestConfig.config);
    }

    @Test
    public void testAkkaLogLevel() {
        Assert.assertEquals(system().settings().config().getString("akka.loglevel"), "DEBUG");
    }

    private static class TestConfig {
        private static Config config = ConfigFactory.parseString("akka.loglevel = DEBUG");
    }
}

以下部分仅显示ScalaTest部分的自定义，不过这些也支持TestNG和JUnit。在你的TestNG/JUnit测试中提供一个public构造函数，使用定制参数调用super来实现定制。查看squbs-testkit/src/test/java/org/squbs/testkit/japi来获取更多TestNG 和JUnit 的例子。

尤其对于JUnit，在你的测试用例中避免设置actor system名称（让 CustomTestKit来设置actor system名称通常是最佳实践）。JUnit为每个 @Test方法创建一个新的fixture实例，这将会潜在的引起actor system冲突。AbstractCustomTestKit 通过对每个actor system name追加自增数字来避免。

通过CustomTestKit启动well-known actor和服务

CustomTestKit 将会在自动启动在src/test/resources/META-INF/squbs-meta.conf中的well-known actors 和服务(参见Unicomplex & Cube Bootstrapping)。然而，如果你想要提供不同的资源路径，你可以通过传递一个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 默认设置）。 squbs-testkit携带一个名叫 PortGetter 的trait，来回收被系统获取的端口。 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实例。这允许完全自定义的引导。查看Bootstrapping squbs 获得更多关于启动Unicomplex的信息。

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.
}

使用Spray/Akka Http TestKit测试Spray/Akka Http 路由

为了测试路由(route)，需要加入spray-testkit和akka-http-testkit依赖。请参考如下加入到你的依赖中：
Spray:

"io.spray" %% "spray-testkit" % sprayV % "test"

Akka-Http:

"com.typesafe.akka" %% "akka-http-testkit" % akkaV % "test"

用法

当你通过扩展RouteDefinition特性来指定squbs中的路由（route），这样squbs将会由后台的actor组成，使得 Spray/Akka Http TestKit测试DSL构造路由将会变得很难。TestRoute提供构建和从RouteDefinition中获取路由（route）。只需要将 RouteDefinition 作为一个参数传递给 TestRoute。这将给你一个完全可配置的和函数式的路由用来测试DSL，在下面的例子中能看到：

指定RouteDefinition

package com.myorg.mypkg

import org.squbs.unicomplex.RouteDefinition
import spray.routing.Directives._

class MyRoute extends RouteDefinition {

  val route =
    path("ping") {
      get {
        complete {
          "pong"
        }
      }
    }
}

继承这个测试,从TestRoute[MyRoute]中获取路由（route）:

package com.myorg.mypkg

import org.scalatest.{Matchers, FlatSpecLike}
import org.squbs.testkit.TestRoute
import spray.testkit.ScalatestRouteTest

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上下文至你的路由（route）。这个可以通过将它传递给TestRoute 实现，如下：

  val route = TestRoute[MyRoute](webContext = "mycontext")

或只传递不含参数名的"mycontext"。不含TestRoute参数的签名与传递根上下文 "".相同。

通过CustomTestKit使用TestRoute

当测试TestRoute时，可能需要引导 Unicomplex ，已例如以下情况：

• 一个squbs的well-known actor参与请求处理
• 请求处理中使用到The Actor Registry

同时使用 Akka's 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，请确保Spray或 Akka Http testkit 在你的 依赖中