telltale-runtime 17.0.0

Choreographic programming for Telltale - effect-based distributed protocols
Documentation
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
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
//! Tests for code generation public API
//!
//! This test suite verifies the major codegen functions produce
//! correctly structured Rust code.

#![allow(clippy::unwrap_used)]
#![allow(clippy::expect_used)]

use quote::format_ident;
use std::collections::HashMap;
use telltale_runtime::ast::{
    annotation::Annotations, Choreography, LocalType, MessageType, Protocol, Role, RoleParam,
};
use telltale_runtime::compiler::codegen::{
    generate_choreography_code, generate_dynamic_role_support, generate_role_implementations,
    generate_session_type, generate_topology_integration, InlineTopology,
};
use telltale_runtime::topology::Topology;

// Helper to create simple roles
fn role(name: &str) -> Role {
    Role::new(format_ident!("{}", name)).unwrap()
}

// Helper to create parameterized roles
fn role_with_param(name: &str, param: RoleParam) -> Role {
    Role::with_param(format_ident!("{}", name), param).unwrap()
}

// Helper to create message types
fn message(name: &str) -> MessageType {
    MessageType {
        name: format_ident!("{}", name),
        type_annotation: None,
        payload: None,
    }
}

// Helper to create a Send protocol with default annotations
fn send(from: Role, to: Role, message: MessageType, continuation: Protocol) -> Protocol {
    Protocol::Send {
        from,
        to,
        message,
        continuation: Box::new(continuation),
        annotations: Annotations::new(),
        from_annotations: Annotations::new(),
        to_annotations: Annotations::new(),
    }
}

// ============================================================================
// generate_session_type Tests
// ============================================================================

#[test]
fn test_generate_session_type_send() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Send {
        to: bob.clone(),
        message: message("Hello"),
        continuation: Box::new(LocalType::End),
    };

    let code = generate_session_type(&alice, &local_type, "TestProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("type Alice_TestProtocol"),
        "Should have type name: {}",
        code_str
    );
    assert!(
        code_str.contains("Send"),
        "Should contain Send: {}",
        code_str
    );
    assert!(
        code_str.contains("Bob"),
        "Should reference Bob: {}",
        code_str
    );
    assert!(
        code_str.contains("Hello"),
        "Should contain message: {}",
        code_str
    );
}

#[test]
fn test_generate_session_type_receive() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Receive {
        from: alice.clone(),
        message: message("Response"),
        continuation: Box::new(LocalType::End),
    };

    let code = generate_session_type(&bob, &local_type, "TestProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("type Bob_TestProtocol"),
        "Should have type name: {}",
        code_str
    );
    assert!(
        code_str.contains("Receive"),
        "Should contain Receive: {}",
        code_str
    );
    assert!(
        code_str.contains("Alice"),
        "Should reference Alice: {}",
        code_str
    );
}

#[test]
fn test_generate_session_type_select() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Select {
        to: bob.clone(),
        branches: vec![
            (format_ident!("Accept"), LocalType::End),
            (format_ident!("Reject"), LocalType::End),
        ],
    };

    let code = generate_session_type(&alice, &local_type, "ChoiceProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("Select"),
        "Should contain Select: {}",
        code_str
    );
    assert!(
        code_str.contains("Accept"),
        "Should contain Accept branch: {}",
        code_str
    );
    assert!(
        code_str.contains("Reject"),
        "Should contain Reject branch: {}",
        code_str
    );
}

#[test]
fn test_generate_session_type_branch() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Branch {
        from: alice.clone(),
        branches: vec![
            (format_ident!("Yes"), LocalType::End),
            (format_ident!("No"), LocalType::End),
        ],
    };

    let code = generate_session_type(&bob, &local_type, "ChoiceProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("Branch"),
        "Should contain Branch: {}",
        code_str
    );
    assert!(
        code_str.contains("Yes"),
        "Should contain Yes branch: {}",
        code_str
    );
    assert!(
        code_str.contains("No"),
        "Should contain No branch: {}",
        code_str
    );
}

#[test]
fn test_generate_session_type_end() {
    let alice = role("Alice");

    let code = generate_session_type(&alice, &LocalType::End, "EmptyProtocol");
    let code_str = code.to_string();

    assert!(code_str.contains("End"), "Should contain End: {}", code_str);
}

// ============================================================================
// generate_role_implementations Tests
// ============================================================================

#[test]
fn test_generate_role_implementations_send() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Send {
        to: bob.clone(),
        message: message("Request"),
        continuation: Box::new(LocalType::End),
    };

    let code = generate_role_implementations(&alice, &local_type, "TestProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("async fn alice_protocol"),
        "Should have async function: {}",
        code_str
    );
    assert!(
        code_str.contains("try_session"),
        "Should use try_session: {}",
        code_str
    );
    assert!(
        code_str.contains("send"),
        "Should have send call: {}",
        code_str
    );
}

#[test]
fn test_generate_role_implementations_receive() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Receive {
        from: alice.clone(),
        message: message("Data"),
        continuation: Box::new(LocalType::End),
    };

    let code = generate_role_implementations(&bob, &local_type, "TestProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("async fn bob_protocol"),
        "Should have async function: {}",
        code_str
    );
    assert!(
        code_str.contains("receive"),
        "Should have receive call: {}",
        code_str
    );
}

#[test]
fn test_generate_role_implementations_branch() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Branch {
        from: alice.clone(),
        branches: vec![
            (format_ident!("Left"), LocalType::End),
            (format_ident!("Right"), LocalType::End),
        ],
    };

    let code = generate_role_implementations(&bob, &local_type, "ChoiceProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("branch"),
        "Should have branch call: {}",
        code_str
    );
    assert!(
        code_str.contains("match"),
        "Should have match statement: {}",
        code_str
    );
    assert!(
        code_str.contains("Choice"),
        "Should reference Choice enum: {}",
        code_str
    );
}

// ============================================================================
// generate_choreography_code Tests
// ============================================================================

#[test]
fn test_generate_choreography_code_basic() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_types = vec![
        (
            alice.clone(),
            LocalType::Send {
                to: bob.clone(),
                message: message("Ping"),
                continuation: Box::new(LocalType::End),
            },
        ),
        (
            bob.clone(),
            LocalType::Receive {
                from: alice.clone(),
                message: message("Ping"),
                continuation: Box::new(LocalType::End),
            },
        ),
    ];

    let code = generate_choreography_code("PingPong", &[alice.clone(), bob.clone()], &local_types);
    let code_str = code.to_string();

    // Should have roles struct
    assert!(
        code_str.contains("Roles"),
        "Should have Roles struct: {}",
        code_str
    );

    // Should have role structs
    assert!(
        code_str.contains("struct Alice"),
        "Should have Alice struct: {}",
        code_str
    );
    assert!(
        code_str.contains("struct Bob"),
        "Should have Bob struct: {}",
        code_str
    );

    // Should have session types
    assert!(
        code_str.contains("Alice_PingPong"),
        "Should have Alice session type: {}",
        code_str
    );
    assert!(
        code_str.contains("Bob_PingPong"),
        "Should have Bob session type: {}",
        code_str
    );
}

#[test]
fn test_generate_choreography_code_three_roles() {
    let alice = role("Alice");
    let bob = role("Bob");
    let charlie = role("Charlie");

    let local_types = vec![
        (alice.clone(), LocalType::End),
        (bob.clone(), LocalType::End),
        (charlie.clone(), LocalType::End),
    ];

    let code = generate_choreography_code(
        "ThreeParty",
        &[alice.clone(), bob.clone(), charlie.clone()],
        &local_types,
    );
    let code_str = code.to_string();

    // All roles should be present
    assert!(
        code_str.contains("Alice"),
        "Should have Alice: {}",
        code_str
    );
    assert!(code_str.contains("Bob"), "Should have Bob: {}", code_str);
    assert!(
        code_str.contains("Charlie"),
        "Should have Charlie: {}",
        code_str
    );

    // Should have routes
    assert!(
        code_str.contains("route"),
        "Should have routes: {}",
        code_str
    );
}

// ============================================================================
// generate_dynamic_role_support Tests
// ============================================================================

#[test]
fn test_generate_dynamic_role_support_static() {
    // Static role params should produce minimal/empty dynamic support
    let worker = role_with_param("Worker", RoleParam::Static(3));
    let manager = role("Manager");

    let choreo = Choreography {
        name: format_ident!("StaticWorkerProtocol"),
        namespace: None,
        roles: vec![worker.clone(), manager.clone()],
        protocol: send(
            worker.clone(),
            manager.clone(),
            message("Report"),
            Protocol::End,
        ),
        attrs: HashMap::new(),
    };

    let code = generate_dynamic_role_support(&choreo);
    let code_str = code.to_string();

    // Static params don't need runtime support - may be empty
    assert!(
        code_str.is_empty() || !code_str.contains("WORKER_COUNT"),
        "Static params should produce minimal dynamic support: {}",
        code_str
    );
}

#[test]
fn test_generate_dynamic_role_support_runtime() {
    // Runtime role params should generate dynamic support code
    let worker = role_with_param("Worker", RoleParam::Runtime);
    let manager = role("Manager");

    let choreo = Choreography {
        name: format_ident!("DynamicWorkerProtocol"),
        namespace: None,
        roles: vec![worker.clone(), manager.clone()],
        protocol: send(
            manager.clone(),
            worker.clone(),
            message("Task"),
            Protocol::End,
        ),
        attrs: HashMap::new(),
    };

    let code = generate_dynamic_role_support(&choreo);
    let code_str = code.to_string();

    // Runtime roles should generate support code (may include constants, traits, etc.)
    // The actual output depends on implementation
    assert!(
        code_str.contains("Worker") || code_str.contains("Dynamic") || code_str.is_empty(),
        "Runtime params should have some dynamic support: {}",
        code_str
    );
}

#[test]
fn test_generate_dynamic_role_support_symbolic() {
    // Symbolic role params should generate dynamic support code
    let worker = role_with_param("Worker", RoleParam::Symbolic("N".to_string()));
    let manager = role("Manager");

    let choreo = Choreography {
        name: format_ident!("SymbolicWorkerProtocol"),
        namespace: None,
        roles: vec![worker.clone(), manager.clone()],
        protocol: send(
            manager.clone(),
            worker.clone(),
            message("Task"),
            Protocol::End,
        ),
        attrs: HashMap::new(),
    };

    let code = generate_dynamic_role_support(&choreo);
    let code_str = code.to_string();

    // Symbolic roles should generate support code
    assert!(
        code_str.contains("Worker") || code_str.contains("N") || code_str.is_empty(),
        "Symbolic params should have some dynamic support: {}",
        code_str
    );
}

// ============================================================================
// generate_topology_integration Tests
// ============================================================================

#[test]
fn test_generate_topology_integration_empty() {
    let alice = role("Alice");
    let bob = role("Bob");

    let choreo = Choreography {
        name: format_ident!("TopologyTest"),
        namespace: None,
        roles: vec![alice.clone(), bob.clone()],
        protocol: send(alice.clone(), bob.clone(), message("Hello"), Protocol::End),
        attrs: HashMap::new(),
    };

    let code = generate_topology_integration(&choreo, &[]);
    let code_str = code.to_string();

    // Even with no inline topologies, should generate base topology module
    // This includes handler() and with_topology() functions
    assert!(
        code_str.contains("topology") || code_str.contains("TopologyHandler"),
        "Should generate topology module: {}",
        code_str
    );
    assert!(
        code_str.contains("handler"),
        "Should have handler function: {}",
        code_str
    );
}

#[test]
fn test_generate_topology_integration_with_inline() {
    let alice = role("Alice");
    let bob = role("Bob");

    let choreo = Choreography {
        name: format_ident!("TopologyTest"),
        namespace: None,
        roles: vec![alice.clone(), bob.clone()],
        protocol: send(alice.clone(), bob.clone(), message("Hello"), Protocol::End),
        attrs: HashMap::new(),
    };

    // Create a simple local topology
    let inline_topology = InlineTopology {
        name: "test".to_string(),
        topology: Topology::local_mode(),
    };

    let code = generate_topology_integration(&choreo, &[inline_topology]);
    let code_str = code.to_string();

    // With inline topology, should generate topology-related code
    assert!(
        code_str.contains("topology")
            || code_str.contains("TOPOLOGY")
            || code_str.contains("test")
            || code_str.contains("TopologyTest"),
        "Should have topology-related code: {}",
        code_str
    );
}

// ============================================================================
// Edge Cases and Error Handling Tests
// ============================================================================

#[test]
fn test_generate_session_type_nested_structure() {
    let alice = role("Alice");
    let bob = role("Bob");

    // Nested Send -> Receive -> Send pattern
    let local_type = LocalType::Send {
        to: bob.clone(),
        message: message("Request"),
        continuation: Box::new(LocalType::Receive {
            from: bob.clone(),
            message: message("Response"),
            continuation: Box::new(LocalType::Send {
                to: bob.clone(),
                message: message("Ack"),
                continuation: Box::new(LocalType::End),
            }),
        }),
    };

    let code = generate_session_type(&alice, &local_type, "NestedProtocol");
    let code_str = code.to_string();

    // Should contain all operations
    assert!(code_str.contains("Send"), "Should have Send: {}", code_str);
    assert!(
        code_str.contains("Receive"),
        "Should have Receive: {}",
        code_str
    );
    assert!(
        code_str.contains("Request"),
        "Should have Request: {}",
        code_str
    );
    assert!(
        code_str.contains("Response"),
        "Should have Response: {}",
        code_str
    );
    assert!(code_str.contains("Ack"), "Should have Ack: {}", code_str);
}

#[test]
fn test_generate_session_type_loop() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Loop {
        condition: None,
        body: Box::new(LocalType::Send {
            to: bob.clone(),
            message: message("Data"),
            continuation: Box::new(LocalType::End),
        }),
    };

    let code = generate_session_type(&alice, &local_type, "LoopProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("Loop"),
        "Should contain Loop: {}",
        code_str
    );
}

#[test]
fn test_generate_session_type_recursive() {
    let alice = role("Alice");
    let bob = role("Bob");

    let local_type = LocalType::Rec {
        label: format_ident!("X"),
        body: Box::new(LocalType::Send {
            to: bob.clone(),
            message: message("Data"),
            continuation: Box::new(LocalType::Var(format_ident!("X"))),
        }),
    };

    let code = generate_session_type(&alice, &local_type, "RecursiveProtocol");
    let code_str = code.to_string();

    // Should generate recursive structure
    assert!(
        code_str.contains("Send") || code_str.contains("Data"),
        "Should have recursive body: {}",
        code_str
    );
}

#[test]
fn test_generate_choreography_code_empty_roles() {
    // Edge case: empty role list
    let code = generate_choreography_code("EmptyProtocol", &[], &[]);
    let code_str = code.to_string();

    // Should still generate something, even if minimal
    assert!(
        code_str.contains("Roles") || code_str.is_empty(),
        "Empty roles should produce valid output: {}",
        code_str
    );
}

#[test]
fn test_generate_session_type_local_choice() {
    let alice = role("Alice");

    let local_type = LocalType::LocalChoice {
        branches: vec![
            (format_ident!("Option1"), LocalType::End),
            (format_ident!("Option2"), LocalType::End),
        ],
    };

    let code = generate_session_type(&alice, &local_type, "LocalChoiceProtocol");
    let code_str = code.to_string();

    assert!(
        code_str.contains("LocalChoice"),
        "Should contain LocalChoice: {}",
        code_str
    );
    assert!(
        code_str.contains("Option1"),
        "Should contain Option1: {}",
        code_str
    );
    assert!(
        code_str.contains("Option2"),
        "Should contain Option2: {}",
        code_str
    );
}