path: root/kamon-core-tests/src/test/scala/kamon/context/ContextCodecSpec.scala

/* =========================================================================================
 * Copyright © 2013-2017 the kamon project <http://kamon.io/>
 *
 * 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 kamon.context

import kamon.Kamon
import kamon.testkit.ContextTesting
import org.scalatest.{Matchers, OptionValues, WordSpec}

class ContextCodecSpec extends WordSpec with Matchers with ContextTesting with OptionValues {
  "the Context Codec" when {
    "encoding/decoding to HttpHeaders" should {
      "round trip a empty context" in {
        val textMap = ContextCodec.HttpHeaders.encode(Context.Empty)
        val decodedContext = ContextCodec.HttpHeaders.decode(textMap)

        decodedContext shouldBe Context.Empty
      }

      "round trip a context with only local keys" in {
        val localOnlyContext = Context.create(StringKey, Some("string-value"))
        val textMap = ContextCodec.HttpHeaders.encode(localOnlyContext)
        val decodedContext = ContextCodec.HttpHeaders.decode(textMap)

        decodedContext shouldBe Context.Empty
      }

      "round trip a context with local and broadcast keys" in {
        val initialContext = Context.create()
          .withKey(StringKey, Some("string-value"))
          .withKey(StringBroadcastKey, Some("this-should-be-round-tripped"))

        val textMap = ContextCodec.HttpHeaders.encode(initialContext)
        val decodedContext = ContextCodec.HttpHeaders.decode(textMap)

        decodedContext.get(StringKey) shouldBe empty
        decodedContext.get(StringBroadcastKey).value shouldBe "this-should-be-round-tripped"
      }

      "read string broadcast keys using the configured header name" in {
        val textMap = TextMap.Default()
        textMap.put("X-Request-ID", "123456")
        val decodedContext = ContextCodec.HttpHeaders.decode(textMap)

        decodedContext.get(Key.broadcastString("request-id")).value shouldBe "123456"
      }
    }

    "encoding/decoding to Binary" should {
      "round trip a empty context" in {
        val byteBuffer = ContextCodec.Binary.encode(Context.Empty)

        val decodedContext = ContextCodec.Binary.decode(byteBuffer)

        decodedContext shouldBe Context.Empty
      }

      "round trip a context with only local keys" in {
        val localOnlyContext = Context.create(StringKey, Some("string-value"))
        val byteBuffer = ContextCodec.Binary.encode(localOnlyContext)
        val decodedContext = ContextCodec.Binary.decode(byteBuffer)

        decodedContext shouldBe Context.Empty
      }

      "round trip a context with local and broadcast keys" in {
        val initialContext = Context.create()
          .withKey(StringKey, Some("string-value"))
          .withKey(StringBroadcastKey, Some("this-should-be-round-tripped"))

        val byteBuffer = ContextCodec.Binary.encode(initialContext)
        val decodedContext = ContextCodec.Binary.decode(byteBuffer)

        decodedContext.get(StringKey) shouldBe empty
        decodedContext.get(StringBroadcastKey).value shouldBe "this-should-be-round-tripped"
      }
    }
  }

  val ContextCodec = new Codecs(Kamon.config())
}