elevator-core 12.0.2

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
431
432
433
434
435
436
437
438
439
440
441
442
//! Tests for the runtime elevator upgrade setters on `Simulation`.
//!
//! Covers happy-path per field, validation errors, unknown-entity errors,
//! velocity preservation when `max_speed` changes mid-flight, door-timing
//! setters not retroactively affecting an in-progress door cycle, and
//! capacity changes applying immediately even when the car is overloaded.

use crate::components::ElevatorPhase;
use crate::dispatch::scan::ScanDispatch;
use crate::entity::ElevatorId;
use crate::error::SimError;
use crate::events::{Event, UpgradeField, UpgradeValue};
use crate::sim::Simulation;
use crate::stop::StopId;
use crate::tests::helpers::default_config;

fn make_sim() -> (Simulation, ElevatorId) {
    let config = default_config();
    let sim = Simulation::new(&config, ScanDispatch::new()).unwrap();
    let elev = ElevatorId::from(sim.world().iter_elevators().next().unwrap().0);
    (sim, elev)
}

fn count_upgrades(events: &[Event], field: UpgradeField) -> usize {
    events
        .iter()
        .filter(|e| matches!(e, Event::ElevatorUpgraded { field: f, .. } if *f == field))
        .count()
}

fn find_upgrade(events: &[Event], field: UpgradeField) -> Option<(UpgradeValue, UpgradeValue)> {
    events.iter().find_map(|e| match e {
        Event::ElevatorUpgraded {
            field: f, old, new, ..
        } if *f == field => Some((*old, *new)),
        _ => None,
    })
}

// ── Happy-path per field ─────────────────────────────────────────────

#[test]
fn set_max_speed_applies_and_emits_event() {
    let (mut sim, elev) = make_sim();
    let old = sim.world().elevator(elev.entity()).unwrap().max_speed();

    sim.set_max_speed(elev, 4.0).unwrap();

    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .max_speed()
            .value(),
        4.0
    );
    let events = sim.drain_events();
    assert_eq!(count_upgrades(&events, UpgradeField::MaxSpeed), 1);
    let (old_v, new_v) = find_upgrade(&events, UpgradeField::MaxSpeed).unwrap();
    assert_eq!(old_v, UpgradeValue::float(old.value()));
    assert_eq!(new_v, UpgradeValue::float(4.0));
}

#[test]
fn set_acceleration_applies_and_emits_event() {
    let (mut sim, elev) = make_sim();
    let old = sim.world().elevator(elev.entity()).unwrap().acceleration();
    sim.set_acceleration(elev, 3.0).unwrap();
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .acceleration()
            .value(),
        3.0
    );
    let events = sim.drain_events();
    assert_eq!(count_upgrades(&events, UpgradeField::Acceleration), 1);
    let (old_v, new_v) = find_upgrade(&events, UpgradeField::Acceleration).unwrap();
    assert_eq!(old_v, UpgradeValue::float(old.value()));
    assert_eq!(new_v, UpgradeValue::float(3.0));
}

#[test]
fn set_deceleration_applies_and_emits_event() {
    let (mut sim, elev) = make_sim();
    let old = sim.world().elevator(elev.entity()).unwrap().deceleration();
    sim.set_deceleration(elev, 3.5).unwrap();
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .deceleration()
            .value(),
        3.5
    );
    let events = sim.drain_events();
    assert_eq!(count_upgrades(&events, UpgradeField::Deceleration), 1);
    let (old_v, new_v) = find_upgrade(&events, UpgradeField::Deceleration).unwrap();
    assert_eq!(old_v, UpgradeValue::float(old.value()));
    assert_eq!(new_v, UpgradeValue::float(3.5));
}

#[test]
fn set_weight_capacity_applies_and_emits_event() {
    let (mut sim, elev) = make_sim();
    let old = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .weight_capacity();
    sim.set_weight_capacity(elev, 1200.0).unwrap();
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .weight_capacity()
            .value(),
        1200.0
    );
    let events = sim.drain_events();
    assert_eq!(count_upgrades(&events, UpgradeField::WeightCapacity), 1);
    let (old_v, new_v) = find_upgrade(&events, UpgradeField::WeightCapacity).unwrap();
    assert_eq!(old_v, UpgradeValue::float(old.value()));
    assert_eq!(new_v, UpgradeValue::float(1200.0));
}

#[test]
fn set_door_transition_ticks_applies_and_emits_event() {
    let (mut sim, elev) = make_sim();
    let old = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .door_transition_ticks();
    sim.set_door_transition_ticks(elev, 3).unwrap();
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .door_transition_ticks(),
        3
    );
    let events = sim.drain_events();
    assert_eq!(
        count_upgrades(&events, UpgradeField::DoorTransitionTicks),
        1
    );
    let (old_v, new_v) = find_upgrade(&events, UpgradeField::DoorTransitionTicks).unwrap();
    assert_eq!(old_v, UpgradeValue::ticks(old));
    assert_eq!(new_v, UpgradeValue::ticks(3));
}

#[test]
fn set_door_open_ticks_applies_and_emits_event() {
    let (mut sim, elev) = make_sim();
    let old = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .door_open_ticks();
    sim.set_door_open_ticks(elev, 20).unwrap();
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .door_open_ticks(),
        20
    );
    let events = sim.drain_events();
    assert_eq!(count_upgrades(&events, UpgradeField::DoorOpenTicks), 1);
    let (old_v, new_v) = find_upgrade(&events, UpgradeField::DoorOpenTicks).unwrap();
    assert_eq!(old_v, UpgradeValue::ticks(old));
    assert_eq!(new_v, UpgradeValue::ticks(20));
}

// ── Validation errors ────────────────────────────────────────────────

#[test]
fn set_max_speed_rejects_non_positive() {
    let (mut sim, elev) = make_sim();
    let before = sim.world().elevator(elev.entity()).unwrap().max_speed();
    let err = sim.set_max_speed(elev, -1.0).unwrap_err();
    assert!(matches!(err, SimError::InvalidConfig { .. }));
    assert_eq!(
        sim.world().elevator(elev.entity()).unwrap().max_speed(),
        before
    );
}

#[test]
fn set_acceleration_rejects_zero() {
    let (mut sim, elev) = make_sim();
    let before = sim.world().elevator(elev.entity()).unwrap().acceleration();
    let err = sim.set_acceleration(elev, 0.0).unwrap_err();
    assert!(matches!(err, SimError::InvalidConfig { .. }));
    assert_eq!(
        sim.world().elevator(elev.entity()).unwrap().acceleration(),
        before
    );
}

#[test]
fn set_weight_capacity_rejects_nan() {
    let (mut sim, elev) = make_sim();
    let before = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .weight_capacity();
    let err = sim.set_weight_capacity(elev, f64::NAN).unwrap_err();
    assert!(matches!(err, SimError::InvalidConfig { .. }));
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .weight_capacity(),
        before
    );
}

#[test]
fn set_deceleration_rejects_infinite() {
    let (mut sim, elev) = make_sim();
    let before = sim.world().elevator(elev.entity()).unwrap().deceleration();
    let err = sim.set_deceleration(elev, f64::INFINITY).unwrap_err();
    assert!(matches!(err, SimError::InvalidConfig { .. }));
    assert_eq!(
        sim.world().elevator(elev.entity()).unwrap().deceleration(),
        before
    );
}

#[test]
fn set_door_transition_ticks_rejects_zero() {
    let (mut sim, elev) = make_sim();
    let before = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .door_transition_ticks();
    let err = sim.set_door_transition_ticks(elev, 0).unwrap_err();
    assert!(matches!(err, SimError::InvalidConfig { .. }));
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .door_transition_ticks(),
        before
    );
}

#[test]
fn set_door_open_ticks_rejects_zero() {
    let (mut sim, elev) = make_sim();
    let before = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .door_open_ticks();
    let err = sim.set_door_open_ticks(elev, 0).unwrap_err();
    assert!(matches!(err, SimError::InvalidConfig { .. }));
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .door_open_ticks(),
        before
    );
}

// ── Unknown elevator ─────────────────────────────────────────────────

#[test]
fn set_on_non_elevator_returns_invalid_state() {
    let (mut sim, _elev) = make_sim();
    // Spawning a rider produces an EntityId that is not an elevator.
    let rider = sim.spawn_rider(StopId(0), StopId(1), 70.0).unwrap();
    let err = sim
        .set_max_speed(ElevatorId::from(rider.entity()), 4.0)
        .unwrap_err();
    assert!(matches!(err, SimError::NotAnElevator(_)));
}

// ── Velocity preservation ────────────────────────────────────────────

/// When `max_speed` is raised mid-flight the current velocity is preserved
/// and the car is free to accelerate up to the new (higher) cap on
/// subsequent ticks.
#[test]
fn raising_max_speed_preserves_current_velocity() {
    let (mut sim, elev) = make_sim();
    // Dispatch far away so the car cruises.
    sim.push_destination(elev, sim.stop_entity(StopId(2)).unwrap())
        .unwrap();
    for _ in 0..30 {
        sim.step();
    }
    let vel_before = sim.world().velocity(elev.entity()).unwrap().value;
    assert!(
        vel_before > 0.0,
        "car should be moving; got velocity {vel_before}"
    );

    sim.set_max_speed(elev, 10.0).unwrap();
    sim.step();
    let vel_after = sim.world().velocity(elev.entity()).unwrap().value;
    // Velocity should be >= prior velocity (either unchanged or accelerated).
    assert!(
        vel_after >= vel_before - 1e-6,
        "expected preserved-or-increased velocity after raising cap: \
         before={vel_before} after={vel_after}"
    );
}

/// When `max_speed` is lowered below the current velocity the movement
/// integrator clamps velocity to the new cap on the next tick (see
/// `tick_movement`'s cruise branch). Velocity is otherwise not
/// instantaneously zeroed — the car simply stops accelerating and cruises
/// at the new cap.
#[test]
fn lowering_max_speed_clamps_velocity_on_next_tick() {
    let (mut sim, elev) = make_sim();
    sim.push_destination(elev, sim.stop_entity(StopId(2)).unwrap())
        .unwrap();
    for _ in 0..30 {
        sim.step();
    }
    let vel_before = sim.world().velocity(elev.entity()).unwrap().value;
    assert!(vel_before > 0.5, "car should be cruising: v={vel_before}");

    // Pick a cap well below current cruising velocity.
    let new_cap = vel_before * 0.5;
    sim.set_max_speed(elev, new_cap).unwrap();
    sim.step();

    let vel_after = sim.world().velocity(elev.entity()).unwrap().value;
    assert!(
        vel_after <= new_cap + 1e-6,
        "expected velocity to be clamped at or below new cap {new_cap}, got {vel_after}"
    );
}

// ── Door timing ──────────────────────────────────────────────────────

/// Setting `door_open_ticks` while doors are already open must not
/// retroactively retime the current open period. The new value only
/// applies to the next door cycle.
#[test]
fn door_open_ticks_change_does_not_affect_in_progress_cycle() {
    let (mut sim, elev) = make_sim();
    sim.push_destination(elev, sim.stop_entity(StopId(1)).unwrap())
        .unwrap();

    // Tick until the doors are fully open (phase Loading).
    let mut reached_loading = false;
    for _ in 0..500 {
        sim.step();
        if sim.world().elevator(elev.entity()).unwrap().phase() == ElevatorPhase::Loading {
            reached_loading = true;
            break;
        }
    }
    assert!(reached_loading, "elevator should reach Loading phase");

    // Snapshot the current in-progress door state.
    let door_before = *sim.world().elevator(elev.entity()).unwrap().door();

    // Change the open-ticks config. This must NOT mutate the current
    // in-progress DoorState — only the next cycle picks it up.
    sim.set_door_open_ticks(elev, 99).unwrap();

    let door_after = *sim.world().elevator(elev.entity()).unwrap().door();
    assert_eq!(
        door_before, door_after,
        "in-progress door FSM must not change when door_open_ticks setter is called"
    );
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .door_open_ticks(),
        99
    );
}

// ── Capacity below current_load ──────────────────────────────────────

/// Lowering `weight_capacity` below `current_load` applies immediately
/// (the car is temporarily overweight) and no new rider can board that
/// would push the load further over the new cap.
#[test]
fn weight_capacity_below_current_load_still_applies() {
    let (mut sim, elev) = make_sim();
    // Get a rider boarded.
    let rider = sim.spawn_rider(StopId(0), StopId(2), 200.0).unwrap();
    let mut boarded = false;
    for _ in 0..500 {
        sim.step();
        if matches!(
            sim.world().rider(rider.entity()).unwrap().phase,
            crate::components::RiderPhase::Riding(_)
                | crate::components::RiderPhase::Exiting(_)
                | crate::components::RiderPhase::Arrived
        ) {
            boarded = true;
            break;
        }
    }
    assert!(boarded, "rider should board within 500 ticks");
    let load = sim
        .world()
        .elevator(elev.entity())
        .unwrap()
        .current_load()
        .value();
    assert!(load > 0.0, "current_load should be non-zero after boarding");

    // Force capacity below current load.
    let new_cap = load / 2.0;
    sim.set_weight_capacity(elev, new_cap).unwrap();
    assert_eq!(
        sim.world()
            .elevator(elev.entity())
            .unwrap()
            .weight_capacity()
            .value(),
        new_cap
    );
    // current_load is unchanged — no riders ejected.
    assert!(
        (sim.world()
            .elevator(elev.entity())
            .unwrap()
            .current_load()
            .value()
            - load)
            .abs()
            < 1e-9,
        "current_load must not change when capacity is lowered"
    );
}