From 01b1c1d94727a8262ed35bce0640d687e8ea7e27 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 13 Feb 2018 11:34:39 +0000 Subject: [PATCH] Perform failure analysis of MissingRequiredConfigurationException Closes gh-12010 --- ...gRequiredConfigurationFailureAnalyzer.java | 45 +++++++++++ .../main/resources/META-INF/spring.factories | 2 + ...iredConfigurationFailureAnalyzerTests.java | 79 +++++++++++++++++++ 3 files changed, 126 insertions(+) create mode 100644 spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzer.java create mode 100644 spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzerTests.java diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzer.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzer.java new file mode 100644 index 0000000000..1c56669b95 --- /dev/null +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzer.java @@ -0,0 +1,45 @@ +/* + * Copyright 2012-2018 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 + * + * http://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.actuate.autoconfigure.metrics.config; + +import io.micrometer.core.instrument.config.MissingRequiredConfigurationException; + +import org.springframework.boot.diagnostics.AbstractFailureAnalyzer; +import org.springframework.boot.diagnostics.FailureAnalysis; + +/** + * An {@link AbstractFailureAnalyzer} that performs analysis of failures caused by a + * {@link MissingRequiredConfigurationException}. + * + * @author Andy Wilkinson + */ +class MissingRequiredConfigurationFailureAnalyzer + extends AbstractFailureAnalyzer { + + @Override + protected FailureAnalysis analyze(Throwable rootFailure, + MissingRequiredConfigurationException cause) { + StringBuilder description = new StringBuilder(); + description.append(cause.getMessage()); + if (!cause.getMessage().endsWith(".")) { + description.append("."); + } + return new FailureAnalysis(description.toString(), + "Update your application to provide the missing configuration.", cause); + } + +} diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring.factories b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring.factories index e7732a3362..26616260e9 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring.factories +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring.factories @@ -74,3 +74,5 @@ org.springframework.boot.actuate.autoconfigure.web.jersey.JerseyManagementChildC org.springframework.boot.actuate.autoconfigure.web.reactive.ReactiveManagementChildContextConfiguration,\ org.springframework.boot.actuate.autoconfigure.web.servlet.ServletManagementChildContextConfiguration,\ org.springframework.boot.actuate.autoconfigure.web.servlet.WebMvcEndpointChildContextConfiguration +org.springframework.boot.diagnostics.FailureAnalyzer=\ +org.springframework.boot.actuate.autoconfigure.metrics.config.MissingRequiredConfigurationFailureAnalyzer diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzerTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzerTests.java new file mode 100644 index 0000000000..710dfc2178 --- /dev/null +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/config/MissingRequiredConfigurationFailureAnalyzerTests.java @@ -0,0 +1,79 @@ +/* + * Copyright 2012-2018 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 + * + * http://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.actuate.autoconfigure.metrics.config; + +import io.micrometer.core.instrument.Clock; +import io.micrometer.newrelic.NewRelicConfig; +import io.micrometer.newrelic.NewRelicMeterRegistry; +import org.junit.Test; + +import org.springframework.boot.diagnostics.FailureAnalysis; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.AnnotationConfigApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.Assert.fail; + +/** + * Tests for {@link MissingRequiredConfigurationFailureAnalyzer}. + * + * @author Andy Wilkinson + */ +public class MissingRequiredConfigurationFailureAnalyzerTests { + + @Test + public void analyzesMissingRequiredConfiguration() { + FailureAnalysis analysis = new MissingRequiredConfigurationFailureAnalyzer() + .analyze(createFailure(MissingAccountIdConfiguration.class)); + assertThat(analysis).isNotNull(); + assertThat(analysis.getDescription()) + .isEqualTo("accountId must be set to report metrics to New Relic."); + assertThat(analysis.getAction()).isEqualTo( + "Update your application to provide the missing configuration."); + } + + private Exception createFailure(Class configuration) { + try (ConfigurableApplicationContext context = new AnnotationConfigApplicationContext( + configuration)) { + fail("Expected failure did not occur"); + return null; + } + catch (Exception ex) { + return ex; + } + } + + @Configuration + static class MissingAccountIdConfiguration { + + @Bean + public NewRelicMeterRegistry meterRegistry() { + return new NewRelicMeterRegistry(new NewRelicConfig() { + + @Override + public String get(String key) { + return null; + } + + }, Clock.SYSTEM); + } + + } + +}