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
#![allow(clippy::unwrap_used)]

use std::path::PathBuf;

use crate::parser::SysMLParser;
use crate::parser::sysml::Rule;
use crate::semantic::Workspace;
use crate::syntax::SyntaxFile;
use crate::syntax::sysml::ast::parse_file;

use pest::Parser;

// Tests for WorkspaceFile::path()

#[test]
fn test_workspace_file_path_returns_correct_path() {
    // Create a workspace and add a file to test path() through public API
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source = "part def Vehicle;";
    let mut pairs = SysMLParser::parse(Rule::file, source).unwrap();
    let file = parse_file(&mut pairs).unwrap();

    let path = PathBuf::from("test/path/vehicle.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file));

    let workspace_file = workspace.get_file(&path).unwrap();
    assert_eq!(workspace_file.path(), &path);
}

#[test]
fn test_workspace_file_path_with_relative_path() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source = "part def Car;";
    let mut pairs = SysMLParser::parse(Rule::file, source).unwrap();
    let file = parse_file(&mut pairs).unwrap();

    let path = PathBuf::from("car.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file));

    let workspace_file = workspace.get_file(&path).unwrap();
    assert_eq!(workspace_file.path(), &path);
}

#[test]
fn test_workspace_file_path_with_nested_directory() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source = "part def Truck;";
    let mut pairs = SysMLParser::parse(Rule::file, source).unwrap();
    let file = parse_file(&mut pairs).unwrap();

    let path = PathBuf::from("models/vehicles/truck.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file));

    let workspace_file = workspace.get_file(&path).unwrap();
    assert_eq!(workspace_file.path(), &path);
    assert_eq!(
        workspace_file.path().to_str().unwrap(),
        "models/vehicles/truck.sysml"
    );
}

#[test]
fn test_workspace_file_path_immutable() {
    // Verify that path remains consistent after updates
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("constant.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    let original_path = workspace.get_file(&path).unwrap().path().clone();

    // Update the file content
    let source2 = "part def V2;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    // Path should remain unchanged
    assert_eq!(workspace.get_file(&path).unwrap().path(), &original_path);
    assert_eq!(workspace.get_file(&path).unwrap().path(), &path);
}

// Tests for WorkspaceFile::version()

#[test]
fn test_workspace_file_version_initial_value() {
    // New files should have version 0
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source = "part def Vehicle;";
    let mut pairs = SysMLParser::parse(Rule::file, source).unwrap();
    let file = parse_file(&mut pairs).unwrap();

    let path = PathBuf::from("vehicle.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file));

    let workspace_file = workspace.get_file(&path).unwrap();
    assert_eq!(workspace_file.version(), 0);
}

#[test]
fn test_workspace_file_version_increments_on_update() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    assert_eq!(workspace.get_file(&path).unwrap().version(), 0);

    // First update
    let source2 = "part def V2;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    assert_eq!(workspace.get_file(&path).unwrap().version(), 1);
}

#[test]
fn test_workspace_file_version_multiple_updates() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Update multiple times and verify version increments correctly
    for expected_version in 1..=10 {
        let source = format!("part def V{expected_version};");
        let mut pairs = SysMLParser::parse(Rule::file, &source).unwrap();
        let file = parse_file(&mut pairs).unwrap();
        workspace.update_file(&path, SyntaxFile::SysML(file));

        assert_eq!(
            workspace.get_file(&path).unwrap().version(),
            expected_version
        );
    }
}

#[test]
fn test_workspace_file_version_independent_across_files() {
    // Verify that different files maintain independent version numbers
    let mut workspace = Workspace::<SyntaxFile>::new();

    let path1 = PathBuf::from("file1.sysml");
    let path2 = PathBuf::from("file2.sysml");

    // Add first file
    let source1 = "part def F1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();
    workspace.add_file(path1.clone(), SyntaxFile::SysML(file1));

    // Add second file
    let source2 = "part def F2;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.add_file(path2.clone(), SyntaxFile::SysML(file2));

    // Both should start at version 0
    assert_eq!(workspace.get_file(&path1).unwrap().version(), 0);
    assert_eq!(workspace.get_file(&path2).unwrap().version(), 0);

    // Update first file twice
    for i in 1..=2 {
        let source = format!("part def F1_V{i};");
        let mut pairs = SysMLParser::parse(Rule::file, &source).unwrap();
        let file = parse_file(&mut pairs).unwrap();
        workspace.update_file(&path1, SyntaxFile::SysML(file));
    }

    // Update second file once
    let source = "part def F2_V1;";
    let mut pairs = SysMLParser::parse(Rule::file, source).unwrap();
    let file = parse_file(&mut pairs).unwrap();
    workspace.update_file(&path2, SyntaxFile::SysML(file));

    // Verify independent version tracking
    assert_eq!(workspace.get_file(&path1).unwrap().version(), 2);
    assert_eq!(workspace.get_file(&path2).unwrap().version(), 1);
}

#[test]
fn test_workspace_file_version_large_number() {
    // Verify version can handle large update counts
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Perform many updates
    let update_count = 100u32;
    for _ in 0..update_count {
        let source = "part def Updated;";
        let mut pairs = SysMLParser::parse(Rule::file, source).unwrap();
        let file = parse_file(&mut pairs).unwrap();
        workspace.update_file(&path, SyntaxFile::SysML(file));
    }

    assert_eq!(workspace.get_file(&path).unwrap().version(), update_count);
}

// Tests for WorkspaceFile::update_content()

#[test]
fn test_workspace_file_update_content_changes_content() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def Vehicle;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Verify initial content exists
    let initial_file = workspace.get_file(&path).unwrap();
    assert!(initial_file.content().as_sysml().is_some());

    // Update content
    let source2 = "part def Car;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    let updated = workspace.update_file(&path, SyntaxFile::SysML(file2));

    assert!(updated);
    assert!(
        workspace
            .get_file(&path)
            .unwrap()
            .content()
            .as_sysml()
            .is_some()
    );
}

#[test]
fn test_workspace_file_update_content_increments_version() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    let version_before = workspace.get_file(&path).unwrap().version();

    // Update content
    let source2 = "part def V2;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    let version_after = workspace.get_file(&path).unwrap().version();
    assert_eq!(version_after, version_before + 1);
}

#[test]
fn test_workspace_file_update_content_resets_populated_flag() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def Vehicle;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Populate the file
    workspace.populate_file(&path).unwrap();
    assert!(workspace.get_file(&path).unwrap().is_populated());

    // Update content
    let source2 = "part def Car;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    // Populated flag should be reset to false
    assert!(!workspace.get_file(&path).unwrap().is_populated());
}

#[test]
fn test_workspace_file_update_content_with_empty_file() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def Vehicle;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Update with empty file
    let empty_source = "";
    let mut pairs_empty = SysMLParser::parse(Rule::file, empty_source).unwrap();
    let empty_file = parse_file(&mut pairs_empty).unwrap();
    let updated = workspace.update_file(&path, SyntaxFile::SysML(empty_file));

    assert!(updated);
    assert_eq!(workspace.get_file(&path).unwrap().version(), 1);
}

#[test]
fn test_workspace_file_update_content_preserves_path() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("important/path/file.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    let path_before = workspace.get_file(&path).unwrap().path().clone();

    // Update content multiple times
    for i in 2..=5 {
        let source = format!("part def V{i};");
        let mut pairs = SysMLParser::parse(Rule::file, &source).unwrap();
        let file = parse_file(&mut pairs).unwrap();
        workspace.update_file(&path, SyntaxFile::SysML(file));
    }

    // Path should remain unchanged
    let path_after = workspace.get_file(&path).unwrap().path().clone();
    assert_eq!(path_after, path_before);
    assert_eq!(path_after, path);
}

#[test]
fn test_workspace_file_update_content_with_syntax_file_sysml() {
    // Test update_content specifically with SyntaxFile::SysML variant
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def Original;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    workspace.populate_file(&path).unwrap();
    assert_eq!(workspace.get_file(&path).unwrap().version(), 0);
    assert!(workspace.get_file(&path).unwrap().is_populated());

    // Update with new SysML content
    let source2 = "part def Updated;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    // Verify all expected changes
    assert_eq!(workspace.get_file(&path).unwrap().version(), 1);
    assert!(!workspace.get_file(&path).unwrap().is_populated());
    assert!(
        workspace
            .get_file(&path)
            .unwrap()
            .content()
            .as_sysml()
            .is_some()
    );
}

#[test]
fn test_workspace_file_update_content_consecutive_updates() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Perform consecutive updates without populating in between
    let source2 = "part def V2;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    let source3 = "part def V3;";
    let mut pairs3 = SysMLParser::parse(Rule::file, source3).unwrap();
    let file3 = parse_file(&mut pairs3).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file3));

    // Version should be 2, populated should still be false
    assert_eq!(workspace.get_file(&path).unwrap().version(), 2);
    assert!(!workspace.get_file(&path).unwrap().is_populated());
}

#[test]
fn test_workspace_file_update_content_after_repopulate() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let source1 = "part def V1;";
    let mut pairs1 = SysMLParser::parse(Rule::file, source1).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Initial populate
    workspace.populate_file(&path).unwrap();
    assert!(workspace.get_file(&path).unwrap().is_populated());
    assert_eq!(workspace.get_file(&path).unwrap().version(), 0);

    // Update
    let source2 = "part def V2;";
    let mut pairs2 = SysMLParser::parse(Rule::file, source2).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    assert!(!workspace.get_file(&path).unwrap().is_populated());
    assert_eq!(workspace.get_file(&path).unwrap().version(), 1);

    // Re-populate
    workspace.populate_file(&path).unwrap();
    assert!(workspace.get_file(&path).unwrap().is_populated());
    assert_eq!(workspace.get_file(&path).unwrap().version(), 1);

    // Another update
    let source3 = "part def V3;";
    let mut pairs3 = SysMLParser::parse(Rule::file, source3).unwrap();
    let file3 = parse_file(&mut pairs3).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file3));

    assert!(!workspace.get_file(&path).unwrap().is_populated());
    assert_eq!(workspace.get_file(&path).unwrap().version(), 2);
}

#[test]
fn test_workspace_file_update_content_with_complex_content() {
    let mut workspace = Workspace::<SyntaxFile>::new();

    let simple_source = "part def Simple;";
    let mut pairs1 = SysMLParser::parse(Rule::file, simple_source).unwrap();
    let file1 = parse_file(&mut pairs1).unwrap();

    let path = PathBuf::from("test.sysml");
    workspace.add_file(path.clone(), SyntaxFile::SysML(file1));

    // Update with more complex content
    let complex_source = r#"
        package Vehicles {
            part def Vehicle {
                attribute mass : Real;
            }
            part def Car :> Vehicle;
        }
    "#;
    let mut pairs2 = SysMLParser::parse(Rule::file, complex_source).unwrap();
    let file2 = parse_file(&mut pairs2).unwrap();
    workspace.update_file(&path, SyntaxFile::SysML(file2));

    assert_eq!(workspace.get_file(&path).unwrap().version(), 1);
    assert!(!workspace.get_file(&path).unwrap().is_populated());
}