feat: Configure OpenTelemetryTestReporter by ScalaTest's ConfigMap

NomadBlacky · Jun 12, 2024 · 961aa1d · 961aa1d
1 parent 37c740a
commit 961aa1d
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -123,6 +123,23 @@ Open the Jaeger UI in your browser (http://localhost:16686/) and you will see th
 
 ![img.png](jaeger-trace.png)
 
-## Blogs
+## Configuration
+
+You can configure the behavior of the reporter by [ScalaTest's config map](https://www.scalatest.org/user_guide/using_the_runner).
+
+```scala
+Test / testOptions += Tests.Argument(
+  TestFrameworks.ScalaTest,
+  "-C",
+  "example.JaegerTestReporter",
+  "-Dscalatest-otel-reporter.root-span-name=my-awesome-tests",
+)
+```
+
+| Key                                      | Description                | Default     |
+|------------------------------------------|----------------------------|-------------|
+| `scalatest-otel-reporter.root-span-name` | The name of the root span. | `scalatest` |
+
+## Posts
 
 - [テストでも Observability したいっ！ ScalaTest を OpenTelemetry で計装してみた (ScalaMatsuri 2024 Unconference)](https://cobalt-lupin-e48.notion.site/Observability-ScalaTest-OpenTelemetry-b2d3e69d75f146b1a26fe9199d51e3e9)
diff --git a/build.sbt b/build.sbt
@@ -74,5 +74,6 @@ lazy val `example-manual-configuration` = (project in file("examples/manual-conf
       TestFrameworks.ScalaTest,
       "-C",
       "dev.nomadblacky.scalatest_otel_reporter.examples.JaegerTestReporter",
+      "-Dscalatest-otel-reporter.root-span-name=example-manual-configuration",
     ),
   )
diff --git a/..._otel_reporter/examples/SimpleTests.scala → ...el_reporter/examples/SucceededTests.scala b/..._otel_reporter/examples/SimpleTests.scala → ...el_reporter/examples/SucceededTests.scala
@@ -2,7 +2,7 @@ package dev.nomadblacky.scalatest_otel_reporter.examples
 
 import org.scalatest.funsuite.AnyFunSuiteLike
 
-class SimpleTests extends AnyFunSuiteLike {
+class SucceededTests extends AnyFunSuiteLike {
 
   test("sum") {
     assert(1 + 1 == 2)

diff --git a/...er/src/main/scala/dev/nomadblacky/scalatest_otel_reporter/OpenTelemetryTestReporter.scala b/...er/src/main/scala/dev/nomadblacky/scalatest_otel_reporter/OpenTelemetryTestReporter.scala
@@ -10,6 +10,8 @@ import java.util.concurrent.ConcurrentHashMap
 import java.util.logging.Logger
 
 trait OpenTelemetryTestReporter extends Reporter {
+  import OpenTelemetryTestReporter._
+
   def otel: OpenTelemetry
 
   private val tracer = otel.getTracerProvider.get("scalatest")
@@ -27,8 +29,8 @@ trait OpenTelemetryTestReporter extends Reporter {
        */
       case starting: RunStarting =>
         logger.fine(s"RunStarting")
-        // TODO: Make possible to configure the root span name
-        testRootSpan = tracer.spanBuilder("UNIT_TEST").startSpan()
+        val rootSpanName = starting.configMap.getWithDefault(ConfigKeyRootSpanName, DefaultRootSpanName)
+        testRootSpan = tracer.spanBuilder(rootSpanName).startSpan()
 
       case completed: RunCompleted =>
         logger.fine(s"RunCompleted")
@@ -143,3 +145,8 @@ trait OpenTelemetryTestReporter extends Reporter {
       case _: MarkupProvided     => ()
     }
 }
+
+object OpenTelemetryTestReporter {
+  val ConfigKeyRootSpanName = "scalatest-otel-reporter.root-span-name"
+  val DefaultRootSpanName   = "scalatest"
+}
diff --git a/...l-reporter/src/test/scala/dev/nomadblacky/scalatest_otel_reporter/ConfigurationSpec.scala b/...l-reporter/src/test/scala/dev/nomadblacky/scalatest_otel_reporter/ConfigurationSpec.scala
@@ -0,0 +1,36 @@
+package dev.nomadblacky.scalatest_otel_reporter
+
+import org.scalatest.{ConfigMap, ParallelTestExecution}
+import org.scalatest.events.{Ordinal, RunCompleted, RunStarting}
+
+class ConfigurationSpec extends UnitTestSuite with OTelMockServer with ParallelTestExecution {
+  import OpenTelemetryTestReporter._
+
+  test("Configure the root span name") {
+    val spans = instrumentWithMockServer { mockServer =>
+      val reporter = new WireMockOTelTestReporter(host, mockServer.port())
+      reporter.apply(RunStarting(new Ordinal(0), 0, new ConfigMap(Map(ConfigKeyRootSpanName -> "my-awesome-tests"))))
+      reporter.apply(RunCompleted(ordinal = new Ordinal(1)))
+    }
+
+    logger.info(s"Received spans: $spans")
+
+    assert(spans.size == 1)
+    val span = spans.head
+    span.getName shouldBe "my-awesome-tests"
+  }
+
+  test("Fallback to the default root span name") {
+    val spans = instrumentWithMockServer { mockServer =>
+      val reporter = new WireMockOTelTestReporter(host, mockServer.port())
+      reporter.apply(RunStarting(new Ordinal(0), 0, new ConfigMap(Map.empty)))
+      reporter.apply(RunCompleted(ordinal = new Ordinal(1)))
+    }
+
+    logger.info(s"Received spans: $spans")
+
+    assert(spans.size == 1)
+    val span = spans.head
+    span.getName shouldBe DefaultRootSpanName
+  }
+}
diff --git a/...tel-reporter/src/test/scala/dev/nomadblacky/scalatest_otel_reporter/FailedTestsSpec.scala b/...tel-reporter/src/test/scala/dev/nomadblacky/scalatest_otel_reporter/FailedTestsSpec.scala
@@ -1,8 +1,5 @@
 package dev.nomadblacky.scalatest_otel_reporter
 
-import com.github.tomakehurst.wiremock.client.WireMock
-import com.github.tomakehurst.wiremock.matching.RequestPatternBuilder
-import io.opentelemetry.proto.collector.trace.v1.ExportTraceServiceRequest
 import io.opentelemetry.proto.trace.v1.Status
 import org.scalatest.funsuite.AnyFunSuiteLike
 import org.scalatest.{Args, ParallelTestExecution}

diff --git a/...latest_otel_reporter/SimpleTestSpec.scala → ...est_otel_reporter/SucceededTestSpec.scala b/...latest_otel_reporter/SimpleTestSpec.scala → ...est_otel_reporter/SucceededTestSpec.scala
@@ -4,7 +4,7 @@ import io.opentelemetry.proto.trace.v1.Status
 import org.scalatest.Args
 import org.scalatest.funspec.AnyFunSpecLike
 
-class SimpleTestSpec extends UnitTestSuite with OTelMockServer {
+class SucceededTestSpec extends UnitTestSuite with OTelMockServer {
 
   test("SimpleTest") {
     class SimpleTests extends AnyFunSpecLike {