SpringBootTest、Testcontainers、容器启动——映射端口只能在容器启动后获取

Posted 2023-03-28

【中文标题】SpringBootTest、Testcontainers、容器启动——映射端口只能在容器启动后获取

【英文标题】：SpringBootTest, Testcontainers, container start up - Mapped port can only be obtained after the container is started

【发布时间】：2021-02-08 05:01:02

【问题描述】：

我正在使用 docker/testcontainers 运行 postgresql 数据库进行测试。我已经为仅测试数据库访问的单元测试有效地做到了这一点。但是，我现在已经将 springboot 测试纳入其中，因此我可以使用嵌入式 Web 服务进行测试，但我遇到了问题。

问题似乎是在容器启动之前请求了 dataSource bean。

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'dataSource' defined in class path resource [com/myproject/integrationtests/IntegrationDataService.class]: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [javax.sql.DataSource]: Factory method 'dataSource' threw exception; nested exception is java.lang.IllegalStateException: Mapped port can only be obtained after the container is started
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [javax.sql.DataSource]: Factory method 'dataSource' threw exception; nested exception is java.lang.IllegalStateException: Mapped port can only be obtained after the container is started
Caused by: java.lang.IllegalStateException: Mapped port can only be obtained after the container is started

这是我的 SpringBootTest：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = IntegrationDataService.class,  TestApplication.class,
        webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class SpringBootTestControllerTesterIT
    
    @Autowired
    private MyController myController;
    @LocalServerPort
    private int port;
    @Autowired
    private TestRestTemplate restTemplate;


    @Test
    public void testRestControllerHello()
        
        String url = "http://localhost:" + port + "/mycontroller/hello";
        ResponseEntity<String> result =
                restTemplate.getForEntity(url, String.class);
        assertEquals(result.getStatusCode(), HttpStatus.OK);
        assertEquals(result.getBody(), "hello");
        

    

这是我从测试中引用的 Spring Boot 应用程序：

@SpringBootApplication
public class TestApplication
    

    public static void main(String[] args)
        
        SpringApplication.run(TestApplication.class, args);
        
   
    

这是用于启动容器并为其他所有内容提供会话工厂/数据源的 IntegrationDataService 类

@Testcontainers
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
@EnableTransactionManagement
@Configuration
public  class IntegrationDataService
    
    @Container
    public static PostgreSQLContainer postgreSQLContainer = (PostgreSQLContainer) new PostgreSQLContainer("postgres:9.6")
            .withDatabaseName("test")
            .withUsername("sa")
            .withPassword("sa")
            .withInitScript("db/postgresql/schema.sql");   

    @Bean
    public Properties hibernateProperties()
        
        Properties hibernateProp = new Properties();
        hibernateProp.put("hibernate.dialect", "org.hibernate.dialect.PostgreSQLDialect");
        hibernateProp.put("hibernate.format_sql", true);
        hibernateProp.put("hibernate.use_sql_comments", true);
//        hibernateProp.put("hibernate.show_sql", true);
        hibernateProp.put("hibernate.max_fetch_depth", 3);
        hibernateProp.put("hibernate.jdbc.batch_size", 10);
        hibernateProp.put("hibernate.jdbc.fetch_size", 50);
        hibernateProp.put("hibernate.id.new_generator_mappings", false);
//        hibernateProp.put("hibernate.hbm2ddl.auto", "create-drop");
//        hibernateProp.put("hibernate.jdbc.lob.non_contextual_creation", true);
        return hibernateProp;
        

    @Bean
    public SessionFactory sessionFactory() throws IOException
        
        LocalSessionFactoryBean sessionFactoryBean = new LocalSessionFactoryBean();
        sessionFactoryBean.setDataSource(dataSource());
        sessionFactoryBean.setHibernateProperties(hibernateProperties());
        sessionFactoryBean.setPackagesToScan("com.myproject.model.entities");
        sessionFactoryBean.afterPropertiesSet();
        return sessionFactoryBean.getObject();
        

    @Bean
    public PlatformTransactionManager transactionManager() throws IOException
        
        return new HibernateTransactionManager(sessionFactory());
             
   
    @Bean
    public DataSource dataSource()
        
        BasicDataSource dataSource = new BasicDataSource();
        dataSource.setDriverClassName(postgreSQLContainer.getDriverClassName());
        dataSource.setUrl(postgreSQLContainer.getJdbcUrl());
        dataSource.setUsername(postgreSQLContainer.getUsername());
        dataSource.setPassword(postgreSQLContainer.getPassword());
        return dataSource;
        

    

在容器启动之前从其中一个 Dao 类的 sessionFactory 请求数据源 bean 时发生错误。

我到底做错了什么？

谢谢！！！

【参考方案1】：

java.lang.IllegalStateException: Mapped port can only be obtained after the container is started 异常的原因是，现在在您使用 @SpringBootTest 进行测试期间创建 Spring 上下文时，它会尝试在应用程序启动时连接到数据库。

由于您仅在 IntegrationDataService 类中启动 PostgreSQL，因此存在时间问题，因为您无法获取 JDBC URL 或在应用程序启动时创建连接，因为此 bean 尚未正确创建。

一般来说，您应该不在IntegrationDataService 类中使用任何与测试相关的代码。启动/停止数据库应该在您的测试设置中完成。

这确保首先启动数据库容器，等待它启动并运行，然后才启动实际测试并创建 Spring 上下文。

我总结了带有 Testcontainers 和 Spring Boot 的 JUnit 4/5 所需的设置机制，这对您有帮助 get the setup right。

最后，这可能如下所示

// JUnit 5 example with Spring Boot >= 2.2.6
@Testcontainers
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
public class ApplicationIT 
 
  @Container
  public static PostgreSQLContainer postgreSQLContainer = new PostgreSQLContainer()
    .withPassword("inmemory")
    .withUsername("inmemory");
 
  @DynamicPropertySource
  static void postgresqlProperties(DynamicPropertyRegistry registry) 
    registry.add("spring.datasource.url", postgreSQLContainer::getJdbcUrl);
    registry.add("spring.datasource.password", postgreSQLContainer::getPassword);
    registry.add("spring.datasource.username", postgreSQLContainer::getUsername);
  
 
  @Test
  public void contextLoads() 
  
 

【讨论】：

太棒了。谢谢你。我让它工作了。但问题是，通过创建 IntegrationDataService 类 ApplicationContextAware 来访问您注册的这些属性的最佳方式是什么？ （这就是我所做的）

如果不是绝对必要的话，我不会自己手动创建 Hibernate Session。让 Spring Boot 为您自动配置一切，而您只需在您的 application.yml

中提供 spring.datasource.url 等

这个设置比较简单。谢谢你的回答。