syster-base 0.4.0-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
//! Focused tests for hover resolution issues.
//!
//! These tests verify that hover works correctly for various SysML patterns.

use syster::ide::AnalysisHost;

fn create_analysis(source: &str) -> AnalysisHost {
    let mut host = AnalysisHost::new();
    let _errors = host.set_file_content("test.sysml", source);
    host
}

/// Helper to check if hover at a position returns something
fn hover_at(host: &mut AnalysisHost, line: u32, col: u32) -> Option<String> {
    let analysis = host.analysis();
    let file_id = analysis.get_file_id("test.sysml").expect("file not found");
    analysis.hover(file_id, line, col).map(|h| h.contents)
}

// =============================================================================
// REDEFINES PATTERN
// =============================================================================

#[test]
fn test_hover_on_redefines_target() {
    let source = r#"
package TestPkg {
    action def ProvidePower;
    
    part def Vehicle {
        perform providePower : ProvidePower;
    }
    
    part vehicle_b : Vehicle {
        perform ActionTree::providePower redefines providePower;
    }
    
    package ActionTree {
        action providePower : ProvidePower;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 9, 60);
    assert!(
        hover.is_some(),
        "Expected hover on redefines target 'providePower'"
    );
    assert!(hover.unwrap().contains("providePower"));
}

#[test]
fn test_hover_on_qualified_redefines_source() {
    let source = r#"
package TestPkg {
    action def ProvidePower;
    
    part def Vehicle {
        perform providePower : ProvidePower;
    }
    
    part vehicle_b : Vehicle {
        perform ActionTree::providePower redefines providePower;
    }
    
    package ActionTree {
        action providePower : ProvidePower;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 9, 36);
    assert!(
        hover.is_some(),
        "Expected hover on qualified ref 'ActionTree::providePower'"
    );
    assert!(hover.unwrap().contains("ActionTree::providePower"));
}

// =============================================================================
// SPECIALIZES PATTERN
// =============================================================================

#[test]
fn test_hover_on_specializes_target() {
    let source = r#"
package TestPkg {
    part def Engine;
    
    part def Vehicle {
        part engine : Engine;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 5, 22);
    assert!(hover.is_some(), "Expected hover on type 'Engine'");
    assert!(hover.unwrap().contains("Engine"));
}

// =============================================================================
// FEATURE CHAIN PATTERN
// =============================================================================

#[test]
fn test_hover_on_feature_chain_first_part() {
    let source = r#"
package TestPkg {
    part def FuelTank {
        attribute mass : Real;
    }
    
    part def Vehicle {
        part fuelTank : FuelTank;
        attribute totalMass = fuelTank.mass;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 8, 32);
    assert!(
        hover.is_some(),
        "Expected hover on feature chain first part 'fuelTank'"
    );
    assert!(hover.unwrap().contains("fuelTank"));
}

#[test]
fn test_hover_on_feature_chain_second_part() {
    let source = r#"
package TestPkg {
    part def FuelTank {
        attribute mass : Real;
    }
    
    part def Vehicle {
        part fuelTank : FuelTank;
        attribute totalMass = fuelTank.mass;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 8, 41);
    assert!(
        hover.is_some(),
        "Expected hover on feature chain second part 'mass'"
    );
    assert!(hover.unwrap().contains("mass"));
}

// =============================================================================
// SUBSETS PATTERN
// =============================================================================

#[test]
fn test_hover_on_subsets_target() {
    let source = r#"
package TestPkg {
    action def ParentAction {
        action parentAction;
    }
    
    action def ChildAction :> ParentAction {
        action doSomething subsets parentAction;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 7, 40);
    assert!(
        hover.is_some(),
        "Expected hover on subsets target 'parentAction'"
    );
    assert!(hover.unwrap().contains("parentAction"));
}

// =============================================================================
// TRANSITION PATTERN
// =============================================================================

#[test]
fn test_hover_on_transition_target() {
    let source = r#"
package TestPkg {
    state def VehicleStates {
        entry; then initial;
        state initial;
        state running;
        transition initial then running;
    }
}
"#;

    let mut host = create_analysis(source);

    // Hover on 'initial' (source)
    let hover_initial = hover_at(&mut host, 6, 21);
    assert!(
        hover_initial.is_some(),
        "Expected hover on transition source 'initial'"
    );
    assert!(hover_initial.unwrap().contains("initial"));

    // Hover on 'running' (target)
    let hover_running = hover_at(&mut host, 6, 36);
    assert!(
        hover_running.is_some(),
        "Expected hover on transition target 'running'"
    );
    assert!(hover_running.unwrap().contains("running"));
}

// =============================================================================
// EXPRESSION VALUE PATTERN
// =============================================================================

#[test]
fn test_hover_on_expression_reference() {
    let source = r#"
package TestPkg {
    part def Calculator {
        attribute y : Real = 10;
        attribute x : Real = y + 1;
    }
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 4, 30);
    assert!(
        hover.is_some(),
        "Expected hover on expression reference 'y'"
    );
    assert!(hover.unwrap().contains("y"));
}

// =============================================================================
// MESSAGE CHAIN PATTERN
// =============================================================================

#[test]
fn test_hover_on_message_chain_second_part() {
    let source = r#"
package TestPkg {
    part def Sequence;
    part def Driver {
        action turnVehicleOn;
    }
    part def Vehicle {
        action trigger1;
    }
    part def IgnitionCmd;
    
    part sequence : Sequence {
        part driver : Driver;
        part vehicle : Vehicle;
        message of ignitionCmd:IgnitionCmd from driver.turnVehicleOn to vehicle.trigger1;
    }
}
"#;

    let mut host = create_analysis(source);

    // Hover on 'driver'
    let hover_driver = hover_at(&mut host, 14, 56);
    assert!(hover_driver.is_some(), "Expected hover on 'driver'");

    // Hover on 'turnVehicleOn'
    let hover_turn = hover_at(&mut host, 14, 63);
    assert!(
        hover_turn.is_some(),
        "Expected hover on 'turnVehicleOn' - chain member"
    );
    assert!(hover_turn.unwrap().contains("turnVehicleOn"));

    // Hover on 'trigger1'
    let hover_trigger = hover_at(&mut host, 14, 87);
    assert!(
        hover_trigger.is_some(),
        "Expected hover on 'trigger1' - chain member"
    );
    assert!(hover_trigger.unwrap().contains("trigger1"));
}

// =============================================================================
// BIND CHAIN PATTERN
// =============================================================================

#[test]
fn test_hover_on_bind_chain_second_part() {
    let source = r#"
package TestPkg {
    port def ShaftPort;
    
    part def Differential {
        port shaftPort_d : ShaftPort;
    }
    
    part def Axle {
        part differential : Differential;
        port shaftPort_d : ShaftPort;
        bind shaftPort_d = differential.shaftPort_d;
    }
}
"#;

    let mut host = create_analysis(source);

    // Hover on first 'shaftPort_d'
    let hover1 = hover_at(&mut host, 11, 17);
    assert!(hover1.is_some(), "Expected hover on first 'shaftPort_d'");

    // Hover on 'differential'
    let hover2 = hover_at(&mut host, 11, 31);
    assert!(hover2.is_some(), "Expected hover on 'differential'");

    // Hover on second 'shaftPort_d' (chain member)
    let hover3 = hover_at(&mut host, 11, 44);
    assert!(
        hover3.is_some(),
        "Expected hover on 'differential.shaftPort_d' chain member"
    );
}

// =============================================================================
// ITEM REDEFINES IN PORT DEF
// =============================================================================

#[test]
fn test_hover_on_item_redefines_in_port_def() {
    let source = r#"
package TestPkg {
    port def PwrCmdPort {
        in item pwrCmd : PwrCmd;
    }
    
    port def FuelCmdPort :> PwrCmdPort {
        in item fuelCmd : FuelCmd redefines pwrCmd;
    }
    
    item def PwrCmd;
    item def FuelCmd :> PwrCmd;
}
"#;

    let mut host = create_analysis(source);
    let hover = hover_at(&mut host, 7, 48);
    assert!(
        hover.is_some(),
        "Expected hover on redefines target 'pwrCmd'"
    );
    assert!(hover.unwrap().contains("pwrCmd"));
}

// =============================================================================
// BIND EQUALS CHAIN
// =============================================================================

#[test]
fn test_hover_on_bind_equals_chain() {
    let source = r#"
package TestPkg {
    port def ShaftPort;
    
    part def Differential {
        port shaftPort_d : ShaftPort;
    }
    
    part def Axle {
        part differential : Differential;
        port shaftPort_d : ShaftPort;
        
        bind shaftPort_d = differential.shaftPort_d;
    }
}
"#;

    let mut host = create_analysis(source);

    // Hover on first 'shaftPort_d' (bind target)
    let hover1 = hover_at(&mut host, 12, 17);
    assert!(
        hover1.is_some(),
        "Expected hover on bind target 'shaftPort_d'"
    );

    // Hover on 'differential'
    let hover2 = hover_at(&mut host, 12, 32);
    assert!(hover2.is_some(), "Expected hover on 'differential'");

    // Hover on second 'shaftPort_d' (chain member)
    let hover3 = hover_at(&mut host, 12, 47);
    assert!(
        hover3.is_some(),
        "Expected hover on chain member 'shaftPort_d'"
    );
}

// =============================================================================
// TRANSITION NAMES
// =============================================================================

#[test]
fn test_hover_on_transition_names() {
    let source = r#"
package TestPkg {
    state def VehicleStates {
        entry; do; exit;
        
        state off;
        state on;
        state initial;
        
        transition initial then off;
        transition off then on;
    }
}
"#;

    let mut host = create_analysis(source);

    // Hover on 'initial'
    let hover1 = hover_at(&mut host, 9, 21);
    assert!(
        hover1.is_some(),
        "Expected hover on transition source 'initial'"
    );
    let h1 = hover1.unwrap();
    assert!(
        h1.contains("initial"),
        "Hover should mention 'initial', got: {}",
        h1
    );

    // Hover on 'off'
    let hover2 = hover_at(&mut host, 9, 33);
    assert!(
        hover2.is_some(),
        "Expected hover on transition target 'off'"
    );
    let h2 = hover2.unwrap();
    assert!(
        h2.contains("off"),
        "Hover should mention 'off', got: {}",
        h2
    );
}