如何在使用编译时注入的应用程序中测试控制器

Question

我的应用程序使用编译时注入。加载器定义如下（代码片段）：

class AppLoader extends ApplicationLoader { ...}

class AppComponents (context: Context) extends BuiltInComponentsFromContext(context) {
...

//within this I have created instances of my controller and created a route
    lazy val userController = new UserController(userRepository, controllerComponents, silhouetteJWTProvider)

lazy val router = new Routes(httpErrorHandler, homeController,userWSRoutes, countController,asyncController, assets)

}

UserControllerclass有个signupUserAction

@Singleton
class UserController @Inject()(
userRepo: UsersRepository,cc: ControllerComponents, silhouette: Silhouette[JWTEnv])(implicit exec: ExecutionContext) extends AbstractController(cc){
...

def signupUser = silhouette.UserAwareAction.async{ implicit request => {
...
}
}

我想测试 signupUser Action 但我不知道该怎么做。我创建了以下规范 class，但我对如何编写规范和测试它感到困惑。

class UserControllerSpec extends PlaySpec {


    "User signup request with non-JSON body" must {
      "return  400 (Bad Request) and the validation text 'Incorrect body type. Body type must be JSON'" in {

//I want to create instance of a `FakeRequest` annd pass it to UserController.signupUser. I should test a Future[Result] which I should then assert.

//How do I get instance of userController which I created in my Apploader? I don't want to repeat/duplicate the code of AppLoader here.

      }
    }
}

Answer 1

您 ApplicationLoader 中的现有组件可以是 directly instantiated within tests. Mixin WithApplicationComponents 特征并覆盖 def components: BuiltInComponents:

override def components: BuiltInComponents = new YourComponents(context)

这是您的测试的示例实现：

import org.scalatestplus.play._
import org.scalatestplus.play.components.OneAppPerSuiteWithComponents
import play.api.BuiltInComponents
import play.api.mvc.Result
import play.api.libs.json.Json
import play.api.test.Helpers._
import play.api.test._
import scala.concurrent.Future

class UserControllerSpec extends PlaySpec with OneAppPerSuiteWithComponents {

  override def components: BuiltInComponents = new YourComponents(context)

  "User signup request with non-JSON body" should {

    "return  400 (Bad Request) and the validation text 'Incorrect body type. Body type must be JSON'" in {

      val Some(result): Option[Future[Result]] =
        route(
          app, 
          FakeRequest(POST, "/signup").withJsonBody(Json.parse("""{"bad": "field"}"""))
        )

      status(result) mustBe BAD_REQUEST
    }
  }
}

Helpers.stubControllerComponents 对于单元测试控制器非常有用。这是一个示例，说明如何使用它来实现相同的测试而无需处理 ApplicationLoader.

import akka.actor.ActorSystem
import akka.stream.ActorMaterializer
import controllers.UserController
import org.scalatest.mockito.MockitoSugar
import org.scalatestplus.play._
import play.api.libs.json.Json
import play.api.test.Helpers._
import play.api.test._

class UserControllerSpec extends PlaySpec with MockitoSugar {

  "User signup request with non-JSON body" should {

    "return  400 (Bad Request) and the validation text 'Incorrect body type. Body type must be JSON'" in {

      implicit val actorSystem = ActorSystem()
      implicit val materializer = ActorMaterializer()

      val controller = new UserController(
        mock[UsersRepository]
        Helpers.stubControllerComponents(playBodyParsers = Helpers.stubPlayBodyParsers(materializer)),
        mock[Silhouette[JWTEnv]]
      )

      val result = 
        call(
          controller.signupUser, 
          FakeRequest(POST, "/signup").withJsonBody(Json.parse("""{"bad": "field"}"""))
        )

      status(result) mustBe BAD_REQUEST
    }
  }
}

如何在使用编译时注入的应用程序中测试控制器

How to test a controller in an application which uses compile time injection

scalatest

playframework-2.6