elevator-core 15.24.0

Engine-agnostic elevator simulation library with pluggable dispatch strategies
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
use crate::components::{RiderPhase, ServiceMode};
use crate::events::Event;
use crate::stop::StopId;

use super::helpers::{default_config, scan};

/// 1. Default mode is Normal -- dispatch assigns elevator, rider arrives.
#[test]
fn default_mode_is_normal() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    let elev = sim.world().elevator_ids()[0];
    assert_eq!(sim.service_mode(elev), ServiceMode::Normal);

    sim.spawn_rider(StopId(0), StopId(2), 75.0).unwrap();

    for _ in 0..1000 {
        sim.step();
    }

    assert!(sim.metrics().total_delivered() > 0);
}

/// 2. Independent mode -- elevator excluded from dispatch, rider stays Waiting.
#[test]
fn independent_skips_dispatch() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    let elev = sim.world().elevator_ids()[0];
    sim.set_service_mode(elev, ServiceMode::Independent)
        .unwrap();

    sim.spawn_rider(StopId(0), StopId(2), 75.0).unwrap();

    for _ in 0..500 {
        sim.step();
    }

    // Rider should still be waiting since the elevator is independent.
    assert!(
        sim.world()
            .iter_riders()
            .any(|(_, r)| r.phase() == RiderPhase::Waiting),
        "rider should still be waiting with Independent elevator"
    );
    assert_eq!(sim.metrics().total_delivered(), 0);
}

/// 3. Inspection mode -- reduced speed, travel time is significantly longer.
///
/// We measure movement time only (not door cycles) by switching to Inspection
/// mode after the elevator departs. The 0.25 speed factor means movement
/// takes roughly 4x longer.
#[test]
fn inspection_reduced_speed() {
    use crate::components::ElevatorPhase;

    // Helper: run a sim, spawn rider 0->2, switch to `mode` once elevator is moving,
    // return tick count when elevator arrives at stop 2.
    fn measure_travel(mode: ServiceMode) -> u64 {
        let config = default_config();
        let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
        let elev = sim.world().elevator_ids()[0];

        sim.spawn_rider(StopId(0), StopId(2), 75.0).unwrap();

        let mut mode_set = false;
        let mut depart_tick: Option<u64> = None;

        for _ in 0..10000 {
            sim.step();

            // Once the elevator starts moving, switch to the target mode.
            if !mode_set {
                let car = sim.world().elevator(elev).unwrap();
                if matches!(car.phase(), ElevatorPhase::MovingToStop(_)) {
                    sim.set_service_mode(elev, mode).unwrap();
                    mode_set = true;
                    depart_tick = Some(sim.current_tick());
                }
            }

            // Detect arrival at any stop while moving.
            if let (true, Some(depart)) = (mode_set, depart_tick) {
                let car = sim.world().elevator(elev).unwrap();
                if !matches!(car.phase(), ElevatorPhase::MovingToStop(_))
                    && sim.current_tick() > depart
                {
                    return sim.current_tick() - depart;
                }
            }
        }
        panic!("elevator never arrived in {mode} mode");
    }

    let normal_ticks = measure_travel(ServiceMode::Normal);
    let inspect_ticks = measure_travel(ServiceMode::Inspection);

    assert!(
        inspect_ticks > normal_ticks * 3,
        "inspection should be at least 3x slower: normal={normal_ticks}, inspection={inspect_ticks}"
    );
}

/// 4. Inspection mode -- doors hold open indefinitely.
///
/// Inspection is dispatch-excluded, so we open doors manually via
/// `open_door` rather than relying on dispatch.
#[test]
fn inspection_doors_hold_open() {
    use crate::entity::ElevatorId;

    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    let elev = sim.world().elevator_ids()[0];
    sim.set_service_mode(elev, ServiceMode::Inspection).unwrap();

    // Manually open doors (elevator starts at stop 0).
    sim.open_door(ElevatorId::from(elev)).unwrap();

    let mut doors_opened = false;
    for _ in 0..200 {
        sim.step();
        let car = sim.world().elevator(elev).unwrap();
        if car.door().is_open() {
            doors_opened = true;
            break;
        }
    }
    assert!(doors_opened, "doors should open at some point");

    // Now run many more ticks -- doors should stay open.
    // Normal door_open_ticks is 10, transition is 5, so 100 ticks is well past close time.
    for _ in 0..100 {
        sim.step();
    }

    let car = sim.world().elevator(elev).unwrap();
    assert!(
        car.door().is_open(),
        "doors should remain open in Inspection mode, but state is: {}",
        car.door()
    );
}

/// 5. `ServiceModeChanged` event is emitted on mode change.
#[test]
fn service_mode_changed_event() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    let elev = sim.world().elevator_ids()[0];
    sim.drain_events(); // clear init events

    sim.set_service_mode(elev, ServiceMode::Independent)
        .unwrap();

    let events = sim.drain_events();
    let mode_events: Vec<_> = events
        .iter()
        .filter(|e| matches!(e, Event::ServiceModeChanged { .. }))
        .collect();

    assert_eq!(mode_events.len(), 1);
    match &mode_events[0] {
        Event::ServiceModeChanged {
            elevator, from, to, ..
        } => {
            assert_eq!(*elevator, elev);
            assert_eq!(*from, ServiceMode::Normal);
            assert_eq!(*to, ServiceMode::Independent);
        }
        _ => panic!("expected ServiceModeChanged"),
    }
}

/// 6. No-op mode change produces no event.
#[test]
fn noop_mode_change_no_event() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    let elev = sim.world().elevator_ids()[0];
    sim.drain_events();

    // Set to Normal when already Normal.
    sim.set_service_mode(elev, ServiceMode::Normal).unwrap();

    let events = sim.drain_events();
    assert!(
        !events
            .iter()
            .any(|e| matches!(e, Event::ServiceModeChanged { .. })),
        "no event should be emitted for no-op mode change"
    );
}

/// 7. Independent mode excludes elevator from repositioning.
#[test]
fn independent_excluded_from_reposition() {
    use crate::builder::SimulationBuilder;
    use crate::dispatch::BuiltinReposition;
    use crate::dispatch::reposition::ReturnToLobby;
    use crate::stop::StopConfig;

    let mut sim = SimulationBuilder::demo()
        .stops(vec![
            StopConfig {
                id: StopId(0),
                name: "Ground".into(),
                position: 0.0,
            },
            StopConfig {
                id: StopId(1),
                name: "Floor 2".into(),
                position: 10.0,
            },
            StopConfig {
                id: StopId(2),
                name: "Floor 3".into(),
                position: 20.0,
            },
        ])
        .reposition(ReturnToLobby::new(), BuiltinReposition::ReturnToLobby)
        .build()
        .unwrap();

    let elev = sim.world().elevator_ids()[0];

    // First, get the elevator to a non-lobby stop by sending a rider.
    sim.spawn_rider(StopId(0), StopId(2), 75.0).unwrap();
    for _ in 0..1000 {
        sim.step();
    }
    assert!(sim.metrics().total_delivered() > 0);

    // Elevator should now be at or near stop 2 (or repositioning to lobby).
    // Set Independent mode.
    sim.set_service_mode(elev, ServiceMode::Independent)
        .unwrap();

    // Wait for any current movement to finish, then verify it stays put.
    // First, let current movement finish if any.
    for _ in 0..500 {
        sim.step();
    }

    let pos_before = sim.world().position(elev).unwrap().value;

    // Run more ticks -- elevator should not move since it's Independent.
    for _ in 0..500 {
        sim.step();
    }

    let pos_after = sim.world().position(elev).unwrap().value;
    let phase = sim.world().elevator(elev).unwrap().phase();

    // If the elevator is idle and independent, it should not have been repositioned.
    // It should stay at the same position.
    assert!(
        (pos_before - pos_after).abs() < 1e-9,
        "independent elevator should not be repositioned: before={pos_before}, after={pos_after}, phase={phase}"
    );
}

/// 8. Non-Normal modes skip auto-boarding even when doors are open.
///
/// An Independent car with manually opened doors at a stop with waiting
/// riders should not auto-board them — only Normal does.
#[test]
fn non_normal_modes_skip_auto_boarding() {
    use crate::entity::ElevatorId;

    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
    let elev = sim.world().elevator_ids()[0];

    sim.spawn_rider(StopId(0), StopId(2), 75.0).unwrap();

    sim.set_service_mode(elev, ServiceMode::Independent)
        .unwrap();

    // Manually open doors at stop 0 (where the rider is waiting).
    sim.open_door(ElevatorId::from(elev)).unwrap();

    for _ in 0..200 {
        sim.step();
    }

    // Rider should still be waiting — Independent mode skips auto-boarding.
    assert!(
        sim.world()
            .iter_riders()
            .any(|(_, r)| r.phase() == RiderPhase::Waiting),
        "rider should not be auto-boarded in Independent mode"
    );
    assert_eq!(
        sim.world().elevator(elev).map_or(0, |c| c.riders().len()),
        0,
        "no riders should be aboard the Independent car"
    );
}

/// 9. `OutOfService`: excluded from dispatch, no auto-boarding, but entity
///    stays visible and queries still work.
#[test]
fn out_of_service_fully_inert() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
    let elev = sim.world().elevator_ids()[0];

    sim.set_service_mode(elev, ServiceMode::OutOfService)
        .unwrap();

    // Entity is still visible (not disabled).
    assert!(!sim.is_disabled(elev));
    assert!(sim.world().elevator(elev).is_some());

    sim.spawn_rider(StopId(0), StopId(2), 75.0).unwrap();

    for _ in 0..500 {
        sim.step();
    }

    // Rider should still be waiting — OOS car doesn't serve dispatch.
    assert!(
        sim.world()
            .iter_riders()
            .any(|(_, r)| r.phase() == RiderPhase::Waiting),
        "rider should not be served by an OutOfService car"
    );
    assert_eq!(sim.metrics().total_delivered(), 0);

    // Restore normal service; rider gets delivered.
    sim.set_service_mode(elev, ServiceMode::Normal).unwrap();
    for _ in 0..2000 {
        sim.step();
    }
    assert!(sim.metrics().total_delivered() > 0);
}

/// 10. `OutOfService` during motion: in-flight trip completes.
#[test]
fn out_of_service_mid_flight_completes_trip() {
    use crate::entity::ElevatorId;

    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
    let elev = sim.world().elevator_ids()[0];

    // Send car to stop 2 via push_destination.
    sim.push_destination(ElevatorId::from(elev), StopId(2))
        .unwrap();

    // Wait until it's moving.
    for _ in 0..20 {
        sim.step();
        if sim.world().elevator(elev).unwrap().phase().is_moving() {
            break;
        }
    }
    assert!(
        sim.world().elevator(elev).unwrap().phase().is_moving(),
        "car should be in flight before switching to OutOfService"
    );

    // Switch to OutOfService mid-flight.
    sim.set_service_mode(elev, ServiceMode::OutOfService)
        .unwrap();

    // Car should still arrive at stop 2.
    let target_pos = sim
        .world()
        .stop(sim.stop_entity(StopId(2)).unwrap())
        .unwrap()
        .position();
    let mut arrived = false;
    for _ in 0..2000 {
        sim.step();
        let pos = sim.world().position(elev).unwrap().value;
        let phase = sim.world().elevator(elev).unwrap().phase();
        if (pos - target_pos).abs() < 0.01 && !phase.is_moving() {
            arrived = true;
            break;
        }
    }
    assert!(
        arrived,
        "OutOfService car should complete in-flight trip to stop 2"
    );
}

/// 11. Leaving Manual mode clears queued door commands.
#[test]
fn leaving_manual_clears_door_command_queue() {
    use crate::entity::ElevatorId;

    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
    let elev = sim.world().elevator_ids()[0];

    sim.set_service_mode(elev, ServiceMode::Manual).unwrap();

    // Queue a hold-open command while in Manual.
    sim.hold_door(ElevatorId::from(elev), 999).unwrap();

    assert!(
        !sim.world()
            .elevator(elev)
            .unwrap()
            .door_command_queue()
            .is_empty(),
        "door command queue should have a pending command"
    );

    // Switch back to Normal — queued commands should be cleared.
    sim.set_service_mode(elev, ServiceMode::Normal).unwrap();

    assert!(
        sim.world()
            .elevator(elev)
            .unwrap()
            .door_command_queue()
            .is_empty(),
        "door command queue should be cleared after leaving Manual"
    );
}