如何使用 JUnit 测试依赖于环境变量的代码？

Question

我有一段使用环境变量的 Java 代码，代码的行为取决于该变量的值。 我想用不同的环境变量值来测试这段代码。 我怎样才能在 JUnit 中做到这一点？

我已经看到了一些在 Java中设置环境变量的一般方法，但我对它的单元测试方面更感兴趣，特别是考虑到测试不应该相互干扰。

Answer 1

库System Lambda有一个withEnvironmentVariables方法来设置环境变量。

import static com.github.stefanbirkner.systemlambda.SystemLambda.*;

public void EnvironmentVariablesTest {
  @Test
  public void setEnvironmentVariable() {
    String value = withEnvironmentVariable("name", "value")
      .execute(() -> System.getenv("name"));
    assertEquals("value", value);
  }
}

对于 Java 5 到 7，库系统规则有一个称为EnvironmentVariables的 JUnit 规则。

import org.junit.contrib.java.lang.system.EnvironmentVariables;

public class EnvironmentVariablesTest {
  @Rule
  public final EnvironmentVariables environmentVariables
    = new EnvironmentVariables();

  @Test
  public void setEnvironmentVariable() {
    environmentVariables.set("name", "value");
    assertEquals("value", System.getenv("name"));
  }
}

完全披露：我是这两个库的作者。

Answer 2

通常的解决方案是创建一个管理对这个环境变量的访问的类，然后你可以在你的测试类中模拟它。

public class Environment {
    public String getVariable() {
        return System.getenv(); // or whatever
    }
}

public class ServiceTest {
    private static class MockEnvironment {
        public String getVariable() {
           return "foobar";
        }
    }

    @Test public void testService() {
        service.doSomething(new MockEnvironment());
    }
}

然后，被测类使用 Environment 类而不是直接从 System.getenv() 获取环境变量。

Answer 3

在类似这样的情况下，我必须编写依赖于Environment Variable 的测试用例，我尝试了以下操作：

1. 我按照Stefan Birkner 的建议选择了System Rules 。 它的使用很简单。 但不久之后，我发现这种行为不稳定。 在一次运行中，它有效，在下一次运行中它失败了。 我调查并发现系统规则适用于 JUnit 4 或更高版本。 但就我而言，我使用了一些依赖于JUnit 3 的Jars。 所以我跳过了System Rules 。 更多关于它你可以在这里找到@Rule 注释在 JUnit 中使用 TestSuite 时不起作用。
2. 接下来我尝试通过Java提供的Process Builder类创建环境变量。 这里通过Java Code我们可以创建一个环境变量，但是你需要知道进程或程序名称，我不知道。 它还为子进程而不是主进程创建环境变量。

使用上述两种方法浪费了一天，但无济于事。 然后Maven来救我了。 我们可以通过Maven POM文件设置环境变量或系统属性，我认为这是对基于Maven的项目进行单元测试的最佳方式。 下面是我在POM文件中创建的条目。

    <build>
      <plugins>
       <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <configuration>
          <systemPropertyVariables>
              <PropertyName1>PropertyValue1</PropertyName1>                                                          
              <PropertyName2>PropertyValue2</PropertyName2>
          </systemPropertyVariables>
          <environmentVariables>
            <EnvironmentVariable1>EnvironmentVariableValue1</EnvironmentVariable1>
            <EnvironmentVariable2>EnvironmentVariableValue2</EnvironmentVariable2>
          </environmentVariables>
        </configuration>
      </plugin>
    </plugins>
  </build>

在此更改之后，我再次运行测试用例，突然一切都按预期工作。 供读者参考，我在Maven 3.x 中探索了这种方法，所以我对Maven 2.x 一无所知。

Answer 4

我认为最干净的方法是使用 Mockito.spy()。 它比创建一个单独的类来模拟和传递更轻巧。

将您的环境变量获取移动到另一种方法：

@VisibleForTesting
String getEnvironmentVariable(String envVar) {
    return System.getenv(envVar);
}

现在在您的单元测试中执行以下操作：

@Test
public void test() {
    ClassToTest classToTest = new ClassToTest();
    ClassToTest classToTestSpy = Mockito.spy(classToTest);
    Mockito.when(classToTestSpy.getEnvironmentVariable("key")).thenReturn("value");
    // Now test the method that uses getEnvironmentVariable
    assertEquals("changedvalue", classToTestSpy.methodToTest());
}

Answer 5

我认为还没有提到这一点，但您也可以使用Powermockito ：

鉴于：

package com.foo.service.impl;

public class FooServiceImpl {

    public void doSomeFooStuff() {
        System.getenv("FOO_VAR_1");
        System.getenv("FOO_VAR_2");
        System.getenv("FOO_VAR_3");

        // Do the other Foo stuff
    }
}

您可以执行以下操作：

package com.foo.service.impl;

import static org.mockito.Mockito.when;
import static org.powermock.api.mockito.PowerMockito.mockStatic;
import static org.powermock.api.mockito.PowerMockito.verifyStatic;

import org.junit.Beforea;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.MockitoAnnotations;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;

@RunWith(PowerMockRunner.class)
@PrepareForTest(FooServiceImpl.class)
public class FooServiceImpTest {

    @InjectMocks
    private FooServiceImpl service;

    @Before
    public void setUp() {
        MockitoAnnotations.initMocks(this);

        mockStatic(System.class);  // Powermock can mock static and private methods

        when(System.getenv("FOO_VAR_1")).thenReturn("test-foo-var-1");
        when(System.getenv("FOO_VAR_2")).thenReturn("test-foo-var-2");
        when(System.getenv("FOO_VAR_3")).thenReturn("test-foo-var-3");
    }

    @Test
    public void testSomeFooStuff() {        
        // Test
        service.doSomeFooStuff();

        verifyStatic();
        System.getenv("FOO_VAR_1");
        verifyStatic();
        System.getenv("FOO_VAR_2");
        verifyStatic();
        System.getenv("FOO_VAR_3");
    }
}

Answer 6

将 Java 代码与 Environment 变量分离，提供一个更抽象的变量读取器，您可以使用 EnvironmentVariableReader 实现您的代码以测试读取。

然后在您的测试中，您可以给出提供测试值的变量读取器的不同实现。

依赖注入可以帮助解决这个问题。

Answer 7

这个问题的答案如何从 Java 设置环境变量？ 提供了一种在 System.getenv() 中更改（不可修改）映射的方法。 因此，虽然它并没有真正改变操作系统环境变量的值，但它可以用于单元测试，因为它确实改变了System.getenv将返回的内容。

Answer 8

对于 JUnit 4 用户， Stefan Birkner建议的System Lambda非常适合。

如果您使用的是 JUnit 5，则有JUnit Pioneer扩展包。 它带有@ClearEnvironmentVariable和@SetEnvironmentVariable 。 从文档：

@ClearEnvironmentVariable和@SetEnvironmentVariable注释可分别用于清除和设置测试执行的环境变量值。 这两个注释都适用于测试方法和类级别，既可重复又可组合。 注解方法执行后，注解中提到的变量将恢复为原始值，如果之前没有，则将被清除。 测试期间更改的其他环境变量不会恢复。

例子：

@Test
@ClearEnvironmentVariable(key = "SOME_VARIABLE")
@SetEnvironmentVariable(key = "ANOTHER_VARIABLE", value = "new value")
void test() {
    assertNull(System.getenv("SOME_VARIABLE"));
    assertEquals("new value", System.getenv("ANOTHER_VARIABLE"));
}

Answer 9

希望问题得到解决。 我只是想告诉我的解决方案。

Map<String, String> env = System.getenv();
    new MockUp<System>() {
        @Mock           
        public String getenv(String name) 
        {
            if (name.equalsIgnoreCase( "OUR_OWN_VARIABLE" )) {
                return "true";
            }
            return env.get(name);
        }
    };

Answer 10

尽管我认为这个答案最适合 Maven 项目，它也可以通过反射实现（在Java 8 中测试）：

public class TestClass {
    private static final Map<String, String> DEFAULTS = new HashMap<>(System.getenv());
    private static Map<String, String> envMap;

    @Test
    public void aTest() {
        assertEquals("6", System.getenv("NUMBER_OF_PROCESSORS"));
        System.getenv().put("NUMBER_OF_PROCESSORS", "155");
        assertEquals("155", System.getenv("NUMBER_OF_PROCESSORS"));
    }

    @Test
    public void anotherTest() {
        assertEquals("6", System.getenv("NUMBER_OF_PROCESSORS"));
        System.getenv().put("NUMBER_OF_PROCESSORS", "77");
        assertEquals("77", System.getenv("NUMBER_OF_PROCESSORS"));
    }

    /*
     * Restore default variables for each test
     */
    @BeforeEach
    public void initEnvMap() {
        envMap.clear();
        envMap.putAll(DEFAULTS);
    }

    @BeforeAll
    public static void accessFields() throws Exception {
        envMap = new HashMap<>();
        Class<?> clazz = Class.forName("java.lang.ProcessEnvironment");
        Field theCaseInsensitiveEnvironmentField = clazz.getDeclaredField("theCaseInsensitiveEnvironment");
        Field theUnmodifiableEnvironmentField = clazz.getDeclaredField("theUnmodifiableEnvironment");
        removeStaticFinalAndSetValue(theCaseInsensitiveEnvironmentField, envMap);
        removeStaticFinalAndSetValue(theUnmodifiableEnvironmentField, envMap);
    }

    private static void removeStaticFinalAndSetValue(Field field, Object value) throws Exception {
        field.setAccessible(true);
        Field modifiersField = Field.class.getDeclaredField("modifiers");
        modifiersField.setAccessible(true);
        modifiersField.setInt(field, field.getModifiers() & ~Modifier.FINAL);
        field.set(null, value);
    }
}

Answer 11

您可以使用Powermock来模拟调用。 喜欢：

PowerMockito.mockStatic(System.class);
PowerMockito.when(System.getenv("MyEnvVariable")).thenReturn("DesiredValue");

您还可以使用以下方法模拟所有调用：

PowerMockito.mockStatic(System.class);
PowerMockito.when(System.getenv(Mockito.anyString())).thenReturn(envVariable);

Answer 12

库https://github.com/webcompere/system-stubs/tree/master/system-stubs-jupiter - system-lambda一个分支 - 提供了一个 JUnit 5 插件：

@ExtendWith(SystemStubsExtension.class)
class SomeTest {
    @SystemStub
    private EnvironmentVariables environmentVariables =
       new EnvironmentVariables("name", "value");

    @Test
    void someTest() {
       // environment is set here

       // can set a new value into the environment too
       environmentVariables.set("other", "value");

       // tidy up happens at end of this test
    }

}

https://junit-pioneer.org/替代方案要求在编译时知道环境变量值。 以上还支持在@BeforeAll设置环境变量，这意味着它可以与Testcontainers东西很好地互操作，这些东西可能会设置子测试所需的一些资源。

Answer 13

上面的建议中很多重点是在运行时发明方法来传递变量，设置它们并清除它们等等..？ 但是为了“从结构上”测试事物，我猜您想为不同的场景使用不同的测试套件？ 就像您想运行“较重”的集成测试构建一样，而在大多数情况下，您只想跳过它们。 但是，您不会尝试“发明在运行时设置内容的方法”，而只是告诉Maven 您想要什么？ 曾经有很多工作告诉 Maven 通过配置文件运行特定的测试，如果你谷歌周围的人会建议通过 springboot 来做（但如果你没有将 springboot monstrum 拖入你的项目，这似乎是一个可怕的'只运行 JUnits' 的足迹，对吗？）。 否则它会暗示大量或多或少不方便的 POM XML 杂耍，这也很烦人，而且，我们只是说，“九十年代的举动”，就像仍然坚持“用 XML 制作春豆”一样不方便，炫耀你的终极600 行 logback.xml 或诸如此类...？

现在，你可以只使用 Junit 5（这个例子是针对 maven 的，更多细节可以在这里找到JUnit 5 用户指南 5 ）

 <dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.junit</groupId>
            <artifactId>junit-bom</artifactId>
            <version>5.7.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

进而

    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <scope>test</scope>
    </dependency>

然后在您最喜欢的实用程序库中创建一个简单的漂亮注释类，例如

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@EnabledIfEnvironmentVariable(named = "MAVEN_CMD_LINE_ARGS", matches = "(.*)integration-testing(.*)")
public @interface IntegrationTest {}

因此，每当您的 cmdline 选项包含 -Pintegration-testing 时，只有这样，您的 @IntegrationTest 注释测试类/方法才会触发。 或者，如果您不想使用（和设置）特定的 Maven 配置文件，而只想通过“触发”系统属性传递

mvn <cmds> -DmySystemPop=mySystemPropValue

并调整您的注释界面以触发它（是的，还有一个@EnabledIfSystemProperty）。 或者确保您的 shell 设置为包含“任何您需要的东西”，或者，如上所述，通过您的 POM XML 实际经历“痛苦”添加系统环境。

让您的代码在运行时内部摆弄 env 或模拟 env，设置它，然后可能“清除”运行时 env 以在执行期间更改自身，这似乎是一种糟糕的，甚至可能是危险的方法 - 很容易想象有人总是会更快或后来犯了一个“隐藏的”内部错误，会在一段时间内被忽视，只是突然出现并在以后的生产中狠狠地咬你..？ 您通常更喜欢一种方法，即“给定的输入”给出“预期的输出”，随着时间的推移很容易掌握和维护，您的编码人员将“立即”看到它。

好长的“答案”，或者更确切地说只是关于为什么你更喜欢这种方法的意见（是的，起初我只是阅读了这个问题的标题并继续回答这个问题，即“如何测试依赖于环境变量的代码使用JUnit'）。

Answer 14

一种缓慢、可靠、老派的方法，始终适用于每种语言（甚至语言之间）的每个操作系统，是将您需要的“系统/环境”数据写入临时文本文件，在需要时读取它，然后擦除它。 当然，如果您并行运行，那么您需要文件的唯一名称，如果您将敏感信息放入其中，则需要对其进行加密。

Answer 15

简单地

添加下面的maven依赖

<!-- for JUnit 4 -->
<dependency>
    <groupId>uk.org.webcompere</groupId>
    <artifactId>system-stubs-junit4</artifactId>
    <version>1.1.0</version>
    <scope>test</scope>
</dependency>

<!-- for JUnit 5 -->
<dependency>
    <groupId>uk.org.webcompere</groupId>
    <artifactId>system-stubs-jupiter</artifactId>
    <version>1.1.0</version>
    <scope>test</scope>
</dependency>

在你的测试中，你可以使用类似的东西：

@Rule
public EnvironmentVariablesRule environmentVariablesRule = new EnvironmentVariablesRule();

@Test
public void givenEnvironmentCanBeModified_whenSetEnvironment_thenItIsSet() {
    // mock that the system contains an  environment variable "ENV_VAR" having value "value1"
    environmentVariablesRule.set("ENV_VAR", "value1");

    assertThat(System.getenv("ENV_VAR")).isEqualTo("value1");
}

更多详情请参考
https://www.baeldung.com/java-system-stubs

Answer 16

我使用 System.getEnv() 获取地图并将其保留为字段，因此我可以模拟它：

public class AAA {

    Map<String, String> environmentVars; 

    public String readEnvironmentVar(String varName) {
        if (environmentVars==null) environmentVars = System.getenv();   
        return environmentVars.get(varName);
    }
}



public class AAATest {

         @Test
         public void test() {
              aaa.environmentVars = new HashMap<String,String>();
              aaa.environmentVars.put("NAME", "value");
              assertEquals("value",aaa.readEnvironmentVar("NAME"));
         }
}

Answer 17

那么您可以使用 setup() 方法来声明您的 env 的不同值。 常量中的变量。 然后在用于测试不同场景的测试方法中使用这些常量。

Answer 18

如果要在Java中检索有关环境变量的信息，可以调用方法： System.getenv(); . 作为属性，此方法返回一个 Map，其中包含变量名称作为键和变量值作为映射值。 这是一个例子：

    import java.util.Map;

public class EnvMap {
    public static void main (String[] args) {
        Map<String, String> env = System.getenv();
        for (String envName : env.keySet()) {
            System.out.format("%s=%s%n", envName, env.get(envName));
        }
    }
}

方法getEnv()也可以接受一个参数。 例如 ：

String myvalue = System.getEnv("MY_VARIABLE");

为了测试，我会做这样的事情：

public class Environment {
    public static String getVariable(String variable) {
       return  System.getenv(variable);
}

@Test
 public class EnvVariableTest {

     @Test testVariable1(){
         String value = Environment.getVariable("MY_VARIABLE1");
         doSometest(value); 
     }

    @Test testVariable2(){
       String value2 = Environment.getVariable("MY_VARIABLE2");
       doSometest(value); 
     }   
 }