From 3aa3c4a2c3317f9f90a529a5a547edf3248fe6a0 Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Tue, 10 May 2022 15:23:12 +0200 Subject: [PATCH] GH-865 Added initial test for Observability module Resolves #865 --- .../catalog/FunctionAroundWrapper.java | 5 ++ spring-cloud-function-observability/pom.xml | 8 +- .../ObservationAutoConfiguration.java | 38 ++++++++++ .../ObservationFunctionAroundWrapper.java | 3 +- .../main/resources/META-INF/spring.factories | 2 + ...ObservationFunctionAroundWrapperTests.java | 75 +++++++++++++++++++ 6 files changed, 128 insertions(+), 3 deletions(-) create mode 100644 spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationAutoConfiguration.java create mode 100644 spring-cloud-function-observability/src/main/resources/META-INF/spring.factories create mode 100644 spring-cloud-function-observability/src/test/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapperTests.java diff --git a/spring-cloud-function-context/src/main/java/org/springframework/cloud/function/context/catalog/FunctionAroundWrapper.java b/spring-cloud-function-context/src/main/java/org/springframework/cloud/function/context/catalog/FunctionAroundWrapper.java index 49ff7454a..9e59c3eb6 100644 --- a/spring-cloud-function-context/src/main/java/org/springframework/cloud/function/context/catalog/FunctionAroundWrapper.java +++ b/spring-cloud-function-context/src/main/java/org/springframework/cloud/function/context/catalog/FunctionAroundWrapper.java @@ -18,6 +18,9 @@ package org.springframework.cloud.function.context.catalog; import java.util.function.BiFunction; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + import org.springframework.cloud.function.context.catalog.SimpleFunctionRegistry.FunctionInvocationWrapper; import org.springframework.messaging.Message; import org.springframework.util.StringUtils; @@ -35,6 +38,8 @@ import org.springframework.util.StringUtils; */ public abstract class FunctionAroundWrapper implements BiFunction { + private static final Log log = LogFactory.getLog(FunctionAroundWrapper.class); + @Override public final Object apply(Object input, FunctionInvocationWrapper targetFunction) { String functionalTracingEnabledStr = System.getProperty("spring.sleuth.function.enabled"); diff --git a/spring-cloud-function-observability/pom.xml b/spring-cloud-function-observability/pom.xml index e1855592e..59befddfb 100644 --- a/spring-cloud-function-observability/pom.xml +++ b/spring-cloud-function-observability/pom.xml @@ -31,11 +31,15 @@ io.micrometer micrometer-tracing-api - io.micrometer - micrometer-tracing-integration-test + micrometer-observation-test + test + + + org.springframework.boot + spring-boot-actuator-autoconfigure test diff --git a/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationAutoConfiguration.java b/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationAutoConfiguration.java new file mode 100644 index 000000000..03f5616ab --- /dev/null +++ b/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationAutoConfiguration.java @@ -0,0 +1,38 @@ +/* + * Copyright 2022-2022 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.cloud.function.observability; + +import io.micrometer.observation.ObservationRegistry; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * + * @author Oleg Zhurakousky + * + */ +@Configuration(proxyBeanMethods = false) +public class ObservationAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public ObservationFunctionAroundWrapper wrapper(ObservationRegistry registry) { + return new ObservationFunctionAroundWrapper(registry); + } +} diff --git a/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapper.java b/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapper.java index 16dbb4529..1a668983b 100644 --- a/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapper.java +++ b/spring-cloud-function-observability/src/main/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapper.java @@ -30,6 +30,7 @@ import org.springframework.cloud.function.context.catalog.SimpleFunctionRegistry /** * @author Marcin Grzejszczak + * @author Oleg Zhurakousky * @since 4.0.0 */ public class ObservationFunctionAroundWrapper extends FunctionAroundWrapper implements Observation.KeyValuesProviderAware { @@ -70,7 +71,7 @@ public class ObservationFunctionAroundWrapper extends FunctionAroundWrapper impl .keyValuesProvider(tagsProvider) .observe(() -> { Object r = message == null ? targetFunction.get() : targetFunction.apply(invocationMessage); - context.setOutput(r); + context.setModifiedOutput(r); return r; }); if (result == null) { diff --git a/spring-cloud-function-observability/src/main/resources/META-INF/spring.factories b/spring-cloud-function-observability/src/main/resources/META-INF/spring.factories new file mode 100644 index 000000000..b50aa16e2 --- /dev/null +++ b/spring-cloud-function-observability/src/main/resources/META-INF/spring.factories @@ -0,0 +1,2 @@ +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.function.observability.ObservationAutoConfiguration \ No newline at end of file diff --git a/spring-cloud-function-observability/src/test/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapperTests.java b/spring-cloud-function-observability/src/test/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapperTests.java new file mode 100644 index 000000000..6767425f8 --- /dev/null +++ b/spring-cloud-function-observability/src/test/java/org/springframework/cloud/function/observability/ObservationFunctionAroundWrapperTests.java @@ -0,0 +1,75 @@ +/* + * Copyright 2022-2022 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.cloud.function.observability; + +import java.util.function.Function; + +import io.micrometer.core.tck.TestObservationRegistry; +import io.micrometer.core.tck.TestObservationRegistryAssert; +import io.micrometer.observation.ObservationRegistry; +import org.junit.jupiter.api.Test; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.cloud.function.context.FunctionCatalog; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.messaging.Message; +import org.springframework.messaging.support.MessageBuilder; + +/** + * + * @author Oleg Zhurakousky + * + */ +public class ObservationFunctionAroundWrapperTests { + + @Test + public void testSingleObservation() { + try (ConfigurableApplicationContext context = SpringApplication.run(SampleConfiguration.class, "")) { + FunctionCatalog catalog = context.getBean(FunctionCatalog.class); + Function, Message> uppercase = catalog.lookup("uppercase", "application/json"); + Message result = uppercase.apply(MessageBuilder.withPayload("\"marcin\"").build()); + System.out.println("Result: " + result); + + TestObservationRegistry registry = context.getBean(TestObservationRegistry.class); + TestObservationRegistryAssert.then(registry).hasSingleObservationThat() + .hasNameEqualTo("spring.cloud.function"); + } + } + + @Configuration + @EnableAutoConfiguration + public static class SampleConfiguration { + + @Bean + public ObservationRegistry testRegistry() { + return TestObservationRegistry.create(); + } + +// @Bean +// public ObservationFunctionAroundWrapper wrapper(ObservationRegistry registry) { +// return new ObservationFunctionAroundWrapper(registry); +// } + + @Bean + public Function uppercase() { + return v -> v.toUpperCase(); + } + } +}