korri-n2k 0.7.1

no_std-first NMEA 2000 protocol stack for embedded and Linux systems
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
use crate::protocol::{
    constants::{addr_mgmt_pgns::COMMAND_ADDR_65240, address::CLAIMABLE_COUNT},
    transport::can_id::CanIdBuilder,
};

use super::*;

const ADDR_1: u8 = 1;
const ADDR_2: u8 = 2;
const ADDR_3: u8 = 144;
const ADDR_4: u8 = 244;
const STARTING_TIME: u64 = 123456789;

//==================================================================================OUTPUT_HELPERS
// Local, deliberately not a public builder: a test spells out all three axes so
// the derivation the engine performs in `output()` is asserted, not assumed.

/// A claim campaign step: a frame goes out and the arbitration window is open.
fn claiming(tx: CanFrame, address: u8, deadline_ms: u64) -> ClaimOutput {
    ClaimOutput {
        tx: Some(tx),
        status: ClaimStatus::Claiming(address),
        wake_at_ms: Some(deadline_ms),
    }
}

/// Waiting out the arbitration window with nothing to emit.
fn waiting_claim(address: u8, deadline_ms: u64) -> ClaimOutput {
    ClaimOutput {
        tx: None,
        status: ClaimStatus::Claiming(address),
        wake_at_ms: Some(deadline_ms),
    }
}

/// The address is held and the bus is quiet.
fn claimed(address: u8) -> ClaimOutput {
    ClaimOutput {
        tx: None,
        status: ClaimStatus::Claimed(address),
        wake_at_ms: None,
    }
}

/// The address is held and a frame is owed to the bus in the same step.
fn defending(tx: CanFrame, address: u8) -> ClaimOutput {
    ClaimOutput {
        tx: Some(tx),
        status: ClaimStatus::Claimed(address),
        wake_at_ms: None,
    }
}

/// No address left; `retry_at_ms` carries the next campaign.
fn cannot_claim(tx: Option<CanFrame>, retry_at_ms: u64) -> ClaimOutput {
    ClaimOutput {
        tx,
        status: ClaimStatus::CannotClaim,
        wake_at_ms: Some(retry_at_ms),
    }
}

struct TestEngine<'a>(AddressClaimEngine<'a>);

impl TestEngine<'_> {
    fn poll(&mut self, now_ms: u64, rx: Option<&CanFrame>) -> ClaimOutput {
        let output = self.0.poll(now_ms, rx);
        if output.tx.is_none() {
            return output;
        }
        let sent = self.0.tx_sent(now_ms);
        ClaimOutput {
            tx: output.tx,
            ..sent
        }
    }
}

impl<'a> core::ops::Deref for TestEngine<'a> {
    type Target = AddressClaimEngine<'a>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl core::ops::DerefMut for TestEngine<'_> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

//==================================================================================FIXTURES

struct ClockTest {
    ms: u64,
}

impl ClockTest {
    fn new(start_value: u64) -> Self {
        Self { ms: start_value }
    }

    fn tick(&mut self, d: u64) -> u64 {
        self.ms += d;
        self.ms
    }
}

#[derive(Clone, Copy)]
struct Name(IsoName);

impl Default for Name {
    fn default() -> Self {
        Self(IsoName::from_raw(0x1234567890ABCDEF))
    }
}

impl Name {
    fn from_raw(raw: u64) -> Self {
        Self(IsoName::from_raw(raw))
    }
}

impl Name {
    fn new(strategy: AddressClaimStrategy) -> Self {
        let name = Name::default();
        match strategy {
            AddressClaimStrategy::Fixed { preferred: _ } => name,
            AddressClaimStrategy::SelfConfigurable { addresses: _ } => name,
            AddressClaimStrategy::Arbitrary { preferred: _ } => {
                let r_name = name.0.raw() | 1u64 << 63;
                assert_eq!(r_name, 0x9234567890ABCDEF);
                Name::from_raw(r_name)
            }
        }
    }

    fn conflict_priority_builder(mut self, name_priority: ConflictPriority) -> Self {
        match name_priority {
            ConflictPriority::BuiltToWin => self.0 = IsoName::from_raw(self.0.raw() & !0xFFFF),
            ConflictPriority::Normal => {}
            ConflictPriority::BuiltToLose => self.0 = IsoName::from_raw(self.0.raw() | 0xFFFF),
        }
        self
    }
}

/// Builds an ISO Request frame, `len` and `requested_pgn` left open to forge invalid ones.
fn build_request_frame(destination: u8, requested_pgn: u32, len: usize) -> CanFrame {
    let mut data = [0xFFu8; 8];
    data[0..REQUEST_PGN_LEN].copy_from_slice(&requested_pgn.to_le_bytes()[0..REQUEST_PGN_LEN]);

    CanFrame {
        id: CanIdBuilder::new(REQUEST_PGN_59904, ADDR_4)
            .to_destination(destination)
            .with_priority(6)
            .build()
            .expect("must be valid"),
        data,
        len,
    }
}

struct Instance<'a> {
    name: Name,
    preferred_addr: u8,
    can_frame_origin: CanFrame,
    can_frame_next: Option<CanFrame>,
    claimer: TestEngine<'a>,
}

enum CanFrameClass {
    Claiming,
    Normal,
}

enum ConflictPriority {
    BuiltToWin,
    Normal,
    BuiltToLose,
}

impl<'a> Instance<'a> {
    fn new(
        strategy: AddressClaimStrategy<'a>,
        can_frame_class: CanFrameClass,
        conflict_design: ConflictPriority,
    ) -> Self {
        let name = Name::new(strategy).conflict_priority_builder(conflict_design);
        let preferred_addr: u8 = match strategy {
            AddressClaimStrategy::Fixed { preferred } => preferred,
            AddressClaimStrategy::SelfConfigurable { addresses } => addresses[0],
            AddressClaimStrategy::Arbitrary { preferred } => preferred,
        };

        let can_frame: CanFrame = match can_frame_class {
            CanFrameClass::Claiming => build_address_claim_frame(name.0, preferred_addr),
            CanFrameClass::Normal => {
                let id = CanIdBuilder::new(129044, preferred_addr)
                    .build()
                    .expect("must be valid");
                CanFrame {
                    id,
                    data: [1u8; 8],
                    len: 8,
                }
            }
        };

        let claimer = TestEngine(
            AddressClaimEngine::new(name.0, strategy)
                .expect("Instance::new() // Claimer must be valid"),
        );

        Self {
            name,
            preferred_addr,
            can_frame_origin: can_frame,
            can_frame_next: None,
            claimer,
        }
    }
}

//==================================================================================CAMPAIGN

#[test]
fn test_addr_claim_machine_aac_without_rx() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let mut timer = ClockTest::new(STARTING_TIME);

    assert_eq!(my_inst.claimer.state, State::Unclaimed);

    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    timer.tick(10);

    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        waiting_claim(my_preferred, deadline_ms)
    );

    timer.tick(240);

    assert_eq!(my_inst.claimer.poll(timer.ms, None), claimed(my_preferred));
}

#[test]
fn test_claim_timer_starts_after_send() {
    let strategy = AddressClaimStrategy::Arbitrary { preferred: ADDR_1 };
    let mut instance = Instance::new(strategy, CanFrameClass::Claiming, ConflictPriority::Normal);
    let mut timer = ClockTest::new(STARTING_TIME);

    let output = instance.claimer.0.poll(timer.ms, None);
    assert_eq!(output.wake_at_ms, None);
    assert!(output.tx.is_some());

    timer.tick(300);
    let output = instance.claimer.0.poll(timer.ms, None);
    assert_eq!(output.wake_at_ms, None);
    assert!(output.tx.is_some());

    let deadline_ms = timer.ms + CLAIM_DELAY_MS as u64;
    assert_eq!(
        instance.claimer.tx_sent(timer.ms),
        waiting_claim(ADDR_1, deadline_ms)
    );

    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(instance.claimer.0.poll(timer.ms, None), claimed(ADDR_1));
}

#[test]
fn test_addr_claim_machine_with_claiming_rx_different_sa() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_preferred = ADDR_2;
    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: their_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert!(their_inst.name.0 < my_inst.name.0); // If it's a conflict situation, their_inst must win.
    assert!(their_inst.preferred_addr != my_inst.preferred_addr); // not the same addr
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state
    assert!(timer.ms == STARTING_TIME);

    // Start
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    timer.tick(10);
    // Despite the rx with lower name, there is no conflict due to the different preferred_addr.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        waiting_claim(my_preferred, deadline_ms)
    );

    timer.tick(240);
    // Claiming's done. Targeted address has been obtained.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claimed(my_preferred)
    );
}

#[test]
fn test_addr_claim_machine_aac_with_conflict_we_win() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_preferred = ADDR_1;
    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: their_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToLose,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    assert!(their_inst.can_frame_origin.id.pgn() == 60928); // claiming pgn
    assert!(their_inst.name.0 > my_inst.name.0); // we win
    assert!(their_inst.preferred_addr == my_inst.preferred_addr); // conflict
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state
    assert!(timer.ms == STARTING_TIME);

    // Round started
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_origin,
            deadline_ms
        }
    );

    timer.tick(10);
    assert!(timer.ms == STARTING_TIME + 10);

    // Conflict -> same preferred_addr
    // * my_inst must win and resend her claiming_frame without resetting her deadline.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    // Claiming frame is resent after a won conflict
    // * remaining 240 ms deadline.
    // * my_inst.claimer.state must be State::Claiming.
    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_origin,
            deadline_ms: 240 + timer.ms
        }
    );

    timer.tick(99);

    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_origin,
            deadline_ms: 141 + timer.ms
        }
    );

    timer.tick(240);

    // Claiming's done. Targeted address has been obtained.
    // `None` and not `their_rx`: the driver clears `rx` once consumed, so a
    // frame is never handed to `poll` twice.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claimed(my_inst.preferred_addr)
    );
}

#[test]
fn test_addr_claim_machine_aac_with_conflict_we_lose_and_no_addr_available() {
    let my_strategy = AddressClaimStrategy::Arbitrary { preferred: ADDR_3 };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_strategy = AddressClaimStrategy::Arbitrary { preferred: ADDR_3 };
    let mut their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );

    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert!(their_inst.name.0 < my_inst.name.0); // we lose
    assert!(their_inst.preferred_addr == my_inst.preferred_addr); // conflict
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state
    assert!(timer.ms == STARTING_TIME);

    // Start
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_inst.preferred_addr,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );

    timer.tick(1);
    let deadline_ms = timer.ms + CLAIM_DELAY_MS as u64;

    let expected_next_addr = my_inst.preferred_addr + 1;
    let expected_canframe = build_address_claim_frame(my_inst.name.0, expected_next_addr);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claiming(expected_canframe, expected_next_addr, deadline_ms)
    );

    // count of tested addr
    let mut tested_addr: u16 = 1;

    while tested_addr < CLAIMABLE_COUNT as u16 {
        their_inst.can_frame_next = Some(build_address_claim_frame(
            their_inst.name.0,
            ((my_inst.preferred_addr as u16 + tested_addr) % CLAIMABLE_COUNT as u16) as u8,
        ));

        // this is the last addr available, next will return None.
        if tested_addr == 251 {
            let expected_canframe =
                build_address_claim_frame(my_inst.name.0, address::NULL_ADDR_254);
            assert_eq!(
                my_inst
                    .claimer
                    .poll(timer.ms, their_inst.can_frame_next.as_ref(),),
                cannot_claim(
                    Some(expected_canframe),
                    timer.ms + CANNOT_CLAIM_RETRY_DELAY_MS as u64
                )
            );

            break;
        }

        let expected_next_addr: u16 =
            (my_inst.preferred_addr as u16 + tested_addr + 1) % CLAIMABLE_COUNT as u16;

        assert!(expected_next_addr < CLAIMABLE_COUNT as u16);

        let expected_canframe = build_address_claim_frame(my_inst.name.0, expected_next_addr as u8);

        assert_eq!(
            my_inst
                .claimer
                .poll(timer.ms, their_inst.can_frame_next.as_ref(),),
            claiming(expected_canframe, expected_next_addr as u8, deadline_ms)
        );

        tested_addr += 1;
    }
}

#[test]
fn test_addr_claim_machine_aac_with_conflict_we_lose() {
    let my_preferred = ADDR_3;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_preferred = ADDR_3;
    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: their_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert!(their_inst.name.0 < my_inst.name.0); // we lose
    assert!(their_inst.preferred_addr == my_inst.preferred_addr); // conflict
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state
    assert!(timer.ms == STARTING_TIME);

    // Start
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );

    timer.tick(10);
    my_inst.can_frame_next = Some(build_address_claim_frame(
        my_inst.name.0,
        my_inst.preferred_addr + 1,
    ));
    let deadline_ms = timer.ms + CLAIM_DELAY_MS as u64;

    let captured_claim = my_inst.claimer.poll(timer.ms, their_rx);

    assert_ne!(
        captured_claim,
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );
    assert_eq!(
        captured_claim,
        claiming(
            my_inst.can_frame_next.expect("must be valid"),
            my_inst.preferred_addr + 1,
            deadline_ms
        )
    );

    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_next.expect("must be valid"),
            deadline_ms
        }
    );

    timer.tick(250);
    // Claiming's done. Next targeted address has been obtained.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claimed(my_inst.preferred_addr + 1)
    );

    assert!(timer.ms == STARTING_TIME + 260);
}

#[test]
fn test_addr_claim_machine_non_aac_fixed_addr_we_lose() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Fixed {
        preferred: my_preferred,
    };

    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_preferred = ADDR_1;
    let their_strategy = AddressClaimStrategy::Fixed {
        preferred: their_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert!(their_inst.name.0 < my_inst.name.0); // we lose
    assert!(their_inst.preferred_addr == my_inst.preferred_addr); // conflict
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state
    assert!(timer.ms == STARTING_TIME);

    // Start
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );

    timer.tick(45);
    // Inject conflict claiming frame.
    // * we lose
    // * there is no other addr available
    let expected_frame = build_address_claim_frame(my_inst.name.0, address::NULL_ADDR_254);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        cannot_claim(
            Some(expected_frame),
            timer.ms + CANNOT_CLAIM_RETRY_DELAY_MS as u64
        )
    );
}

#[test]
fn test_addr_claim_machine_non_aac_self_config_strategy_with_conflict_we_lose() {
    let my_preferred = &[ADDR_3, ADDR_1, ADDR_2, ADDR_4];
    let my_strategy = AddressClaimStrategy::SelfConfigurable {
        addresses: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );
    my_inst.can_frame_next = Some(build_address_claim_frame(my_inst.name.0, ADDR_1));

    let their_preferred = &[ADDR_3, ADDR_2, ADDR_1, ADDR_4];
    let their_strategy = AddressClaimStrategy::SelfConfigurable {
        addresses: their_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert!(their_inst.name.0 < my_inst.name.0); // we lose
    assert!(their_inst.preferred_addr == my_inst.preferred_addr); // conflict
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state
    assert!(timer.ms == STARTING_TIME);

    //Start
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claiming(
            my_inst.can_frame_origin,
            ADDR_3,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );

    timer.tick(45);
    let deadline_ms = timer.ms + CLAIM_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claiming(my_inst.can_frame_next.unwrap(), ADDR_1, deadline_ms)
    );

    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_next.unwrap(),
            deadline_ms
        }
    );

    timer.tick(250);
    // Claiming's done. Targeted address has been obtained.
    assert_eq!(my_inst.claimer.poll(timer.ms, their_rx), claimed(ADDR_1));
    assert!(timer.ms == STARTING_TIME + 295);
}

#[test]
fn test_addr_claim_machine_aac_disturbed_with_no_effect() {
    // The aim of this test is to confirm that a non claiming frame is correctly ignored.

    // build the tested instance
    // * AAC: yes
    // * preferred: ADDR_3
    // * conflict design: normal
    // * claiming frame: yes
    let my_preferred = ADDR_3;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    // build a non disturbing frame
    // * AAC: yes
    // * preferred: ADDR_3
    // * conflict design: built to win
    // * claiming frame: no
    let their_preferred = ADDR_3;
    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: their_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Normal,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert!(their_inst.name.0 < my_inst.name.0); // we lose
    assert!(their_inst.preferred_addr == my_inst.preferred_addr); // conflict but != claiming frame
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct starting state
    assert!(timer.ms == STARTING_TIME);

    // Starting test.
    // * claiming address: ADDR_3
    // * rx: None
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    // Send a non-claiming frame on the same addr.
    // * rx: their_rx
    timer.tick(10);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        waiting_claim(my_preferred, deadline_ms)
    );

    // Timer advance of 239 to reach deadline == 1;
    timer.tick(239);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        waiting_claim(my_preferred, deadline_ms)
    );

    // Claiming's done. Targeted address has been obtained.
    timer.tick(1);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claimed(my_inst.preferred_addr)
    );
}

//==================================================================================ISO_REQUEST

/// A request arriving before the campaign starts it. The Address Claim that
/// goes out is the answer, so no separate Cannot Claim is owed.
#[test]
fn test_iso_request_from_unclaimed_starts_the_campaign() {
    let my_strategy = AddressClaimStrategy::Arbitrary { preferred: ADDR_1 };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);

    let timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions
    assert_eq!(my_inst.claimer.state, State::Unclaimed); // correct beginning state

    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        claiming(
            my_inst.can_frame_origin,
            ADDR_1,
            timer.ms + CLAIM_DELAY_MS as u64
        )
    );
}

/// A strategy with nothing claimable still owes the Cannot Claim, and the first
/// poll is where it goes out.
#[test]
fn test_a_strategy_with_no_claimable_address_answers_cannot_claim() {
    // Built without `Instance`: an empty address list has no preferred address.
    let name = Name::default().0;
    let strategy = AddressClaimStrategy::SelfConfigurable { addresses: &[] };
    let mut engine =
        TestEngine(AddressClaimEngine::new(name, strategy).expect("SAC name, SAC strategy"));

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    let timer = ClockTest::new(STARTING_TIME);

    let expected_frame = build_address_claim_frame(name, address::NULL_ADDR_254);
    assert_eq!(
        engine.poll(timer.ms, Some(&request_rx)),
        cannot_claim(
            Some(expected_frame),
            timer.ms + CANNOT_CLAIM_RETRY_DELAY_MS as u64
        )
    );
}

/// Regression: a stream of requests arriving from the very first poll must not
/// keep the node addressless.
///
/// The runner reads the bus before the wake deadline, so an engine that answered
/// a request without starting its campaign would be handed the next request
/// instead of ever reaching `start_claim`.
#[test]
fn test_continuous_requests_from_unclaimed_do_not_starve_the_first_claim() {
    let my_strategy = AddressClaimStrategy::Arbitrary { preferred: ADDR_1 };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    let mut timer = ClockTest::new(STARTING_TIME);

    // Every poll is handed a request, starting with the first.
    for _ in 0..10 {
        my_inst.claimer.poll(timer.ms, Some(&request_rx));
        assert!(
            matches!(my_inst.claimer.state, State::Claiming { .. }),
            "a request stream must not keep the engine out of a campaign"
        );
        timer.tick(10);
    }

    // And the campaign still closes on time.
    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        defending(my_inst.can_frame_origin, ADDR_1)
    );
}

#[test]
fn test_iso_request_while_claiming_resends_current_claim() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let mut timer = ClockTest::new(STARTING_TIME);

    // Start
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    // Pre-conditions
    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_origin,
            deadline_ms
        }
    );

    timer.tick(10);
    let request_rx = build_request_frame(my_preferred, CLAIM_PGN_60928, REQUEST_PGN_LEN);

    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    // The deadline is not rearmed by an answer.
    assert_eq!(
        my_inst.claimer.state,
        State::Claiming {
            frame: my_inst.can_frame_origin,
            deadline_ms
        }
    );

    timer.tick(240);
    assert_eq!(my_inst.claimer.poll(timer.ms, None), claimed(my_preferred));
}

#[test]
fn test_iso_request_while_claimed_resends_current_claim() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let mut timer = ClockTest::new(STARTING_TIME);

    // Reach the Claimed state.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );
    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(my_inst.claimer.poll(timer.ms, None), claimed(my_preferred));

    // Pre-conditions
    assert_eq!(
        my_inst.claimer.state,
        State::Claimed {
            frame: my_inst.can_frame_origin
        }
    );

    // A globally broadcast request is answered with the current claim.
    let global_request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&global_request_rx)),
        defending(my_inst.can_frame_origin, my_preferred)
    );

    // A request addressed to us is answered the same way.
    let addressed_request_rx = build_request_frame(my_preferred, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&addressed_request_rx)),
        defending(my_inst.can_frame_origin, my_preferred)
    );

    // No deadline is created by an answer.
    assert_eq!(
        my_inst.claimer.state,
        State::Claimed {
            frame: my_inst.can_frame_origin
        }
    );
}

#[test]
fn test_iso_request_from_cannot_claim_answers_cannot_claim() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Fixed {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_strategy = AddressClaimStrategy::Fixed {
        preferred: my_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Reach the CannotClaim state: Fixed strategy, lost conflict, no fallback address.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );
    let expected_frame = build_address_claim_frame(my_inst.name.0, address::NULL_ADDR_254);
    let retry_at_ms = STARTING_TIME + CANNOT_CLAIM_RETRY_DELAY_MS as u64;
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        cannot_claim(Some(expected_frame), retry_at_ms)
    );

    // Pre-conditions
    assert_eq!(my_inst.claimer.state, State::CannotClaim { retry_at_ms });

    timer.tick(10);
    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        cannot_claim(Some(expected_frame), retry_at_ms)
    );

    // The retry deadline survives the answer.
    assert_eq!(my_inst.claimer.state, State::CannotClaim { retry_at_ms });

    // Once elapsed, the retry still happens.
    timer.tick(CANNOT_CLAIM_RETRY_DELAY_MS as u64);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            timer.ms + CLAIM_DELAY_MS as u64
        )
    );
}

#[test]
fn test_iso_request_is_ignored_when_not_for_us() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let mut timer = ClockTest::new(STARTING_TIME);

    // Reach the Claimed state.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            STARTING_TIME + CLAIM_DELAY_MS as u64
        )
    );
    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(my_inst.claimer.poll(timer.ms, None), claimed(my_preferred));

    // Pre-conditions: ADDR_2 is neither ours nor the broadcast address.
    const _: () = assert!(ADDR_2 != ADDR_1 && ADDR_2 != GLOBAL);

    // Addressed to another node.
    let other_node_rx = build_request_frame(ADDR_2, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&other_node_rx)),
        claimed(my_preferred)
    );

    // Requesting another PGN than the address claim.
    let other_pgn_rx = build_request_frame(GLOBAL, COMMAND_ADDR_65240, REQUEST_PGN_LEN);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&other_pgn_rx)),
        claimed(my_preferred)
    );

    // Truncated payload: the requested PGN cannot be read.
    let truncated_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN - 1);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&truncated_rx)),
        claimed(my_preferred)
    );

    assert_eq!(
        my_inst.claimer.state,
        State::Claimed {
            frame: my_inst.can_frame_origin
        }
    );
}

#[test]
fn test_iso_request_payload_padding_is_not_part_of_the_pgn() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);

    let mut timer = ClockTest::new(STARTING_TIME);

    // Pre-conditions: three PGN bytes, then J1939 padding.
    assert_eq!(request_rx.data[0..3], [0x00, 0xEE, 0x00]);
    assert_eq!(request_rx.data[3..8], [0xFF; 5]);

    // Reach the Claimed state, where a request is answered with the claim.
    my_inst.claimer.poll(timer.ms, None);
    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(my_inst.claimer.poll(timer.ms, None), claimed(my_preferred));

    // Reading a fourth byte would drown the PGN in the padding, and the request
    // would go unanswered.
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        defending(my_inst.can_frame_origin, my_preferred)
    );
}

//==================================================================================LIVENESS
// The deadline must survive traffic. Every case below hammers the engine with
// frames it has to answer and checks it still reaches the next state on time.

/// A request answered on every single poll must not postpone the acquisition.
#[test]
fn test_a_request_on_every_poll_does_not_starve_the_claim() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    let mut timer = ClockTest::new(STARTING_TIME);
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;

    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    // 24 answered requests inside the 250 ms window: every one re-emits the
    // claim, none of them touches the deadline.
    for _ in 0..24 {
        timer.tick(10);
        assert_eq!(
            my_inst.claimer.poll(timer.ms, Some(&request_rx)),
            claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
        );
    }

    // The 250 ms are up. The request is still there, and the address is still won.
    timer.tick(10);
    assert!(timer.ms >= deadline_ms);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        defending(my_inst.can_frame_origin, my_preferred)
    );
}

/// A rival we beat, claiming on every poll, must not starve the acquisition either.
#[test]
fn test_continuous_we_win_conflicts_do_not_starve_the_claim() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToLose,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    assert!(their_inst.name.0 > my_inst.name.0); // we win every round

    let mut timer = ClockTest::new(STARTING_TIME);
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;

    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    for _ in 0..24 {
        timer.tick(10);
        assert_eq!(
            my_inst.claimer.poll(timer.ms, their_rx),
            claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
        );
    }

    timer.tick(10);
    assert!(timer.ms >= deadline_ms);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        defending(my_inst.can_frame_origin, my_preferred)
    );
}

/// A request answered on every poll must not postpone the Cannot Claim retry.
#[test]
fn test_a_request_on_every_poll_does_not_starve_the_cannot_claim_retry() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Fixed {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_strategy = AddressClaimStrategy::Fixed {
        preferred: my_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );

    let mut timer = ClockTest::new(STARTING_TIME);
    let retry_at_ms = STARTING_TIME + CANNOT_CLAIM_RETRY_DELAY_MS as u64;
    let cannot_claim_frame = build_address_claim_frame(my_inst.name.0, address::NULL_ADDR_254);

    // Reach CannotClaim.
    my_inst.claimer.poll(timer.ms, None);
    assert_eq!(
        my_inst
            .claimer
            .poll(timer.ms, Some(&their_inst.can_frame_origin)),
        cannot_claim(Some(cannot_claim_frame), retry_at_ms)
    );

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);

    // 99 answered requests spread over the retry window.
    for _ in 0..99 {
        timer.tick(100);
        assert!(timer.ms < retry_at_ms);
        assert_eq!(
            my_inst.claimer.poll(timer.ms, Some(&request_rx)),
            cannot_claim(Some(cannot_claim_frame), retry_at_ms)
        );
    }

    // The retry outranks the request the moment it is due.
    timer.tick(100);
    assert!(timer.ms >= retry_at_ms);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, Some(&request_rx)),
        claiming(
            my_inst.can_frame_origin,
            my_preferred,
            timer.ms + CLAIM_DELAY_MS as u64
        )
    );
}

/// A loss landing exactly on the deadline outranks it: winning the wait does not
/// make the address ours if a better NAME took it in the same millisecond.
#[test]
fn test_a_lost_conflict_on_the_exact_deadline_outranks_it() {
    let my_preferred = ADDR_3;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );
    let their_rx = Some(&their_inst.can_frame_origin);

    assert!(their_inst.name.0 < my_inst.name.0); // we lose

    let mut timer = ClockTest::new(STARTING_TIME);
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;

    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    // Land on the deadline to the millisecond.
    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(timer.ms, deadline_ms);

    // The next address is claimed, not the contested one.
    let expected_frame = build_address_claim_frame(my_inst.name.0, my_preferred + 1);
    assert_eq!(
        my_inst.claimer.poll(timer.ms, their_rx),
        claiming(
            expected_frame,
            my_preferred + 1,
            timer.ms + CLAIM_DELAY_MS as u64
        )
    );

    // And the contested address was never handed out.
    assert_eq!(my_inst.claimer.claimed_address(), None);
}

/// The axes are independent: a request landing on the deadline yields a frame to
/// emit *and* the acquired address in the same output.
#[test]
fn test_a_request_on_the_deadline_yields_both_a_frame_and_the_address() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let mut timer = ClockTest::new(STARTING_TIME);
    let deadline_ms = STARTING_TIME + CLAIM_DELAY_MS as u64;

    assert_eq!(
        my_inst.claimer.poll(timer.ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, deadline_ms)
    );

    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(timer.ms, deadline_ms);

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    let output = my_inst.claimer.poll(timer.ms, Some(&request_rx));

    // Under `ClaimAction` this frame was lost: one variant could not say both.
    assert_eq!(output.tx, Some(my_inst.can_frame_origin));
    assert_eq!(output.status, ClaimStatus::Claimed(my_preferred));
    assert_eq!(output.wake_at_ms, None);
}

/// A held address with a quiet bus has no deadline at all.
#[test]
fn test_claimed_without_activity_has_no_deadline() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let mut timer = ClockTest::new(STARTING_TIME);

    my_inst.claimer.poll(timer.ms, None);
    timer.tick(CLAIM_DELAY_MS as u64);
    assert_eq!(my_inst.claimer.poll(timer.ms, None), claimed(my_preferred));

    // Hours later, still nothing to wake up for: only a frame can change this.
    timer.tick(6 * 3600 * 1000);
    let output = my_inst.claimer.poll(timer.ms, None);
    assert_eq!(output.tx, None);
    assert_eq!(output.wake_at_ms, None);
    assert_eq!(output.status, ClaimStatus::Claimed(my_preferred));
}

/// Deadlines are built with `saturating_add`: a clock reading at the very end of
/// the `u64` range pins them instead of overflowing.
#[test]
fn test_deadlines_near_u64_max_do_not_panic() {
    let my_preferred = ADDR_1;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let now_ms = u64::MAX - 10;

    assert_eq!(
        my_inst.claimer.poll(now_ms, None),
        claiming(my_inst.can_frame_origin, my_preferred, u64::MAX)
    );

    // Pinned at the maximum, and still reachable.
    assert_eq!(my_inst.claimer.poll(u64::MAX, None), claimed(my_preferred));

    // The Cannot Claim retry saturates the same way.
    let fixed_strategy = AddressClaimStrategy::Fixed {
        preferred: my_preferred,
    };
    let mut fixed_inst = Instance::new(
        fixed_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );
    let rival = Instance::new(
        fixed_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );

    fixed_inst.claimer.poll(now_ms, None);
    let expected_frame = build_address_claim_frame(fixed_inst.name.0, address::NULL_ADDR_254);
    assert_eq!(
        fixed_inst
            .claimer
            .poll(now_ms, Some(&rival.can_frame_origin)),
        cannot_claim(Some(expected_frame), u64::MAX)
    );
}

/// `status` and `claimed_address()` are two views of the same state and must
/// never disagree, whatever the step.
#[test]
fn test_status_and_claimed_address_never_disagree() {
    let my_preferred = ADDR_3;
    let my_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let mut my_inst = Instance::new(
        my_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::Normal,
    );

    let their_strategy = AddressClaimStrategy::Arbitrary {
        preferred: my_preferred,
    };
    let their_inst = Instance::new(
        their_strategy,
        CanFrameClass::Claiming,
        ConflictPriority::BuiltToWin,
    );

    let request_rx = build_request_frame(GLOBAL, CLAIM_PGN_60928, REQUEST_PGN_LEN);
    let mut timer = ClockTest::new(STARTING_TIME);

    // A script covering every state: start, wait, acquire, answer, lose, requeue.
    let script: [Option<&CanFrame>; 6] = [
        None,
        None,
        None,
        Some(&request_rx),
        Some(&their_inst.can_frame_origin),
        None,
    ];

    for rx in script {
        let output = my_inst.claimer.poll(timer.ms, rx);
        assert_eq!(
            output.status.claimed_address(),
            my_inst.claimer.claimed_address(),
            "status {:?} disagrees with claimed_address()",
            output.status
        );
        timer.tick(CLAIM_DELAY_MS as u64);
    }
}