sim-lib-topology 0.1.1

Data-driven topology engine.
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

use sim_kernel::{Error, Expr, Symbol};

use super::test_cx;
use crate::{
    InstrumentTopologyAdapter, InstrumentTopologyCord, InstrumentTopologyJack,
    InstrumentTopologyModule, InstrumentTopologySpec, PortRef, validate::validate_graph,
};

#[test]
fn instrument_adapter_maps_modules_cords_and_normalled_defaults() {
    let adapter = InstrumentTopologyAdapter;
    let spec = identity_spec()
        .with_module(
            InstrumentTopologyModule::new("gain", Symbol::new("gain"))
                .with_input(InstrumentTopologyJack::value("in", true))
                .with_input(
                    InstrumentTopologyJack::value("bias", true)
                        .with_normalled_default(Expr::String("unity".to_owned())),
                )
                .with_output(InstrumentTopologyJack::value("out", true))
                .with_setting(Symbol::new("gain"), Expr::String("0.5".to_owned()))
                .with_raw(Symbol::new("raw-gain"), Expr::String("64".to_owned())),
        )
        .with_cord(InstrumentTopologyCord::new(
            PortRef::output("in"),
            PortRef::input("gain"),
        ))
        .with_cord(InstrumentTopologyCord::new(
            PortRef::output("gain"),
            PortRef::input("out"),
        ));
    let graph = adapter.graph_from_spec(&spec);

    validate_graph(&mut test_cx(), &graph).expect("normalled graph is valid");
    let gain = graph
        .nodes
        .iter()
        .find(|node| node.id.as_symbol() == &Symbol::new("gain"))
        .expect("gain node");
    assert!(
        gain.inputs
            .iter()
            .any(|port| port.name == Symbol::new("bias") && !port.required)
    );
    assert!(
        gain.options
            .iter()
            .any(|(key, _)| key.name.as_ref() == "settings")
    );
    assert!(
        gain.options
            .iter()
            .any(|(key, _)| key.name.as_ref() == "normalled-defaults")
    );
}

#[test]
fn instrument_adapter_rejects_invalid_cord_endpoint_node() {
    let adapter = InstrumentTopologyAdapter;
    let graph = adapter.graph_from_spec(&identity_spec().with_cord(InstrumentTopologyCord::new(
        PortRef::output("missing"),
        PortRef::input("out"),
    )));

    assert_validate_error(&graph, &["unknown output endpoint node missing"]);
}

#[test]
fn instrument_adapter_rejects_missing_port() {
    let adapter = InstrumentTopologyAdapter;
    let graph = adapter.graph_from_spec(
        &identity_spec()
            .with_module(
                InstrumentTopologyModule::new("amp", Symbol::new("amp"))
                    .with_input(InstrumentTopologyJack::value("audio", true))
                    .with_output(InstrumentTopologyJack::value("out", true)),
            )
            .with_cord(InstrumentTopologyCord::new(
                PortRef::output("in"),
                PortRef::new("amp", Symbol::new("missing")),
            )),
    );

    assert_validate_error(&graph, &["unknown input endpoint port amp:missing"]);
}

#[test]
fn instrument_adapter_rejects_unbounded_cycle() {
    let adapter = InstrumentTopologyAdapter;
    let graph = adapter.graph_from_spec(
        &identity_spec()
            .with_module(module("a"))
            .with_module(module("b"))
            .with_cord(InstrumentTopologyCord::new(
                PortRef::output("in"),
                PortRef::input("a"),
            ))
            .with_cord(InstrumentTopologyCord::new(
                PortRef::output("a"),
                PortRef::input("b"),
            ))
            .with_cord(InstrumentTopologyCord::new(
                PortRef::output("b"),
                PortRef::input("a"),
            ))
            .with_cord(InstrumentTopologyCord::new(
                PortRef::output("b"),
                PortRef::input("out"),
            )),
    );

    assert_validate_error(&graph, &["unbounded cycle", "a -> b -> a"]);
}

fn identity_spec() -> InstrumentTopologySpec {
    InstrumentTopologySpec::new(Symbol::new("instrument-test"))
        .with_module(
            InstrumentTopologyModule::new("in", Symbol::new("in"))
                .with_output(InstrumentTopologyJack::value("out", true)),
        )
        .with_module(
            InstrumentTopologyModule::new("out", Symbol::new("out"))
                .with_input(InstrumentTopologyJack::value("in", true)),
        )
}

fn module(name: &str) -> InstrumentTopologyModule {
    InstrumentTopologyModule::new(name, Symbol::new("module"))
        .with_input(InstrumentTopologyJack::value("in", true))
        .with_output(InstrumentTopologyJack::value("out", true))
}

fn assert_validate_error(graph: &crate::Graph, fragments: &[&str]) {
    let error = validate_graph(&mut test_cx(), graph).expect_err("validation should fail");
    let Error::Eval(message) = error else {
        panic!("unexpected validation error type: {error}");
    };
    for fragment in fragments {
        assert!(
            message.contains(fragment),
            "validation error {message:?} did not contain {fragment:?}"
        );
    }
}