asupersync-conformance 0.3.3

Conformance test suite for async runtime specifications
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
use asupersync::trace::distributed::context::{
    RegionTag, SymbolTraceContext, TraceFlags as AsuperTraceFlags,
};
use asupersync::trace::distributed::id::{DistTraceId, SymbolSpanId};
use asupersync::util::DetRng;
use clap::{Arg, Command};
use opentelemetry::trace::{
    SpanContext, SpanId, TraceContextExt as _, TraceFlags as OtelTraceFlags, TraceId, TraceState,
};
use opentelemetry::{Context, propagation::TextMapPropagator};
use opentelemetry_sdk::propagation::TraceContextPropagator;
use std::collections::HashMap;

/// Cross-process trace context propagation conformance testing.
/// Tests W3C trace context and B3 propagation formats to ensure identical
/// SpanContext + Baggage roundtrip across process boundaries.
fn main() {
    env_logger::init();

    let matches = Command::new("cross_process_trace_conformance")
        .about("Cross-process trace context propagation conformance testing")
        .arg(
            Arg::new("test")
                .long("test")
                .value_name("NAME")
                .help("Run specific test case (w3c-roundtrip, b3-roundtrip, baggage-roundtrip, mixed-headers)")
                .action(clap::ArgAction::Set),
        )
        .arg(
            Arg::new("verbose")
                .short('v')
                .long("verbose")
                .help("Show detailed output")
                .action(clap::ArgAction::SetTrue),
        )
        .get_matches();

    let verbose = matches.get_flag("verbose");
    let test_name = matches.get_one::<String>("test");

    let test_cases: [TestCase; 5] = [
        ("w3c-roundtrip", test_w3c_roundtrip),
        ("b3-roundtrip", test_b3_roundtrip),
        ("baggage-roundtrip", test_baggage_roundtrip),
        ("mixed-headers", test_mixed_headers),
        ("comprehensive", test_comprehensive_scenario),
    ];

    let mut total_tests = 0;
    let mut passed_tests = 0;

    for (name, test_fn) in test_cases {
        if let Some(filter) = test_name
            && name != filter
        {
            continue;
        }

        total_tests += 1;
        println!("Running test: {}", name);

        match test_fn(verbose) {
            Ok(()) => {
                println!("{} PASSED", name);
                passed_tests += 1;
            }
            Err(e) => {
                println!("{} FAILED: {}", name, e);
                if verbose {
                    eprintln!("Error details: {:?}", e);
                }
            }
        }
        println!();
    }

    println!("Results: {}/{} tests passed", passed_tests, total_tests);
    if passed_tests < total_tests {
        std::process::exit(1);
    }
}

type TestResult = Result<(), Box<dyn std::error::Error>>;
type TestCase = (&'static str, fn(bool) -> TestResult);

// =============================================================================
// Header Format Converters
// =============================================================================

/// W3C Trace Context format: traceparent + tracestate
#[derive(Debug, Clone)]
struct W3cHeaders {
    traceparent: String,
    tracestate: Option<String>,
}

/// B3 format: X-B3-TraceId, X-B3-SpanId, X-B3-Sampled, X-B3-Flags
#[derive(Debug, Clone)]
struct B3Headers {
    trace_id: String,
    span_id: String,
    sampled: Option<String>,
}

/// Converts SymbolTraceContext to W3C headers
fn to_w3c_headers(ctx: &SymbolTraceContext) -> W3cHeaders {
    let traceparent = format!(
        "00-{:016x}{:016x}-{:016x}-{:02x}",
        ctx.trace_id().high(),
        ctx.trace_id().low(),
        ctx.span_id().as_u64(),
        ctx.flags().as_byte()
    );

    let tracestate = if ctx.baggage().is_empty() {
        None
    } else {
        let entries: Vec<String> = ctx
            .baggage()
            .iter()
            .map(|(k, v)| format!("{}={}", k, v))
            .collect();
        Some(entries.join(","))
    };

    W3cHeaders {
        traceparent,
        tracestate,
    }
}

/// Converts SymbolTraceContext to B3 headers
fn to_b3_headers(ctx: &SymbolTraceContext) -> B3Headers {
    let trace_id = format!(
        "{:016x}{:016x}",
        ctx.trace_id().high(),
        ctx.trace_id().low()
    );
    let span_id = format!("{:016x}", ctx.span_id().as_u64());

    let sampled = if ctx.flags().is_sampled() {
        Some("1".to_string())
    } else {
        Some("0".to_string())
    };

    B3Headers {
        trace_id,
        span_id,
        sampled,
    }
}

/// Parses W3C traceparent header back to components
fn parse_w3c_traceparent(
    traceparent: &str,
) -> Result<(DistTraceId, SymbolSpanId, AsuperTraceFlags), Box<dyn std::error::Error>> {
    let parts: Vec<&str> = traceparent.split('-').collect();
    if parts.len() != 4 || parts[0] != "00" {
        return Err("Invalid traceparent format".into());
    }

    let trace_id_str = parts[1];
    let span_id_str = parts[2];
    let flags_str = parts[3];

    if trace_id_str.len() != 32 {
        return Err("Invalid trace ID length".into());
    }

    let trace_high = u64::from_str_radix(&trace_id_str[0..16], 16)?;
    let trace_low = u64::from_str_radix(&trace_id_str[16..32], 16)?;
    let trace_id = DistTraceId::new(trace_high, trace_low);

    let span_id_val = u64::from_str_radix(span_id_str, 16)?;
    let span_id = SymbolSpanId::new(span_id_val);

    let flags_val = u8::from_str_radix(flags_str, 16)?;
    let flags = AsuperTraceFlags::from_byte(flags_val);

    Ok((trace_id, span_id, flags))
}

/// Creates OpenTelemetry SpanContext for comparison
fn create_otel_span_context(
    trace_id: DistTraceId,
    span_id: SymbolSpanId,
    flags: AsuperTraceFlags,
    baggage: &[(String, String)],
) -> Result<SpanContext, Box<dyn std::error::Error>> {
    let mut trace_id_bytes = [0_u8; 16];
    trace_id_bytes[..8].copy_from_slice(&trace_id.high().to_be_bytes());
    trace_id_bytes[8..].copy_from_slice(&trace_id.low().to_be_bytes());
    let otel_trace_id = TraceId::from_bytes(trace_id_bytes);

    let span_id_bytes = span_id.as_u64().to_be_bytes();
    let otel_span_id = SpanId::from_bytes(span_id_bytes);

    let otel_flags = if flags.is_sampled() {
        OtelTraceFlags::SAMPLED
    } else {
        OtelTraceFlags::default()
    };

    let trace_state = TraceState::from_key_value(baggage.iter().map(|(key, value)| (key, value)))?;

    Ok(SpanContext::new(
        otel_trace_id,
        otel_span_id,
        otel_flags,
        false,
        trace_state,
    ))
}

// =============================================================================
// Test Cases
// =============================================================================

/// Test W3C trace context roundtrip across process boundary
fn test_w3c_roundtrip(verbose: bool) -> TestResult {
    if verbose {
        println!("  Testing W3C trace context roundtrip");
    }

    // Create original context
    let mut rng = DetRng::new(500);
    let original_ctx = SymbolTraceContext::new_for_encoding(
        DistTraceId::new(0x1234567890abcdef, 0xfedcba0987654321),
        SymbolSpanId::new(0x1111222233334444),
        RegionTag::new("service-a"),
        &mut rng,
    )
    .with_baggage("service", "user-api")
    .with_baggage("version", "1.0.0")
    .with_baggage("region", "us-west-2");

    // Convert to W3C headers for a process-boundary handoff.
    let w3c_headers = to_w3c_headers(&original_ctx);

    if verbose {
        println!(
            "  Original trace: {:016x}{:016x}",
            original_ctx.trace_id().high(),
            original_ctx.trace_id().low()
        );
        println!("  W3C traceparent: {}", w3c_headers.traceparent);
        if let Some(ref tracestate) = w3c_headers.tracestate {
            println!("  W3C tracestate: {}", tracestate);
        }
    }

    // Parse headers back on the receiving side of the handoff.
    let (parsed_trace_id, parsed_span_id, parsed_flags) =
        parse_w3c_traceparent(&w3c_headers.traceparent)?;

    // Verify roundtrip accuracy
    if parsed_trace_id != original_ctx.trace_id() {
        return Err(format!(
            "Trace ID roundtrip failed: {:016x}{:016x} != {:016x}{:016x}",
            parsed_trace_id.high(),
            parsed_trace_id.low(),
            original_ctx.trace_id().high(),
            original_ctx.trace_id().low()
        )
        .into());
    }

    if parsed_span_id != original_ctx.span_id() {
        return Err(format!(
            "Span ID roundtrip failed: {:016x} != {:016x}",
            parsed_span_id.as_u64(),
            original_ctx.span_id().as_u64()
        )
        .into());
    }

    if parsed_flags.as_byte() != original_ctx.flags().as_byte() {
        return Err(format!(
            "Flags roundtrip failed: {:02x} != {:02x}",
            parsed_flags.as_byte(),
            original_ctx.flags().as_byte()
        )
        .into());
    }

    // Test against OpenTelemetry reference
    let otel_span_context = create_otel_span_context(
        original_ctx.trace_id(),
        original_ctx.span_id(),
        original_ctx.flags(),
        original_ctx.baggage(),
    )?;

    let propagator = TraceContextPropagator::new();
    let mut ref_headers = HashMap::new();
    let ctx = Context::default().with_remote_span_context(otel_span_context);
    propagator.inject_context(&ctx, &mut HeaderInjector(&mut ref_headers));

    let ref_traceparent = ref_headers
        .get("traceparent")
        .ok_or("Reference traceparent missing")?;

    if &w3c_headers.traceparent != ref_traceparent {
        return Err(format!(
            "W3C conformance mismatch:\n  Our: {}\n  Ref: {}",
            w3c_headers.traceparent, ref_traceparent
        )
        .into());
    }

    if verbose {
        println!("  Roundtrip verification: ✓");
        println!("  OpenTelemetry conformance: ✓");
    }

    Ok(())
}

/// Test B3 trace context roundtrip
fn test_b3_roundtrip(verbose: bool) -> TestResult {
    if verbose {
        println!("  Testing B3 trace context roundtrip");
    }

    let mut rng = DetRng::new(600);
    let original_ctx = SymbolTraceContext::new_for_encoding(
        DistTraceId::new(0xabcdef1234567890, 0x0123456789abcdef),
        SymbolSpanId::new(0x5555666677778888),
        RegionTag::new("service-b"),
        &mut rng,
    );

    let b3_headers = to_b3_headers(&original_ctx);

    if verbose {
        println!("  B3 Trace-Id: {}", b3_headers.trace_id);
        println!("  B3 Span-Id: {}", b3_headers.span_id);
        if let Some(ref sampled) = b3_headers.sampled {
            println!("  B3 Sampled: {}", sampled);
        }
    }

    // Parse back trace ID and span ID
    let parsed_trace_high = u64::from_str_radix(&b3_headers.trace_id[0..16], 16)?;
    let parsed_trace_low = u64::from_str_radix(&b3_headers.trace_id[16..32], 16)?;
    let parsed_trace_id = DistTraceId::new(parsed_trace_high, parsed_trace_low);

    let parsed_span_id = SymbolSpanId::new(u64::from_str_radix(&b3_headers.span_id, 16)?);

    // Verify roundtrip
    if parsed_trace_id != original_ctx.trace_id() {
        return Err("B3 trace ID roundtrip failed".into());
    }

    if parsed_span_id != original_ctx.span_id() {
        return Err("B3 span ID roundtrip failed".into());
    }

    // Check sampling flag
    let expected_sampled = if original_ctx.flags().is_sampled() {
        "1"
    } else {
        "0"
    };
    if b3_headers.sampled.as_deref() != Some(expected_sampled) {
        return Err("B3 sampling flag mismatch".into());
    }

    if verbose {
        println!("  B3 roundtrip verification: ✓");
    }

    Ok(())
}

/// Test baggage propagation across process boundaries
fn test_baggage_roundtrip(verbose: bool) -> TestResult {
    if verbose {
        println!("  Testing baggage roundtrip");
    }

    let mut rng = DetRng::new(700);
    let original_ctx = SymbolTraceContext::new_for_encoding(
        DistTraceId::new(0x1111111111111111, 0x2222222222222222),
        SymbolSpanId::new(0x3333333333333333),
        RegionTag::new("baggage-test"),
        &mut rng,
    )
    .with_baggage("user_id", "user-12345")
    .with_baggage("session_id", "sess-abcdef")
    .with_baggage("request_id", "req-xyz789")
    .with_baggage("correlation", "corr-123");

    // Convert to W3C format (includes baggage as tracestate)
    let w3c_headers = to_w3c_headers(&original_ctx);

    let tracestate = w3c_headers
        .tracestate
        .ok_or("Tracestate should be present with baggage")?;

    if verbose {
        println!("  Original baggage count: {}", original_ctx.baggage().len());
        println!("  Tracestate: {}", tracestate);
    }

    // Parse tracestate back to baggage
    let parsed_baggage: Vec<(String, String)> = tracestate
        .split(',')
        .map(|entry| {
            let parts: Vec<&str> = entry.split('=').collect();
            (parts[0].to_string(), parts[1].to_string())
        })
        .collect();

    // Verify all baggage items preserved
    for (key, value) in original_ctx.baggage() {
        let found = parsed_baggage.iter().any(|(k, v)| k == key && v == value);

        if !found {
            return Err(format!("Baggage item lost: {}={}", key, value).into());
        }
    }

    if verbose {
        println!("  Parsed baggage count: {}", parsed_baggage.len());
        println!("  Baggage roundtrip verification: ✓");
    }

    Ok(())
}

/// Test mixed header formats in same context
fn test_mixed_headers(verbose: bool) -> TestResult {
    if verbose {
        println!("  Testing mixed W3C and B3 headers");
    }

    let mut rng = DetRng::new(800);
    let ctx = SymbolTraceContext::new_for_encoding(
        DistTraceId::new(0xfafafafafafafafa, 0xbbbbbbbbbbbbbbb),
        SymbolSpanId::new(0xcccccccccccccccc),
        RegionTag::new("mixed-test"),
        &mut rng,
    )
    .with_baggage("format", "mixed")
    .with_baggage("test", "conformance");

    // Generate both header formats
    let w3c_headers = to_w3c_headers(&ctx);
    let b3_headers = to_b3_headers(&ctx);

    // Both should represent the same trace context
    let (w3c_trace_id, _, _) = parse_w3c_traceparent(&w3c_headers.traceparent)?;

    let b3_trace_high = u64::from_str_radix(&b3_headers.trace_id[0..16], 16)?;
    let b3_trace_low = u64::from_str_radix(&b3_headers.trace_id[16..32], 16)?;
    let b3_trace_id = DistTraceId::new(b3_trace_high, b3_trace_low);

    if w3c_trace_id != b3_trace_id {
        return Err("Mixed headers have different trace IDs".into());
    }

    if verbose {
        println!("  W3C format: {}", w3c_headers.traceparent);
        println!(
            "  B3 format: X-B3-TraceId={}, X-B3-SpanId={}",
            b3_headers.trace_id, b3_headers.span_id
        );
        println!("  Cross-format consistency: ✓");
    }

    Ok(())
}

/// Test comprehensive cross-process scenario
fn test_comprehensive_scenario(verbose: bool) -> TestResult {
    if verbose {
        println!("  Testing comprehensive cross-process scenario");
    }

    // Exercise Service A -> Service B -> Service C propagation.
    let mut rng = DetRng::new(900);

    // Service A initiates request
    let service_a_ctx = SymbolTraceContext::new_for_encoding(
        DistTraceId::new(0x1000000000000001, 0x2000000000000002),
        SymbolSpanId::new(0x3000000000000003),
        RegionTag::new("service-a"),
        &mut rng,
    )
    .with_baggage("request_id", "req-root-123")
    .with_baggage("user_id", "user-456");

    // Service A -> Service B (W3C headers)
    let a_to_b_headers = to_w3c_headers(&service_a_ctx);
    let (trace_id, _, _flags) = parse_w3c_traceparent(&a_to_b_headers.traceparent)?;

    // Service B creates child span
    let service_b_ctx = SymbolTraceContext::new_for_encoding(
        trace_id,
        service_a_ctx.span_id(), // Parent span
        RegionTag::new("service-b"),
        &mut rng,
    )
    .with_baggage("request_id", "req-root-123") // Inherited
    .with_baggage("user_id", "user-456") // Inherited
    .with_baggage("service_b_op", "process"); // Added

    // Service B -> Service C (B3 headers)
    let b_to_c_headers = to_b3_headers(&service_b_ctx);
    let b3_trace_high = u64::from_str_radix(&b_to_c_headers.trace_id[0..16], 16)?;
    let b3_trace_low = u64::from_str_radix(&b_to_c_headers.trace_id[16..32], 16)?;
    let b3_trace_id = DistTraceId::new(b3_trace_high, b3_trace_low);

    // Verify trace ID propagated correctly across all services
    if service_a_ctx.trace_id() != service_b_ctx.trace_id()
        || service_b_ctx.trace_id() != b3_trace_id
    {
        return Err("Trace ID not preserved across service calls".into());
    }

    // Verify baggage propagation and evolution
    if service_a_ctx.get_baggage("request_id") != service_b_ctx.get_baggage("request_id") {
        return Err("Request ID not preserved in baggage".into());
    }

    if service_b_ctx.get_baggage("service_b_op") != Some("process") {
        return Err("Service B did not add its baggage".into());
    }

    if verbose {
        println!(
            "  Service A trace: {:016x}{:016x}",
            service_a_ctx.trace_id().high(),
            service_a_ctx.trace_id().low()
        );
        println!(
            "  Service B trace: {:016x}{:016x}",
            service_b_ctx.trace_id().high(),
            service_b_ctx.trace_id().low()
        );
        println!(
            "  Service C trace: {:016x}{:016x}",
            b3_trace_id.high(),
            b3_trace_id.low()
        );
        println!("  A->B headers: W3C");
        println!("  B->C headers: B3");
        println!("  Trace continuity: ✓");
        println!("  Baggage evolution: ✓");
    }

    Ok(())
}

struct HeaderInjector<'a>(&'a mut HashMap<String, String>);

impl<'a> opentelemetry::propagation::Injector for HeaderInjector<'a> {
    fn set(&mut self, key: &str, value: String) {
        self.0.insert(key.to_string(), value);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_w3c_header_format() {
        let mut rng = DetRng::new(42);
        let ctx = SymbolTraceContext::new_for_encoding(
            DistTraceId::new(0x1234567890abcdef, 0xfedcba0987654321),
            SymbolSpanId::new(0x1111222233334444),
            RegionTag::new("test"),
            &mut rng,
        );

        let headers = to_w3c_headers(&ctx);
        assert!(
            headers
                .traceparent
                .starts_with("00-1234567890abcdeffedcba0987654321")
        );
        assert!(headers.traceparent.ends_with("-01")); // SAMPLED flag
    }

    #[test]
    fn test_traceparent_parsing() {
        let traceparent = "00-1234567890abcdeffedcba0987654321-5555666677778888-01";
        let (trace_id, span_id, flags) = parse_w3c_traceparent(traceparent).unwrap();

        assert_eq!(trace_id.high(), 0x1234567890abcdef);
        assert_eq!(trace_id.low(), 0xfedcba0987654321);
        assert_eq!(span_id.as_u64(), 0x5555666677778888);
        assert!(flags.is_sampled());
    }

    #[test]
    fn source_uses_real_opentelemetry_context_instead_of_local_mock_span() {
        let source = include_str!("cross_process_trace_conformance.rs");
        for (left, right) in [
            ("Mock", "Span"),
            ("Mock", " Implementations"),
            ("Context::default().with_", "span"),
        ] {
            let forbidden = format!("{left}{right}");
            assert!(!source.contains(&forbidden), "found {forbidden}");
        }
        assert!(source.contains("with_remote_span_context"));
    }
}