Replace deep exception message nesting with custom inclusion of cause messages

Includes deprecation of NestedServletException, whereas NestedCheckedException and NestedRuntimeException remain as base classes with several convenience methods.

Closes gh-25162
This commit is contained in:
Juergen Hoeller
2022-06-14 14:00:28 +02:00
parent 933965b7b4
commit 4e1b9f1492
31 changed files with 78 additions and 245 deletions

View File

@@ -1,109 +0,0 @@
/*
* Copyright 2002-2019 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.core;
import java.io.ByteArrayOutputStream;
import java.io.PrintWriter;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* @author Rod Johnson
* @author Juergen Hoeller
*/
@SuppressWarnings("serial")
class NestedExceptionTests {
@Test
void nestedRuntimeExceptionWithNoRootCause() {
String mesg = "mesg of mine";
// Making a class abstract doesn't _really_ prevent instantiation :-)
NestedRuntimeException nex = new NestedRuntimeException(mesg) {};
assertThat(nex.getCause()).isNull();
assertThat(mesg).isEqualTo(nex.getMessage());
// Check printStackTrace
ByteArrayOutputStream baos = new ByteArrayOutputStream();
PrintWriter pw = new PrintWriter(baos);
nex.printStackTrace(pw);
pw.flush();
String stackTrace = new String(baos.toByteArray());
assertThat(stackTrace.contains(mesg)).isTrue();
}
@Test
void nestedRuntimeExceptionWithRootCause() {
String myMessage = "mesg for this exception";
String rootCauseMsg = "this is the obscure message of the root cause";
Exception rootCause = new Exception(rootCauseMsg);
// Making a class abstract doesn't _really_ prevent instantiation :-)
NestedRuntimeException nex = new NestedRuntimeException(myMessage, rootCause) {};
assertThat(rootCause).isEqualTo(nex.getCause());
assertThat(nex.getMessage().contains(myMessage)).isTrue();
assertThat(nex.getMessage().endsWith(rootCauseMsg)).isTrue();
// check PrintStackTrace
ByteArrayOutputStream baos = new ByteArrayOutputStream();
PrintWriter pw = new PrintWriter(baos);
nex.printStackTrace(pw);
pw.flush();
String stackTrace = new String(baos.toByteArray());
assertThat(stackTrace.contains(rootCause.getClass().getName())).isTrue();
assertThat(stackTrace.contains(rootCauseMsg)).isTrue();
}
@Test
void nestedCheckedExceptionWithNoRootCause() {
String mesg = "mesg of mine";
// Making a class abstract doesn't _really_ prevent instantiation :-)
NestedCheckedException nex = new NestedCheckedException(mesg) {};
assertThat(nex.getCause()).isNull();
assertThat(mesg).isEqualTo(nex.getMessage());
// Check printStackTrace
ByteArrayOutputStream baos = new ByteArrayOutputStream();
PrintWriter pw = new PrintWriter(baos);
nex.printStackTrace(pw);
pw.flush();
String stackTrace = new String(baos.toByteArray());
assertThat(stackTrace.contains(mesg)).isTrue();
}
@Test
void nestedCheckedExceptionWithRootCause() {
String myMessage = "mesg for this exception";
String rootCauseMsg = "this is the obscure message of the root cause";
Exception rootCause = new Exception(rootCauseMsg);
// Making a class abstract doesn't _really_ prevent instantiation :-)
NestedCheckedException nex = new NestedCheckedException(myMessage, rootCause) {};
assertThat(rootCause).isEqualTo(nex.getCause());
assertThat(nex.getMessage().contains(myMessage)).isTrue();
assertThat(nex.getMessage().endsWith(rootCauseMsg)).isTrue();
// check PrintStackTrace
ByteArrayOutputStream baos = new ByteArrayOutputStream();
PrintWriter pw = new PrintWriter(baos);
nex.printStackTrace(pw);
pw.flush();
String stackTrace = new String(baos.toByteArray());
assertThat(stackTrace.contains(rootCause.getClass().getName())).isTrue();
assertThat(stackTrace.contains(rootCauseMsg)).isTrue();
}
}