如何在Play Framework 2 scala中对控制器进行单元测试

假设我有一个控制器接收两个参数。

它调用两个服务，每个参数一个，服务都返回字符串

每个字符串都作为参数传递给模板

结果传递给Ok并返回。

我想编写一个简单的单元测试，以确保：1 - 使用正确的参数调用正确的服务2 - 将服务的返回值传递给模板的正确属性

什么是最好的方式来做到这一点？

---

使用Mockito与Specs2，我嘲笑服务来验证他们的方法调用。

我的控制器是由Spring实例化的。 这让我把它看作是一个class而不是object 。 =>这对于controller可测试是必不可少的。 这里是一个例子：

@Controller
class MyController @Autowired()(val myServices: MyServices) extends Controller

要为控制器启用Spring，您必须定义一个Global对象，如Play！ 文档说明：

object Global extends GlobalSettings {

  val context = new ClassPathXmlApplicationContext("application-context.xml")

  override def getControllerInstance[A](controllerClass: Class[A]): A = {
    context.getBean(controllerClass)
  }
}

我的单元测试不需要Spring; 我只是将合作者（嘲笑）传递给构造函数。

但是，关于呈现的模板，我只测试结果的类型（Ok，BadRequest，重定向等）。 事实上，我发现让我的测试在整个渲染模板中进行详细扫描（发送给它的参数等）并不容易，只有单元测试。

因此，为了声明正确的模板是用正确的参数调用的，我相信我的验收测试正在运行Selenium，或者可能的功能测试（如果您愿意的话）来扫描整个预期结果。

2 - 来自服务的返回值传递给模板的正确属性

这很容易检查..如何？ 通过信任编译器！ 喜欢将一些自定义类型传递给您的模板，而不是简单的原语，例如： phone: String将变为： phone: Phone 。 （一个简单的值对象）。 因此，不要害怕将非预期顺序的属性传递给模板（在单元测试或实际生产代码中）。 编译器确实会警告。

下面是使用specs2进行单元测试（简化）的一个示例:(您将注意到使用包装器： WithFreshMocks ）。 这个case class将允许在测试之后刷新所有变量（在这种情况下为嘲讽）测试。 因此这是重置模拟的好方法。

    class MyControllerSpec extends Specification with Mockito {

      def is =
        "listAllCars should retrieve all cars" ! WithFreshMocks().listAllCarsShouldRetrieveAllCars

      case class WithFreshMocks() {

        val myServicesMock = mock[MyServices]
        val myController = new MyController(myServicesMock)

        def listAllCarsShouldRetrieveAllCars = {
          val FakeGetRequest = FakeRequest() //fakeRequest needed by controller
          mockListAllCarsAsReturningSomeCars()
          val result = myController.listAllCars(FakeGetRequest).asInstanceOf[PlainResult] //passing fakeRequest to simulate a true request
          assertOkResult(result).
            and(there was one(myServicesMock).listAllCars()) //verify that there is one and only one call of listAllCars. If listAllCars would take any parameters that you expected to be called, you could have precise them.
        }

        private def mockListAllCarsAsReturningSomeCars() { 
           myServicesMock.listAllCars() returns List[Cars](Car("ferrari"), Car("porsche"))
        }

        private def assertOkResult(result: PlainResult) = result.header.status must_== 200

       }

---

所以，我想出了一个蛋糕模式和基于mockito的解决方案：

给予服务：

trait Service {
  def indexMessage : String
}

trait ServiceImpl {
  def indexMessage = {
    "Hello world"
  }
}

然后控制器看起来像：

object Application extends ApplicationController
                   with ServiceImpl  {
  def template = views.html.index.apply
}

trait ApplicationController extends Controller
                            with Service {
  def template: (String) => play.api.templates.Html

  def index = Action {
    Ok(template("controller got:" + indexMessage))
  }
}

测试看起来像：

class ApplicationControllerSpec extends Specification with Mockito {
  "cake ApplicationController" should {
      "return OK with the results of the service invocation" in {
        val expectedMessage = "Test Message"
        val m = mock[(String) => play.api.templates.Html]

        object ApplicationControllerSpec extends ApplicationController {
          def indexMessage = expectedMessage
          def template = m
        }

        val response = ApplicationControllerSpec.index(FakeRequest())

        status(response) must equalTo(OK)
        there was one(m).apply(Matchers.eq("controller got:" + expectedMessage))
      }
  }
}

Mockito工作时遇到了很多麻烦。
它需要一个额外的依赖关系，并且我在处理scala中如何使用匹配器时遇到了很多麻烦（我在Java中使用它非常舒服）

最终，我认为上述答案更好，避免使用String和其他基本类型，您可以将它们包装在特定于任务的类型中，然后得到编译器警告。

另外，我通常会避免在控制器中加入前缀“controller got：”的前缀。

在这种情况下，我可以验证它是否已经通过，在现实世界中应该由其他组件完成（控制器仅用于管理IMO）

链接地址: http://www.djcxy.com/p/72629.html

上一篇: How do I unit test a controller in play framework 2 scala

下一篇: Error creating android subproject when using phonegap run android command