fmi-rs 0.3.1

Functional Mock-up Interface (FMI) for Rust
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

#![allow(
    clippy::arc_with_non_send_sync,
    clippy::arithmetic_side_effects,
    clippy::expect_used,
    clippy::indexing_slicing,
    clippy::panic,
    clippy::redundant_field_names,
    clippy::unwrap_used
)]

use fmi_rs::model_description::ValidationError;
use fmi_rs::model_description::fmi3::ModelDescription;
use fmi_rs::model_description::validation::validate_structured_variable_name;

fn validate_model_description(xml: &str) -> Vec<ValidationError> {
    ModelDescription::from_string(xml)
        .expect("parse model description")
        .validate()
}

fn initial_unknowns_error(problems: &[ValidationError]) -> bool {
    problems.iter().any(|p| p.message.contains("initial unknowns"))
}

const CLOCK_TEST_BASE: &str = r#"<?xml version="1.0" encoding="UTF-8"?>
<fmiModelDescription fmiVersion="3.0" modelName="ClockTest" instantiationToken="">
  <CoSimulation modelIdentifier="ClockTest" hasEventMode="true"/>
  <ModelVariables>
    <Float64 name="time" valueReference="0" causality="independent" variability="continuous"/>
    <Clock name="inClock" valueReference="1" causality="input" intervalVariability="triggered"/>
    <Clock name="alarm" valueReference="2" causality="output" intervalVariability="triggered"/>
    <Float64 name="y" valueReference="3" causality="output" variability="discrete"/>
  </ModelVariables>
  <ModelStructure>
    <Output valueReference="2"/>
    <Output valueReference="3"/>
    {initial_unknowns}
  </ModelStructure>
</fmiModelDescription>"#;

#[test]
fn output_clock_not_required_in_initial_unknowns() {
    let xml = CLOCK_TEST_BASE.replace("{initial_unknowns}", r#"<InitialUnknown valueReference="3"/>"#);
    assert!(!initial_unknowns_error(&validate_model_description(&xml)));
}

#[test]
fn output_clock_must_not_be_listed_in_initial_unknowns() {
    let xml = CLOCK_TEST_BASE.replace(
        "{initial_unknowns}",
        r#"<InitialUnknown valueReference="2"/><InitialUnknown valueReference="3"/>"#,
    );
    assert!(initial_unknowns_error(&validate_model_description(&xml)));
}

#[test]
fn clocked_output_may_be_listed_in_initial_unknowns() {
    let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<fmiModelDescription fmiVersion="3.0" modelName="ClockTest" instantiationToken="">
  <CoSimulation modelIdentifier="ClockTest" hasEventMode="true"/>
  <ModelVariables>
    <Float64 name="time" valueReference="0" causality="independent" variability="continuous"/>
    <Clock name="inClock" valueReference="1" causality="input" intervalVariability="triggered"/>
    <Int32 name="z" valueReference="4" causality="output" variability="discrete" clocks="1"/>
    <Float64 name="y" valueReference="3" causality="output" variability="discrete"/>
  </ModelVariables>
  <ModelStructure>
    <Output valueReference="3"/>
    <Output valueReference="4"/>
    <InitialUnknown valueReference="3"/>
    <InitialUnknown valueReference="4"/>
  </ModelStructure>
</fmiModelDescription>"#;
    assert!(!initial_unknowns_error(&validate_model_description(xml)));
}

#[test]
fn test_structured_variable_name_validation() {
    let valid_names = vec![
        "_",
        "der(x)",
        "a.b.c",
        "v[1]",
        "v[1,2]",
        "'quoted.name'",
        "der('quoted name'[1])",
        "der(a[1].b[2,3].c)",
    ];

    for name in valid_names {
        assert_eq!(validate_structured_variable_name(name), Ok(()));
    }

    let invalid_names = vec![
        (
            "1x",
            "syntax error, unexpected UNSIGNED_INTEGER, expecting DER or NONDIGIT or Q_NAME",
        ),
        (
            "a..b",
            "syntax error, unexpected '.', expecting NONDIGIT or Q_NAME",
        ),
        (
            "a[1",
            "syntax error, unexpected end of file, expecting ',' or ']'",
        ),
        (
            "a[1,2",
            "syntax error, unexpected end of file, expecting ',' or ']'",
        ),
        (
            "a[1]b",
            "syntax error, unexpected NONDIGIT, expecting end of file",
        ),
        (
            "der(a[1].b[2].c",
            "syntax error, unexpected end of file, expecting ')' or ',' or '.'",
        ),
    ];

    for (name, expected_error) in invalid_names {
        assert_eq!(
            validate_structured_variable_name(name),
            Err(expected_error.to_string())
        );
    }
}