Add manually run test code to exercise AWS X-Ray remote sampler end-to-end. (#56)

Author: Anuraag Agrawal

aws-xray/build.gradle.kts

@@ -1,9 +1,15 @@
 plugins {
     id("otel.java-conventions")
+
+    id("org.unbroken-dome.test-sets")
 }
 
 description = "OpenTelemetry AWS X-Ray Support"
 
+testSets {
+    create("awsTest")
+}
+
 dependencies {
     api("io.opentelemetry:opentelemetry-api")
     api("io.opentelemetry:opentelemetry-sdk-trace")
@@ -23,4 +29,7 @@ dependencies {
     testImplementation("com.google.guava:guava")
     testImplementation("org.slf4j:slf4j-simple")
     testImplementation("org.skyscreamer:jsonassert")
+
+    add("awsTestImplementation", "io.opentelemetry:opentelemetry-exporter-otlp-trace")
+    add("awsTestImplementation", "org.testcontainers:junit-jupiter")
 }

aws-xray/src/awsTest/java/io/opentelemetry/contrib/aws/xray/AwsXrayRemoteSamplerIntegrationTest.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package io.opentelemetry.contrib.aws.xray;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.contrib.awsxray.AwsXrayRemoteSampler;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.trace.IdGenerator;
+import java.time.Duration;
+import java.util.Collections;
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.output.Slf4jLogConsumer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.DockerImageName;
+import org.testcontainers.utility.MountableFile;
+
+// We do not currently automate integration testing because it requires AWS credentials. If we were
+// to set up AWS credentials in CI in the future, this test could be improved to use the AWS API
+// to update sampling rules and assert rough ratios of sampling decisions. In the meantime, it
+// expects you to update the rules through the dashboard to see the effect on the sampling decisions
+// that are printed.
+@Testcontainers(disabledWithoutDocker = true)
+class AwsXrayRemoteSamplerIntegrationTest {
+
+  private static final Logger logger =
+      LoggerFactory.getLogger(AwsXrayRemoteSamplerIntegrationTest.class);
+
+  @Container
+  private static final GenericContainer<?> otelCollector =
+      new GenericContainer<>(DockerImageName.parse("otel/opentelemetry-collector-contrib:latest"))
+          .withExposedPorts(13133, 2000)
+          .waitingFor(Wait.forHttp("/").forPort(13133))
+          .withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("otel-collector")))
+          .withCopyFileToContainer(
+              MountableFile.forClasspathResource("/otel-collector.yml"), "/etc/otel-collector.yml")
+          .withCommand("--config /etc/otel-collector.yml --log-level DEBUG")
+          .withEnv("AWS_ACCESS_KEY_ID", System.getenv("AWS_ACCESS_KEY_ID"))
+          .withEnv("AWS_SECRET_ACCESS_KEY", System.getenv("AWS_SECRET_ACCESS_KEY"))
+          .withEnv("AWS_REGION", System.getenv("AWS_REGION"));
+
+  @Test
+  void keepSampling() throws Exception {
+    AwsXrayRemoteSampler sampler =
+        AwsXrayRemoteSampler.newBuilder(Resource.getDefault())
+            .setEndpoint("http://localhost:" + otelCollector.getMappedPort(2000))
+            .setPollingInterval(Duration.ofSeconds(5))
+            .build();
+
+    try {
+      while (true) {
+        logger.info(
+            "Sampling Decision: {}",
+            sampler
+                .shouldSample(
+                    Context.root(),
+                    IdGenerator.random().generateTraceId(),
+                    "cat-service",
+                    SpanKind.SERVER,
+                    Attributes.empty(),
+                    Collections.emptyList())
+                .getDecision());
+        Thread.sleep(500);
+      }
+    } finally {
+      sampler.close();
+    }
+  }
+}

aws-xray/src/awsTest/resources/otel-collector.yml

@@ -0,0 +1,15 @@
+receivers:
+  awsxray:
+
+extensions:
+  health_check:
+
+exporters:
+  logging:
+
+service:
+  extensions: [health_check]
+  pipelines:
+    traces:
+      receivers: [awsxray]
+      exporters: [logging]

dependencyManagement/build.gradle.kts

@@ -17,7 +17,8 @@ val DEPENDENCY_BOMS = listOf(
     "org.junit:junit-bom:5.7.2",
     "com.linecorp.armeria:armeria-bom:1.9.1",
     "io.opentelemetry:opentelemetry-bom:1.4.1",
-    "io.opentelemetry:opentelemetry-bom-alpha:1.4.1-alpha"
+    "io.opentelemetry:opentelemetry-bom-alpha:1.4.1-alpha",
+    "org.testcontainers:testcontainers-bom:1.16.0"
 )
 
 val DEPENDENCY_SETS = listOf<DependencySet>(

settings.gradle.kts

@@ -2,6 +2,7 @@ pluginManagement {
     plugins {
         id("com.github.ben-manes.versions") version "0.39.0"
         id("com.github.johnrengelman.shadow") version "7.0.0"
+        id("org.unbroken-dome.test-sets") version "4.0.0"
         id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
     }
 }