syster-base 0.1.12-alpha

Core library for SysML v2 and KerML parsing, AST, and semantic analysis
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
#![allow(clippy::unwrap_used)]

//! Tests for SysmlAdapter AstVisitor implementation
//!
//! This file contains tests for:
//! - `visit_namespace` - Tests namespace declaration handling
//! - `visit_comment` - Tests comment handling

use super::super::SysmlAdapter;
use crate::semantic::resolver::Resolver;
use crate::semantic::symbol_table::{Symbol, SymbolTable};
use crate::syntax::sysml::ast::{Comment, Element, NamespaceDeclaration, SysMLFile};

// ============================================================================
// visit_namespace TESTS
// ============================================================================

#[test]
fn test_visit_namespace_creates_package_symbol() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "TestNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Verify the namespace was added as a Package symbol
    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("TestNamespace");
    assert!(symbol.is_some());

    let Some(Symbol::Package {
        documentation: None,
        name,
        qualified_name,
        ..
    }) = symbol
    else {
        panic!("Expected Package symbol, got: {symbol:?}");
    };
    assert_eq!(name, "TestNamespace");
    assert_eq!(qualified_name, "TestNamespace");
}

#[test]
fn test_visit_namespace_enters_namespace_scope() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "MyNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // After populate, the adapter should have entered the namespace
    // We can't directly test current_namespace (it's private), but we can test
    // that the namespace affects scope by checking all_symbols
    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("MyNamespace");
    assert!(symbol.is_some());
}

#[test]
fn test_visit_namespace_with_empty_name() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Even with empty name, should create a symbol
    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("");
    assert!(symbol.is_some());
}

#[test]
fn test_visit_namespace_with_special_characters() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "Name_With_Underscores123".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("Name_With_Underscores123");
    assert!(symbol.is_some());
}

#[test]
fn test_visit_namespace_stores_scope_id() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "ScopedNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("ScopedNamespace");
    assert!(symbol.is_some());

    if let Some(Symbol::Package {
        documentation: None,
        scope_id,
        ..
    }) = symbol
    {
        // Scope ID should be set (0 is the root scope)
        assert_eq!(*scope_id, 0);
    } else {
        panic!("Expected Package symbol");
    }
}

#[test]
fn test_visit_namespace_with_span() {
    use crate::core::{Position, Span};

    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let test_span = Some(Span {
        start: Position::new(1, 1),
        end: Position::new(1, 10),
    });

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "SpannedNamespace".to_string(),
            span: test_span,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("SpannedNamespace");
    assert!(symbol.is_some());

    if let Some(Symbol::Package {
        documentation: None,
        span,
        ..
    }) = symbol
    {
        assert_eq!(*span, test_span);
    } else {
        panic!("Expected Package symbol");
    }
}

#[test]
fn test_visit_namespace_no_namespace_in_file() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // With no namespace, symbol table should remain empty (except for any default symbols)
    let is_empty = table.iter_symbols().next().is_none();
    let has_empty_name = table.iter_symbols().any(|sym| sym.name().is_empty());
    assert!(is_empty || !has_empty_name);
}

#[test]
fn test_visit_namespace_affects_subsequent_elements() {
    use crate::syntax::sysml::ast::{Definition, DefinitionKind};

    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "OuterNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![Element::Definition(Definition {
            kind: DefinitionKind::Part,
            name: Some("InnerPart".to_string()),
            body: vec![],
            relationships: Default::default(),
            is_abstract: false,
            is_variation: false,
            span: None,
            short_name: None,
            short_name_span: None,
        })],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // The namespace should exist
    let resolver = Resolver::new(&table);
    let ns_symbol = resolver.resolve("OuterNamespace");
    assert!(ns_symbol.is_some());

    // The inner part should be qualified with the namespace
    let has_qualified = table
        .iter_symbols()
        .any(|sym| sym.qualified_name().contains("OuterNamespace::InnerPart"));
    assert!(
        has_qualified,
        "Definition should be qualified with namespace"
    );
}

#[test]
fn test_visit_namespace_multiple_namespaces_not_supported() {
    // This test documents current behavior - multiple namespace declarations
    // are not typically used in a single file, but if they are, only the
    // first one should be processed
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "FirstNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Only the first namespace should be in the symbol table
    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("FirstNamespace");
    assert!(symbol.is_some());
}

// ============================================================================
// visit_comment TESTS
// ============================================================================

#[test]
fn test_visit_comment_does_not_affect_symbol_table() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "This is a test comment",
            None,
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Symbol table should remain empty - comments don't create symbols
    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_empty_content() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new("", None))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_multiline_content() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "Line 1\nLine 2\nLine 3",
            None,
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_with_special_characters() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "/* Comment with special chars: @#$%^&*() */",
            None,
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_multiple_comments() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![
            Element::Comment(Comment::new("First comment", None)),
            Element::Comment(Comment::new("Second comment", None)),
            Element::Comment(Comment::new("Third comment", None)),
        ],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_between_definitions() {
    use crate::syntax::sysml::ast::{Definition, DefinitionKind};

    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![
            Element::Definition(Definition {
                kind: DefinitionKind::Part,
                name: Some("FirstPart".to_string()),
                body: vec![],
                relationships: Default::default(),
                is_abstract: false,
                is_variation: false,
                span: None,
                short_name: None,
                short_name_span: None,
            }),
            Element::Comment(Comment::new("Comment between definitions", None)),
            Element::Definition(Definition {
                kind: DefinitionKind::Part,
                name: Some("SecondPart".to_string()),
                body: vec![],
                relationships: Default::default(),
                is_abstract: false,
                is_variation: false,
                span: None,
                short_name: None,
                short_name_span: None,
            }),
        ],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Should have exactly 2 symbols (the definitions), not the comment
    assert_eq!(table.iter_symbols().count(), 2);
    assert!(Resolver::new(&table).resolve("FirstPart").is_some());
    assert!(Resolver::new(&table).resolve("SecondPart").is_some());
}

#[test]
fn test_visit_comment_with_span() {
    use crate::core::{Position, Span};

    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "Comment with span",
            Some(Span {
                start: Position::new(1, 1),
                end: Position::new(1, 20),
            }),
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Comment with span should still not affect symbol table
    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_does_not_change_current_namespace() {
    use crate::syntax::sysml::ast::{Definition, DefinitionKind};

    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "TestNS".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![
            Element::Comment(Comment::new("Comment in namespace", None)),
            Element::Definition(Definition {
                kind: DefinitionKind::Part,
                name: Some("PartInNamespace".to_string()),
                body: vec![],
                relationships: Default::default(),
                is_abstract: false,
                is_variation: false,
                span: None,
                short_name: None,
                short_name_span: None,
            }),
        ],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // The definition should still be qualified with the namespace,
    // proving that the comment didn't change the namespace context
    let has_qualified = table
        .iter_symbols()
        .any(|sym| sym.qualified_name().contains("TestNS::PartInNamespace"));
    assert!(has_qualified, "Comment should not affect namespace context");
}

#[test]
fn test_visit_comment_long_content() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let long_comment = "a".repeat(10000);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(&long_comment, None))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    assert!(table.iter_symbols().next().is_none());
}

#[test]
fn test_visit_comment_unicode_content() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: None,
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "Unicode comment: 你好世界 🚀 ñ é",
            None,
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    assert!(table.iter_symbols().next().is_none());
}

// ============================================================================
// INTEGRATION TESTS - Both visit_namespace and visit_comment
// ============================================================================

#[test]
fn test_namespace_with_comments() {
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "DocumentedNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "This namespace is documented",
            None,
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // Should have only the namespace symbol, not the comment
    assert_eq!(table.iter_symbols().count(), 1);
    assert!(
        Resolver::new(&table)
            .resolve("DocumentedNamespace")
            .is_some()
    );
}

#[test]
fn test_comment_before_namespace_not_typical_but_handled() {
    // This test documents the behavior when elements appear before namespace
    // which is not typical SysML structure but should be handled gracefully
    let mut table = SymbolTable::new();
    let mut adapter = SysmlAdapter::new(&mut table);

    let file = SysMLFile {
        namespace: Some(NamespaceDeclaration {
            name: "LateNamespace".to_string(),
            span: None,
        }),
        namespaces: vec![],
        elements: vec![Element::Comment(Comment::new(
            "Comment at file level",
            None,
        ))],
    };

    let result = adapter.populate(&file);
    assert!(result.is_ok());

    // The namespace should still be created
    let resolver = Resolver::new(&table);
    let symbol = resolver.resolve("LateNamespace");
    assert!(symbol.is_some());

    // The comment should not create a symbol
    assert_eq!(table.iter_symbols().count(), 1);
}