-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
PropagatorTests.cs
672 lines (532 loc) · 27.1 KB
/
PropagatorTests.cs
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Net;
using System.Linq;
using System.Collections.Generic;
using Microsoft.DotNet.RemoteExecutor;
using Xunit;
namespace System.Diagnostics.Tests
{
public class PropagatorTests
{
internal const string TraceParent = "traceparent";
internal const string RequestId = "Request-Id";
internal const string TraceState = "tracestate";
internal const string Baggage = "baggage";
internal const string CorrelationContext = "Correlation-Context";
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
public void TestAllPropagators()
{
RemoteExecutor.Invoke(() => {
Assert.NotNull(DistributedContextPropagator.Current);
//
// Default Propagator
//
Assert.Same(DistributedContextPropagator.CreateDefaultPropagator(), DistributedContextPropagator.Current);
TestDefaultPropagatorUsingW3CActivity(
DistributedContextPropagator.Current,
"Legacy1=true",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>(" LegacyKey1 ", " LegacyValue1 ") });
TestDefaultPropagatorUsingHierarchicalActivity(
DistributedContextPropagator.Current,
"Legacy2=true",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("LegacyKey2", "LegacyValue2") });
TestFields(DistributedContextPropagator.Current);
//
// NoOutput Propagator
//
DistributedContextPropagator.Current = DistributedContextPropagator.CreateNoOutputPropagator();
Assert.NotNull(DistributedContextPropagator.Current);
TestNoOutputPropagatorUsingHierarchicalActivity(
DistributedContextPropagator.Current,
"ActivityState=1",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("B1", "V1"), new KeyValuePair<string, string>(" B2 ", " V2 ")});
TestNoOutputPropagatorUsingHierarchicalActivity(
DistributedContextPropagator.Current,
"ActivityState=2",
null);
TestNoOutputPropagatorUsingW3CActivity(
DistributedContextPropagator.Current,
"ActivityState=1",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>(" B3 ", " V3"), new KeyValuePair<string, string>(" B4 ", " V4 "), new KeyValuePair<string, string>("B5", "V5")});
TestNoOutputPropagatorUsingW3CActivity(
DistributedContextPropagator.Current,
"ActivityState=2",
null);
TestFields(DistributedContextPropagator.Current);
//
// Pass Through Propagator
//
DistributedContextPropagator.Current = DistributedContextPropagator.CreatePassThroughPropagator();
Assert.NotNull(DistributedContextPropagator.Current);
TestPassThroughPropagatorUsingHierarchicalActivityWithParentChain(
DistributedContextPropagator.Current,
"PassThrough=true",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("PassThroughKey1", "PassThroughValue1"), new KeyValuePair<string, string>("PassThroughKey2", "PassThroughValue2")});
TestPassThroughPropagatorUsingHierarchicalActivityWithParentId(
DistributedContextPropagator.Current,
"PassThrough1=true",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("PassThroughKey3", "PassThroughValue3"), new KeyValuePair<string, string>(" PassThroughKey4 ", " PassThroughValue4 ")});
TestPassThroughPropagatorUsingW3CActivity(
DistributedContextPropagator.Current,
"PassThrough2=1",
new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>(" PassThroughKey4 ", " PassThroughValue4 ") });
TestPassThroughPropagatorWithNullCurrent(DistributedContextPropagator.Current);
TestFields(DistributedContextPropagator.Current);
//
// Test Current
//
Assert.Throws<ArgumentNullException>(() => DistributedContextPropagator.Current = null);
}).Dispose();
}
private void TestDefaultPropagatorUsingW3CActivity(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateW3CActivity("LegacyW3C1", "LegacyW3CState=1", baggage);
using Activity b = CreateW3CActivity("LegacyW3C2", "LegacyW3CState=2", baggage);
Assert.NotSame(Activity.Current, a);
TestDefaultPropagatorUsing(a, propagator, state, baggage);
Assert.Same(Activity.Current, b);
TestDefaultPropagatorUsing(Activity.Current, propagator, state, baggage);
}
private void TestDefaultPropagatorUsingHierarchicalActivity(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateHierarchicalActivity("LegacyHierarchical1", null, "LegacyHierarchicalState=1", baggage);
using Activity b = CreateHierarchicalActivity("LegacyHierarchical2", null, "LegacyHierarchicalState=2", baggage);
Assert.NotSame(Activity.Current, a);
TestDefaultPropagatorUsing(a, propagator, state, baggage);
Assert.Same(Activity.Current, b);
TestDefaultPropagatorUsing(Activity.Current, propagator, state, baggage);
}
private void TestDefaultPropagatorUsing(Activity a, DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
// Test with non-current
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
if (fieldName == TraceParent && a.IdFormat == ActivityIdFormat.W3C)
{
Assert.Equal(a.Id, value);
return;
}
if (fieldName == RequestId && a.IdFormat != ActivityIdFormat.W3C)
{
Assert.Equal(a.Id, value);
return;
}
if (fieldName == TraceState)
{
Assert.Equal(a.TraceStateString, value);
return;
}
if (fieldName == CorrelationContext)
{
Assert.Equal(GetFormattedBaggage(a.Baggage), value);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
});
TestDefaultExtraction(propagator, a);
TestBaggageExtraction(propagator, a);
}
private void TestNoOutputPropagatorUsingHierarchicalActivity(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateHierarchicalActivity("NoOutputHierarchical", null, state, baggage);
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
Assert.False(true, $"Not expected to have the setter callback be called in the NoOutput propgator.");
});
TestDefaultExtraction(propagator, a);
TestBaggageExtraction(propagator, a);
}
private void TestNoOutputPropagatorUsingW3CActivity(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateW3CActivity("NoOutputW3C", state, baggage);
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
Assert.False(true, $"Not expected to have the setter callback be called in the NoOutput propgator.");
});
TestDefaultExtraction(propagator, a);
TestBaggageExtraction(propagator, a);
}
private void TestPassThroughPropagatorUsingHierarchicalActivityWithParentChain(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateHierarchicalActivity("PassThrough", null, state, baggage);
using Activity b = CreateHierarchicalActivity("PassThroughChild1", null, state + "1", new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("Child1Key", "Child1Value") } );
using Activity c = CreateHierarchicalActivity("PassThroughChild2", null, state + "2", new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("Child2Key", "Child2Value") } );
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
if (fieldName == TraceParent)
{
Assert.False(true, $"Unexpected to inject a TraceParent with Hierarchical Activity.");
return;
}
if (fieldName == RequestId)
{
Assert.Equal(a.Id, value);
return;
}
if (fieldName == TraceState)
{
Assert.Equal(a.TraceStateString, value);
return;
}
if (fieldName == CorrelationContext)
{
Assert.Equal(GetFormattedBaggage(a.Baggage), value);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
});
TestDefaultExtraction(propagator, a);
TestDefaultExtraction(propagator, b);
TestDefaultExtraction(propagator, c);
TestBaggageExtraction(propagator, a);
TestBaggageExtraction(propagator, b);
TestBaggageExtraction(propagator, c);
}
private void TestPassThroughPropagatorUsingHierarchicalActivityWithParentId(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateHierarchicalActivity("PassThrough", "Parent1", state, baggage);
using Activity b = CreateHierarchicalActivity("PassThroughChild1", "Parent2", state + "1", new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("Child1Key", "Child1Value") } );
using Activity c = CreateHierarchicalActivity("PassThroughChild2", "Parent3", state + "2", new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>("Child2Key", "Child2Value") } );
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
if (fieldName == TraceParent)
{
Assert.False(true, $"Unexpected to inject a TraceParent with Hierarchical Activity.");
return;
}
if (fieldName == RequestId)
{
Assert.Equal(c.ParentId, value);
return;
}
if (fieldName == TraceState)
{
Assert.Equal(c.TraceStateString, value);
return;
}
if (fieldName == CorrelationContext)
{
Assert.Equal(GetFormattedBaggage(c.Baggage), value);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
});
TestDefaultExtraction(propagator, a);
TestDefaultExtraction(propagator, b);
TestDefaultExtraction(propagator, c);
TestBaggageExtraction(propagator, a);
TestBaggageExtraction(propagator, b);
TestBaggageExtraction(propagator, c);
}
private void TestPassThroughPropagatorUsingW3CActivity(DistributedContextPropagator propagator, string state, IEnumerable<KeyValuePair<string, string>> baggage)
{
using Activity a = CreateW3CActivity("PassThroughW3C", "PassThroughW3CState=1", baggage);
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
if (fieldName == TraceParent)
{
Assert.Equal(a.Id, value);
return;
}
if (fieldName == TraceState)
{
Assert.Equal(a.TraceStateString, value);
return;
}
if (fieldName == CorrelationContext)
{
Assert.Equal(GetFormattedBaggage(a.Baggage), value);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
});
TestDefaultExtraction(propagator, a);
TestBaggageExtraction(propagator, a);
}
private void TestPassThroughPropagatorWithNullCurrent(DistributedContextPropagator propagator)
{
Activity.Current = null;
propagator.Inject(null, null, (object carrier, string fieldName, string value) =>
{
Assert.False(true, $"PassThroughPropagator shouldn't inject anything if the Activity.Current is null");
});
using Activity a = CreateW3CActivity("PassThroughNotNull", "", null);
propagator.Inject(a, null, (object carrier, string fieldName, string value) =>
{
if (fieldName == TraceParent)
{
Assert.Equal(a.Id, value);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
});
}
private void TestDefaultExtraction(DistributedContextPropagator propagator, Activity a)
{
bool traceParentEncountered = false;
propagator.ExtractTraceIdAndState(null, (object carrier, string fieldName, out string? fieldValue, out IEnumerable<string>? fieldValues) =>
{
Assert.Null(carrier);
fieldValues = null;
fieldValue = null;
if (fieldName == TraceParent)
{
if (a.IdFormat == ActivityIdFormat.W3C)
{
fieldValue = a.Id;
}
else
{
traceParentEncountered = true;
}
return;
}
if (fieldName == RequestId)
{
if (a.IdFormat == ActivityIdFormat.W3C)
{
Assert.True(false, $"Not expected to get RequestId as we expect the request handled using TraceParenet.");
}
else
{
Assert.True(traceParentEncountered, $"Expected to get TraceParent request before getting RequestId.");
fieldValue = a.Id;
}
return;
}
if (fieldName == TraceState)
{
fieldValue = a.TraceStateString;
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
}, out string? traceId, out string? traceState);
Assert.Equal(a.Id, traceId);
Assert.Equal(a.TraceStateString, traceState);
}
private void TestBaggageExtraction(DistributedContextPropagator propagator, Activity a)
{
bool baggageEncountered = false;
IEnumerable<KeyValuePair<string, string?>>? b = propagator.ExtractBaggage(null, (object carrier, string fieldName, out string? fieldValue, out IEnumerable<string>? fieldValues) =>
{
Assert.Null(carrier);
fieldValue = null;
fieldValues = null;
if (fieldName == Baggage)
{
if (a.IdFormat == ActivityIdFormat.W3C)
{
fieldValue = GetFormattedBaggage(a.Baggage);
}
else
{
baggageEncountered = true;
}
return;
}
if (fieldName == CorrelationContext && a.IdFormat != ActivityIdFormat.W3C)
{
Assert.True(baggageEncountered, $"Expected to get Baggage request before getting Correlation-Context.");
fieldValue = GetFormattedBaggage(a.Baggage);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}'");
});
Assert.Equal(GetFormattedBaggage(a.Baggage, false, true), GetFormattedBaggage(b, true));
}
private void TestFields(DistributedContextPropagator propagator)
{
Assert.True(propagator.Fields.Contains(TraceParent));
Assert.True(propagator.Fields.Contains(RequestId));
Assert.True(propagator.Fields.Contains(TraceState));
Assert.True(propagator.Fields.Contains(Baggage));
Assert.True(propagator.Fields.Contains(CorrelationContext));
}
internal static string GetFormattedBaggage(IEnumerable<KeyValuePair<string, string?>>? b, bool flipOrder = false, bool trimSpaces = false)
{
string formattedBaggage = "";
if (b is null)
{
return formattedBaggage;
}
List<KeyValuePair<string, string>> list = new List<KeyValuePair<string, string>>(b);
int startIndex = flipOrder ? list.Count - 1 : 0;
int exitIndex = flipOrder ? -1 : list.Count;
int step = flipOrder ? -1 : 1;
for (int i = startIndex; i != exitIndex; i += step)
{
string key = trimSpaces ? list[i].Key.Trim() : list[i].Key;
string value = trimSpaces ? list[i].Value.Trim() : list[i].Value;
formattedBaggage += (formattedBaggage.Length > 0 ? ", " : "") + WebUtility.UrlEncode(key) + "=" + WebUtility.UrlEncode(value);
}
return formattedBaggage;
}
private Activity CreateHierarchicalActivity(string name, string parentId, string state, IEnumerable<KeyValuePair<string, string?>>? baggage)
{
Activity a = new Activity(name);
a.SetIdFormat(ActivityIdFormat.Hierarchical);
if (baggage is not null)
{
foreach (KeyValuePair<string, string> kvp in baggage)
{
a.SetBaggage(kvp.Key, kvp.Value);
}
}
a.TraceStateString = state;
if (parentId is not null)
{
a.SetParentId(parentId);
}
a.Start();
return a;
}
private Activity CreateW3CActivity(string name, string state, IEnumerable<KeyValuePair<string, string?>>? baggage)
{
Activity a = new Activity(name);
a.SetIdFormat(ActivityIdFormat.W3C);
if (baggage is not null)
{
foreach (KeyValuePair<string, string> kvp in baggage)
{
a.SetBaggage(kvp.Key, kvp.Value);
}
}
a.TraceStateString = state;
a.Start();
return a;
}
internal static IEnumerable<KeyValuePair<string, string>>? ParseBaggage(string baggageString)
{
if (baggageString is null)
{
return null;
}
List<KeyValuePair<string, string>> list = new();
string [] parts = baggageString.Split(',');
foreach (string part in parts)
{
string [] baggageItem = part.Split('=');
if (baggageItem.Length != 2)
{
return null; // Invalid format
}
list.Add(new KeyValuePair<string, string>(WebUtility.UrlDecode(baggageItem[0]).Trim(), WebUtility.UrlDecode(baggageItem[1]).Trim()));
}
return list;
}
[Fact]
public void TestBuiltInPropagatorsAreCached()
{
Assert.Same(DistributedContextPropagator.CreateDefaultPropagator(), DistributedContextPropagator.CreateDefaultPropagator());
Assert.Same(DistributedContextPropagator.CreateNoOutputPropagator(), DistributedContextPropagator.CreateNoOutputPropagator());
Assert.Same(DistributedContextPropagator.CreatePassThroughPropagator(), DistributedContextPropagator.CreatePassThroughPropagator());
}
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
public void TestCustomPropagator()
{
RemoteExecutor.Invoke(() => {
DistributedContextPropagator.Current = new CustomPropagator();
using Activity a = CreateW3CActivity("CustomW3C1", "CustomW3CState=1", new List<KeyValuePair<string, string>>() { new KeyValuePair<string, string>(" CustomKey1 ", " CustomValue1 ") });
string traceParent = "x-" + a.Id ;
string traceState = "x-" + a.TraceStateString;
string baggageString = "x=y, " + GetFormattedBaggage(a.Baggage);
DistributedContextPropagator.Current.Inject(a, null, (object carrier, string fieldName, string value) =>
{
if (fieldName == CustomPropagator.XTraceParent)
{
Assert.Equal(traceParent, value);
return;
}
if (fieldName == CustomPropagator.XTraceState)
{
Assert.Equal(traceState, value);
return;
}
if (fieldName == CustomPropagator.XBaggage)
{
Assert.Equal(baggageString, value);
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}' in the Custom Propagator");
});
DistributedContextPropagator.Current.ExtractTraceIdAndState(null, (object carrier, string fieldName, out string? fieldValue, out IEnumerable<string>? fieldValues) =>
{
fieldValues = null;
fieldValue = null;
if (fieldName == CustomPropagator.XTraceParent)
{
fieldValue = traceParent;
return;
}
if (fieldName == CustomPropagator.XTraceState)
{
fieldValue = traceState;
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}' in the Custom propagator");
}, out string? traceId, out string? state);
Assert.Equal(traceParent, traceId);
Assert.Equal(traceState, state);
IEnumerable<KeyValuePair<string, string?>>? b = DistributedContextPropagator.Current.ExtractBaggage(null, (object carrier, string fieldName, out string? fieldValue, out IEnumerable<string>? fieldValues) =>
{
Assert.Null(carrier);
fieldValue = null;
fieldValues = null;
if (fieldName == CustomPropagator.XBaggage)
{
fieldValue = baggageString;
return;
}
Assert.False(true, $"Encountered wrong header name '{fieldName}' in custom propagator");
});
Assert.Equal(2, b.Count());
Assert.Equal(new KeyValuePair<string, string>("x", "y"), b.ElementAt(0));
Assert.Equal(new KeyValuePair<string, string>("CustomKey1", "CustomValue1"), b.ElementAt(1));
}).Dispose();
}
internal class CustomPropagator : DistributedContextPropagator
{
internal const string XTraceParent = "x-traceparent";
internal const string XTraceState = "x-tracestate";
internal const string XBaggage = "x-baggage";
public override IReadOnlyCollection<string> Fields { get; } = new[] { XTraceParent, XTraceState, XBaggage};
public override void Inject(Activity? activity, object? carrier, PropagatorSetterCallback? setter)
{
if (activity is null || carrier is null)
{
return;
}
setter(carrier, XTraceParent, "x-" + activity.Id);
if (!string.IsNullOrEmpty(activity.TraceStateString))
{
setter(carrier, XTraceState, "x-" + activity.TraceStateString);
}
if (activity.Baggage.Count() > 0)
{
setter(carrier, XBaggage, "x=y, " + PropagatorTests.GetFormattedBaggage(activity.Baggage));
}
}
public override void ExtractTraceIdAndState(object? carrier, PropagatorGetterCallback? getter, out string? traceId, out string? traceState)
{
if (getter is null)
{
traceId = null;
traceState = null;
return;
}
getter(carrier, XTraceParent, out traceId, out _);
getter(carrier, XTraceState, out traceState, out _);
}
public override IEnumerable<KeyValuePair<string, string?>>? ExtractBaggage(object? carrier, PropagatorGetterCallback? getter)
{
if (getter is null)
{
return null;
}
getter(carrier, XBaggage, out string? theBaggage, out _);
return PropagatorTests.ParseBaggage(theBaggage);
}
}
}
}