StandardStackTracePrinterTests Class — spring-boot Architecture

Architecture documentation for the StandardStackTracePrinterTests class in StandardStackTracePrinterTests.java from the spring-boot codebase.
Class java
Entity Profile

Source Code

core/spring-boot/src/test/java/org/springframework/boot/logging/StandardStackTracePrinterTests.java lines 36–392
class StandardStackTracePrinterTests {

	@Test
	void rootLastPrintsStackTrace() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast();
		assertThatCleanedStackTraceMatches(printer, exception, standardStackTrace());
	}

	@Test
	void rootLastPrintsStackTraceThatMatchesJvm() {
		Throwable exception = TestException.create();
		Writer printedJvmStackTrace = new StringWriter();
		exception.printStackTrace(new PrintWriter(printedJvmStackTrace));
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast();
		assertThatCleanedStackTraceMatches(printer, exception,
				TestException.withoutLineNumbers(printedJvmStackTrace.toString()));
	}

	@Test
	void rootFirstPrintsStackTrace() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst();
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
				Wrapped by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
				Wrapped by: java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					Suppressed: java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						... 1 more
						""");
	}

	@Test
	void withCommonFramesWhenRootLastPrintsAllFrames() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast().withCommonFrames();
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					Suppressed: java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Caused by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Caused by: java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					""");
	}

	@Test
	void withCommonFramesWhenRootFirstPrintsAllFrames() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst().withCommonFrames();
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Wrapped by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Wrapped by: java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					Suppressed: java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
						""");
	}

	@Test
	void withoutSuppressedHidesSuppressed() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast().withoutSuppressed();
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Caused by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
				Caused by: java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
					""");
	}

	@Test
	void withMaximumLengthWhenNegativeThrowsException() {
		assertThatIllegalArgumentException()
			.isThrownBy(() -> StandardStackTracePrinter.rootFirst().withMaximumLength(0))
			.withMessage("'maximumLength' must be positive");
	}

	@Test
	void withMaximumLengthTruncatesOutput() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst().withMaximumLength(14);
		assertThat(printer.printStackTraceToString(exception)).isEqualTo("java.lang.R...");
	}

	@Test
	void withMaximumThrowableDepthWhenNegativeThrowsException() {
		assertThatIllegalArgumentException()
			.isThrownBy(() -> StandardStackTracePrinter.rootFirst().withMaximumThrowableDepth(0))
			.withMessage("'maximumThrowableDepth' must be positive");
	}

	@Test
	void withMaximumThrowableDepthFiltersElements() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst().withMaximumThrowableDepth(1);
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
				Wrapped by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					... 1 filtered
					... 1 more
				Wrapped by: java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					... 3 filtered
					Suppressed: java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						... 1 more
						""");
	}

	@Test
	void withMaximumThrowableDepthAndCommonFramesFiltersElements() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst()
			.withCommonFrames()
			.withMaximumThrowableDepth(2);
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Wrapped by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 filtered
				Wrapped by: java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					... 2 filtered
					Suppressed: java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
						""");
	}

	@Test
	@SuppressWarnings("NullAway") // Test null check
	void withFilterWhenPredicateIsNullThrowsException() {
		assertThatIllegalArgumentException().isThrownBy(() -> StandardStackTracePrinter.rootFirst().withFilter(null))
			.withMessage("'predicate' must not be null");
	}

	@Test
	void withFilterWhenFilterMatches() {
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst()
			.withFilter(IllegalStateException.class::isInstance);
		assertThat(printer.printStackTraceToString(new IllegalStateException("test"))).isNotEmpty();
	}

	@Test
	void withFilterWhenFilterDoesNotMatch() {
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst()
			.withFilter(IllegalStateException.class::isInstance);
		assertThat(printer.printStackTraceToString(new RuntimeException("test"))).isEmpty();
	}

	@Test
	void withMultipleFiltersMustAllMatch() {
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst()
			.withFilter(IllegalStateException.class::isInstance)
			.withFilter((ex) -> "test".equals(ex.getMessage()));
		assertThat(printer.printStackTraceToString(new IllegalStateException("test"))).isNotEmpty();
		assertThat(printer.printStackTraceToString(new IllegalStateException("nope"))).isEmpty();
		assertThat(printer.printStackTraceToString(new RuntimeException("test"))).isEmpty();
	}

	@Test
	void withFrameFilter() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootFirst()
			.withCommonFrames()
			.withFrameFilter((index, element) -> element.getMethodName().startsWith("run"));
		assertThatCleanedStackTraceMatches(printer, exception, """
				java.lang.RuntimeException: root
					... 1 filtered
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Wrapped by: java.lang.RuntimeException: cause
					... 2 filtered
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
				Wrapped by: java.lang.RuntimeException: exception
					... 3 filtered
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					Suppressed: java.lang.RuntimeException: suppressed
						... 1 filtered
						at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
						""");
	}

	@Test
	void withLineSeparatorUsesLineSeparator() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast().withLineSeparator("!");
		assertThatCleanedStackTraceMatches(printer, exception, standardStackTrace().replace("\n", "!"));
	}

	@Test
	@SuppressWarnings("NullAway") // Test null check
	void withFormatterWhenFormatterIsNullThrowsException() {
		assertThatIllegalArgumentException().isThrownBy(() -> StandardStackTracePrinter.rootLast().withFormatter(null))
			.withMessage("'formatter' must not be null");
	}

	@Test
	void withFormatterFormatsThrowable() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast()
			.withFormatter((throwable) -> ClassUtils.getShortName(throwable.getClass()) + ": "
					+ throwable.getLocalizedMessage());
		assertThatCleanedStackTraceMatches(printer, exception, """
				RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					Suppressed: RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						... 1 more
				Caused by: RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
				Caused by: RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
					""");
	}

	@Test
	@SuppressWarnings("NullAway") // Test null check
	void withFrameFormatterWhenFormatterIsNullThrowsException() {
		assertThatIllegalArgumentException()
			.isThrownBy(() -> StandardStackTracePrinter.rootLast().withFrameFormatter(null))
			.withMessage("'frameFormatter' must not be null");
	}

	@Test
	void withFrameFormatterFormatsFrame() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast()
			.withFrameFormatter(
					(element) -> ClassUtils.getShortName(element.getClassName()) + "." + element.getMethodName());
		assertThat(printer.printStackTraceToString(exception)).isEqualToNormalizingNewlines("""
				java.lang.RuntimeException: exception
					at TestException.actualCreateException
					at TestException.createException
					at TestException.createTestException
					at TestException.CreatorThread.run
					Suppressed: java.lang.RuntimeException: suppressed
						at TestException.createTestException
						... 1 more
				Caused by: java.lang.RuntimeException: cause
					at TestException.createCause
					at TestException.createTestException
					... 1 more
				Caused by: java.lang.RuntimeException: root
					at TestException.createTestException
					... 1 more
					""");
	}

	@Test
	void withHashesFunctionPrintsStackTraceWithHashes() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast()
			.withHashes((frame) -> Objects.hash(frame.getClassName(), frame.getMethodName()));
		assertThat(printer.printStackTraceToString(exception)).isEqualToNormalizingNewlines("""
				<#cc3eebec> java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:69)
					at org.springframework.boot.logging.TestException.createException(TestException.java:65)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:55)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:83)
					Suppressed: <#834defc3> java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:56)
						... 1 more
				Caused by: <#611639c5> java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:61)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:54)
					... 1 more
				Caused by: <#834defc3> java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:53)
					... 1 more
				""");
	}

	@Test
	void withHashesPrintsStackTraceWithHashes() {
		Throwable exception = TestException.create();
		StandardStackTracePrinter printer = StandardStackTracePrinter.rootLast().withHashes();
		assertThat(printer.printStackTraceToString(exception)).containsPattern("<#[0-9a-f]{8}>");
	}

	private String standardStackTrace() {
		return """
				java.lang.RuntimeException: exception
					at org.springframework.boot.logging.TestException.actualCreateException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createException(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					at org.springframework.boot.logging.TestException$CreatorThread.run(TestException.java:NN)
					Suppressed: java.lang.RuntimeException: suppressed
						at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
						... 1 more
				Caused by: java.lang.RuntimeException: cause
					at org.springframework.boot.logging.TestException.createCause(TestException.java:NN)
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
				Caused by: java.lang.RuntimeException: root
					at org.springframework.boot.logging.TestException.createTestException(TestException.java:NN)
					... 1 more
					""";
	}

	private void assertThatCleanedStackTraceMatches(StandardStackTracePrinter printer, Throwable throwable,
			String expected) {
		String actual = printer.printStackTraceToString(throwable);
		assertThat(TestException.withoutLineNumbers(actual)).isEqualToNormalizingNewlines(expected);
	}

}
Source

View on GitHub
Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free