spring-bootのDynamicPropertyRegistryでtest時に動的にプロパティ変更

src/main/resources/application.properties

sample.value=sample

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;

@SpringBootTest
class DynamicPropertySourceTest {

    @DynamicPropertySource
    static void registerProperties(DynamicPropertyRegistry registry) {
        registry.add("sample.value", () -> "dynamic sample value.");
    }

    @Value("${sample.value}")
    String value;

    @Test
    void test() {
        System.out.println(value); //dynamic sample value.と表示
    }

}

これの主な使いどころは、ユニットテストの外部で起動するものに依存する場合に使用する。たとえば、 https://www.baeldung.com/spring-dynamicpropertysource にあるとおりTestcontainersとの組み合わせで用いる。dockerで起動したコンテナからポートとかJDBC URLとかを取得してspring-bootのプロパティとして指定する。