使用 guice 上下文的 Scala Play 应用程序集成测试
Scala Play application integration tests with guice context
我是框架新手,对 scala 的经验有限。使用 play framework 2.4
我试图在我想调用控制器的地方编写完整的集成测试,并使用内存数据库从中检索数据。我正在使用 scalatest-plus
和 scalatest
。我已经阅读了播放文档中的播放单元测试,现在尝试使用 play.api.test.FakeApplication
但我找不到将我的 guice 模块注入到这个假应用程序的方法。我正在使用 OneAppPerSuite
特性,我可以覆盖 FakeApplication
但不能传递任何 guice
模块进行注入。这是 FakeApplication
来源:
case class FakeApplication(
override val path: java.io.File = new java.io.File("."),
override val classloader: ClassLoader = classOf[FakeApplication].getClassLoader,
additionalPlugins: Seq[String] = Nil,
withoutPlugins: Seq[String] = Nil,
additionalConfiguration: Map[String, _ <: Any] = Map.empty,
withGlobal: Option[play.api.GlobalSettings] = None,
withRoutes: PartialFunction[(String, String), Handler] = PartialFunction.empty) extends Application {
private val app: Application = new GuiceApplicationBuilder()
.in(Environment(path, classloader, Mode.Test))
.global(withGlobal.orNull)
.configure(additionalConfiguration)
.bindings(
bind[FakePluginsConfig] to FakePluginsConfig(additionalPlugins, withoutPlugins),
bind[FakeRouterConfig] to FakeRouterConfig(withRoutes))
.overrides(
bind[Plugins].toProvider[FakePluginsProvider],
bind[Router].toProvider[FakeRouterProvider])
.build
....
所以我没有办法在这里传递自定义模块。
我的测试是这样的:
class UsersControllerTest extends PlaySpec with OneAppPerSuite {
override implicit lazy val app = FakeApplication(additionalConfiguration = inMemoryDatabase())
"Application " should {
"work" in {
val resp = route(FakeRequest(GET, "/api/users")).get
}
}
}
这是我要测试的控制器:
class UserController @Inject()
(userService: UserService)
(implicit ec: ExecutionContext) extends Controller {
def get = Action.async { implicit request => {
// implementation
}
}
}
显然我的测试现在失败了,因为它找不到 UserService
个实例。
所以我的问题是:
- 如何使用 guice 上下文正确编写端到端集成测试
- 在 play 应用程序中编写此类测试是否很常见,因为我找不到任何像样的示例或文档来做类似的事情。我曾经在集成测试加载 spring 上下文的 java Web 应用程序中编写此类测试,但在游戏中找不到此类示例。
提前致谢。
如果你想测试你的默认配置,启动 FakeApplication 就足够了。它会自动加载 application.conf
中指定的模块。因此,如果它找不到 UserService
,则意味着您的 application.conf
中没有正确的模块配置,并且您的服务器无法满足这些请求。
https://www.playframework.com/documentation/2.4.x/ScalaDependencyInjection
如果您想使用一些模型,并覆盖默认配置:
https://www.playframework.com/documentation/2.4.x/ScalaTestingWithGuice
我是框架新手,对 scala 的经验有限。使用 play framework 2.4
我试图在我想调用控制器的地方编写完整的集成测试,并使用内存数据库从中检索数据。我正在使用 scalatest-plus
和 scalatest
。我已经阅读了播放文档中的播放单元测试,现在尝试使用 play.api.test.FakeApplication
但我找不到将我的 guice 模块注入到这个假应用程序的方法。我正在使用 OneAppPerSuite
特性,我可以覆盖 FakeApplication
但不能传递任何 guice
模块进行注入。这是 FakeApplication
来源:
case class FakeApplication(
override val path: java.io.File = new java.io.File("."),
override val classloader: ClassLoader = classOf[FakeApplication].getClassLoader,
additionalPlugins: Seq[String] = Nil,
withoutPlugins: Seq[String] = Nil,
additionalConfiguration: Map[String, _ <: Any] = Map.empty,
withGlobal: Option[play.api.GlobalSettings] = None,
withRoutes: PartialFunction[(String, String), Handler] = PartialFunction.empty) extends Application {
private val app: Application = new GuiceApplicationBuilder()
.in(Environment(path, classloader, Mode.Test))
.global(withGlobal.orNull)
.configure(additionalConfiguration)
.bindings(
bind[FakePluginsConfig] to FakePluginsConfig(additionalPlugins, withoutPlugins),
bind[FakeRouterConfig] to FakeRouterConfig(withRoutes))
.overrides(
bind[Plugins].toProvider[FakePluginsProvider],
bind[Router].toProvider[FakeRouterProvider])
.build
....
所以我没有办法在这里传递自定义模块。
我的测试是这样的:
class UsersControllerTest extends PlaySpec with OneAppPerSuite {
override implicit lazy val app = FakeApplication(additionalConfiguration = inMemoryDatabase())
"Application " should {
"work" in {
val resp = route(FakeRequest(GET, "/api/users")).get
}
}
}
这是我要测试的控制器:
class UserController @Inject()
(userService: UserService)
(implicit ec: ExecutionContext) extends Controller {
def get = Action.async { implicit request => {
// implementation
}
}
}
显然我的测试现在失败了,因为它找不到 UserService
个实例。
所以我的问题是:
- 如何使用 guice 上下文正确编写端到端集成测试
- 在 play 应用程序中编写此类测试是否很常见,因为我找不到任何像样的示例或文档来做类似的事情。我曾经在集成测试加载 spring 上下文的 java Web 应用程序中编写此类测试,但在游戏中找不到此类示例。
提前致谢。
如果你想测试你的默认配置,启动 FakeApplication 就足够了。它会自动加载
application.conf
中指定的模块。因此,如果它找不到UserService
,则意味着您的application.conf
中没有正确的模块配置,并且您的服务器无法满足这些请求。https://www.playframework.com/documentation/2.4.x/ScalaDependencyInjection
如果您想使用一些模型,并覆盖默认配置:
https://www.playframework.com/documentation/2.4.x/ScalaTestingWithGuice