diff --git a/module/spring-boot-actuator-autoconfigure/build.gradle b/module/spring-boot-actuator-autoconfigure/build.gradle index d95823aba60..385261c3d94 100644 --- a/module/spring-boot-actuator-autoconfigure/build.gradle +++ b/module/spring-boot-actuator-autoconfigure/build.gradle @@ -48,6 +48,7 @@ dependencies { testCompileOnly("com.google.code.findbugs:jsr305") testRuntimeOnly("ch.qos.logback:logback-classic") + testRuntimeOnly("com.fasterxml.jackson.datatype:jackson-datatype-jsr310") } tasks.named("compileTestJava") { diff --git a/module/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfiguration.java b/module/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfiguration.java index a09c39a0ea1..8b764183285 100644 --- a/module/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfiguration.java +++ b/module/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfiguration.java @@ -20,13 +20,11 @@ import com.fasterxml.jackson.annotation.JsonInclude.Include; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.SerializationFeature; -import org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper; import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnBooleanProperty; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.context.annotation.Bean; -import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder; /** * {@link EnableAutoConfiguration Auto-configuration} for Endpoint Jackson 2 support. @@ -36,15 +34,15 @@ import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder; * @deprecated since 4.0.0 for removal in 4.2.0 in favor of Jackson 3. */ @AutoConfiguration -@ConditionalOnClass(ObjectMapper.class) +@ConditionalOnClass({ ObjectMapper.class, org.springframework.http.converter.json.Jackson2ObjectMapperBuilder.class }) @Deprecated(since = "4.0.0", forRemoval = true) @SuppressWarnings("removal") public final class Jackson2EndpointAutoConfiguration { @Bean @ConditionalOnBooleanProperty(name = "management.endpoints.jackson.isolated-object-mapper", matchIfMissing = true) - EndpointJackson2ObjectMapper jackson2EndpointJsonMapper() { - ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.json() + org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper jackson2EndpointJsonMapper() { + ObjectMapper objectMapper = org.springframework.http.converter.json.Jackson2ObjectMapperBuilder.json() .featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS) .serializationInclusion(Include.NON_NULL) diff --git a/module/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfigurationTests.java b/module/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfigurationTests.java new file mode 100644 index 00000000000..128c819fc68 --- /dev/null +++ b/module/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/jackson/Jackson2EndpointAutoConfigurationTests.java @@ -0,0 +1,135 @@ +/* + * Copyright 2012-present 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.boot.actuate.autoconfigure.endpoint.jackson; + +import java.time.Duration; +import java.time.Instant; +import java.time.format.DateTimeFormatter; +import java.util.HashMap; +import java.util.Map; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.Test; +import tools.jackson.databind.json.JsonMapper; + +import org.springframework.boot.actuate.endpoint.jackson.EndpointJsonMapper; +import org.springframework.boot.autoconfigure.AutoConfigurations; +import org.springframework.boot.test.context.FilteredClassLoader; +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link Jackson2EndpointAutoConfiguration}. + * + * @author Phillip Webb + * @author Andy Wilkinson + * @deprecated since 4.0.0 for removal in 4.2.0 in favor of Jackson 3 + */ +@SuppressWarnings("removal") +@Deprecated(since = "4.0.0", forRemoval = true) +class Jackson2EndpointAutoConfigurationTests { + + private final ApplicationContextRunner runner = new ApplicationContextRunner() + .withConfiguration(AutoConfigurations.of(Jackson2EndpointAutoConfiguration.class)); + + @Test + void endpointObjectMapperWhenNoProperty() { + this.runner.run((context) -> assertThat(context) + .hasSingleBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class)); + } + + @Test + void endpointObjectMapperWhenPropertyTrue() { + this.runner.run((context) -> assertThat(context) + .hasSingleBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class)); + } + + @Test + void endpointObjectMapperWhenPropertyFalse() { + this.runner.withPropertyValues("management.endpoints.jackson.isolated-object-mapper=false") + .run((context) -> assertThat(context) + .doesNotHaveBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class)); + } + + @Test + void endpointObjectMapperWhenSpringWebIsAbsent() { + this.runner.withClassLoader(new FilteredClassLoader(Jackson2ObjectMapperBuilder.class)) + .run((context) -> assertThat(context) + .doesNotHaveBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class)); + } + + @Test + void endpointObjectMapperDoesNotSerializeDatesAsTimestamps() { + this.runner.run((context) -> { + ObjectMapper objectMapper = context + .getBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class) + .get(); + Instant now = Instant.now(); + String json = objectMapper.writeValueAsString(Map.of("timestamp", now)); + assertThat(json).contains(DateTimeFormatter.ISO_INSTANT.format(now)); + }); + } + + @Test + void endpointObjectMapperDoesNotSerializeDurationsAsTimestamps() { + this.runner.run((context) -> { + ObjectMapper objectMapper = context + .getBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class) + .get(); + Duration duration = Duration.ofSeconds(42); + String json = objectMapper.writeValueAsString(Map.of("duration", duration)); + assertThat(json).contains(duration.toString()); + }); + } + + @Test + void endpointObjectMapperDoesNotSerializeNullValues() { + this.runner.run((context) -> { + ObjectMapper objectMapper = context + .getBean(org.springframework.boot.actuate.endpoint.jackson.EndpointJackson2ObjectMapper.class) + .get(); + HashMap map = new HashMap<>(); + map.put("key", null); + String json = objectMapper.writeValueAsString(map); + assertThat(json).isEqualTo("{}"); + }); + } + + @Configuration(proxyBeanMethods = false) + static class TestEndpointMapperConfiguration { + + @Bean + TestEndpointJsonMapper testEndpointJsonMapper() { + return new TestEndpointJsonMapper(); + } + + } + + static class TestEndpointJsonMapper implements EndpointJsonMapper { + + @Override + public JsonMapper get() { + return new JsonMapper(); + } + + } + +} diff --git a/smoke-test/spring-boot-smoke-test-jackson2-only/build.gradle b/smoke-test/spring-boot-smoke-test-jackson2-only/build.gradle index 136d32d6701..21a155701e1 100644 --- a/smoke-test/spring-boot-smoke-test-jackson2-only/build.gradle +++ b/smoke-test/spring-boot-smoke-test-jackson2-only/build.gradle @@ -31,4 +31,5 @@ dependencies { testImplementation(project(":starter:spring-boot-starter-webmvc-test")) { exclude module: 'spring-boot-starter-jackson' } + testImplementation(project(":test-support:spring-boot-test-support")) } diff --git a/smoke-test/spring-boot-smoke-test-jackson2-only/src/test/java/smoketest/jackson2/only/SampleJackson2OnlyWithoutSpringWebApplicationTests.java b/smoke-test/spring-boot-smoke-test-jackson2-only/src/test/java/smoketest/jackson2/only/SampleJackson2OnlyWithoutSpringWebApplicationTests.java new file mode 100644 index 00000000000..556335ce651 --- /dev/null +++ b/smoke-test/spring-boot-smoke-test-jackson2-only/src/test/java/smoketest/jackson2/only/SampleJackson2OnlyWithoutSpringWebApplicationTests.java @@ -0,0 +1,52 @@ +/* + * Copyright 2012-present 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.jackson2.only; + +import java.lang.management.ManagementFactory; +import java.util.Map; + +import javax.management.MBeanServer; +import javax.management.ObjectName; + +import org.junit.jupiter.api.Test; + +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.testsupport.classpath.ClassPathExclusions; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for Actuator running in {@link SampleJackson2OnlyApplication} with + * {@code spring-web} on the classpath. + * + * @author Andy Wilkinson + */ +@ClassPathExclusions("spring-web-*") +@SpringBootTest(properties = "spring.jmx.enabled=true") +class SampleJackson2OnlyWithoutSpringWebApplicationTests { + + @Test + @SuppressWarnings("unchecked") + void jmxEndpointsShouldWork() throws Exception { + MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer(); + Map result = (Map) mbeanServer.invoke( + ObjectName.getInstance("org.springframework.boot:type=Endpoint,name=Configprops"), + "configurationProperties", new Object[0], null); + assertThat(result).containsOnlyKeys("contexts"); + } + +}