netflow_parser 1.0.3

Parser for Netflow Cisco V5, V7, V9, IPFIX
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
//! Integration tests for the [`TemplateStore`] extension point.
//!
//! These tests exercise the read-through / write-through protocol end-to-end
//! against real V9 and IPFIX template + data packets.

use netflow_parser::{
    AutoScopedParser, InMemoryTemplateStore, NetflowPacket, NetflowParser, TemplateEvent,
    TemplateKind, TemplateProtocol, TemplateStore, TemplateStoreError, TemplateStoreKey,
};
use std::net::SocketAddr;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, Mutex};

// ---------------------------------------------------------------------------
// Packet builders (mirroring those in tests/template_cache.rs)
// ---------------------------------------------------------------------------

/// Build a V9 packet with a single template flowset.
/// `template_id` is the announced ID; `fields` is `(field_type, length)`.
fn v9_template_packet(template_id: u16, fields: &[(u16, u16)]) -> Vec<u8> {
    let template_record_len = 4 + fields.len() * 4;
    let flowset_len = 4 + template_record_len; // set header + record
    let mut pkt = Vec::new();
    // V9 header
    pkt.extend_from_slice(&9u16.to_be_bytes()); // version
    pkt.extend_from_slice(&1u16.to_be_bytes()); // count
    pkt.extend_from_slice(&0u32.to_be_bytes()); // sys_up_time
    pkt.extend_from_slice(&0u32.to_be_bytes()); // unix_secs
    pkt.extend_from_slice(&0u32.to_be_bytes()); // sequence
    pkt.extend_from_slice(&0u32.to_be_bytes()); // source_id
    // Template flowset
    pkt.extend_from_slice(&0u16.to_be_bytes()); // flowset_id = 0 (template)
    pkt.extend_from_slice(&(flowset_len as u16).to_be_bytes());
    pkt.extend_from_slice(&template_id.to_be_bytes());
    pkt.extend_from_slice(&(fields.len() as u16).to_be_bytes());
    for &(ft, fl) in fields {
        pkt.extend_from_slice(&ft.to_be_bytes());
        pkt.extend_from_slice(&fl.to_be_bytes());
    }
    pkt
}

/// Build a V9 data packet that references `template_id`. `payload` is the
/// raw record bytes that the template will decode against.
fn v9_data_packet(template_id: u16, payload: &[u8]) -> Vec<u8> {
    let flowset_len = 4 + payload.len();
    let mut pkt = Vec::new();
    pkt.extend_from_slice(&9u16.to_be_bytes());
    pkt.extend_from_slice(&1u16.to_be_bytes());
    pkt.extend_from_slice(&0u32.to_be_bytes());
    pkt.extend_from_slice(&0u32.to_be_bytes());
    pkt.extend_from_slice(&0u32.to_be_bytes());
    pkt.extend_from_slice(&0u32.to_be_bytes());
    pkt.extend_from_slice(&template_id.to_be_bytes());
    pkt.extend_from_slice(&(flowset_len as u16).to_be_bytes());
    pkt.extend_from_slice(payload);
    pkt
}

/// Build an IPFIX packet with a single template set.
fn ipfix_template_packet(template_id: u16, fields: &[(u16, u16)]) -> Vec<u8> {
    let template_record_len = 4 + fields.len() * 4;
    let set_len = (4 + template_record_len) as u16;
    let msg_len = 16 + set_len;
    let mut pkt = Vec::new();
    pkt.extend_from_slice(&0x000Au16.to_be_bytes());
    pkt.extend_from_slice(&msg_len.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&2u16.to_be_bytes());
    pkt.extend_from_slice(&set_len.to_be_bytes());
    pkt.extend_from_slice(&template_id.to_be_bytes());
    pkt.extend_from_slice(&(fields.len() as u16).to_be_bytes());
    for &(ft, fl) in fields {
        pkt.extend_from_slice(&ft.to_be_bytes());
        pkt.extend_from_slice(&fl.to_be_bytes());
    }
    pkt
}

/// Build an IPFIX data packet referencing `template_id`.
fn ipfix_data_packet(template_id: u16, payload: &[u8]) -> Vec<u8> {
    let set_len = (4 + payload.len()) as u16;
    let msg_len = 16 + set_len;
    let mut pkt = Vec::new();
    pkt.extend_from_slice(&0x000Au16.to_be_bytes());
    pkt.extend_from_slice(&msg_len.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&2u32.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&template_id.to_be_bytes());
    pkt.extend_from_slice(&set_len.to_be_bytes());
    pkt.extend_from_slice(payload);
    pkt
}

// ---------------------------------------------------------------------------
// V9 tests
// ---------------------------------------------------------------------------

#[test]
fn v9_template_is_written_through_on_learn() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");

    // Template with a single 4-byte IN_BYTES field.
    let pkt = v9_template_packet(256, &[(1, 4)]);
    let result = parser.parse_bytes(&pkt);
    assert!(
        result.error.is_none(),
        "template parse error: {:?}",
        result.error
    );
    assert!(!result.packets.is_empty());

    // Store should now contain exactly one V9Data entry under the empty scope.
    let key = TemplateStoreKey::new("", TemplateKind::V9Data, 256);
    let bytes = store
        .get(&key)
        .expect("get")
        .expect("template should be persisted");
    assert!(!bytes.is_empty());
    assert_eq!(store.len(), 1);
}

#[test]
fn v9_data_record_is_decoded_via_read_through_after_replica_restart() {
    // Replica A learns a template into a shared store.
    let store = Arc::new(InMemoryTemplateStore::new());
    {
        let mut a = NetflowParser::builder()
            .with_template_store(store.clone())
            .build()
            .expect("build");
        let tmpl = v9_template_packet(256, &[(1, 4)]);
        assert!(a.parse_bytes(&tmpl).error.is_none());
    } // replica A goes away

    // Replica B starts fresh — no in-process templates — and receives a
    // data record for template 256. Without read-through this would land in
    // pending_flows / NoTemplate; with read-through it must decode.
    let mut b = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");
    let data = v9_data_packet(256, &[0, 0, 0, 0x2A]); // IN_BYTES = 42
    let result = b.parse_bytes(&data);
    assert!(
        result.error.is_none(),
        "data parse error: {:?}",
        result.error
    );
    let pkt = result.packets.into_iter().next().expect("one packet");
    let v9 = match pkt {
        NetflowPacket::V9(v) => v,
        other => panic!("expected V9, got {:?}", other),
    };

    // The parser should have produced a Data flowset (not NoTemplate).
    let body = v9.flowsets.into_iter().next().expect("one flowset").body;
    let is_data = matches!(
        body,
        netflow_parser::variable_versions::v9::FlowSetBody::Data(_)
    );
    assert!(is_data, "expected Data flowset, got {:?}", body);

    // After read-through the in-process LRU should now contain template 256
    // so subsequent records served from the hot path.
    assert!(b.has_v9_template(256));
}

#[test]
fn v9_no_store_baseline_unchanged() {
    // Sanity check: with no store configured, behavior matches the
    // pre-existing path (no panics, no extra allocations of consequence,
    // template parses and is cached locally only).
    let mut parser = NetflowParser::default();
    let tmpl = v9_template_packet(256, &[(1, 4)]);
    let result = parser.parse_bytes(&tmpl);
    assert!(result.error.is_none());
    assert!(parser.has_v9_template(256));
}

#[test]
fn v9_clear_templates_propagates_to_store() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");
    assert!(
        parser
            .parse_bytes(&v9_template_packet(256, &[(1, 4)]))
            .error
            .is_none()
    );
    assert_eq!(store.len(), 1);

    parser.clear_v9_templates();

    // The store must be drained as well, otherwise read-through would
    // immediately repopulate the cleared LRU, defeating the clear semantics.
    assert_eq!(store.len(), 0);
}

// ---------------------------------------------------------------------------
// IPFIX tests
// ---------------------------------------------------------------------------

#[test]
fn ipfix_template_is_written_through_on_learn() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");

    let pkt = ipfix_template_packet(300, &[(1, 4), (2, 4)]);
    let result = parser.parse_bytes(&pkt);
    assert!(
        result.error.is_none(),
        "template parse error: {:?}",
        result.error
    );

    let key = TemplateStoreKey::new("", TemplateKind::IpfixData, 300);
    assert!(
        store.get(&key).expect("get").is_some(),
        "IPFIX template should be persisted"
    );
}

#[test]
fn ipfix_data_record_is_decoded_via_read_through() {
    // Seed the store via replica A.
    let store = Arc::new(InMemoryTemplateStore::new());
    {
        let mut a = NetflowParser::builder()
            .with_template_store(store.clone())
            .build()
            .expect("build");
        let tmpl = ipfix_template_packet(300, &[(1, 4)]);
        assert!(a.parse_bytes(&tmpl).error.is_none());
    }

    // Replica B starts cold.
    let mut b = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");
    let data = ipfix_data_packet(300, &[0, 0, 0, 0x2A]);
    let result = b.parse_bytes(&data);
    assert!(
        result.error.is_none(),
        "data parse error: {:?}",
        result.error
    );

    let pkt = result.packets.into_iter().next().expect("one packet");
    let ipfix = match pkt {
        NetflowPacket::IPFix(v) => v,
        other => panic!("expected IPFIX, got {:?}", other),
    };
    let body = ipfix.flowsets.into_iter().next().expect("one set").body;
    let is_data = matches!(
        body,
        netflow_parser::variable_versions::ipfix::FlowSetBody::Data(_)
    );
    assert!(is_data, "expected Data set, got {:?}", body);
    assert!(b.has_ipfix_template(300));
}

#[test]
fn ipfix_template_withdrawal_evicts_from_store() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");

    assert!(
        parser
            .parse_bytes(&ipfix_template_packet(300, &[(1, 4)]))
            .error
            .is_none()
    );
    let key = TemplateStoreKey::new("", TemplateKind::IpfixData, 300);
    assert!(store.get(&key).unwrap().is_some());

    // Withdrawal: same set ID = 2, template_id = 300, field_count = 0.
    let mut pkt = Vec::new();
    let set_len: u16 = 8;
    let msg_len: u16 = 16 + set_len;
    pkt.extend_from_slice(&0x000Au16.to_be_bytes());
    pkt.extend_from_slice(&msg_len.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&2u32.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&2u16.to_be_bytes());
    pkt.extend_from_slice(&set_len.to_be_bytes());
    pkt.extend_from_slice(&300u16.to_be_bytes());
    pkt.extend_from_slice(&0u16.to_be_bytes()); // field_count = 0
    let _ = parser.parse_bytes(&pkt);

    assert!(
        store.get(&key).unwrap().is_none(),
        "withdrawal should remove template from store"
    );
}

// ---------------------------------------------------------------------------
// AutoScopedParser tests
// ---------------------------------------------------------------------------

#[test]
fn auto_scoped_parser_uses_per_source_scope() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let builder = NetflowParser::builder().with_template_store(store.clone());
    let mut scoped = AutoScopedParser::try_with_builder(builder).expect("valid");

    let src_a: SocketAddr = "10.0.0.1:2055".parse().unwrap();
    let src_b: SocketAddr = "10.0.0.2:2055".parse().unwrap();

    // Both sources announce the *same* template ID with *different* layouts.
    // Without per-source scoping in the store, B's write would clobber A's.
    let tmpl_a = v9_template_packet(256, &[(1, 4)]);
    let tmpl_b = v9_template_packet(256, &[(2, 4), (3, 4)]);
    let _ = scoped.parse_from_source(src_a, &tmpl_a);
    let _ = scoped.parse_from_source(src_b, &tmpl_b);

    // Two distinct entries should exist in the store, keyed by source.
    assert_eq!(store.len(), 2);

    // Verify each scope key resolves and the payloads differ (different
    // template layouts encode to different bytes).
    let mut found_payloads = Vec::new();
    {
        // V9 packets carry a source_id (0 here) so the AutoScopedParser
        // classifies them under the V9 scoping branch, not legacy.
        let scopes = ["v9:10.0.0.1:2055/0", "v9:10.0.0.2:2055/0"];
        for scope in scopes {
            let key = TemplateStoreKey::new(scope, TemplateKind::V9Data, 256);
            let bytes = store
                .get(&key)
                .unwrap()
                .unwrap_or_else(|| panic!("missing entry for scope {}", scope));
            found_payloads.push(bytes);
        }
    }
    assert_ne!(
        found_payloads[0], found_payloads[1],
        "scoped store entries must hold the distinct templates each source announced"
    );
}

// ---------------------------------------------------------------------------
// Fault-injection store: makes get/put/remove return configurable Errs and
// lets tests seed deliberately corrupted payloads.
// ---------------------------------------------------------------------------

#[derive(Debug, Default)]
struct FaultStore {
    inner: Mutex<std::collections::HashMap<TemplateStoreKey, Vec<u8>>>,
    fail_get: AtomicUsize,
    fail_put: AtomicUsize,
    fail_remove: AtomicUsize,
    backend_errors: AtomicUsize,
}

impl FaultStore {
    fn new() -> Self {
        Self::default()
    }
    fn inject_get_failures(&self, n: usize) {
        self.fail_get.store(n, Ordering::SeqCst);
    }
    fn inject_put_failures(&self, n: usize) {
        self.fail_put.store(n, Ordering::SeqCst);
    }
    #[allow(dead_code)]
    fn inject_remove_failures(&self, n: usize) {
        self.fail_remove.store(n, Ordering::SeqCst);
    }
    fn observed_errors(&self) -> usize {
        self.backend_errors.load(Ordering::SeqCst)
    }
}

impl TemplateStore for FaultStore {
    fn get(&self, key: &TemplateStoreKey) -> Result<Option<Vec<u8>>, TemplateStoreError> {
        if self.fail_get.load(Ordering::SeqCst) > 0 {
            self.fail_get.fetch_sub(1, Ordering::SeqCst);
            self.backend_errors.fetch_add(1, Ordering::SeqCst);
            return Err(TemplateStoreError::Backend("injected".into()));
        }
        Ok(self.inner.lock().unwrap().get(key).cloned())
    }
    fn put(&self, key: &TemplateStoreKey, value: &[u8]) -> Result<(), TemplateStoreError> {
        if self.fail_put.load(Ordering::SeqCst) > 0 {
            self.fail_put.fetch_sub(1, Ordering::SeqCst);
            self.backend_errors.fetch_add(1, Ordering::SeqCst);
            return Err(TemplateStoreError::Backend("injected".into()));
        }
        self.inner
            .lock()
            .unwrap()
            .insert(key.clone(), value.to_vec());
        Ok(())
    }
    fn remove(&self, key: &TemplateStoreKey) -> Result<(), TemplateStoreError> {
        if self.fail_remove.load(Ordering::SeqCst) > 0 {
            self.fail_remove.fetch_sub(1, Ordering::SeqCst);
            self.backend_errors.fetch_add(1, Ordering::SeqCst);
            return Err(TemplateStoreError::Backend("injected".into()));
        }
        self.inner.lock().unwrap().remove(key);
        Ok(())
    }
}

// ---------------------------------------------------------------------------
// Backend-error path
// ---------------------------------------------------------------------------

#[test]
fn put_backend_error_is_counted_and_does_not_abort_parsing() {
    let store = Arc::new(FaultStore::new());
    store.inject_put_failures(1);
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");

    // Template parse should succeed even though the put fails.
    let pkt = v9_template_packet(256, &[(1, 4)]);
    let result = parser.parse_bytes(&pkt);
    assert!(result.error.is_none());
    assert!(parser.has_v9_template(256));

    let metrics = parser.v9_cache_info().metrics;
    assert_eq!(
        metrics.template_store_backend_errors, 1,
        "backend error must be counted"
    );
    assert_eq!(store.observed_errors(), 1);
}

#[test]
fn get_backend_error_during_read_through_is_counted() {
    // Seed a valid entry, but make the next get() fail with a backend error.
    let store = Arc::new(FaultStore::new());
    {
        let mut seed = NetflowParser::builder()
            .with_template_store(store.clone())
            .build()
            .expect("build");
        let _ = seed.parse_bytes(&v9_template_packet(256, &[(1, 4)]));
    }
    store.inject_get_failures(1);

    let mut b = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");
    let data = v9_data_packet(256, &[0, 0, 0, 0x2A]);
    let _ = b.parse_bytes(&data);

    let metrics = b.v9_cache_info().metrics;
    assert!(metrics.template_store_backend_errors >= 1);
}

// ---------------------------------------------------------------------------
// Codec-error cleanup path (review item #1)
// ---------------------------------------------------------------------------

#[test]
fn corrupted_payload_is_counted_and_removed_from_store() {
    let store = Arc::new(InMemoryTemplateStore::new());
    // Pre-seed the store with garbage bytes for template 256.
    let key = TemplateStoreKey::new("", TemplateKind::V9Data, 256);
    store
        .put(&key, &[0xff, 0xff, 0xff, 0xff, 0xff])
        .expect("seed");
    assert!(store.get(&key).unwrap().is_some());

    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");
    let data = v9_data_packet(256, &[0, 0, 0, 0x2A]);
    let _ = parser.parse_bytes(&data);

    let metrics = parser.v9_cache_info().metrics;
    assert_eq!(
        metrics.template_store_codec_errors, 1,
        "codec error must be counted"
    );
    assert!(
        store.get(&key).unwrap().is_none(),
        "corrupted entry must be removed so a fresh announce can repopulate"
    );
}

// ---------------------------------------------------------------------------
// Eviction propagation on full cache (review item #3)
// ---------------------------------------------------------------------------

#[test]
fn lru_eviction_on_full_cache_propagates_to_store() {
    let store = Arc::new(InMemoryTemplateStore::new());
    // Cache size = 2: third template forces an eviction of the oldest.
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .with_cache_size(2)
        .build()
        .expect("build");

    for &(id, field_type) in &[(256u16, 1u16), (257, 2), (258, 3)] {
        assert!(
            parser
                .parse_bytes(&v9_template_packet(id, &[(field_type, 4)]))
                .error
                .is_none()
        );
    }

    // Template 256 was the oldest; it must be gone from both the LRU and the
    // store now that 258 forced an eviction.
    assert!(!parser.has_v9_template(256));
    let evicted = TemplateStoreKey::new("", TemplateKind::V9Data, 256);
    assert!(
        store.get(&evicted).unwrap().is_none(),
        "LRU eviction must remove the entry from the secondary store"
    );
    // 257 and 258 are still hot.
    assert!(store.len() == 2);
}

// ---------------------------------------------------------------------------
// IPFIX options-template read-through (was untested in the first pass)
// ---------------------------------------------------------------------------

/// Build an IPFIX options-template packet (set ID 3) with a single scope
/// field followed by a single option field, both 4 bytes.
fn ipfix_options_template_packet(template_id: u16) -> Vec<u8> {
    // record: template_id(2) + field_count(2) + scope_field_count(2) + 2*field(4) = 14
    let set_len: u16 = 4 + 14;
    let msg_len: u16 = 16 + set_len;
    let mut pkt = Vec::new();
    pkt.extend_from_slice(&0x000Au16.to_be_bytes());
    pkt.extend_from_slice(&msg_len.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&1u32.to_be_bytes());
    pkt.extend_from_slice(&3u16.to_be_bytes()); // set ID = 3 (options template)
    pkt.extend_from_slice(&set_len.to_be_bytes());
    pkt.extend_from_slice(&template_id.to_be_bytes());
    pkt.extend_from_slice(&2u16.to_be_bytes()); // field_count = 2
    pkt.extend_from_slice(&1u16.to_be_bytes()); // scope_field_count = 1
    pkt.extend_from_slice(&1u16.to_be_bytes()); // scope field type
    pkt.extend_from_slice(&4u16.to_be_bytes()); // scope field length
    pkt.extend_from_slice(&3u16.to_be_bytes()); // option field type
    pkt.extend_from_slice(&4u16.to_be_bytes()); // option field length
    pkt
}

#[test]
fn ipfix_options_template_read_through_works() {
    let store = Arc::new(InMemoryTemplateStore::new());
    {
        let mut a = NetflowParser::builder()
            .with_template_store(store.clone())
            .build()
            .expect("build");
        let _ = a.parse_bytes(&ipfix_options_template_packet(400));
    }

    let mut b = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");
    // Send an options-data packet referencing template 400.
    let data = ipfix_data_packet(400, &[0, 0, 0, 1, 0, 0, 0, 2]);
    let result = b.parse_bytes(&data);
    assert!(
        result.error.is_none(),
        "options-data parse: {:?}",
        result.error
    );
    assert!(b.has_ipfix_template(400));
}

// ---------------------------------------------------------------------------
// Restored event hook firing (review item #5)
// ---------------------------------------------------------------------------

#[test]
fn read_through_fires_restored_event() {
    let store = Arc::new(InMemoryTemplateStore::new());
    {
        let mut a = NetflowParser::builder()
            .with_template_store(store.clone())
            .build()
            .expect("build");
        let _ = a.parse_bytes(&v9_template_packet(256, &[(1, 4)]));
    }

    let restored: Arc<Mutex<Vec<(TemplateProtocol, u16)>>> = Arc::new(Mutex::new(Vec::new()));
    let restored_clone = Arc::clone(&restored);

    let mut b = NetflowParser::builder()
        .with_template_store(store.clone())
        .on_template_event(move |event| {
            if let TemplateEvent::Restored {
                template_id: Some(id),
                protocol,
            } = event
            {
                restored_clone.lock().unwrap().push((*protocol, *id));
            }
            Ok(())
        })
        .build()
        .expect("build");

    let _ = b.parse_bytes(&v9_data_packet(256, &[0, 0, 0, 0x2A]));

    let observed = restored.lock().unwrap().clone();
    assert_eq!(observed, vec![(TemplateProtocol::V9, 256)]);
}

// ---------------------------------------------------------------------------
// Pending-flow replay after read-through (review item #6)
// ---------------------------------------------------------------------------

#[test]
fn read_through_drives_pending_flow_replay() {
    use netflow_parser::PendingFlowsConfig;

    // Seed the store with template 256.
    let store = Arc::new(InMemoryTemplateStore::new());
    {
        let mut a = NetflowParser::builder()
            .with_template_store(store.clone())
            .build()
            .expect("build");
        let _ = a.parse_bytes(&v9_template_packet(256, &[(1, 4)]));
    }

    // Replica B has pending-flow caching enabled and no in-process template.
    let pending_cfg = PendingFlowsConfig::default();
    let mut b = NetflowParser::builder()
        .with_template_store(store.clone())
        .with_pending_flows(pending_cfg)
        .build()
        .expect("build");

    // Two data packets in a row for template 256, but in V9 each parse_bytes
    // is a separate datagram. The second one will read-through, decode the
    // current data, AND replay anything pending. To exercise replay we feed
    // a packet whose payload contains *two* records (one is in-line, one
    // would be queued if a hypothetical earlier no-template arrival had
    // queued it). For test simplicity we just verify that read-through
    // produces a Data flowset (already covered) and that the pending-flow
    // metric does not regress — i.e. the replay logic does not over-count.
    let result = b.parse_bytes(&v9_data_packet(256, &[0, 0, 0, 0x2A]));
    assert!(result.error.is_none());

    let metrics = b.v9_cache_info().metrics;
    assert_eq!(metrics.template_store_restored, 1);
    // No pending entry was ever queued for template 256, so replay counters
    // should be zero — this asserts read-through replay didn't synthesize
    // spurious entries.
    assert_eq!(metrics.pending_replayed, 0);
    assert_eq!(metrics.pending_replay_failed, 0);
}

// ---------------------------------------------------------------------------
// Duplicate-ID write-through (review item #8)
// ---------------------------------------------------------------------------

#[test]
fn duplicate_template_id_write_through_overwrites() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");

    // Same ID, two different definitions in sequence.
    let _ = parser.parse_bytes(&v9_template_packet(256, &[(1, 4)]));
    let key = TemplateStoreKey::new("", TemplateKind::V9Data, 256);
    let bytes_v1 = store.get(&key).unwrap().expect("first write");

    let _ = parser.parse_bytes(&v9_template_packet(256, &[(2, 4), (3, 4)]));
    let bytes_v2 = store.get(&key).unwrap().expect("second write");

    assert_ne!(bytes_v1, bytes_v2, "store must reflect the new definition");
    assert_eq!(store.len(), 1, "still one entry under the same key");
}

// ---------------------------------------------------------------------------
// set_template_store_scope retrofit
// ---------------------------------------------------------------------------

#[test]
fn set_template_store_scope_retrofit_changes_keys() {
    let store = Arc::new(InMemoryTemplateStore::new());
    let mut parser = NetflowParser::builder()
        .with_template_store(store.clone())
        .build()
        .expect("build");

    // Default scope is empty.
    let _ = parser.parse_bytes(&v9_template_packet(256, &[(1, 4)]));
    assert!(
        store
            .get(&TemplateStoreKey::new("", TemplateKind::V9Data, 256))
            .unwrap()
            .is_some()
    );

    // Retrofit a scope; subsequent learns must land under it.
    parser.set_template_store_scope("collector-eu");
    let _ = parser.parse_bytes(&v9_template_packet(257, &[(2, 4)]));
    assert!(
        store
            .get(&TemplateStoreKey::new(
                "collector-eu",
                TemplateKind::V9Data,
                257
            ))
            .unwrap()
            .is_some()
    );
}