path: root/kamon-core/src/test/scala/kamon/trace/RealSpanSpec.scala

package kamon.trace

import kamon.testkit.{MetricInspection, Reconfigure, TestSpanReporter}
import kamon.util.Registration
import kamon.Kamon
import kamon.trace.Span.{Annotation, TagValue}
import org.scalatest.concurrent.Eventually
import org.scalatest.{BeforeAndAfterAll, Matchers, OptionValues, WordSpec}
import org.scalatest.time.SpanSugar._

class RealSpanSpec extends WordSpec with Matchers with BeforeAndAfterAll with Eventually with OptionValues
    with Reconfigure with MetricInspection {

  "a real span" when {
    "sampled and finished" should {
      "be sent to the Span reporters" in {
        Kamon.buildSpan("test-span")
          .withSpanTag("test", "value")
          .withStartTimestamp(100)
          .start()
          .finish(200)

        eventually(timeout(2 seconds)) {
          val finishedSpan = reporter.nextSpan().value
          finishedSpan.operationName shouldBe("test-span")
          finishedSpan.startTimestampMicros shouldBe 100
          finishedSpan.endTimestampMicros shouldBe 200
          finishedSpan.tags should contain("test" -> TagValue.String("value"))
        }
      }

      "pass all the tags, annotations and baggage to the FinishedSpan instance when started and finished" in {
        Kamon.buildSpan("full-span")
          .withSpanTag("builder-string-tag", "value")
          .withSpanTag("builder-boolean-tag-true", true)
          .withSpanTag("builder-boolean-tag-false", false)
          .withSpanTag("builder-number-tag", 42)
          .withStartTimestamp(100)
          .start()
          .addBaggage("baggage", "value")
          .addSpanTag("span-string-tag", "value")
          .addSpanTag("span-boolean-tag-true", true)
          .addSpanTag("span-boolean-tag-false", false)
          .addSpanTag("span-number-tag", 42)
          .annotate("simple-annotation")
          .annotate("regular-annotation", Map("data" -> "something"))
          .annotate(4200, "custom-annotation-1", Map("custom" -> "yes-1"))
          .annotate(Annotation(4201, "custom-annotation-2", Map("custom" -> "yes-2")))
          .setOperationName("fully-populated-span")
          .finish(200)

        eventually(timeout(2 seconds)) {
          val finishedSpan = reporter.nextSpan().value
          finishedSpan.operationName shouldBe ("fully-populated-span")
          finishedSpan.startTimestampMicros shouldBe 100
          finishedSpan.endTimestampMicros shouldBe 200
          finishedSpan.tags should contain allOf(
            "builder-string-tag" -> TagValue.String("value"),
            "builder-boolean-tag-true" -> TagValue.True,
            "builder-boolean-tag-false" -> TagValue.False,
            "builder-number-tag" -> TagValue.Number(42),
            "span-string-tag" -> TagValue.String("value"),
            "span-boolean-tag-true" -> TagValue.True,
            "span-boolean-tag-false" -> TagValue.False,
            "span-number-tag" -> TagValue.Number(42)
          )

          finishedSpan.annotations.length shouldBe (4)
          val annotations = finishedSpan.annotations.groupBy(_.name)
          annotations.keys should contain allOf(
            "simple-annotation",
            "regular-annotation",
            "custom-annotation-1",
            "custom-annotation-2"
          )

          val customAnnotationOne = annotations("custom-annotation-1").head
          customAnnotationOne.timestampMicros shouldBe (4200)
          customAnnotationOne.fields shouldBe (Map("custom" -> "yes-1"))

          val customAnnotationTwo = annotations("custom-annotation-2").head
          customAnnotationTwo.timestampMicros shouldBe (4201)
          customAnnotationTwo.fields shouldBe (Map("custom" -> "yes-2"))

          finishedSpan.context.baggage.getAll() should contain(
            "baggage" -> "value"
          )
        }
      }

      "pass all the tags, annotations and baggage to the FinishedSpan instance when started active and finished" in {
        val activeSpan = Kamon.buildSpan("full-span")
          .withSpanTag("builder-string-tag", "value")
          .withSpanTag("builder-boolean-tag-true", true)
          .withSpanTag("builder-boolean-tag-false", false)
          .withSpanTag("builder-number-tag", 42)
          .withStartTimestamp(100)
          .startActive()

        activeSpan
          .addBaggage("baggage", "value")
          .addSpanTag("span-string-tag", "value")
          .addSpanTag("span-boolean-tag-true", true)
          .addSpanTag("span-boolean-tag-false", false)
          .addSpanTag("span-number-tag", 42)
          .annotate("simple-annotation")
          .annotate("regular-annotation", Map("data" -> "something"))
          .annotate(4200, "custom-annotation-1", Map("custom" -> "yes-1"))
          .annotate(Annotation(4201, "custom-annotation-2", Map("custom" -> "yes-2")))
          .setOperationName("fully-populated-active-span")
          .finish(200)

        activeSpan.deactivate()

        eventually(timeout(2 seconds)) {
          val finishedSpan = reporter.nextSpan().value
          finishedSpan.operationName shouldBe ("fully-populated-active-span")
          finishedSpan.startTimestampMicros shouldBe 100
          finishedSpan.endTimestampMicros shouldBe 200
          finishedSpan.tags should contain allOf(
            "builder-string-tag" -> TagValue.String("value"),
            "builder-boolean-tag-true" -> TagValue.True,
            "builder-boolean-tag-false" -> TagValue.False,
            "builder-number-tag" -> TagValue.Number(42),
            "span-string-tag" -> TagValue.String("value"),
            "span-boolean-tag-true" -> TagValue.True,
            "span-boolean-tag-false" -> TagValue.False,
            "span-number-tag" -> TagValue.Number(42)
          )

          finishedSpan.annotations.length shouldBe (4)
          val annotations = finishedSpan.annotations.groupBy(_.name)
          annotations.keys should contain allOf(
            "simple-annotation",
            "regular-annotation",
            "custom-annotation-1",
            "custom-annotation-2"
          )

          val customAnnotationOne = annotations("custom-annotation-1").head
          customAnnotationOne.timestampMicros shouldBe (4200)
          customAnnotationOne.fields shouldBe (Map("custom" -> "yes-1"))

          val customAnnotationTwo = annotations("custom-annotation-2").head
          customAnnotationTwo.timestampMicros shouldBe (4201)
          customAnnotationTwo.fields shouldBe (Map("custom" -> "yes-2"))

          finishedSpan.context.baggage.getAll() should contain(
            "baggage" -> "value"
          )
        }
      }

      "allow storing and retrieving baggage items" in {
        val span = Kamon.buildSpan("span-with-baggage").start()
        span.addBaggage("my-baggage", "value-1")
        span.addBaggage("my-baggage", "value-2")
        span.addBaggage("my-other-baggage", "value-3")

        span.context().baggage.getAll() should contain only(
          "my-baggage" -> "value-2",
          "my-other-baggage" -> "value-3"
        )
      }
    }
  }

  @volatile var registration: Registration = _
  val reporter = new TestSpanReporter()

  override protected def beforeAll(): Unit = {
    enableFastSpanFlushing()
    sampleAlways()
    registration = Kamon.addReporter(reporter)
  }

  override protected def afterAll(): Unit = {
    registration.cancel()
  }
}