如何在 Play 2.1 中指定不同的配置文件进行测试

Question

我想为多个测试环境（生产、暂存、开发）定义不同的数据库连接。阅读文章“如何为 sbt 测试指定 sbt 0.12.2 的配置文件？”后，似乎在早期版本的 Play 中可以通过使用以下 SBT 设置来实现：

val main = play.Project(appName, appVersion, appDependencies).settings(
    javaOptions in Test += "-Dconfig.file=conf/test.conf"
)

但是如果我在 Build.scala 中使用此设置，则会收到以下错误：

not found: value javaOptions

所以我的问题是，如何为不同的测试环境定义不同的连接？

---

编辑： 一种可能的解决方法是在测试期间覆盖默认设置。这可以通过环境变量来完成。

object Config {
  var defaultConfig = Map(
    "db.default.user" -> "user",
    "db.default.pass" -> "************"
  )

  def additionalConfiguration(): Map[String, _] = sys.env.getOrElse("PLAY_TEST_SCOPE", "") match {
    case "development" => {
      defaultConfig += "db.default.url" -> "jdbc:mysql://host:3306/development"
      defaultConfig
    }
    case "staging" => {
      defaultConfig += "db.default.url" -> "jdbc:mysql://host:3306/staging"
      defaultConfig
    }
    case "production" => {
      defaultConfig += "db.default.url" -> "jdbc:mysql://host:3306/production"
      defaultConfig
    }
    case _ => {
      throw new Exception("Environment variable `PLAY_TEST_SCOPE` isn't defined")
    }
  }
}

然后使用此配置运行一个假应用程序。

FakeApplication(additionalConfiguration = Config.additionalConfiguration())

Answer 1

javaOptions

包含在 Keys 对象中。

确保在

Build.scala

文件中使用正确的导入：

import Keys._

Answer 2

我们可以混合上述解决方案，将配置文件作为参数传递给 sbt。
这对于将测试集成到 CI 管道中非常有用

首先，在 Build.scala 文件中

val testOptions = "-Dconfig.file=conf/" + Option(System.getProperty("test.config")).getOrElse("application") + ".conf"

val main = PlayProject(appName, appVersion, appDependencies, mainLang = SCALA).settings(
    javaOptions in Test += testOptions
)

然后，在命令行中使用 integ.conf

运行测试

sbt -Dtest.config=integ test

使用默认的 application.conf

sbt test 

Answer 3

Play 2.5.x 更新

不再需要显式导入 import Keys._，并且配置资源位置的 vm 参数已更改。

javaOptions in Test += "-Dconfig.resource=<conf_name>.conf"

Answer 4

您可以使用替代配置文件从控制台运行您的应用程序，无论如何您需要使用带有完整路径的

-Dconfig.file

，因为存在一些问题......我无法使用其他选项来实现。以 unix 环境为例：

play -Dconfig.file=/home/akkie/play/some-project/conf/local_akkie_dev.conf "~run 9123"

当然，为了更轻松地启动，您可以创建 bash 脚本来调用此行。

编辑：请注意，您不需要在每个附加配置文件中编写整个配置，因为您只需在开始时include您的主配置，然后仅覆盖所需的属性：

include "application.conf"

key.to.override=blah

查看官方文档

Answer 5

在 Play 项目中运行测试时使用不同的配置文件 https://www.pmatiello.me/2014/12/using-a- Different-configuration-file-when-running-tests-in-a-play-project.html#:~:text=First%20create% 20a%20配置%20文件，当%20运行%20测试时为%20不同%20。