我正在使用 JUnit 5。我的 Java 代码使用
System.getenv("demoVar")
来访问环境变量。
如何在 JUnit 5 测试类中设置此环境变量,以便我的代码可以在测试期间访问其值?
来自另一个SO答案https://stackoverflow.com/a/59635733/2185719:
有 JUnit Pioneer,一个“JUnit 5 扩展包”。
jUnit Pioneer 提供了一个为测试设置环境变量的注释。例如:
@Test
@SetEnvironmentVariable(key = "PATH", value = "")
void testPath_isEmpty() {
assertThat(System.getenv("PATH")).isEmpty();
}
您不能在实际的 java 进程中,因为使用 getenv 的这些环境值是不可变的。
一种方法是启动另一个虚拟机或另一个进程,您可以在其中引入新的环境值。
另一种方法是切换到 System.getProperty,但请确保您了解其中的差异。
https://www.baeldung.com/java-system-get-property-vs-system-getenv
这是一个小测试代码:
public class EnvironmentVarsTest {
private static int counter = 0;
@BeforeEach
public void setUp() {
counter = counter + 1;
System.setProperty("simple_test_env_property", String.valueOf(counter));
}
@Test
public void testFirst() {
printOutValues();
}
@Test
public void testSecond() {
printOutValues();
}
private void printOutValues() {
System.out.println("--------------------");
System.out.println("val=" + counter);
System.out.println("envval=" + System.getProperty("simple_test_env_property"));
}
}
这可以通过https://github.com/webcompere/system-stubs/tree/master/system-stubs-jupiter
来实现
@ExtendWith(SystemStubsExtension.class)
class TestClass {
@SystemStub
private EnvironmentVariables environmentVariables =
new EnvironmentVariables("demoVar", "val");
@Test
void test() {
// can use the environment
assertThat(System.getenv("demoVar")).isEqualTo("val");
// can also change the environment
environmentVariables.set("foo", "bar");
// environment variables restored to previous state when
// test ends
}
}
简单的解决方案,如果您使用 Gradle,您可以将以下内容添加到您的 build.gradle
test {
environment "ENV_VAR_NAME", "ENV_VAR_VALUE"
}
常见的做法是使用系统属性而不是环境变量。 在这种情况下,您将运行 java/maven/gradle 命令或使用选项 -D demoVar="{your_value}" 来运行测试的任何命令。 对于 Maven 目标:
maven clean install -DdemoVar="test"
对于 Java jar:
java -jar xxx.jar -DdemoVar="test"
您可以使用
System.getProperty("demoVar")
从代码中获取它。
如果您确实需要使用环境变量,请使用操作系统功能。 对于 Linux:
demoVar="test" mvn clean install
对于 Windows PowerShell:
$env:demoVar = 'test'; mvn clean install
这是使用 Kotlin DSL 的解决方案(build.gradle.kts):
tasks.withType<Test> {
environment["myFirst"] = "bunny"
// OR
environment(
"mySecond" to "7249",
"myThird" to "curtain"
)
}
环境变量在测试和主代码中都可用:
val name = System.getenv().get("myFirst")
旁注:您还可以根据环境变量禁用/启用测试:
@Test
@EnabledIfEnvironmentVariable(named = "myFirst", matches = "bunny", disabledReason = "Oh no")
public void myTest() {
// ...
}