Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Catch WebServer stop or destroy exception when context refresh fails

Browse Source 
This commit adds the stop or destroy failure as a suppressed
exception if either ServletWebServerApplicationContext or
ReactiveWebServerApplicationContext refresh fails.

See gh-44310

Signed-off-by: Dmytro Nosan <dimanosan@gmail.com>
This commit is contained in:
Dmytro Nosan
2025-02-05 12:48:53 +02:00
committed by Stéphane Nicoll
parent e51efef30b
commit 84bde2a836
4 changed files with 100 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/context/ReactiveWebServerApplicationContext.java
View File

@@ -65,13 +65,18 @@ public class ReactiveWebServerApplicationContext extends GenericReactiveWebAppli
try {
super.refresh();
}
catch (RuntimeException ex) {
catch (RuntimeException refreshEx) {
WebServer webServer = getWebServer();
if (webServer != null) {
webServer.stop();
webServer.destroy();
try {
webServer.stop();
webServer.destroy();
}
catch (RuntimeException stopOrDestroyEx) {
refreshEx.addSuppressed(stopOrDestroyEx);
}
}
throw ex;
throw refreshEx;
}
}

17
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContext.java
View File

@@ -145,13 +145,18 @@ public class ServletWebServerApplicationContext extends GenericWebApplicationCon
try {
super.refresh();
}
catch (RuntimeException ex) {
WebServer webServer = this.webServer;
if (webServer != null) {
webServer.stop();
webServer.destroy();
catch (RuntimeException refreshEx) {
try {
WebServer webServer = this.webServer;
if (webServer != null) {
webServer.stop();
webServer.destroy();
}
}
throw ex;
catch (RuntimeException stopOrDestroyEx) {
refreshEx.addSuppressed(stopOrDestroyEx);
}
throw refreshEx;
}
}

35
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/reactive/context/ReactiveWebServerApplicationContextTests.java
View File

@@ -43,6 +43,7 @@ import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.mockito.BDDMockito.then;
import static org.mockito.BDDMockito.willThrow;
import static org.mockito.Mockito.times;
/**
@@ -133,6 +134,40 @@ class ReactiveWebServerApplicationContextTests {
then(webServer).should().destroy();
}
@Test
void whenContextRefreshFailedThenWebServerStopFailedCatchStopException() {
addWebServerFactoryBean();
addHttpHandlerBean();
this.context.registerBeanDefinition("refreshFailure", new RootBeanDefinition(RefreshFailure.class, () -> {
willThrow(new RuntimeException("WebServer has failed to stop")).willCallRealMethod()
.given(this.context.getWebServer())
.stop();
return new RefreshFailure();
}));
assertThatExceptionOfType(BeanCreationException.class).isThrownBy(this.context::refresh)
.withStackTraceContaining("WebServer has failed to stop");
WebServer webServer = this.context.getWebServer();
then(webServer).should().stop();
then(webServer).should(times(0)).destroy();
}
@Test
void whenContextRefreshFailedThenWebServerIsStoppedAndDestroyFailedCatchDestroyException() {
addWebServerFactoryBean();
addHttpHandlerBean();
this.context.registerBeanDefinition("refreshFailure", new RootBeanDefinition(RefreshFailure.class, () -> {
willThrow(new RuntimeException("WebServer has failed to destroy")).willCallRealMethod()
.given(this.context.getWebServer())
.destroy();
return new RefreshFailure();
}));
assertThatExceptionOfType(BeanCreationException.class).isThrownBy(this.context::refresh)
.withStackTraceContaining("WebServer has failed to destroy");
WebServer webServer = this.context.getWebServer();
then(webServer).should().stop();
then(webServer).should().destroy();
}
@Test
void whenContextIsClosedThenWebServerIsStoppedAndDestroyed() {
addWebServerFactoryBean();

46
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/context/ServletWebServerApplicationContextTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -51,6 +51,7 @@ import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.testsupport.system.CapturedOutput;
import org.springframework.boot.testsupport.system.OutputCaptureExtension;
import org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer;
import org.springframework.boot.web.server.WebServer;
import org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletContextInitializer;
@@ -81,6 +82,7 @@ import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.BDDMockito.given;
import static org.mockito.BDDMockito.then;
import static org.mockito.BDDMockito.willThrow;
import static org.mockito.Mockito.atMost;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
@@ -211,6 +213,48 @@ class ServletWebServerApplicationContextTests {
assertThat(listener.receivedEvents()).isEmpty();
}
@Test
void whenContextRefreshFailedThenWebServerIsStoppedAndDestroyed() {
addWebServerFactoryBean();
this.context.registerBeanDefinition("refreshFailure", new RootBeanDefinition(RefreshFailure.class));
assertThatExceptionOfType(BeanCreationException.class).isThrownBy(this.context::refresh);
WebServer webServer = this.context.getWebServer();
then(webServer).should(times(2)).stop();
then(webServer).should().destroy();
}
@Test
void whenContextRefreshFailedThenWebServerStopFailedCatchStopException() {
addWebServerFactoryBean();
this.context.registerBeanDefinition("refreshFailure", new RootBeanDefinition(RefreshFailure.class, () -> {
willThrow(new RuntimeException("WebServer has failed to stop")).willCallRealMethod()
.given(this.context.getWebServer())
.stop();
return new RefreshFailure();
}));
assertThatExceptionOfType(BeanCreationException.class).isThrownBy(this.context::refresh)
.withStackTraceContaining("WebServer has failed to stop");
WebServer webServer = this.context.getWebServer();
then(webServer).should().stop();
then(webServer).should(times(0)).destroy();
}
@Test
void whenContextRefreshFailedThenWebServerIsStoppedAndDestroyFailedCatchDestroyException() {
addWebServerFactoryBean();
this.context.registerBeanDefinition("refreshFailure", new RootBeanDefinition(RefreshFailure.class, () -> {
willThrow(new RuntimeException("WebServer has failed to destroy")).willCallRealMethod()
.given(this.context.getWebServer())
.destroy();
return new RefreshFailure();
}));
assertThatExceptionOfType(BeanCreationException.class).isThrownBy(this.context::refresh)
.withStackTraceContaining("WebServer has failed to destroy");
WebServer webServer = this.context.getWebServer();
then(webServer).should().stop();
then(webServer).should().destroy();
}
@Test
void cannotSecondRefresh() {
addWebServerFactoryBean();