如何使用 junit5 和 testcontainers 测试存储库？

Posted 2023-03-28

技术标签:

【中文标题】如何使用 junit5 和 testcontainers 测试存储库？【英文标题】：How to test repository with junit5 and testcontainers? 【发布时间】：2021-02-10 16:21:15 【问题描述】：

我有一个示例项目，我在其中试验不同的技术。

我有以下设置：

Spring Boot 2.3.4.RELEASE 飞路 7.0.1 测试容器 1.15.0-rc2 Junit 5.7.0

如何使用 testcontainer-junit5 测试 Repository 层？

我现在为CompanyRepositoryTest.java 提供的代码示例：

@ExtendWith(SpringExtension.class)
@Testcontainers
public class CompanyRepositoryTest 

    @Autowired
    private CompanyRepository companyRepository;

    @Container
    public mysqlContainer mysqlContainer = new MySQLContainer()
            .withDatabaseName("foo")
            .withUsername("foo")
            .withPassword("secret");;

    
    @Test
    public void whenFindByIdExecuted_thenNullReturned()
            throws Exception 
        assertEquals(companyRepository.findById(1L), Optional.ofNullable(null));
    

    @Test
    public void whenFindAllExecuted_thenEmptyListReturned() 
        assertEquals(companyRepository.findAll(), new ArrayList<>());

当我添加@SpringBootTest 时，我需要设置所有上下文并且有一些应用程序加载上下文问题？

问题是，谁能揭开@TestContainers 注释的作用？在测试存储库时使用它的最佳做法或正确做法是什么？

【问题讨论】：

除了已经很好的答案外，本指南还讨论了 Testcontainers + Spring Boot + JUnit (4/5) 的所有可能设置方式：rieckpil.de/… 【参考方案1】：

@Testcontainers 注释提供的JUnit 5 extension 会扫描使用@Container 注释声明的任何容器，然后启动和停止这些容器以进行测试。作为静态字段的容器将与所有测试共享，作为实例字段的容器将为每个测试启动和停止。

如果您使用 Spring Boot，为测试设置测试容器的最简单方法可能是在 application-test.yml 中提供属性。这将使用数据源 JDBC URL 来启动 testcontainers 容器。有关详细信息，请参阅 Testcontainers JDBC support。

您也可以使用@DataJpaTest 而不是@SpringBootTest 仅测试存储库层：

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@ActiveProfiles("test")
class CompanyRepositoryTest

您的application-test.yml 文件：

spring:
  datasource:
    url: jdbc:tc:mysql:8.0://hostname/databasename
    driver-class-name: org.testcontainers.jdbc.ContainerDatabaseDriver

在某些情况下，您可能还想使用@TestPropertySource 注释：

@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@TestPropertySource(
    properties = 
        "spring.datasource.url = jdbc:tc:mysql:8.0://hostname/test-database",
        "spring.datasource.driver-class-name = org.testcontainers.jdbc.ContainerDatabaseDriver"
    
)
class CompanyRepositoryTest

请注意，hostname 和 test-database 实际上并未在任何地方使用。

【讨论】：

【参考方案2】：

你说

当我添加@SpringBootTest 时，我需要设置所有上下文并拥有一些应用程序加载上下文问题？

如果您想尝试替代方案并且 Testcontainer 不是强制性的，您可以采用不同的方式。

使用SpringBootTest注解不需要加载everyting，可以指定需要哪些类如

@SpringBootTest(classes =  TheService.class )

或者使用@Import注解

并嘲笑其他人，例如

@MockBean
MyService service;

对于数据库连接，您可以使用注释，例如

@ActiveProfiles("my-profile-for-jpa-test")
@DataJpaTest
@EnableJpaAuditing
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)

编辑：我觉得这应该是一个评论，但我想用正确的格式解决问题的 SpringBootTest 部分

【讨论】：

这是一个不错的答案，但我也想使用测试容器。作为我想要评估的技术之一。另外，我特别想要 testcontainers + junit5，因为我使用过 testconatiners + junit4，并且网上有很多关于它的用法的参考资料，但还不是 junit5。【参考方案3】：

这是一个例子，我是如何在 Spring 中使用 MySql 配置 Liquibase（类似于 Flyway 的框架）：

@DataJpaTest
@TestPropertySource(properties = "spring.jpa.hibernate.ddl-auto=validate")
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@ContextConfiguration(initializers =  MySqlLiquibaseBaseIT.Initializer.class )
@Testcontainers
public class MySqlLiquibaseBaseIT 

  @Container
  public static MySQLContainer<?> mysql = new MySQLContainer<>(
    DockerImageName
      .parse(MySQLContainer.NAME)
      .withTag("5.7.22"));

  @Configuration
  @EnableJpaRepositories
  @EntityScan
  static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> 
    @Override
    public void initialize(ConfigurableApplicationContext configurableApplicationContext) 
      TestPropertyValues.of(
        "spring.datasource.url=" + mysql.getJdbcUrl(),
        "spring.datasource.username=" + mysql.getUsername(),
        "spring.datasource.password=" + mysql.getPassword(),
        "spring.datasource.driver-class-name=" + mysql.getDriverClassName())
        .applyTo(configurableApplicationContext.getEnvironment());
    

    @Bean
    public SpringLiquibase springLiquibase(DataSource dataSource) 
      SpringLiquibase liquibase = new SpringLiquibase();
      liquibase.setDropFirst(true);
      liquibase.setDataSource(dataSource);
      liquibase.setChangeLog("classpath:/db/changelog/db.changelog-master.yml");
      return liquibase;

完整的MySqlLiquibaseBaseIT.java

【讨论】：

【参考方案4】：

根据docs: