SampleStructuredLoggingApplicationTests.java

/*
 * Copyright 2012-2025 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 smoketest.structuredlogging;

import java.nio.file.Path;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.LoggerFactory;

import org.springframework.boot.logging.LoggingSystem;
import org.springframework.boot.logging.LoggingSystemProperty;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;

import static org.assertj.core.api.Assertions.assertThat;

/**
 * Tests for {@link SampleStructuredLoggingApplication}.
 *
 * @author Phillip Webb
 */
@ExtendWith(OutputCaptureExtension.class)
class SampleStructuredLoggingApplicationTests {

	@AfterEach
	void reset() {
		LoggingSystem.get(getClass().getClassLoader()).cleanUp();
		for (LoggingSystemProperty property : LoggingSystemProperty.values()) {
			System.getProperties().remove(property.getEnvironmentVariableName());
		}
	}

	// https://github.com/spring-projects/spring-boot/issues/44502
	@Test
	void javaNioPathShouldNotCauseStackOverflowError(CapturedOutput output) {
		SampleStructuredLoggingApplication.main(new String[0]);
		LoggerFactory.getLogger(SampleStructuredLoggingApplication.class)
			.atInfo()
			.addKeyValue("directory", Path.of("stack/overflow/error"))
			.log("java.nio.file.Path works as expected");
		assertThat(output).contains("java.nio.file.Path works as expected").contains("""
				"directory":"stack\\/overflow\\/error""");
	}

	@Test
	void shouldNotLogBanner(CapturedOutput output) {
		SampleStructuredLoggingApplication.main(new String[0]);
		assertThat(output).doesNotContain(" :: Spring Boot :: ");
	}

	@Test
	void json(CapturedOutput output) {
		SampleStructuredLoggingApplication.main(new String[0]);
		assertThat(output).doesNotContain("{\"@timestamp\"")
			.contains("\"process.thread.name\":\"!!")
			.contains("\"process.procid\"")
			.contains("\"message\":\"Starting SampleStructuredLoggingApplication")
			.contains("\"foo\":\"hello");
	}

	@Test
	void custom(CapturedOutput output) {
		SampleStructuredLoggingApplication.main(new String[] { "--spring.profiles.active=custom" });
		assertThat(output).contains("epoch=").contains("msg=\"Starting SampleStructuredLoggingApplication");
	}

}