polish and add more tests

Author: nosan

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/diagnostics/analyzer/AbstractNoSuchBeanDefinitionFailureAnalyzer.java

@@ -100,16 +100,6 @@ protected final FailureAnalysis analyze(Throwable rootFailure, T cause,
 				beanMetadata);
 	}
 
-	private List<Annotation> findInjectionAnnotations(Throwable failure) {
-		UnsatisfiedDependencyException unsatisfiedDependencyException = findCause(failure,
-				UnsatisfiedDependencyException.class);
-		if (unsatisfiedDependencyException == null) {
-			return Collections.emptyList();
-		}
-		return Arrays.asList(
-				unsatisfiedDependencyException.getInjectionPoint().getAnnotations());
-	}
-
 	/**
 	 * Returns an analysis of the given {@code rootFailure}, or {@code null} if no
 	 * analysis was possible.
@@ -144,6 +134,16 @@ private List<AutoConfigurationReport> getAutoConfigurationReports(
 		return result;
 	}
 
+	private List<Annotation> findInjectionAnnotations(Throwable failure) {
+		UnsatisfiedDependencyException unsatisfiedDependencyException = findCause(failure,
+				UnsatisfiedDependencyException.class);
+		if (unsatisfiedDependencyException == null) {
+			return Collections.emptyList();
+		}
+		return Arrays.asList(
+				unsatisfiedDependencyException.getInjectionPoint().getAnnotations());
+	}
+
 	private List<AutoConfigurationReport> getReportedConditionOutcomes(
 			BeanMetadata beanMetadata) {
 		List<AutoConfigurationReport> result = new ArrayList<>();

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/diagnostics/analyzer/NoSuchBeanDefinitionFailureAnalyzerTests.java

@@ -37,8 +37,11 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.context.annotation.ImportResource;
+import org.springframework.stereotype.Component;
 import org.springframework.test.util.ReflectionTestUtils;
 import org.springframework.util.ClassUtils;
+import org.springframework.util.StringUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -166,7 +169,8 @@ public void failureAnalysisForNullBeanByType() {
 		assertDescriptionConstructorMissingType(analysis, StringHandler.class, 0,
 				String.class);
 		assertUserDefinedBean(analysis, "as the bean value is null",
-				TestNullBeanConfiguration.class, "string", "string", String.class);
+				ClassUtils.getShortName(TestNullBeanConfiguration.class), "string",
+				"string", String.class);
 		assertActionMissingType(analysis, String.class);
 	}
 
@@ -178,13 +182,37 @@ public void failureAnalysisForUnmatchedQualifier() {
 				"@org.springframework.beans.factory.annotation.Qualifier\\(value=\"*alpha\"*\\)");
 	}
 
+	@Test
+	public void failureAnalysisForQualifierBeanByType() {
+		FailureAnalysis analysis = analyzeFailure(
+				createFailure(TestClassQualifierComponentBeanConfiguration.class));
+		assertDescriptionConstructorMissingType(analysis, TestClassQualifierHandler.class,
+				0, TestClass.class);
+		assertThat(analysis.getDescription())
+				.containsPattern("Qualifier\\(value=\"*test-class\"*\\)");
+		assertUserDefinedBean(analysis, null, null, null, "testClass", TestClass.class);
+		assertActionMissingType(analysis, TestClass.class);
+	}
+
+	@Test
+	public void failureAnalysisForQualifierBeanByTypeXmlResource() {
+		FailureAnalysis analysis = analyzeFailure(
+				createFailure(TestClassQualifierXmlBeanConfiguration.class));
+		assertDescriptionConstructorMissingType(analysis, TestClassQualifierHandler.class,
+				0, TestClass.class);
+		assertUserDefinedBean(analysis, null,
+				"class path resource [org/springframework/boot/autoconfigure/diagnostics/analyzer/beans.xml]",
+				null, "xmlTestBean", TestClass.class);
+		assertActionMissingType(analysis, TestClass.class);
+	}
+
 	private void assertDescriptionConstructorMissingType(FailureAnalysis analysis,
 			Class<?> component, int index, Class<?> type) {
 		String expected = String.format(
 				"Parameter %s of constructor in %s required a bean of "
 						+ "type '%s' that could not be found.",
 				index, component.getName(), type.getName());
-		assertThat(analysis.getDescription()).startsWith(expected);
+		assertThat(analysis.getDescription()).contains(expected);
 	}
 
 	private void assertActionMissingType(FailureAnalysis analysis, Class<?> type) {
@@ -218,13 +246,19 @@ private void assertClassDisabled(FailureAnalysis analysis, String description,
 	}
 
 	private void assertUserDefinedBean(FailureAnalysis analysis, String description,
-			Class<?> target, String methodName, String beanName, Class<?> beanClass) {
-		String expected = String.format(
-				"User-defined bean '%s' of type '%s' : defined by method '%s' in %s",
-				beanName, beanClass.getName(), methodName,
-				ClassUtils.getShortName(target));
+			String target, String methodName, String beanName, Class<?> beanClass) {
+		StringBuilder expected = new StringBuilder(String.format(
+				"User-defined bean '%s' of type '%s'", beanName, beanClass.getName()));
+		if (StringUtils.hasText(methodName)) {
+			expected.append(String.format(" : defined by method '%s'", methodName));
+		}
+		if (StringUtils.hasText(target)) {
+			expected.append(String.format(" in %s", target));
+		}
 		assertThat(analysis.getDescription()).contains(expected);
-		assertThat(analysis.getDescription()).contains(description);
+		if (StringUtils.hasText(description)) {
+			assertThat(analysis.getDescription()).contains(description);
+		}
 	}
 
 	private static void addExclusions(NoSuchBeanDefinitionFailureAnalyzer analyzer,
@@ -295,6 +329,20 @@ protected static class StringMissingBeanNameConfiguration {
 
 	}
 
+	@Configuration
+	@Import({ TestClass.class, TestClassQualifierHandler.class })
+	protected static class TestClassQualifierComponentBeanConfiguration {
+
+	}
+
+	@Configuration
+	@Import({ TestClassQualifierHandler.class })
+	@ImportResource("classpath:/org/springframework/boot/autoconfigure/diagnostics"
+			+ "/analyzer/beans.xml")
+	protected static class TestClassQualifierXmlBeanConfiguration {
+
+	}
+
 	@Configuration
 	@ImportAutoConfiguration(TestNullBeanConfiguration.class)
 	@Import(StringHandler.class)
@@ -392,4 +440,16 @@ public StringNameHandler(BeanFactory beanFactory) {
 
 	}
 
+	protected static class TestClassQualifierHandler {
+
+		public TestClassQualifierHandler(@Qualifier("test-class") TestClass foo) {
+		}
+
+	}
+
+	@Component("testClass")
+	protected static class TestClass {
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/test/resources/org/springframework/boot/autoconfigure/diagnostics/analyzer/beans.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
+
+	<bean class="org.springframework.boot.autoconfigure.diagnostics.analyzer.NoSuchBeanDefinitionFailureAnalyzerTests$TestClass"
+		  name="xmlTestBean"/>
+
+</beans>