那些遇到过的问题

如何将 Testcontainers 与 @DataJpaTest 结合起来避免代码重复？

Wim*_*uwe 7 java spring-test junit5 testcontainers

我想使用 JUnit 5 来​​使用 Testcontainers 和@DataJpaTest(and )。我有使用and注释@SpringBootTest的基本设置，如下所示：@Testcontainers@Container

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import static org.assertj.core.api.Assertions.assertThat;

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@Testcontainers
public class AtleteRepositoryTest {
    @Container
    private static final PostgreSQLContainer<?> CONTAINER = new PostgreSQLContainer<>("postgres:11");

    @DynamicPropertySource
    static void registerProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.datasource.url", CONTAINER::getJdbcUrl);
        registry.add("spring.datasource.username", CONTAINER::getUsername);
        registry.add("spring.datasource.password", CONTAINER::getPassword);
    }

    @Autowired
    private AtleteRepository repository;

    @Test
    void testSave() {
        repository.save(new Atlete("Wout Van Aert", 0, 1, 0));

        assertThat(repository.count()).isEqualTo(1);
    }
}
Run Code Online (Sandbox Code Playgroud)

有关完整示例代码（AtleteRepositoryTest、TeamRepositoryTest和TestcontainersDatajpatestApplicationTests ），请参阅https://github.com/wimdeblauwe/blog-example-code/tree/feature/testcontainers-datajpatest/testcontainers-datajpatest。

为了避免重复声明 PostgreSQL 容器和动态属性，我尝试了以下操作：

JUnit 5 扩展

Baeldung 有一篇博客介绍如何使用JUnit 5 扩展来避免重复。

import org.junit.jupiter.api.extension.AfterAllCallback;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.testcontainers.containers.PostgreSQLContainer;

public class PostgreSQLExtension implements BeforeAllCallback, AfterAllCallback {

    private PostgreSQLContainer<?> postgres;

    @Override
    public void beforeAll(ExtensionContext context) {
        postgres = new PostgreSQLContainer<>("postgres:11");

        postgres.start();
        System.setProperty("spring.datasource.url", postgres.getJdbcUrl());
        System.setProperty("spring.datasource.username", postgres.getUsername());
        System.setProperty("spring.datasource.password", postgres.getPassword());
    }

    @Override
    public void afterAll(ExtensionContext context) {
        postgres.stop();
    }
}
Run Code Online (Sandbox Code Playgroud)

如果您只有 1 个测试，它会起作用，但如果您同时运行多个测试（使用 IntelliJ 或 Maven），则它不会起作用。在这种情况下，其中一项测试将会失败，因为无法与数据库建立连接。另请注意，此扩展不使用，DynamicPropertyRegistry而是使用普通环境变量。请参阅feature/testcontainers-datajpatest_baeldung-extension分支以获取代码。

使用公共超类

在分支feature/testcontainers-datajpatest_database-base-test上，我尝试使用通用超类：


import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.testcontainers.containers.PostgreSQLContainer;

public class DatabaseBaseTest {
    private static final PostgreSQLContainer<?> CONTAINER = new PostgreSQLContainer<>("postgres:11");

    @BeforeAll
    static void start() {
        CONTAINER.start();
    }

    @AfterAll
    static void stop() {
        CONTAINER.stop();
    }

    @DynamicPropertySource
    static void registerProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.datasource.url", () -> {
            String jdbcUrl = CONTAINER.getJdbcUrl();
            System.out.println("jdbcUrl = " + jdbcUrl);
            return jdbcUrl;
        });
        registry.add("spring.datasource.username", CONTAINER::getUsername);
        registry.add("spring.datasource.password", CONTAINER::getPassword);
    }
}
Run Code Online (Sandbox Code Playgroud)

不幸的是，这也行不通。我在日志记录中注意到@DynamicPropertySource带注释的方法仅调用一次，而不是每次测试都调用一次，这导致我尝试选项 3：

公共超类与@DynamicPropertySource子类

当使用公共超类，但@DynamicPropertySource在每个子类中添加该方法时，它又可以工作了。

该子类的示例代码：

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
public class AtleteRepositoryTest extends DatabaseBaseTest {

    @DynamicPropertySource
    static void registerProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.datasource.url", () -> {
            String jdbcUrl = CONTAINER.getJdbcUrl();
            System.out.println("jdbcUrl = " + jdbcUrl);
            return jdbcUrl;
        });
        registry.add("spring.datasource.username", CONTAINER::getUsername);
        registry.add("spring.datasource.password", CONTAINER::getPassword);
    }

    @Autowired
    private AtleteRepository repository;

    @Test
    void testSave() {
        repository.save(new Atlete("Wout Van Aert", 0, 1, 0));

        assertThat(repository.count()).isEqualTo(1);
    }
}
Run Code Online (Sandbox Code Playgroud)

请参阅该版本的分支feature/testcontainers-datajpatest_database-base-test_subclasses 。

因此，虽然它有效，但每个测试类中仍然存在大量重复。

还有其他选择可以避免重复吗？

K. *_*ddy 13

为了避免 Testcontainers 代码重复，我通常遵循两种方法：

  1. 将ApplicationContextInitializer与@ContextConfiguration一起使用
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.test.util.TestPropertyValues;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.testcontainers.containers.PostgreSQLContainer;

@Slf4j
public class PostgreSQLContainerInitializer
        implements ApplicationContextInitializer<ConfigurableApplicationContext> {

    private static PostgreSQLContainer sqlContainer = new PostgreSQLContainer("postgres:10.7");

    static {
        
        sqlContainer.start();
    }

    public void initialize (ConfigurableApplicationContext configurableApplicationContext){
        TestPropertyValues.of(
                "spring.datasource.url=" + sqlContainer.getJdbcUrl(),
                "spring.datasource.username=" + sqlContainer.getUsername(),
                "spring.datasource.password=" + sqlContainer.getPassword()
        ).applyTo(configurableApplicationContext.getEnvironment());
    }

}
Run Code Online (Sandbox Code Playgroud) 
import com.sivalabs.myservice.common.PostgreSQLContainerInitializer;
import com.sivalabs.myservice.entities.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.test.context.ContextConfiguration;
import javax.persistence.EntityManager;
import java.util.Optional;
import static org.assertj.core.api.Assertions.assertThat;

@DataJpaTest
@AutoConfigureTestDatabase(replace= AutoConfigureTestDatabase.Replace.NONE)
@ContextConfiguration(initializers = {PostgreSQLContainerInitializer.class})
class UserRepositoryTest {

    @Autowired
    EntityManager entityManager;

    @Autowired
    private UserRepository userRepository;

    @Test
    void shouldReturnUserGivenValidCredentials() {
        User user = new User(null, "test@gmail.com", "test", "Test");
        entityManager.persist(user);
        
        Optional<User> userOptional = userRepository.login("test@gmail.com", "test");
        
        assertThat(userOptional).isNotEmpty();
    }
}
Run Code Online (Sandbox Code Playgroud)
  1. 在Java 8+ 接口中使用@DynamicPropertySource
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

@Testcontainers
public interface PostgreSQLContainerInitializer {

    @Container
    PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:12.3");

    @DynamicPropertySource
    static void registerPgProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.datasource.url", postgres::getJdbcUrl);
        registry.add("spring.datasource.username", postgres::getUsername);
        registry.add("spring.datasource.password", postgres::getPassword);
    }
}
Run Code Online (Sandbox Code Playgroud) 
@DataJpaTest
@AutoConfigureTestDatabase(replace= AutoConfigureTestDatabase.Replace.NONE)
class UserRepositoryTest implements PostgreSQLContainerInitializer {

    ....
    ....
}
Run Code Online (Sandbox Code Playgroud)

通过这些方法，我们不必重复PostgreSQLContainer声明和 Spring 属性设置。

是否使用PostgreSQLContainer作为静态字段取决于您是否想要为每个测试启动一个新容器或每个测试类 1 个容器。

PS： 我避免使用通用基类方法，因为有时一个测试只需要 1 个容器，而另一个测试需要多个容器。如果我们将所有容器添加到公共基类中，那么对于每个测试/类，所有这些容器都将启动，无论它们的使用情况如何，这使得测试非常慢。

  • 测试这两种方法后，我发现这两种方法都适用于单个测试，但如果您有很多测试，则只有方法 1 可以正常工作。我现在在我的测试套件中使用方法 1。谢谢你！ (2认同)

归档时间：

查看次数：

2789 次

最近记录：

4 年 前
相关归档
为什么我在Java中获得NoClassDefFoundError？ 505
Eclipse调试器中Step Into和Step Over有什么区别？ 178
具有已定义超时的Java HTTP客户端请求 83
"条件"时"无所事事" 69
从JavaScript读取JSP变量 57
简单的基于Java名称的锁？ 57
HMAC-SHA1:如何在Java中正确完成？ 52
如何为Java程序创建.exe？ 50
排除 Junit4 测试依赖项 5
如何使用 AssertJ 递归比较具有不同字段名称但相同值的两个对象 3
难疑归档
'git pull'和'git fetch'有什么区别？ 11447
"yield"关键字有什么作用？ 9664
"INNER JOIN"和"OUTER JOIN"有什么区别？ 4506
在Python中查找包含它的列表的项目的索引 2887
在Bash中提取文件名和扩展名 1969
CSS三角形如何工作？ 1791
如何生成随机字母数字字符串？ 1679
C#在foreach中重用变量是否有原因？ 1631
在jQuery中序列化为JSON 1189
如何查找Python中是否存在目录 1048