java - 如何测试Spring Boot优雅关闭？

Question

我的目标是测试 spring-boot 执行器调用以关闭我的应用程序。

我编写了以下测试:

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class MyAppTest {

  private static final String SHUTDOWN_URL = "/actuator/shutdown";

  @Autowired
  protected TestRestTemplate restTemplate;

  @Autowired
  protected ConfigurableApplicationContext ctx;

  @Test
  @DirtiesContext(methodMode = DirtiesContext.MethodMode.AFTER_METHOD)
  void applicationShutsDown() throws URISyntaxException {
    RequestEntity<Void> request = RequestEntity.post(new URI(SHUTDOWN_URL)).contentType(MediaType.APPLICATION_JSON).build();
    ResponseEntity<Void> response = restTemplate.exchange(request, Void.class);

    assertThat(response.getStatusCode()).isSameAs(HttpStatus.OK);

    await().atMost(Duration.ofSeconds(30))
        .until(() -> !ctx.isActive() && !ctx.isRunning());
  }
}

我发现这个测试通过得很好。但测试执行后，我收到以下错误。

因此，尽管所有断言均成功，但测试仍被标记为失败。

java.lang.IllegalStateException: The ApplicationContext loaded for [[WebMergedContextConfiguration@eda25e5 testClass = MyAppTest, locations = '{}', classes = '{class com.mytest.MyAppTest}', contextInitializerClasses = '[]', activeProfiles = '{}', propertySourceLocations = '{}', propertySourceProperties = '{org.springframework.boot.test.context.SpringBootTestContextBootstrapper=true, server.port=0}', contextCustomizers = set[org.springframework.boot.test.context.filter.ExcludeFilterContextCustomizer@4bdeaabb, org.springframework.boot.test.json.DuplicateJsonObjectContextCustomizerFactory$DuplicateJsonObjectContextCustomizer@71075444, org.springframework.boot.test.mock.mockito.MockitoContextCustomizer@0, org.springframework.boot.test.web.client.TestRestTemplateContextCustomizer@5745ca0e, org.springframework.boot.test.autoconfigure.properties.PropertyMappingContextCustomizer@0, org.springframework.boot.test.autoconfigure.web.servlet.WebDriverContextCustomizerFactory$Customizer@4d15107f, org.springframework.boot.test.context.SpringBootTestArgs@1], resourceBasePath = 'src/main/webapp', contextLoader = 'org.springframework.boot.test.context.SpringBootContextLoader', parent = [null]]] is not active. This may be due to one of the following reasons: 1) the context was closed programmatically by user code; 2) the context was closed during parallel test execution either according to @DirtiesContext semantics or due to automatic eviction from the ContextCache due to a maximum cache size policy.

    at org.springframework.util.Assert.state(Assert.java:97)
    at org.springframework.test.context.support.DefaultTestContext.getApplicationContext(DefaultTestContext.java:127)
    at org.springframework.test.context.TestContext.publishEvent(TestContext.java:94)
    at org.springframework.test.context.event.EventPublishingTestExecutionListener.afterTestExecution(EventPublishingTestExecutionListener.java:129)
    at org.springframework.test.context.TestContextManager.afterTestExecution(TestContextManager.java:379)
    at org.springframework.test.context.junit.jupiter.SpringExtension.afterTestExecution(SpringExtension.java:129)

Answer 1

可以引用Spring Boot Actuator代码中已有的测试here

@SpringBootApplication
@ConfigurationPropertiesScan
public class SampleActuatorApplication {

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

    @Bean
    public HealthIndicator helloHealthIndicator() {
        return () -> Health.up().withDetail("hello", "world").build();
    }

}

---

@SpringBootTest(classes = { ShutdownSampleActuatorApplicationTests.SecurityConfiguration.class,
        SampleActuatorApplication.class }, webEnvironment = WebEnvironment.RANDOM_PORT)
class ShutdownSampleActuatorApplicationTests {

    @Autowired
    private TestRestTemplate restTemplate;

    @Test
    void testHome() {
        ResponseEntity<Map<String, Object>> entity = asMapEntity(
                this.restTemplate.withBasicAuth("user", "password").getForEntity("/", Map.class));
        assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
        Map<String, Object> body = entity.getBody();
        assertThat(body.get("message")).isEqualTo("Hello Phil");
    }

    @Test
    @DirtiesContext
    void testShutdown() {
        ResponseEntity<Map<String, Object>> entity = asMapEntity(this.restTemplate.withBasicAuth("user", "password")
                .postForEntity("/actuator/shutdown", null, Map.class));
        assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
        assertThat(((String) entity.getBody().get("message"))).contains("Shutting down");
    }

    @SuppressWarnings({ "unchecked", "rawtypes" })
    static <K, V> ResponseEntity<Map<K, V>> asMapEntity(ResponseEntity<Map> entity) {
        return (ResponseEntity) entity;
    }

    @Configuration(proxyBeanMethods = false)
    static class SecurityConfiguration extends WebSecurityConfigurerAdapter {

        @Override
        protected void configure(HttpSecurity http) throws Exception {
            http.csrf().disable();
        }

    }

}