-
Notifications
You must be signed in to change notification settings - Fork 7
/
EmbraceSpanImplTest.kt
305 lines (283 loc) · 12.4 KB
/
EmbraceSpanImplTest.kt
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
package io.embrace.android.embracesdk.internal.spans
import io.embrace.android.embracesdk.arch.schema.EmbType
import io.embrace.android.embracesdk.fakes.FakeClock
import io.embrace.android.embracesdk.fakes.injection.FakeInitModule
import io.embrace.android.embracesdk.fixtures.MAX_LENGTH_ATTRIBUTE_KEY
import io.embrace.android.embracesdk.fixtures.MAX_LENGTH_ATTRIBUTE_VALUE
import io.embrace.android.embracesdk.fixtures.MAX_LENGTH_EVENT_NAME
import io.embrace.android.embracesdk.fixtures.TOO_LONG_ATTRIBUTE_KEY
import io.embrace.android.embracesdk.fixtures.TOO_LONG_ATTRIBUTE_VALUE
import io.embrace.android.embracesdk.fixtures.TOO_LONG_EVENT_NAME
import io.embrace.android.embracesdk.fixtures.maxSizeEventAttributes
import io.embrace.android.embracesdk.fixtures.tooBigEventAttributes
import io.embrace.android.embracesdk.internal.clock.millisToNanos
import io.embrace.android.embracesdk.internal.clock.nanosToMillis
import io.embrace.android.embracesdk.internal.payload.Span
import io.embrace.android.embracesdk.spans.EmbraceSpanEvent
import io.embrace.android.embracesdk.spans.ErrorCode
import io.opentelemetry.sdk.OpenTelemetrySdk
import io.opentelemetry.sdk.common.Clock
import io.opentelemetry.sdk.trace.SdkTracerProvider
import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertNotNull
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Before
import org.junit.Test
internal class EmbraceSpanImplTest {
private lateinit var fakeClock: FakeClock
private lateinit var openTelemetryClock: Clock
private lateinit var embraceSpan: EmbraceSpanImpl
private lateinit var spanRepository: SpanRepository
private val tracer = OpenTelemetrySdk.builder()
.setTracerProvider(SdkTracerProvider.builder().build()).build()
.getTracer(EmbraceSpanImplTest::class.java.name)
@Before
fun setup() {
fakeClock = FakeClock()
val fakeInitModule = FakeInitModule(fakeClock)
openTelemetryClock = fakeInitModule.openTelemetryClock
spanRepository = SpanRepository()
embraceSpan = EmbraceSpanImpl(
spanBuilder = tracer.embraceSpanBuilder(
name = EXPECTED_SPAN_NAME,
type = EmbType.Performance.Default,
internal = false,
private = false
),
openTelemetryClock = fakeInitModule.openTelemetryClock,
spanRepository = spanRepository
)
fakeClock.tick(100)
}
@Test
fun `validate default state`() {
with(embraceSpan) {
assertNull(traceId)
assertNull(spanId)
assertFalse(isRecording)
assertFalse(addEvent("eventName"))
assertFalse(addAttribute("first", "value"))
assertEquals(0, spanRepository.getActiveSpans().size)
assertEquals(0, spanRepository.getCompletedSpans().size)
assertNull(embraceSpan.snapshot())
}
}
@Test
fun `validate span started state`() {
with(embraceSpan) {
assertTrue(start())
val expectedStartTimeMs = fakeClock.now()
assertFalse(start())
assertNotNull(traceId)
assertNotNull(spanId)
assertTrue(isRecording)
assertSnapshot(expectedStartTimeMs = expectedStartTimeMs)
assertTrue(addEvent("eventName"))
assertTrue(addAttribute("first", "value"))
assertSnapshot(expectedStartTimeMs = expectedStartTimeMs, eventCount = 1, expectedCustomAttributeCount = 1)
assertEquals(1, spanRepository.getActiveSpans().size)
assertEquals(0, spanRepository.getCompletedSpans().size)
}
}
@Test
fun `validate span stopped state`() {
with(embraceSpan) {
assertTrue(start())
val expectedStartTimeMs = fakeClock.now()
fakeClock.tick(200)
assertTrue(stop())
val expectedEndTimeMs = fakeClock.now()
assertSnapshot(
expectedStartTimeMs = expectedStartTimeMs,
expectedEndTimeMs = expectedEndTimeMs,
expectedStatus = Span.Status.OK
)
validateStoppedSpan()
}
}
@Test
fun `validate starting and stopping span with specific times`() {
with(embraceSpan) {
val expectedStartTimeMs = fakeClock.now() + 1000
val expectedEndTimeMs = fakeClock.now() + 5700
assertTrue(start(startTimeMs = expectedStartTimeMs))
assertTrue(stop(errorCode = ErrorCode.FAILURE, endTimeMs = expectedEndTimeMs))
assertSnapshot(
expectedStartTimeMs = expectedStartTimeMs,
expectedEndTimeMs = expectedEndTimeMs,
expectedStatus = Span.Status.ERROR
)
validateStoppedSpan()
}
}
@Test
fun `starting and stopping span with nanosecond timestamps`() {
with(embraceSpan) {
val expectedStartTimeMs = fakeClock.now() + 99
val expectedEndTimeMs = fakeClock.now() + 505
assertTrue(start(startTimeMs = expectedStartTimeMs.millisToNanos()))
assertTrue(stop(errorCode = ErrorCode.FAILURE, endTimeMs = expectedEndTimeMs.millisToNanos()))
assertSnapshot(
expectedStartTimeMs = expectedStartTimeMs,
expectedEndTimeMs = expectedEndTimeMs,
expectedStatus = Span.Status.ERROR
)
validateStoppedSpan()
}
}
@Test
fun `check adding events`() {
with(embraceSpan) {
assertTrue(start())
assertTrue(addEvent(name = "current event"))
assertTrue(
addEvent(
name = "second current event",
timestampMs = null,
attributes = mapOf(Pair("key", "value"), Pair("key2", "value1"))
)
)
assertTrue(addEvent(name = "past event", timestampMs = fakeClock.now() - 1L, attributes = null))
assertTrue(
addEvent(name = "future event", timestampMs = fakeClock.now() + 2L, mapOf(Pair("key", "value"), Pair("key2", "value1")))
)
}
}
@Test
fun `cannot stop twice irrespective of error code`() {
with(embraceSpan) {
assertTrue(start())
assertTrue(stop(ErrorCode.FAILURE))
assertFalse(stop())
assertEquals(0, spanRepository.getActiveSpans().size)
assertEquals(1, spanRepository.getCompletedSpans().size)
}
}
@Test
fun `check event limits`() {
with(embraceSpan) {
assertTrue(start())
assertFalse(addEvent(name = TOO_LONG_EVENT_NAME))
assertFalse(addEvent(name = TOO_LONG_EVENT_NAME, timestampMs = null, attributes = null))
assertFalse(addEvent(name = "yo", timestampMs = null, attributes = tooBigEventAttributes))
assertTrue(addEvent(name = MAX_LENGTH_EVENT_NAME))
assertTrue(addEvent(name = MAX_LENGTH_EVENT_NAME, timestampMs = null, attributes = null))
assertTrue(addEvent(name = "yo", timestampMs = null, attributes = maxSizeEventAttributes))
repeat(EmbraceSpanImpl.MAX_EVENT_COUNT - 4) {
assertTrue(addEvent(name = "event $it"))
}
val eventAttributesAMap = mutableMapOf(
Pair(TOO_LONG_ATTRIBUTE_KEY, "value"),
Pair("key", TOO_LONG_ATTRIBUTE_VALUE),
)
repeat(EmbraceSpanEvent.MAX_EVENT_ATTRIBUTE_COUNT - 2) {
eventAttributesAMap["key$it"] = "value"
}
assertTrue(
addEvent(
name = "yo",
timestampMs = null,
attributes = eventAttributesAMap
)
)
assertFalse(addEvent("failed event"))
assertTrue(stop())
}
}
@Test
fun `check adding and removing custom attributes`() {
with(embraceSpan) {
assertTrue(start())
assertTrue(addAttribute("test", "value"))
assertTrue(removeCustomAttribute("test"))
assertFalse(removeCustomAttribute("test"))
}
}
@Test
fun `check attribute limits`() {
with(embraceSpan) {
assertTrue(start())
assertFalse(addAttribute(key = TOO_LONG_ATTRIBUTE_KEY, value = "value"))
assertFalse(addAttribute(key = "key", value = TOO_LONG_ATTRIBUTE_VALUE))
assertTrue(addAttribute(key = MAX_LENGTH_ATTRIBUTE_KEY, value = "value"))
assertTrue(addAttribute(key = "key", value = MAX_LENGTH_ATTRIBUTE_VALUE))
assertTrue(addAttribute(key = "Key", value = MAX_LENGTH_ATTRIBUTE_VALUE))
repeat(EmbraceSpanImpl.MAX_ATTRIBUTE_COUNT - 3) {
assertTrue(addAttribute(key = "key$it", value = "value"))
}
assertFalse(addAttribute(key = "failedKey", value = "value"))
}
}
@Test
fun `validate full snapshot`() {
assertTrue(embraceSpan.start())
assertNotNull(embraceSpan.snapshot())
with(embraceSpan) {
val expectedStartTimeMs = fakeClock.now()
fakeClock.tick(100)
val expectedEventTime = fakeClock.now()
assertTrue(
addEvent(
name = EXPECTED_EVENT_NAME,
timestampMs = null,
attributes = mapOf(Pair(EXPECTED_ATTRIBUTE_NAME, EXPECTED_ATTRIBUTE_VALUE))
)
)
assertTrue(addAttribute(key = EXPECTED_ATTRIBUTE_NAME, value = EXPECTED_ATTRIBUTE_VALUE))
val snapshot = checkNotNull(embraceSpan.snapshot())
assertEquals(traceId, snapshot.traceId)
assertEquals(spanId, snapshot.spanId)
assertNull(snapshot.parentSpanId)
assertEquals(EXPECTED_SPAN_NAME, snapshot.name)
assertEquals(expectedStartTimeMs.millisToNanos(), snapshot.startTimeUnixNano)
assertEquals(Span.Status.UNSET, snapshot.status)
val snapshotEvent = checkNotNull(snapshot.events).single()
assertEquals(EXPECTED_EVENT_NAME, snapshotEvent.name)
assertEquals(expectedEventTime.millisToNanos(), snapshotEvent.timeUnixNano)
val eventAttributes = checkNotNull(snapshotEvent.attributes).single { !checkNotNull(it.key).startsWith("emb.") }
assertEquals(EXPECTED_ATTRIBUTE_NAME, eventAttributes.key)
assertEquals(EXPECTED_ATTRIBUTE_VALUE, eventAttributes.data)
val snapshotAttributes = checkNotNull(snapshot.attributes).single { !checkNotNull(it.key).startsWith("emb.") }
assertEquals(EXPECTED_ATTRIBUTE_NAME, snapshotAttributes.key)
assertEquals(EXPECTED_ATTRIBUTE_VALUE, snapshotAttributes.data)
}
}
private fun EmbraceSpanImpl.assertSnapshot(
expectedStartTimeMs: Long,
expectedEndTimeMs: Long? = null,
expectedStatus: Span.Status = Span.Status.UNSET,
eventCount: Int = 0,
expectedEmbraceAttributes: Int = 2,
expectedCustomAttributeCount: Int = 0
) {
with(checkNotNull(snapshot())) {
assertEquals(expectedStartTimeMs, startTimeUnixNano?.nanosToMillis())
assertEquals(expectedEndTimeMs, endTimeUnixNano?.nanosToMillis())
assertEquals(expectedStatus, status)
assertEquals(eventCount, events?.size)
checkNotNull(attributes)
val embraceAttributeCount = attributes.filter { checkNotNull(it.key).startsWith("emb.") }.size
val customAttributeCount = attributes.size - embraceAttributeCount
assertEquals(expectedEmbraceAttributes, embraceAttributeCount)
assertEquals(expectedCustomAttributeCount, customAttributeCount)
}
}
private fun EmbraceSpanImpl.validateStoppedSpan() {
assertFalse(stop())
assertNotNull(traceId)
assertNotNull(spanId)
assertFalse(isRecording)
assertFalse(addEvent("eventName"))
assertFalse(addAttribute("first", "value"))
assertEquals(0, spanRepository.getActiveSpans().size)
assertEquals(1, spanRepository.getCompletedSpans().size)
}
companion object {
private const val EXPECTED_SPAN_NAME = "test-span"
private const val EXPECTED_EVENT_NAME = "fun event 🔥"
private const val EXPECTED_ATTRIBUTE_NAME = "attribute-key"
private const val EXPECTED_ATTRIBUTE_VALUE = "harharhar"
}
}