Add test to verify Jaeger baggage propagation

Signed-off-by: Tim Quinn <[email protected]>

tracing/providers/jaeger/pom.xml

@@ -108,6 +108,20 @@
         <!--
          - Test dependencies
          -->
+
+        <!-- OTel dependencies needed to get fully-functional propagators -->
+        <dependency>
+            <groupId>io.opentelemetry</groupId>
+            <artifactId>opentelemetry-sdk-extension-autoconfigure</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.opentelemetry</groupId>
+            <artifactId>opentelemetry-exporter-otlp</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <!-- -->
+
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
@@ -128,10 +142,42 @@
             <artifactId>helidon-config-yaml</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.common.testing</groupId>
+            <artifactId>helidon-common-testing-junit5</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <!-- Separate the baggage prop test to avoid interference with other tests -->
+                <executions>
+                    <execution>
+                        <id>default-test</id>
+                        <configuration>
+                            <excludes>**/JaegerBaggagePropagationTest.java</excludes>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>baggage-propagation-test</id>
+                        <goals>
+                            <goal>test</goal>
+                        </goals>
+                        <configuration>
+                            <properties>
+                                <configurationParameters>
+                                    junit.jupiter.extensions.autodetection.enabled = true
+                                </configurationParameters>
+                            </properties>
+                            <includes>**/JaegerBaggagePropagationTest.java</includes>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>

tracing/providers/jaeger/src/test/java/io/helidon/tracing/providers/jaeger/JaegerBaggagePropagationTest.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * 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
+ *
+ *     http://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 io.helidon.tracing.providers.jaeger;
+
+import java.util.Optional;
+import java.util.TreeMap;
+
+import io.helidon.common.testing.junit5.OptionalMatcher;
+import io.helidon.tracing.HeaderConsumer;
+import io.helidon.tracing.HeaderProvider;
+import io.helidon.tracing.SpanContext;
+import io.helidon.tracing.Tracer;
+import io.helidon.tracing.WritableBaggage;
+
+import org.junit.jupiter.api.Test;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
+
+class JaegerBaggagePropagationTest {
+
+    static final String BAGGAGE_KEY = "myKey";
+    static final String BAGGAGE_VALUE = "myValue";
+
+    @Test
+    void testBaggageProp() {
+        var tracer = Tracer.global();
+        var span = tracer.spanBuilder("testSpan").start();
+
+        WritableBaggage baggage = span.baggage();
+        baggage.set(BAGGAGE_KEY, BAGGAGE_VALUE);
+
+        try {
+            assertThat("Value after initial storage of baggage",
+                       baggage.get(BAGGAGE_KEY),
+                       OptionalMatcher.optionalValue(is(equalTo(BAGGAGE_VALUE))));
+
+            var headerConsumer = HeaderConsumer.create(new TreeMap<>(String.CASE_INSENSITIVE_ORDER));
+            tracer.inject(span.context(), HeaderProvider.empty(), headerConsumer);
+
+            // Make sure the baggage header was set.
+            Optional<String> baggageHeader = headerConsumer.get("baggage");
+            assertThat("Baggage contents in propagated headers",
+                       baggageHeader,
+                       OptionalMatcher.optionalValue(is(equalTo(BAGGAGE_KEY + "=" + BAGGAGE_VALUE))));
+
+            // Now make sure the baggage is propagated to a new span context based on the header.
+            Optional<SpanContext> propagatedSpanContext = tracer.extract(headerConsumer);
+            assertThat("Propagated span context",
+                       propagatedSpanContext,
+                       OptionalMatcher.optionalPresent());
+            assertThat("Baggage value from propagated span context",
+                       propagatedSpanContext.get().baggage().get(BAGGAGE_KEY),
+                       OptionalMatcher.optionalValue(is(BAGGAGE_VALUE)));
+
+            span.end();
+        } catch (Exception ex) {
+            span.end(ex);
+        }
+    }
+}

tracing/providers/jaeger/src/test/java/io/helidon/tracing/providers/jaeger/OtelTestsJunitExtension.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * 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
+ *
+ *     http://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 io.helidon.tracing.providers.jaeger;
+
+import org.junit.jupiter.api.extension.AfterAllCallback;
+import org.junit.jupiter.api.extension.BeforeAllCallback;
+import org.junit.jupiter.api.extension.Extension;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+public class OtelTestsJunitExtension implements Extension, BeforeAllCallback, AfterAllCallback {
+
+    private static final String OTEL_AUTO_CONFIGURE_PROP = "otel.java.global-autoconfigure.enabled";
+    private static final String OTEL_SDK_DISABLED_PROP = "otel.sdk.disabled";
+    private String originalOtelSdkAutoConfiguredSetting;
+    private String originalOtelSdkDisabledSetting;
+
+    @Override
+    public void afterAll(ExtensionContext extensionContext) throws Exception {
+        if (originalOtelSdkAutoConfiguredSetting != null) {
+            System.setProperty(OTEL_AUTO_CONFIGURE_PROP, originalOtelSdkAutoConfiguredSetting);
+        }
+        if (originalOtelSdkDisabledSetting != null) {
+            System.setProperty(OTEL_SDK_DISABLED_PROP, originalOtelSdkDisabledSetting);
+        }
+    }
+
+    @Override
+    public void beforeAll(ExtensionContext extensionContext) throws Exception {
+        originalOtelSdkAutoConfiguredSetting = System.setProperty(OTEL_AUTO_CONFIGURE_PROP, "true");
+        originalOtelSdkDisabledSetting = System.setProperty(OTEL_SDK_DISABLED_PROP, "false");
+    }
+}

tracing/providers/jaeger/src/test/resources/META-INF/services/org.junit.jupiter.api.extension.Extension

@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2024 Oracle and/or its affiliates.
+#
+# 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
+#
+#     http://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.
+#
+io.helidon.tracing.providers.jaeger.OtelTestsJunitExtension