Merge pull request #30358 from terminux
* gh-30358: Polish "Add failure analyzer for missing web factory bean" Add failure analyzer for missing web factory bean Closes gh-30358pull/30641/head
Andy Wilkinson
3 years ago
commit
a584989408
@ -0,0 +1,59 @@
|
||||
/*
|
||||
* Copyright 2012-2022 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.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.web.context;
|
||||
|
||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
|
||||
import org.springframework.boot.WebApplicationType;
|
||||
import org.springframework.boot.web.server.WebServerFactory;
|
||||
|
||||
/**
|
||||
* Exception thrown when there is no {@link WebServerFactory} bean of the required type
|
||||
* defined in a {@link WebServerApplicationContext}.
|
||||
*
|
||||
* @author Guirong Hu
|
||||
* @author Andy Wilkinson
|
||||
* @since 2.7.0
|
||||
*/
|
||||
public class MissingWebServerFactoryBeanException extends NoSuchBeanDefinitionException {
|
||||
|
||||
private final WebApplicationType webApplicationType;
|
||||
|
||||
/**
|
||||
* Create a new {@code MissingWebServerFactoryBeanException}.
|
||||
* @param webServerApplicationContextClass the class of the
|
||||
* WebServerApplicationContext that required the WebServerFactory
|
||||
* @param webServerFactoryClass the class of the WebServerFactory that was missing
|
||||
* @param webApplicationType the type of the web application
|
||||
*/
|
||||
public MissingWebServerFactoryBeanException(
|
||||
Class<? extends WebServerApplicationContext> webServerApplicationContextClass,
|
||||
Class<? extends WebServerFactory> webServerFactoryClass, WebApplicationType webApplicationType) {
|
||||
super(webServerFactoryClass, String.format("Unable to start %s due to missing %s bean",
|
||||
webServerApplicationContextClass.getSimpleName(), webServerFactoryClass.getSimpleName()));
|
||||
this.webApplicationType = webApplicationType;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the type of web application for which a {@link WebServerFactory} bean was
|
||||
* missing.
|
||||
* @return the type of web application
|
||||
*/
|
||||
public WebApplicationType getWebApplicationType() {
|
||||
return this.webApplicationType;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,47 @@
|
||||
/*
|
||||
* Copyright 2012-2022 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.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.web.context;
|
||||
|
||||
import java.util.Locale;
|
||||
|
||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import org.springframework.boot.diagnostics.FailureAnalyzer;
|
||||
import org.springframework.core.annotation.Order;
|
||||
|
||||
/**
|
||||
* A {@link FailureAnalyzer} that performs analysis of failures caused by an
|
||||
* {@link MissingWebServerFactoryBeanException}.
|
||||
*
|
||||
* @author Guirong Hu
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
@Order(0)
|
||||
class MissingWebServerFactoryBeanFailureAnalyzer extends AbstractFailureAnalyzer<MissingWebServerFactoryBeanException> {
|
||||
|
||||
@Override
|
||||
protected FailureAnalysis analyze(Throwable rootFailure, MissingWebServerFactoryBeanException cause) {
|
||||
return new FailureAnalysis(
|
||||
"Web application could not be started as there was no " + cause.getBeanType().getName()
|
||||
+ " bean defined in the context.",
|
||||
"Check your application's dependencies for a supported "
|
||||
+ cause.getWebApplicationType().name().toLowerCase(Locale.ENGLISH) + " web server.\n"
|
||||
+ "Check the configured web application type.",
|
||||
cause);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,75 @@
|
||||
/*
|
||||
* Copyright 2012-2022 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.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.web.context;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext;
|
||||
import org.springframework.boot.web.reactive.server.ReactiveWebServerFactory;
|
||||
import org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext;
|
||||
import org.springframework.boot.web.servlet.server.ServletWebServerFactory;
|
||||
import org.springframework.context.ApplicationContextException;
|
||||
import org.springframework.context.ConfigurableApplicationContext;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link MissingWebServerFactoryBeanFailureAnalyzer}.
|
||||
*
|
||||
* @author Guirong Hu
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
class MissingWebServerFactoryBeanFailureAnalyzerTests {
|
||||
|
||||
@Test
|
||||
void missingServletWebServerFactoryBeanFailure() {
|
||||
ApplicationContextException failure = createFailure(new ServletWebServerApplicationContext());
|
||||
assertThat(failure).isNotNull();
|
||||
FailureAnalysis analysis = new MissingWebServerFactoryBeanFailureAnalyzer().analyze(failure);
|
||||
assertThat(analysis).isNotNull();
|
||||
assertThat(analysis.getDescription()).isEqualTo("Web application could not be started as there was no "
|
||||
+ ServletWebServerFactory.class.getName() + " bean defined in the context.");
|
||||
assertThat(analysis.getAction()).isEqualTo(
|
||||
"Check your application's dependencies for a supported servlet web server.\nCheck the configured web "
|
||||
+ "application type.");
|
||||
}
|
||||
|
||||
@Test
|
||||
void missingReactiveWebServerFactoryBeanFailure() {
|
||||
ApplicationContextException failure = createFailure(new ReactiveWebServerApplicationContext());
|
||||
FailureAnalysis analysis = new MissingWebServerFactoryBeanFailureAnalyzer().analyze(failure);
|
||||
assertThat(analysis).isNotNull();
|
||||
assertThat(analysis.getDescription()).isEqualTo("Web application could not be started as there was no "
|
||||
+ ReactiveWebServerFactory.class.getName() + " bean defined in the context.");
|
||||
assertThat(analysis.getAction()).isEqualTo(
|
||||
"Check your application's dependencies for a supported reactive web server.\nCheck the configured web "
|
||||
+ "application type.");
|
||||
}
|
||||
|
||||
private ApplicationContextException createFailure(ConfigurableApplicationContext context) {
|
||||
try {
|
||||
context.refresh();
|
||||
context.close();
|
||||
return null;
|
||||
}
|
||||
catch (ApplicationContextException ex) {
|
||||
return ex;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue