从单元测试中读取配置文件

Question

我有一个非常简单的项目。

build.sbt:

scalaVersion := "2.13.5"

lazy val testSettings = Seq(
  Test / javaOptions += "-Dconfig.resource=/test.conf"
)

libraryDependencies ++= Seq(
  "org.scalatest" %% "scalatest" % "3.2.3" % Test, 
  "com.typesafe" % "config" % "1.4.1"
)

resources文件夹下的两个配置文件：

应用程序.conf

some-value = "value from application.conf file"

test.conf

some-value = "value from test.conf file"

而且只有 1 个规格测试类：

一些测试规范：

class SomeTestSpec extends AnyFlatSpec with Matchers {
  val config: Config = ConfigFactory.load()

  "some test" should "read and print from test.conf" in {
    val value = config.getString("some-value")
    println(s"value of some-value = $value")

    value shouldBe "value from test.conf file"
  }
}

如果失败则运行测试时：

"value from [application].conf file" was not equal to "value from [test].conf file"
ScalaTestFailureLocation: SomeTestSpec at (SomeTestSpec.scala:12)
Expected :"value from [test].conf file"
Actual   :"value from [application].conf file"

为什么规范读取文件application.conf 而不是test.conf？ build.sbt 有什么问题吗？：

lazy val testSettings = Seq(
  Test / javaOptions += "-Dconfig.resource=/test.conf"
)

Answer 1

最佳做法是将application.conf 放入src/main/resources/ 以进行常规使用，并将src/test/resources/ 放入以进行测试。您将在测试中有 2 个具有不同值的 conf 文件。如果您不需要更改配置进行测试，您只需在main 中保留一个配置文件即可。

您不必为您的测试显式地使用-Dconfig.resource 或-Dconfig.file 覆盖该文件，因为从类路径加载资源将按照您期望的开箱即用方式工作，并且将使用您的测试配置。 -D 选项主要用于运行时提供外部配置或一些复杂的构建场景。

如果您使用-Dconfig.resource 或-Dconfig.file，请注意路径。 config.resource 只是一个文件名，即application.conf 将作为资源加载，而config.file 是绝对或相对文件路径。

如果您正在创建一个库，您可以对具有默认值的 reference.conf 文件和 application.conf 覆盖它们感到满意。这也可以在您的场景中使用，但会更令人困惑，因为这不是目的或参考文件。

出于测试目的，只需使用 2 个application.conf 文件。

此外，这里有一些在运行时覆盖配置的选项：

Overriding multiple config values in Typesafe config when using an uberjar to deploy.

Overriding configuration with environment variables in typesafe config

Scala environment ${USER} in application.conf

更多信息在这里：https://github.com/lightbend/config#standard-behavior