From a2eed676a20e14b483823e780a7cbb6ddc531a22 Mon Sep 17 00:00:00 2001 From: smoothbear Date: Fri, 3 Sep 2021 17:08:10 +0900 Subject: [PATCH 1/2] Add testing for AbstractFailureAnalyzer.findCause See gh-27862 --- .../diagnostics/AbstractFailureAnalyzer.java | 6 +- .../AbstractFailureAnalyzerTests.java | 77 +++++++++++++++++++ 2 files changed, 79 insertions(+), 4 deletions(-) create mode 100644 spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java index d2641962db..e683693d2e 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java @@ -31,10 +31,8 @@ public abstract class AbstractFailureAnalyzer implements Fa @Override public FailureAnalysis analyze(Throwable failure) { T cause = findCause(failure, getCauseType()); - if (cause != null) { - return analyze(failure, cause); - } - return null; + + return (cause != null) ? analyze(failure, cause) : null; } /** diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java new file mode 100644 index 0000000000..4647feb23d --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java @@ -0,0 +1,77 @@ +/* + * Copyright 2012-2020 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.diagnostics; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +class AbstractFailureAnalyzerTests { + + private FailureAnalyzerConcrete failureAnalyzerConcrete; + + @BeforeEach + void configureFailureAnalyzer() { + this.failureAnalyzerConcrete = new FailureAnalyzerConcrete(); + } + + @Test + void findCauseExtendsThrowable() { + ThrowableExtendsException ex = new ThrowableExtendsException(); + assertThat(this.failureAnalyzerConcrete.findCause(ex, Throwable.class).getClass()).isNotNull(); + } + + @Test + void findCauseExtendsOtherException() { + ExtendsThrowableExtendsException ex = new ExtendsThrowableExtendsException(); + assertThat(this.failureAnalyzerConcrete.findCause(ex, ThrowableExtendsException.class).getClass()).isNotNull(); + } + + @Test + void findCauseOtherException() { + ThrowableExtendsException ex = new ThrowableExtendsException(); + assertThat(this.failureAnalyzerConcrete.findCause(ex, OtherException.class)).isNull(); + } + + @Test + void findCauseNullObject() { + assertThat(this.failureAnalyzerConcrete.findCause(null, Throwable.class)).isNull(); + } + + static class FailureAnalyzerConcrete extends AbstractFailureAnalyzer { + + @Override + protected FailureAnalysis analyze(Throwable rootFailure, Throwable cause) { + return null; + } + + } + + static class ThrowableExtendsException extends Throwable { + + } + + static class ExtendsThrowableExtendsException extends ThrowableExtendsException { + + } + + static class OtherException extends Throwable { + + } + +} From d68b6bb2f14c0e95760666c3313c1187db439be1 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Tue, 21 Sep 2021 10:05:15 +0200 Subject: [PATCH 2/2] Polish "Add testing for AbstractFailureAnalyzer.findCause" See gh-27862 --- .../diagnostics/AbstractFailureAnalyzer.java | 3 +- .../AbstractFailureAnalyzerTests.java | 64 ++++++++++++------- 2 files changed, 42 insertions(+), 25 deletions(-) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java index e683693d2e..c2a7ec95e2 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzer.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 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. @@ -31,7 +31,6 @@ public abstract class AbstractFailureAnalyzer implements Fa @Override public FailureAnalysis analyze(Throwable failure) { T cause = findCause(failure, getCauseType()); - return (cause != null) ? analyze(failure, cause) : null; } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java index 4647feb23d..e8137f9872 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/diagnostics/AbstractFailureAnalyzerTests.java @@ -16,44 +16,66 @@ package org.springframework.boot.diagnostics; -import org.junit.jupiter.api.BeforeEach; +import java.io.IOException; + import org.junit.jupiter.api.Test; import static org.assertj.core.api.Assertions.assertThat; +/** + * Tests for {@link AbstractFailureAnalyzer}. + * + * @author Kim Jung Bin + * @author Stephane Nicoll + */ class AbstractFailureAnalyzerTests { - private FailureAnalyzerConcrete failureAnalyzerConcrete; + private final TestFailureAnalyzer failureAnalyzer = new TestFailureAnalyzer(); - @BeforeEach - void configureFailureAnalyzer() { - this.failureAnalyzerConcrete = new FailureAnalyzerConcrete(); + @Test + void findCauseWithNullException() { + assertThat(this.failureAnalyzer.findCause(null, Throwable.class)).isNull(); } @Test - void findCauseExtendsThrowable() { - ThrowableExtendsException ex = new ThrowableExtendsException(); - assertThat(this.failureAnalyzerConcrete.findCause(ex, Throwable.class).getClass()).isNotNull(); + void findCauseWithDirectExactMatch() { + TestException ex = new TestException(); + assertThat(this.failureAnalyzer.findCause(ex, TestException.class)).isEqualTo(ex); } @Test - void findCauseExtendsOtherException() { - ExtendsThrowableExtendsException ex = new ExtendsThrowableExtendsException(); - assertThat(this.failureAnalyzerConcrete.findCause(ex, ThrowableExtendsException.class).getClass()).isNotNull(); + void findCauseWithDirectSubClass() { + SpecificTestException ex = new SpecificTestException(); + assertThat(this.failureAnalyzer.findCause(ex, TestException.class)).isEqualTo(ex); } @Test - void findCauseOtherException() { - ThrowableExtendsException ex = new ThrowableExtendsException(); - assertThat(this.failureAnalyzerConcrete.findCause(ex, OtherException.class)).isNull(); + void findCauseWitNestedAndExactMatch() { + TestException ex = new TestException(); + assertThat(this.failureAnalyzer.findCause(new IllegalArgumentException(new IllegalStateException(ex)), + TestException.class)).isEqualTo(ex); } @Test - void findCauseNullObject() { - assertThat(this.failureAnalyzerConcrete.findCause(null, Throwable.class)).isNull(); + void findCauseWitNestedAndSubClass() { + SpecificTestException ex = new SpecificTestException(); + assertThat(this.failureAnalyzer.findCause(new IOException(new IllegalStateException(ex)), TestException.class)) + .isEqualTo(ex); } - static class FailureAnalyzerConcrete extends AbstractFailureAnalyzer { + @Test + void findCauseWithUnrelatedException() { + IOException ex = new IOException(); + assertThat(this.failureAnalyzer.findCause(ex, TestException.class)).isNull(); + } + + @Test + void findCauseWithMoreSpecificException() { + TestException ex = new TestException(); + assertThat(this.failureAnalyzer.findCause(ex, SpecificTestException.class)).isNull(); + } + + static class TestFailureAnalyzer extends AbstractFailureAnalyzer { @Override protected FailureAnalysis analyze(Throwable rootFailure, Throwable cause) { @@ -62,15 +84,11 @@ class AbstractFailureAnalyzerTests { } - static class ThrowableExtendsException extends Throwable { + static class TestException extends Exception { } - static class ExtendsThrowableExtendsException extends ThrowableExtendsException { - - } - - static class OtherException extends Throwable { + static class SpecificTestException extends TestException { }