simcore 0.1.0

A generic discrete-event simulation framework
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

use serde::Serialize;

use simcore::{async_mode::EventKey, Simulation, SimulationContext};

#[derive(Clone, Serialize)]
struct EventWithKey {
    key: EventKey,
}

#[derive(Clone, Serialize)]
struct AnotherEventWithKey {
    key: EventKey,
}

fn make_simulation() -> (Simulation, SimulationContext, SimulationContext, SimulationContext) {
    let mut sim = Simulation::new(123);
    let ctx1 = sim.create_context("ctx1");
    let ctx2 = sim.create_context("ctx2");
    let ctx3 = sim.create_context("ctx3");
    sim.register_key_getter_for::<EventWithKey>(|e| e.key);
    sim.register_key_getter_for::<AnotherEventWithKey>(|e| e.key);

    (sim, ctx1, ctx2, ctx3)
}

#[test]
fn test_ok_different_keys() {
    let (mut sim, ctx1, ctx2, ctx3) = make_simulation();

    ctx2.emit(EventWithKey { key: 1 }, ctx1.id(), 1.);
    ctx3.emit(EventWithKey { key: 2 }, ctx1.id(), 2.);

    sim.spawn(async move {
        futures::join!(
            async {
                let e = ctx1.recv_event_by_key::<EventWithKey>(1).await;
                assert_eq!(ctx1.time(), 1.);
                assert_eq!(e.src, ctx2.id());
            },
            async {
                let e = ctx1.recv_event_by_key::<EventWithKey>(2).await;
                assert_eq!(ctx1.time(), 2.);
                assert_eq!(e.src, ctx3.id());
            }
        );
    });

    sim.step_until_no_events();
    assert_eq!(sim.event_count(), 2);
    assert_eq!(sim.time(), 2.);
}

#[test]
fn test_ok_with_different_sources() {
    let (mut sim, ctx1, ctx2, ctx3) = make_simulation();

    ctx2.emit(EventWithKey { key: 1 }, ctx1.id(), 1.);
    ctx3.emit(EventWithKey { key: 1 }, ctx1.id(), 2.);

    sim.spawn(async move {
        futures::join!(
            async {
                let e = ctx1.recv_event_by_key_from::<EventWithKey>(ctx2.id(), 1).await;
                assert_eq!(ctx1.time(), 1.);
                assert_eq!(e.src, ctx2.id());
            },
            async {
                let e = ctx1.recv_event_by_key_from::<EventWithKey>(ctx3.id(), 1).await;
                assert_eq!(ctx1.time(), 2.);
                assert_eq!(e.src, ctx3.id());
            }
        );
    });

    sim.step_until_no_events();
    assert_eq!(sim.event_count(), 2);
    assert_eq!(sim.time(), 2.);
}

#[test]
#[should_panic(expected = "Failed to create EventFuture")]
fn test_panic_with_different_sources() {
    let (mut sim, ctx1, ctx2, ctx3) = make_simulation();

    ctx2.emit(EventWithKey { key: 1 }, ctx1.id(), 1.);
    ctx3.emit(EventWithKey { key: 1 }, ctx1.id(), 2.);

    sim.spawn(async move {
        futures::join!(
            async {
                let e = ctx1.recv_event_by_key::<EventWithKey>(1).await;
                assert_eq!(ctx1.time(), 1.);
                assert_eq!(e.src, ctx2.id());
            },
            async {
                let e = ctx1.recv_event_by_key::<EventWithKey>(1).await;
                assert_eq!(ctx1.time(), 2.);
                assert_eq!(e.src, ctx3.id());
            }
        );
    });

    sim.step_until_no_events();
    assert_eq!(sim.event_count(), 2);
    assert_eq!(sim.time(), 2.);
}

fn test_panic_with_and_without_sources(first_wait_time: f64, second_wait_time: f64) {
    let (mut sim, ctx1, ctx2, ctx3) = make_simulation();

    ctx2.emit(EventWithKey { key: 1 }, ctx1.id(), 100.);
    ctx3.emit(EventWithKey { key: 1 }, ctx1.id(), 200.);

    sim.spawn(async move {
        futures::join!(
            async {
                ctx1.sleep(first_wait_time).await;
                let e = ctx1.recv_event_by_key_from::<EventWithKey>(ctx2.id(), 1).await;
                assert_eq!(ctx1.time(), 100.);
                assert_eq!(e.src, ctx2.id());
            },
            async {
                ctx1.sleep(second_wait_time).await;
                let e = ctx1.recv_event_by_key::<EventWithKey>(1).await;
                assert_eq!(ctx1.time(), 200.);
                assert_eq!(e.src, ctx3.id());
            }
        );
    });

    sim.step_until_no_events();
    assert_eq!(sim.event_count(), 2);
    assert_eq!(sim.time(), 2.);
}

#[test]
#[should_panic(expected = "Failed to create EventFuture")]
fn test_panic_with_and_without_sources_1() {
    test_panic_with_and_without_sources(10., 20.);
}

#[test]
#[should_panic(expected = "Failed to create EventFuture")]
fn test_panic_with_and_without_sources_2() {
    test_panic_with_and_without_sources(20., 10.);
}

#[test]
fn test_ok_with_different_events() {
    let (mut sim, ctx1, ctx2, ctx3) = make_simulation();

    ctx2.emit(EventWithKey { key: 1 }, ctx1.id(), 1.);
    ctx3.emit(AnotherEventWithKey { key: 1 }, ctx1.id(), 2.);

    sim.spawn(async move {
        futures::join!(
            async {
                let e = ctx1.recv_event_by_key::<EventWithKey>(1).await;
                assert_eq!(ctx1.time(), 1.);
                assert_eq!(e.src, ctx2.id());
            },
            async {
                let e = ctx1.recv_event_by_key::<AnotherEventWithKey>(1).await;
                assert_eq!(ctx1.time(), 2.);
                assert_eq!(e.src, ctx3.id());
            }
        );
    });

    sim.step_until_no_events();
    assert_eq!(sim.event_count(), 2);
    assert_eq!(sim.time(), 2.);
}