StructuredLogFormatterFactoryTests Class — spring-boot Architecture

Source Code

core/spring-boot/src/test/java/org/springframework/boot/logging/structured/StructuredLogFormatterFactoryTests.java lines 49–241

class StructuredLogFormatterFactoryTests {

	private final StructuredLogFormatterFactory<LogEvent> factory;

	private final MockEnvironment environment = new MockEnvironment();

	StructuredLogFormatterFactoryTests() {
		this.environment.setProperty("logging.structured.ecs.service.version", "1.2.3");
		this.factory = new StructuredLogFormatterFactory<>(LogEvent.class, this.environment,
				this::addAvailableParameters, this::addCommonFormatters);
	}

	private void addAvailableParameters(AvailableParameters availableParameters) {
		availableParameters.add(StringBuilder.class, new StringBuilder("Hello"));
	}

	private void addCommonFormatters(CommonFormatters<LogEvent> commonFormatters) {
		commonFormatters.add(CommonStructuredLogFormat.ELASTIC_COMMON_SCHEMA, (instantiator) -> {
			Environment environment = instantiator.getArg(Environment.class);
			assertThat(environment).isNotNull();
			StackTracePrinter stackTracePrinter = instantiator.getArg(StackTracePrinter.class);
			StringBuilder stringBuilder = instantiator.getArg(StringBuilder.class);
			assertThat(stringBuilder).isNotNull();
			return new TestEcsFormatter(environment, stackTracePrinter, stringBuilder);
		});
	}

	@Test
	void getUsingCommonFormat() {
		assertThat(this.factory.get("ecs")).isInstanceOf(TestEcsFormatter.class);
	}

	@Test
	void getUsingClassName() {
		assertThat(this.factory.get(ExtendedTestEcsFormatter.class.getName()))
			.isInstanceOf(ExtendedTestEcsFormatter.class);
	}

	@Test
	void getUsingClassNameWhenNoSuchClass() {
		assertThatIllegalArgumentException()
			.isThrownBy(() -> assertThat(this.factory.get("com.example.WeMadeItUp")).isNull())
			.withMessage("Unknown format 'com.example.WeMadeItUp'. "
					+ "Values can be a valid fully-qualified class name or one of the common formats: [ecs]");
	}

	@Test
	void getUsingClassNameWhenHasGenericMismatch() {
		assertThatIllegalStateException().isThrownBy(() -> this.factory.get(DifferentFormatter.class.getName()))
			.withMessage("Type argument of org.springframework.boot.logging.structured."
					+ "StructuredLogFormatterFactoryTests$DifferentFormatter "
					+ "must be org.springframework.boot.logging.structured."
					+ "StructuredLogFormatterFactoryTests$LogEvent "
					+ "but was org.springframework.boot.logging.structured."
					+ "StructuredLogFormatterFactoryTests$DifferentLogEvent");
	}

	@Test
	void getUsingClassNameInjectsEnvironment() {
		TestEcsFormatter formatter = (TestEcsFormatter) this.factory.get(TestEcsFormatter.class.getName());
		assertThat(formatter.getEnvironment()).isSameAs(this.environment);
	}

	@Test
	void getUsingClassNameInjectsStackTracePrinter() {
		this.environment.setProperty("logging.structured.json.stacktrace.printer", "standard");
		StructuredLogFormatterFactory<LogEvent> factory = new StructuredLogFormatterFactory<>(LogEvent.class,
				this.environment, this::addAvailableParameters, this::addCommonFormatters);
		TestEcsFormatter formatter = (TestEcsFormatter) factory.get(TestEcsFormatter.class.getName());
		assertThat(formatter.getStackTracePrinter()).isInstanceOf(StandardStackTracePrinter.class);
	}

	@Test
	void getUsingClassNameInjectsCustomParameter() {
		TestEcsFormatter formatter = (TestEcsFormatter) this.factory.get(TestEcsFormatter.class.getName());
		assertThat(formatter.getCustom()).hasToString("Hello");
	}

	@Test
	void getInjectStringMembersCustomizer() {
		this.environment.setProperty("logging.structured.json.rename.spring", "test");
		SpringFactoriesLoader factoriesLoader = mock(SpringFactoriesLoader.class);
		given(factoriesLoader.load(any(), any(ArgumentResolver.class)))
			.willReturn(List.of(new StringMembersStructuredLoggingJsonMembersCustomizer()));
		StructuredLogFormatterFactory<LogEvent> factory = new StructuredLogFormatterFactory<>(factoriesLoader,
				LogEvent.class, this.environment, this::addAvailableParameters, this::addCommonFormatters);
		CustomizedFormatter formatter = (CustomizedFormatter) factory.get(CustomizedFormatter.class.getName());
		assertThat(formatter.format(new LogEvent())).contains("\"test\":\"BOOT\"");
	}

	@Test
	void getInjectObjectMembersCustomizer() {
		this.environment.setProperty("logging.structured.json.rename.spring", "test");
		SpringFactoriesLoader factoriesLoader = mock(SpringFactoriesLoader.class);
		given(factoriesLoader.load(any(), any(ArgumentResolver.class)))
			.willReturn(List.of(new ObjectMembersStructuredLoggingJsonMembersCustomizer()));
		StructuredLogFormatterFactory<LogEvent> factory = new StructuredLogFormatterFactory<>(factoriesLoader,
				LogEvent.class, this.environment, this::addAvailableParameters, this::addCommonFormatters);
		CustomizedFormatter formatter = (CustomizedFormatter) factory.get(CustomizedFormatter.class.getName());
		assertThat(formatter.format(new LogEvent())).contains("\"test\":\"BOOT\"");
	}

	static class StringMembersStructuredLoggingJsonMembersCustomizer
			implements StructuredLoggingJsonMembersCustomizer<String> {

		@Override
		public void customize(Members<String> members) {
			UnaryOperator<@Nullable String> toUpperCase = (string) -> (string != null) ? string.toUpperCase(Locale.ROOT)
					: null;
			members.applyingValueProcessor(ValueProcessor.of(String.class, toUpperCase));
		}

	}

	static class ObjectMembersStructuredLoggingJsonMembersCustomizer
			implements StructuredLoggingJsonMembersCustomizer<Object> {

		@Override
		public void customize(Members<Object> members) {
			UnaryOperator<@Nullable String> toUpperCase = (string) -> (string != null) ? string.toUpperCase(Locale.ROOT)
					: null;
			members.applyingValueProcessor(ValueProcessor.of(String.class, toUpperCase));
		}

	}

	static class LogEvent {

	}

	static class DifferentLogEvent {

	}

	static class TestEcsFormatter implements StructuredLogFormatter<LogEvent> {

		private final Environment environment;

		private final @Nullable StackTracePrinter stackTracePrinter;

		private final StringBuilder custom;

		TestEcsFormatter(Environment environment, @Nullable StackTracePrinter stackTracePrinter, StringBuilder custom) {
			this.environment = environment;
			this.stackTracePrinter = stackTracePrinter;
			this.custom = custom;
		}

		@Override
		public String format(LogEvent event) {
			return "formatted " + this.environment.getProperty("logging.structured.ecs.service.version");
		}

		Environment getEnvironment() {
			return this.environment;
		}

		@Nullable StackTracePrinter getStackTracePrinter() {
			return this.stackTracePrinter;
		}

		StringBuilder getCustom() {
			return this.custom;
		}

	}

	static class ExtendedTestEcsFormatter extends TestEcsFormatter {

		ExtendedTestEcsFormatter(Environment environment, StackTracePrinter stackTracePrinter, StringBuilder custom) {
			super(environment, stackTracePrinter, custom);
		}

	}

	static class DifferentFormatter implements StructuredLogFormatter<DifferentLogEvent> {

		@Override
		public String format(DifferentLogEvent event) {
			return "";
		}

	}

	static class CustomizedFormatter extends JsonWriterStructuredLogFormatter<LogEvent> {

		CustomizedFormatter(StructuredLoggingJsonMembersCustomizer<?> customizer) {
			super((members) -> members.add("spring", "boot"), customizer);
		}

	}

}