1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* =========================================================================================
* 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.trace
import kamon.trace.IdentityProvider.Identifier
import kamon.trace.SpanContext.{SamplingDecision, Source}
import org.scalatest.{Matchers, OptionValues, WordSpecLike}
class ExtendedB3SpanContextCodecSpec extends WordSpecLike with Matchers with OptionValues {
"The ExtendedB3 SpanContextCodec" should {
"return a TextMap containing the SpanContext data" in {
val context = createSpanContext()
context.baggage.add("some", "baggage")
context.baggage.add("more", "baggage")
val textMap = extendedB3Codec.inject(context)
textMap.get("X-B3-TraceId").value shouldBe "1234"
textMap.get("X-B3-ParentSpanId").value shouldBe "2222"
textMap.get("X-B3-SpanId").value shouldBe "4321"
textMap.get("X-B3-Sampled").value shouldBe "1"
textMap.get("X-B3-Extra-Baggage").value shouldBe "some=baggage;more=baggage"
}
"allow to provide the TextMap to be used for encoding" in {
val context = createSpanContext()
context.baggage.add("some", "baggage")
context.baggage.add("more", "baggage")
val textMap = TextMap.Default()
extendedB3Codec.inject(context, textMap)
textMap.get("X-B3-TraceId").value shouldBe "1234"
textMap.get("X-B3-ParentSpanId").value shouldBe "2222"
textMap.get("X-B3-SpanId").value shouldBe "4321"
textMap.get("X-B3-Sampled").value shouldBe "1"
textMap.get("X-B3-Extra-Baggage").value shouldBe "some=baggage;more=baggage"
}
"extract a SpanContext from a TextMap when all fields are set" in {
val textMap = TextMap.Default()
textMap.put("X-B3-TraceId", "1234")
textMap.put("X-B3-ParentSpanId", "2222")
textMap.put("X-B3-SpanId", "4321")
textMap.put("X-B3-Sampled", "1")
textMap.put("X-B3-Extra-Baggage", "some=baggage;more=baggage")
val spanContext = extendedB3Codec.extract(textMap).value
spanContext.traceID.string shouldBe "1234"
spanContext.spanID.string shouldBe "4321"
spanContext.parentID.string shouldBe "2222"
spanContext.samplingDecision shouldBe SamplingDecision.Sample
spanContext.baggage.getAll() should contain allOf(
"some" -> "baggage",
"more" -> "baggage"
)
}
"use the Debug flag to override the sampling decision, if provided." in {
val textMap = TextMap.Default()
textMap.put("X-B3-TraceId", "1234")
textMap.put("X-B3-SpanId", "4321")
textMap.put("X-B3-Sampled", "0")
textMap.put("X-B3-Flags", "1")
val spanContext = extendedB3Codec.extract(textMap).value
spanContext.samplingDecision shouldBe SamplingDecision.Sample
}
"use the Debug flag as sampling decision when Sampled is not provided" in {
val textMap = TextMap.Default()
textMap.put("X-B3-TraceId", "1234")
textMap.put("X-B3-SpanId", "4321")
textMap.put("X-B3-Flags", "1")
val spanContext = extendedB3Codec.extract(textMap).value
spanContext.samplingDecision shouldBe SamplingDecision.Sample
}
"extract a minimal SpanContext from a TextMap containing only the Trace ID and Span ID" in {
val textMap = TextMap.Default()
textMap.put("X-B3-TraceId", "1234")
textMap.put("X-B3-SpanId", "4321")
val spanContext = extendedB3Codec.extract(textMap).value
spanContext.traceID.string shouldBe "1234"
spanContext.spanID.string shouldBe "4321"
spanContext.parentID shouldBe IdentityProvider.NoIdentifier
spanContext.samplingDecision shouldBe SamplingDecision.Unknown
spanContext.baggage.getAll() shouldBe empty
}
"round trip a SpanContext from TextMap -> SpanContext -> TextMap" in {
val textMap = TextMap.Default()
textMap.put("X-B3-TraceId", "1234")
textMap.put("X-B3-ParentSpanId", "2222")
textMap.put("X-B3-SpanId", "4321")
textMap.put("X-B3-Sampled", "1")
textMap.put("X-B3-Extra-Baggage", "some=baggage;more=baggage")
val spanContext = extendedB3Codec.extract(textMap).value
val injectTextMap = extendedB3Codec.inject(spanContext)
textMap.values.toSeq should contain theSameElementsAs(injectTextMap.values.toSeq)
}
"round trip a baggage that has special characters in there" in {
val spanContext = createSpanContext()
spanContext.baggage.add("key-with-!specials", "value=with~spec;als")
val textMap = extendedB3Codec.inject(spanContext)
val extractedSpanContext = extendedB3Codec.extract(textMap).value
extractedSpanContext.baggage.getAll().values.toSeq should contain theSameElementsAs(spanContext.baggage.getAll().values.toSeq)
}
}
val identityProvider = IdentityProvider.Default()
val extendedB3Codec = SpanContextCodec.ExtendedB3(identityProvider)
def createSpanContext(samplingDecision: SamplingDecision = SamplingDecision.Sample): SpanContext =
SpanContext(
traceID = Identifier("1234", Array[Byte](1, 2, 3, 4)),
spanID = Identifier("4321", Array[Byte](4, 3, 2, 1)),
parentID = Identifier("2222", Array[Byte](2, 2, 2, 2)),
samplingDecision = samplingDecision,
baggage = SpanContext.Baggage(),
source = Source.Local
)
}
|
