集成测试时如何Mock PropertySource并指定临时配置文件路径？

遇到测试环境中@PropertySource指定的外部配置文件不存在导致的初始化失败，你可以通过以下几种方式解决：

1. 利用Spring Profiles区分环境 #

给生产环境的配置类指定生产Profile，同时编写测试专用的配置类绑定测试Profile，测试时激活测试Profile即可加载测试配置：

修改生产配置类 #

@Configuration
@Getter
@Setter
@Profile("prod") // 指定仅生产环境激活
@PropertySource(value = { "file:/config/appconfig.properties" })
public class ExternalProperties {
    // 原@Value注解的变量
}

编写测试配置类 #

@Configuration
@Getter
@Setter
@Profile("test") // 指定仅测试环境激活
@PropertySource(value = { "classpath:test-appconfig.properties" }) // 指向测试资源目录下的配置文件
public class TestExternalProperties {
    // 和生产类完全一致的@Value变量，或者直接继承ExternalProperties
}

在测试类中激活测试Profile #

@SpringBootTest
@ActiveProfiles("test") // 激活测试Profile
public class YourIntegrationTest {
    // 测试逻辑
}

2. 使用@TestPropertySource直接覆盖路径 #

在测试类上通过@TestPropertySource注解直接指定测试用的配置文件路径，覆盖原@PropertySource的配置：

@SpringBootTest
@TestPropertySource(locations = "file:./src/test/resources/test-appconfig.properties")
public class YourIntegrationTest {
    // 测试逻辑
}

如果需要动态生成临时配置文件，可以在测试生命周期中创建临时文件并指定路径：

@SpringBootTest
public class YourIntegrationTest {

    private static File tempConfigFile;

    @BeforeAll
    static void setupTempConfig() throws IOException {
        // 创建临时配置文件并写入测试属性
        tempConfigFile = File.createTempFile("test-appconfig", ".properties");
        try (PrintWriter writer = new PrintWriter(tempConfigFile)) {
            writer.println("demo.property=testValue");
            writer.println("another.property=123");
        }
    }

    // 动态注册测试用的PropertySource
    @TestConfiguration
    @PropertySource(value = "file:${temp.config.path}")
    static class TestConfig {
        @Value("${temp.config.path}")
        private String tempConfigPath;
    }

    @BeforeEach
    void setTempPathProperty() {
        // 将临时文件路径设置为系统属性
        System.setProperty("temp.config.path", tempConfigFile.getAbsolutePath());
    }

    @AfterAll
    static void cleanupTempFile() {
        // 测试结束后删除临时文件
        tempConfigFile.delete();
    }

    // 测试方法
    @Test
    void testConfigLoading() {
        // 验证配置是否加载成功
    }
}

3. 给原配置路径添加占位符，测试时动态替换 #

修改原配置类的@PropertySource，使用占位符指定默认路径，测试时通过属性覆盖默认值：

修改原配置类 #

@Configuration
@Getter
@Setter
// 优先使用app.config.path属性指定的路径，未指定则用默认路径
@PropertySource(value = { "file:${app.config.path:/config/appconfig.properties}" })
public class ExternalProperties {
    // @Value注解的变量
}

在测试类中指定测试路径 #

@SpringBootTest(properties = "app.config.path=./src/test/resources/test-appconfig.properties")
public class YourIntegrationTest {
    // 测试逻辑
}

你也可以通过测试启动的JVM参数指定路径：-Dapp.config.path=./src/test/resources/test-appconfig.properties

内容的提问来源于stack exchange，提问作者dead programmer