cleans up unnecessary tests and adds comments

open-telemetry · Jan 16, 2023 · 460495b · 460495b
1 parent 38d5c27
commit 460495b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 65 deletions.
diff --git a/opencensus-shim/build.gradle.kts b/opencensus-shim/build.gradle.kts
@@ -3,8 +3,6 @@ plugins {
   id("otel.publish-conventions")
 }
 
-val javaagent by configurations.creating
-
 description = "OpenTelemetry OpenCensus Shim"
 otelJava.moduleName.set("io.opentelemetry.opencensusshim")
 
@@ -23,8 +21,6 @@ dependencies {
 
   testImplementation("io.opencensus:opencensus-impl")
   testImplementation("io.opencensus:opencensus-contrib-exemplar-util")
-
-  javaagent("io.opentelemetry.javaagent:opentelemetry-javaagent:1.21.0")
 }
 
 tasks.named<Test>("test") {
@@ -33,22 +29,3 @@ tasks.named<Test>("test") {
   setForkEvery(1)
   maxParallelForks = 3
 }
-
-testing {
-  suites {
-    val integrationTest by registering(JvmTestSuite::class) {
-      dependencies {
-      }
-
-      targets {
-        all {
-          testTask.configure {
-            jvmArgs("-javaagent:${javaagent.asPath}")
-            environment("OTEL_TRACES_EXPORTER", "logging")
-            environment("OTEL_METRICS_EXPORTER", "none")
-          }
-        }
-      }
-    }
-  }
-}
diff --git a/...census-shim/src/integrationTest/java/io/opentelemetry/opencensusshim/IntegrationTest.java b/...census-shim/src/integrationTest/java/io/opentelemetry/opencensusshim/IntegrationTest.java
diff --git a/opencensus-shim/src/test/java/io/opentelemetry/opencensusshim/ProxyingSpanTest.java b/opencensus-shim/src/test/java/io/opentelemetry/opencensusshim/ProxyingSpanTest.java
@@ -23,6 +23,14 @@
 import org.mockito.Mockito;
 import org.mockito.verification.VerificationMode;
 
+/**
+ * Ensures all methods for {@link Span} are appropriately proxied by {@link OpenTelemetrySpanImpl},
+ * further ensuring the shim behaves as expected when under otel javaagent instrumentation.
+ *
+ * <p>This addresses a regression between the shim as used with the Otel SDK on the app classloader
+ * and as instrumented via the javaagent. Details <a
+ * href="https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/6876">here</a>.
+ */
 class ProxyingSpanTest {
 
   /*