DefaultLogbackConfigurationTests Class — spring-boot Architecture

Source Code

core/spring-boot/src/test/java/org/springframework/boot/logging/logback/DefaultLogbackConfigurationTests.java lines 38–122

class DefaultLogbackConfigurationTests {

	private final LoggerContext loggerContext = new LoggerContext();

	private final LogbackConfigurator logbackConfigurator = new LogbackConfigurator(this.loggerContext);

	@Test
	void defaultLogbackXmlContainsConsoleLogPattern() throws Exception {
		assertThatDefaultXmlContains("CONSOLE_LOG_PATTERN", DefaultLogbackConfiguration.CONSOLE_LOG_PATTERN);
	}

	@Test
	void defaultLogbackXmlContainsFileLogPattern() throws Exception {
		assertThatDefaultXmlContains("FILE_LOG_PATTERN", DefaultLogbackConfiguration.FILE_LOG_PATTERN);
	}

	@Test
	void consoleLogCharsetShouldUseConsoleCharsetIfConsoleAvailable() {
		DefaultLogbackConfiguration logbackConfiguration = spy(new DefaultLogbackConfiguration(null));
		Console console = mock(Console.class);
		given(console.charset()).willReturn(StandardCharsets.UTF_16);
		given(logbackConfiguration.getConsole()).willReturn(console);
		logbackConfiguration.apply(this.logbackConfigurator);
		assertThat(this.loggerContext.getProperty("CONSOLE_LOG_CHARSET")).isEqualTo(StandardCharsets.UTF_16.name());
	}

	@Test
	void consoleLogCharsetShouldDefaultToUtf8WhenConsoleIsNull() {
		DefaultLogbackConfiguration logbackConfiguration = spy(new DefaultLogbackConfiguration(null));
		given(logbackConfiguration.getConsole()).willReturn(null);
		logbackConfiguration.apply(this.logbackConfigurator);
		assertThat(this.loggerContext.getProperty("CONSOLE_LOG_CHARSET")).isEqualTo(StandardCharsets.UTF_8.name());
	}

	@Test
	void consoleLogCharsetShouldUseSystemPropertyIfSet() {
		withSystemProperty("CONSOLE_LOG_CHARSET", StandardCharsets.US_ASCII.name(), () -> {
			new DefaultLogbackConfiguration(null).apply(this.logbackConfigurator);
			assertThat(this.loggerContext.getProperty("CONSOLE_LOG_CHARSET"))
				.isEqualTo(StandardCharsets.US_ASCII.name());
		});
	}

	@Test
	void fileLogCharsetShouldUseSystemPropertyIfSet() {
		withSystemProperty("FILE_LOG_CHARSET", StandardCharsets.ISO_8859_1.name(), () -> {
			new DefaultLogbackConfiguration(null).apply(this.logbackConfigurator);
			assertThat(this.loggerContext.getProperty("FILE_LOG_CHARSET"))
				.isEqualTo(StandardCharsets.ISO_8859_1.name());
		});
	}

	@Test
	void fileLogCharsetShouldDefaultToUtf8() {
		new DefaultLogbackConfiguration(null).apply(this.logbackConfigurator);
		assertThat(this.loggerContext.getProperty("FILE_LOG_CHARSET")).isEqualTo(StandardCharsets.UTF_8.name());
	}

	private void assertThatDefaultXmlContains(String name, String value) throws Exception {
		String expected = "<property name=\"%s\" value=\"%s\"/>".formatted(name, value);
		assertThat(defaultXmlContent()).contains(expected);
	}

	private String defaultXmlContent() throws IOException {
		return StreamUtils.copyToString(getClass().getResourceAsStream("defaults.xml"), StandardCharsets.UTF_8);
	}

	private static void withSystemProperty(String name, String value, Runnable action) {
		String previous = System.getProperty(name);
		try {
			System.setProperty(name, value);
			action.run();
		}
		finally {
			if (previous != null) {
				System.setProperty(name, previous);
			}
			else {
				System.clearProperty(name);
			}
		}

	}

}