snmp_rust_agent 0.4.0

A framework for building SNMP v3 Agents
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
use crate::parser::{Entry, ModuleCompliance, ObjectIdentity, ObjectType, TextConvention};
use crate::resolver::{self, Resolver};
use log::{debug, error, info, warn};
use std::collections::HashMap;
use std::fs;
use std::io::{Error, Write};

fn upper_snake(name: &str) -> String {
    lower_snake(name).to_uppercase()
}

fn lower_snake(text: &str) -> String {
    let mut buffer = String::with_capacity(text.len() + text.len() / 2);
    let mut text = text.chars();
    if let Some(first) = text.next() {
        let mut n2: Option<(bool, char)> = None;
        let mut n1: (bool, char) = (first.is_lowercase(), first);

        for c in text {
            let prev_n1 = n1;

            let n3 = n2;

            n2 = Some(n1);
            n1 = (c.is_lowercase(), c);

            // insert underscore if acronym at beginning
            // ABc -> a_bc

            if let Some((false, c3)) = n3 {
                if let Some((false, c2)) = n2 {
                    if n1.0 && c3.is_uppercase() && c2.is_uppercase() {
                        buffer.push('_');
                    }
                }
            }

            buffer.push_str(&prev_n1.1.to_lowercase().to_string());

            // insert underscore before next word
            // abC -> ab_c

            if let Some((true, _)) = n2 {
                if n1.1.is_uppercase() {
                    buffer.push('_');
                }
            }
        }
        buffer.push_str(&n1.1.to_lowercase().to_string());
    }
    buffer
}

fn title(name: &str) -> String {
    let mut c = name.chars();
    match c.next() {
        None => String::new(),
        Some(f) => f.to_uppercase().collect::<String>() + c.as_str(),
    }
}

/// Put // at start of every line
fn slash_b(description: &str) -> String {
    let lines = description.lines();
    let ret: String = lines.map(|l| "// ".to_owned() + l.trim() + "\n").collect();
    ret
}

static NAME_OTYPES: [(&str, &str); 34] = [
    ("INTEGER", "OType::Integer"),
    ("TruthValue", "OType::Integer"),
    ("TimeStamp", "OType::Ticks"),
    ("DateAndTime", "OType::String"),
    ("TimeTicks", "OType::Ticks"),
    ("TimeInterval", "OType::Integer"),
    ("TestAndIncr", "OType::Integer"),
    ("UUIDorZero", "OType::String"),
    ("Counter64", "OType::BigCounter"),
    ("Counter", "OType::Counter"),
    ("AutonomousType", "OType::ObjectId"),
    ("IANAStorageMediaType", "OType::Integer"),
    ("SnmpAdminString", "OType::String"),
    ("DisplayString", "OType::String"),
    ("OwnerString", "OType::String"),
    ("MacAddress", "OType::String"),
    ("EntryStatus", "OType::Integer"),
    ("InterfaceIndexOrZero", "OType::Integer"),
    ("PhysAddress", "OType::String"),
    ("Integer32", "OType::Integer"),
    ("Unsigned32", "OType::Integer"),
    ("TimeInterval", "OType::Integer"),
    ("RowStatus", "OType::Integer"),
    ("Gauge32", "OType::Counter"),
    ("OCTET", "OType::String"),
    ("BITS", "OType::String"),
    ("Opaque", "OType::String"),
    ("OBJECT", "OType::ObjectId"),
    ("Counter32", "OType::Counter"),
    ("IpAddress", "OType::Address"),
    ("InetAddress", "OType::Address"),
    ("InetAddressType", "OType::Integer"),
    ("InetPortNumber", "OType::Integer"),
    ("InterfaceIndexOrZero", "OType::Integer"),
];

fn name_otype(text: &str) -> &str {
    let text = text.trim();
    for (key, value) in NAME_OTYPES.iter() {
        if text.starts_with(*key) {
            return value;
        }
    }
    warn!("Otype lookup failed for {text}");
    "OType::ObjectId"
}

static ACCESS: [(&str, &str); 5] = [
    ("not-accessible", "Access::NoAccess"),
    ("accessible-for-notify", "Access::NotificationOnly"),
    ("read-only", "Access::ReadOnly"),
    ("read-write", "Access::ReadWrite"),
    ("read-create", "Access::ReadCreate"),
];

fn access_lookup(text: &str) -> &str {
    for (key, value) in ACCESS.iter() {
        if text == *key {
            return value;
        }
    }
    ACCESS[0].1
}

fn ordered_names<'a>(
    object_types: &HashMap<&'a str, ObjectType>,
    resolve: &resolver::Resolver,
) -> Vec<&'a str> {
    let mut arcs = vec![];
    for (name, data) in object_types.iter() {
        if data.col || !data.index.is_empty() {
            continue;
        }
        let arc = resolve.lookup(name);
        arcs.push((arc, name));
    }
    arcs.sort_by(|a, b| a.0.cmp(b.0));
    let mut names = vec![];
    for arc in arcs {
        names.push(*arc.1)
    }
    names
}

fn write_arcs(
    out: &mut fs::File,
    object_ids: &[ObjectIdentity],
    resolve: &resolver::Resolver,
    names: &Vec<&str>,
    mod_comps: &[ModuleCompliance],
) -> Result<(), Error> {
    //Write out the constants for Oids"""
    for name in names {
        let uname = upper_snake(name);
        let arc = resolve.lookup(name);
        let larc = arc.len();
        out.write_all(format!("const ARC_{uname}: [u32; {larc}] = {arc:?};\n").as_bytes())?;
    }

    if !object_ids.is_empty() {
        let mut arcs = vec![];
        out.write_all(b"\n// OID definitions for OBJECT-IDENTITY\n\n")?;
        for data in object_ids {
            let uname = upper_snake(data.name);
            let arc = resolve.lookup(data.name);
            arcs.push((arc, uname));
        }
        arcs.sort_by(|a, b| a.0.cmp(b.0));
        for (arc, uname) in arcs {
            let larc = arc.len();
            out.write_all(format!("const ARC_{uname}: [u32; {larc}] = {arc:?};\n").as_bytes())?;
        }
    }

    for mod_comp in mod_comps {
        let name = mod_comp.name;
        let uname = upper_snake(name);
        let arc = resolve.lookup(name);
        let larc = arc.len();
        out.write_all(format!("const COMPLIANCE_{uname}: [u32; {larc}] = {arc:?};\n").as_bytes())?;
    }
    Ok(())
}

fn write_object_ids(out: &mut fs::File, object_ids: &[ObjectIdentity]) -> Result<(), Error> {
    //Write OBJECT-IDENTITY constants"""
    if !object_ids.is_empty() {
        out.write_all(b"\n// The next group is for OBJECT-IDENTITY.\n")?;
        out.write_all(b"\n// These may be used as values rather than MIB addresses\n\n")?;
        for oid in object_ids {
            let uname = upper_snake(oid.name);
            let uname_tr = uname.trim();
            let lname = lower_snake(oid.name);
            out.write_all(format!("    let _oid_{lname}: ObjectIdentifier =\n").as_bytes())?;
            out.write_all(
                format!("        ObjectIdentifier::new(&ARC_{uname_tr}).unwrap();\n").as_bytes(),
            )?;
            out.write_all(b"\n")?;
        }
    }
    Ok(())
}

fn value_from_syntax(syntax: &str) -> String {
    //Use syntax char to choose an appropriate initial value"""
    match syntax {
        "OType::String" => "simple_from_str(b\"b\")",
        "OType::ObjectId" => "simple_from_vec(&[1, 3, 6, 1])",
        "OType::Counter" => "counter_from_int(0)",
        "OType::BigCounter" => "big_counter_from_int(0)",
        "OType::Ticks" => "ticks_from_int(0)",
        "OType::Address" => "address_from_vec([0, 0, 0, 0])",
        _ => "simple_from_int(4)",
    }
    .to_string()
}

fn lookup_int_syntax(arg: &str, syntax: &str) -> String {
    if arg.parse::<i32>().is_ok() {
        return format!("simple_from_int({arg})");
    }
    if syntax.contains("{") {
        let mut syn_bits = syntax.split("{");
        syn_bits.next();
        let body = syn_bits.next().unwrap().split("}").next().unwrap();
        let parts = body.split(",");
        for part in parts {
            let mut part_itr = part.split("(");
            let name = part_itr.next().unwrap().trim();
            let new_name = if name.starts_with("--") && name.contains("\n") {
                let mut nsplit = name.split("\n");
                let _ = nsplit.next();
                nsplit.next().unwrap().trim()
            } else {
                name
            };
            if arg.trim() == new_name {
                let valb = part_itr.next().unwrap();
                let val = valb.split(")").next().unwrap();
                return format!("simple_from_int({val})").to_string();
            }
        }
    }
    warn!("Not found name match for syntax, {arg}, returning 0");
    "simple_from_int(0)".to_string()
}

fn fix_def(
    arg: &str,
    syntax: &str,
    tcs: &HashMap<&str, TextConvention>,
    resolver: &Resolver,
) -> String {
    //Generate default value"""
    let arg = arg.trim();
    let mut syntax = syntax.trim();

    if arg.ends_with("'H") || arg.ends_with("'h") {
        let tend = arg.len() - 2;
        let txt = if tend > 1 { &arg[1..tend] } else { "" };
        return format!("simple_from_str(b\"{txt}\")").to_string();
    }

    if let Some(tcsyn) = tc_find_syntax(syntax, tcs) {
        syntax = tcsyn;
    }
    if syntax.starts_with("Integer32")
        || syntax.starts_with("Unsigned32")
        || syntax.starts_with("Gauge")
        || syntax.starts_with("INTEGER")
        || syntax.starts_with("TimeInterval")
        || syntax.starts_with("TimeTicks")
    {
        return lookup_int_syntax(arg, syntax);
    }
    if syntax == "OBJECT IDENTIFIER" || syntax == "RowPointer" || syntax == "VariablePointer" {
        if resolver.check_name(arg) {
            let arc = resolver.lookup(arg);
            return format!("simple_from_vec(&{arc:?})").to_string();
        }
        let uarg = upper_snake(arg);
        return "simple_from_vec(&ARC_".to_owned() + &uarg + ")";
    }
    if syntax.starts_with("BITS") {
        let txt = "\x00";
        return format!("simple_from_str(b\"{txt}\")");
    }
    warn!("Return DEFVAL {arg} {syntax} literal");
    arg.to_string()
}

fn tc_find_syntax<'a>(text: &str, tcs: &HashMap<&str, TextConvention<'a>>) -> Option<&'a str> {
    if tcs.contains_key(text) {
        return Some(tcs[text].syntax.trim());
    }
    if text.contains(" ") {
        let key = text.split_once(" ").unwrap().0;
        if tcs.contains_key(key) {
            return Some(tcs[key].syntax.trim());
        }
    }
    None
}

fn write_table_struct(
    out: &mut fs::File,
    name: &str,
    object_types: &HashMap<&str, ObjectType>,
    child: ObjectType,
    raw_entry: Vec<(&str, &str)>,
    tcs: &HashMap<&str, TextConvention>,
    resolver: &Resolver,
) -> Result<(), Error> {
    //Write struct for single table"""
    let index_list = child.index;
    // Dodgy, but best guess. If some columns are deprecated or obsolete, they
    // won't be in object_types, so remove them here.
    let entry: Vec<(&str, &str)> = raw_entry
        .into_iter()
        .filter(|(name, _)| object_types.contains_key(name))
        .collect();
    if child.augments.len() > 2 {
        info!("Augments, processing {}", child.augments)
    }
    let ntitle = title(name);
    let struct_name = format!("Keep{ntitle}");
    // entry = [(a, " ( ".join(b.split("("))) for (a, b) in entry];
    debug!("entry {:?}", entry);
    debug!("index {:?}", index_list);
    let implied = index_list.contains("IMPLIED");
    if implied {
        // index_list[-1] = index_list[-1].split()[-1];
    }
    let acols_vec: Vec<&str> = entry
        .iter()
        .map(|(name, _)| {
            if !object_types.contains_key(name) {
                warn!("Unknown object name {name}");
            }
            access_lookup(object_types[name].access)
        })
        .collect();
    let acols = acols_vec.join(", ");
    //", ".join([ACCESS[object_types[name].access]  for (name, _) in entry.syntax]);
    let cols: Vec<&str> = entry
        .iter()
        .map(|(_, x)| {
            let y = tc_find_syntax(x, tcs).unwrap_or(x);
            name_otype(y)
        })
        .collect();
    let cols_txt = cols.join(", ");
    //cols = [NAME_OTYPE[_[1].split()[0]] for _ in entry]
    let mut icol_data = vec![];
    for ent in &entry {
        if object_types[ent.0].defval.len() > 2 {
            icol_data.push(fix_def(
                object_types[ent.0].defval,
                object_types[ent.0].syntax,
                tcs,
                resolver,
            ))
        } else {
            let syn = tc_find_syntax(ent.1, tcs).unwrap_or(ent.1);
            icol_data.push(value_from_syntax(name_otype(syn)));
        }
    }
    let idat = icol_data.join(", ");
    let icols: Vec<usize> = entry
        .iter()
        .enumerate()
        .filter(|(_i, (name, _))| index_list.contains(name))
        .map(|(i, _)| i + 1)
        .collect();
    //[i + 1 for i, e in enumerate(entry)
    //       for _ in index_list if e[0] == _]
    let lcols = cols.len();
    let uname = upper_snake(name);
    let uname_tr = uname.trim();
    if child.description.len() > 2 {
        out.write_all(slash_b(child.description).as_bytes())?;
    }
    let set_data = if icols.is_empty() {
        format!("  tab.table.set_indexed_data(vec![(vec![1], vec![{idat}])]);")
    } else {
        format!("  tab.table.set_data(vec![vec![{idat}]]);")
    };
    out.write_all(
        format!(
            "
struct {struct_name} {{
table: TableMemOid,
}}

impl {struct_name} {{
fn new() -> Self {{
   let base_oid: ObjectIdentifier =
       ObjectIdentifier::new(&ARC_{uname_tr}).unwrap();

   let mut tab = {struct_name} {{
       table: TableMemOid::new(
    vec![{idat}],
    {lcols},
    &base_oid,
    vec![{cols_txt}],
    vec![{acols}],
    vec!{icols:?},
    {implied},
    )
   }};

   {set_data}
   tab
}}
}}

impl OidKeeper for {struct_name} {{
fn is_scalar(&self, _oid: ObjectIdentifier) -> bool {{false}}
fn is_empty(&self) -> bool {{
       self.table.is_empty()
    }}
fn get(&self, oid: ObjectIdentifier) -> Result<VarBindValue, OidErr> {{
  self.table.get(oid) }}
fn get_next(&self, oid: ObjectIdentifier) -> Result<VarBind, OidErr> {{
  self.table.get_next(oid) }}
fn access(&self, oid: ObjectIdentifier) -> Access {{
  self.table.access(oid) }}
fn set(
        &mut self,
        oid: ObjectIdentifier,
        value: VarBindValue,
        user: &User,
    ) -> Result<VarBindValue, OidErr> {{
    self.table.set(oid, value, user) }}
fn begin_transaction(&mut self) -> Result<(), OidErr> {{
        self.table.begin_transaction()
    }}
fn commit(&mut self, user: &User) -> Result<(), OidErr> {{
        self.table.commit(user)
    }}
fn rollback(&mut self) -> Result<(), OidErr> {{
        self.table.rollback()
    }}
}}

"
        )
        .as_bytes(),
    )?;
    Ok(())
}

fn write_scalar_struct(
    out: &mut fs::File,
    name: &str,
    data: &ObjectType,
    tcs: &HashMap<&str, TextConvention>,
) -> Result<(), Error> {
    //Write struct for scalar"""
    let acc = access_lookup(data.access);
    let syntax = data.syntax;
    let syntax = tc_find_syntax(syntax, tcs).unwrap_or(syntax);
    let otype = name_otype(syntax);
    let val = value_from_syntax(otype);
    let tname = title(name);
    let struct_name = format!("Keep{tname}");
    if data.description.len() > 2 {
        out.write_all(slash_b(data.description).as_bytes())?;
    }
    out.write_all(
        format!(
            "
struct {struct_name} {{
scalar: ScalarMemOid,
}}

impl {struct_name} {{
fn new() -> Self {{
   {struct_name} {{
       scalar: ScalarMemOid::new({val}, {otype}, {acc}),
}}
}}
}}

impl OidKeeper for {struct_name} {{
    fn is_scalar(&self, _oid: ObjectIdentifier) -> bool {{
        true
    }}
    fn get(&self, oid: ObjectIdentifier) -> Result<VarBindValue, OidErr> {{
        self.scalar.get(oid)
    }}
    fn get_next(&self, oid: ObjectIdentifier) -> Result<VarBind, OidErr> {{
        self.scalar.get_next(oid)
    }}
    fn access(&self, oid: ObjectIdentifier) -> Access {{
        self.scalar.access(oid)
    }}
    fn set(&mut self, oid: ObjectIdentifier, value: VarBindValue, user: &User) -> Result<VarBindValue, OidErr> {{
        self.scalar.set(oid, value, user)
    }}
    fn begin_transaction(&mut self) -> Result<(), OidErr> {{
        self.scalar.begin_transaction()
    }}
    fn commit(&mut self, user: &User) -> Result<(), OidErr> {{
        self.scalar.commit(user)
    }}
    fn rollback(&mut self) -> Result<(), OidErr> {{
        self.scalar.rollback()
    }}
}}
"
        )
        .as_bytes(),
    )?;
    Ok(())
}

fn write_ot_structs(
    out: &mut fs::File,
    object_types: &HashMap<&str, ObjectType>,
    tcs: &HashMap<&str, TextConvention>,
    entries: &HashMap<&str, Entry>,
    names: &Vec<&str>,
    resolver: &Resolver,
) -> Result<(), Error> {
    // Heavy lifting
    out.write_all(b"\n// Now the OBJECT-TYPES.")?;
    out.write_all(b" These need actual code added to the stubs\n\n")?;
    for name in names {
        let data = &object_types[name];
        // for (name, data) in object_types.iter() {
        if data.col || !data.index.is_empty() || !data.augments.is_empty() {
            continue;
        }
        if data.table {
            let en_itr = data.syntax.split(" ");
            let entry_name = en_itr.last().unwrap();
            debug!("entry_name is |{entry_name}|");
            let entry = entries[entry_name].syntax.clone();
            let child_opt = object_types
                .values()
                .find(|o| o.syntax.trim() == entry_name);
            if let Some(child) = child_opt {
                if child.augments.len() > 2 {
                    warn!("Buggy AUGMENTS behavior, needs fixing");
                    //panic!("Don't support AUGMENTS yet")
                    //# FIXME - this is wrong - we should
                    //# somehow tie just the added columns back to a row in
                    //# the master table
                    /*   let master_name = child.augments;
                    let master = object_types[master_name];
                    let ent_title = title(master_name);
                    let master_raw = entries[&ent_title[..]];
                    let master_e = master_raw.syntax;
                    master_e.extend(entry);
                    let new_child = master.copy();
                    new_child.update(child);*/
                    write_table_struct(
                        out,
                        name,
                        object_types,
                        child.clone(),
                        entry,
                        tcs,
                        resolver,
                    )?;
                } else {
                    write_table_struct(
                        out,
                        name,
                        object_types,
                        child.clone(),
                        entry,
                        tcs,
                        resolver,
                    )?;
                }
            } else {
                error!("Table definition not found {}", entry_name);
            }
        } else {
            write_scalar_struct(out, name, data, tcs)?;
        }
    }
    Ok(())
}

fn write_object_types(
    out: &mut fs::File,
    object_types: &HashMap<&str, ObjectType>,
    names: &Vec<&str>,
) -> Result<(), Error> {
    //Invoke the types defined earlier"""
    for name in names {
        let data = &object_types[name];
        if data.col || !data.index.is_empty() {
            continue;
        }
        let uname = upper_snake(name);
        let uname_tr = uname.trim();
        let lname = lower_snake(name);
        let tname = title(name);
        out.write_all(format!("    let oid_{lname}: ObjectIdentifier =\n").as_bytes())?;
        out.write_all(
            format!("        ObjectIdentifier::new(&ARC_{uname_tr}).unwrap();\n").as_bytes(),
        )?;
        out.write_all(format!("    let k_{lname}: Box<dyn OidKeeper> = \n").as_bytes())?;
        out.write_all(format!("       Box::new(Keep{tname}::new());\n").as_bytes())?;
        out.write_all(format!("    oid_map.push(oid_{lname}, k_{lname});\n").as_bytes())?;
    }
    Ok(())
}

fn write_module_compliances(
    out: &mut fs::File,
    mod_comps: &[ModuleCompliance],
) -> Result<(), Error> {
    out.write_all(b"   // Module Compliance values, change false to true when implemented\n\n")?;

    for mod_c in mod_comps {
        let name = mod_c.name;
        let uname = upper_snake(name);
        out.write_all(
            format!("    comp.register_compliance(&COMPLIANCE_{uname}, \"{name}\", false);\n")
                .as_bytes(),
        )?;
    }

    Ok(())
}

pub fn open_output(mib_name: &str, out_dir: &str) -> Result<fs::File, Error> {
    info!("MIB name is {mib_name}");
    let mut base_name = mib_name.split("-MIB").next().unwrap().to_lowercase();

    base_name = base_name.replace("-", "_");
    let stub_name = out_dir.to_owned() + &base_name + "_stub.rs";
    info!("Generated output would be in {stub_name}");
    let stub_ref = &stub_name;
    if fs::exists(stub_ref).is_ok() {
        info!("Overwriting stub {stub_ref}");
        //return Ok(());
    } else {
        info!("Writing new stub to {stub_ref}");
    }
    fs::File::create(stub_name)
}

pub fn gen_stub(
    object_types: &HashMap<&str, ObjectType>,
    resolve: resolver::Resolver,
    tcs: &HashMap<&str, TextConvention>,
    entries: &HashMap<&str, Entry>,
    object_ids: &[ObjectIdentity],
    mod_comps: &[ModuleCompliance],
    mut out: fs::File,
) -> Result<(), Error> {
    let stub_start = r"
use crate::config::ComplianceStatements;
use crate::keeper::{Access, OidErr, OidKeeper, OType};
use crate::scalar::ScalarMemOid;
use crate::table::TableMemOid;
use crate::oidmap::OidMap;
use crate::utils::*;
use crate::usm::User;
use rasn::types::ObjectIdentifier;

use rasn_snmp::v3::{VarBind, VarBindValue};
";

    out.write_all(stub_start.as_bytes())?;

    let names = ordered_names(object_types, &resolve);
    write_arcs(&mut out, object_ids, &resolve, &names, mod_comps)?;
    write_ot_structs(&mut out, object_types, tcs, entries, &names, &resolve)?;
    let ot = r"

pub fn load_stub(oid_map: &mut OidMap, comp: &mut ComplianceStatements) {
";
    out.write_all(ot.as_bytes())?;
    write_object_ids(&mut out, object_ids)?;
    write_object_types(&mut out, object_types, &names)?;
    write_module_compliances(&mut out, mod_comps)?;
    out.write_all(r"}".as_bytes())?;
    out.flush()?;
    Ok(())
}

pub fn loader(mib_files: Vec<String>) -> Result<(), Error> {
    //"""Write master loader to src/stubs.rs"""
    info!("Writing loader to src/stubs.rs {0:?}", mib_files);
    let mut src = fs::File::create("src/stubs.rs")?;
    let doc = b"//! Stub loader generated by stub-gen.
//!
//! Do not edit - it will be over-written next time you run stub-gen
";
    src.write_all(doc)?;
    src.write_all(b"use crate::oidmap::OidMap;\nuse crate::config::ComplianceStatements;\n\n")?;
    let mut stubs = vec![];
    for mib_name in &mib_files {
        let mut base_name = mib_name.split("-MIB").next().unwrap().to_lowercase();

        base_name = base_name.replace("-", "_");
        let stub_name = base_name + "_stub";
        stubs.push(stub_name);
    }
    for stub in &stubs {
        src.write_all(format!("mod {stub};\n").as_bytes())?;
    }
    // Shut clippy up in the case where no stubs are generated
    if mib_files.is_empty() {
        src.write_all(
        b"\n\n///Generated function to load all stubs\npub fn load_stubs(_oid_map: &mut OidMap, _comp: &mut ComplianceStatements) {\n",
    )?;
    } else {
        src.write_all(
        b"\n\n///Generated function to load all stubs\npub fn load_stubs(oid_map: &mut OidMap, comp: &mut ComplianceStatements) {\n",
    )?;
    }

    for stub in &stubs {
        src.write_all(format!("    {stub}::load_stub(oid_map, comp);\n").as_bytes())?;
    }
    src.write_all(b"}\n")?;
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::parser::{
        parse_entry, parse_mod_comp, parse_obj_type, parse_object_identity, parse_tc, MibNode,
        ParentNum,
    };
    use tempfile::tempfile;

    #[test]
    fn test_access_lookup() {
        let acc = access_lookup("read-only");
        assert_eq!(acc, "Access::ReadOnly");
        assert_eq!(access_lookup("miss"), "Access::NoAccess");
    }

    #[test]
    fn test_otype_lookup() {
        assert_eq!(name_otype("INTEGER"), "OType::Integer");
        assert_eq!(name_otype("miss"), "OType::ObjectId");
    }

    #[test]
    fn test_slasb() {
        assert_eq!(slash_b("text\nalso"), "// text\n// also\n");
    }

    #[test]
    fn test_lower_snake() {
        assert_eq!(lower_snake("camelCase"), "camel_case");
        assert_eq!(lower_snake("ABc"), "a_bc");
    }

    #[test]
    fn test_upper_snake() {
        assert_eq!(upper_snake("camelCase"), "CAMEL_CASE");
    }

    #[test]
    fn test_title() {
        assert_eq!(title("title"), "Title");
        assert_eq!(title(""), "");
    }

    #[test]
    fn test_value_from_syntax() {
        // fairly pointless, just check lookups work!
        for (syntax, val) in [
            ("OType::String", "simple_from_str(b\"b\")"),
            ("OType::ObjectId", "simple_from_vec(&[1, 3, 6, 1])"),
            ("OType::Counter", "counter_from_int(0)"),
            ("OType::BigCounter", "big_counter_from_int(0)"),
            ("OType::Ticks", "ticks_from_int(0)"),
            ("OType::Address", "address_from_vec([0, 0, 0, 0])"),
        ] {
            assert_eq!(value_from_syntax(syntax), val);
        }
    }

    #[test]
    fn test_lookup_int() {
        for (arg, syntax, val) in [
            ("27", "any_old-thing", "simple_from_int(27)"),
            (
                "mid",
                "
INTEGER {
low (1), -- too small
mid (2), -- nice
high (3)
    }
",
                "simple_from_int(2)",
            ),
            ("mid", "crazy", "simple_from_int(0)"),
        ] {
            assert_eq!(lookup_int_syntax(arg, syntax), val);
        }
    }

    #[test]
    fn test_ordered_names() {
        let mut res = resolver::Resolver::new();
        let mut obj_ty = HashMap::<&str, ObjectType>::new();
        res.try_add("a", "zeroDotZero", &[2u32]);
        res.try_add("b", "zeroDotZero", &[1u32]);
        res.try_add("c", "zeroDotZero", &[3u32]);
        let syntax = "syn";
        let units = "";
        let access = "acc";
        let status = "";
        let description = "";
        let reference = "";
        let index = "";
        let augments = "";
        let defval = "";
        let val = ParentNum {
            parent: "z",
            num: vec![1],
        };
        for name in ["a", "b"] {
            let o = ObjectType {
                name,
                syntax,
                units,
                access,
                status,
                description,
                reference,
                index,
                augments,
                defval,
                val: val.clone(),
                table: false,
                col: false,
            };
            obj_ty.insert(name, o);
        }
        assert_eq!(ordered_names(&obj_ty, &res), vec!["b", "a"]);
    }

    fn tcs_fixture() -> HashMap<&'static str, TextConvention<'static>> {
        let mut tcs = HashMap::<&str, TextConvention>::new();
        for tctext in [
            " Tca ::= TEXTUAL-CONVENTION
 STATUS current
 DESCRIPTION 
  \"blah\"
 SYNTAX INTEGER (0-255)
  ",
            "Tcb ::= TEXTUAL-CONVENTION
 STATUS current
 DESCRIPTION 
  \"blah\"
 SYNTAX OBJECT IDENTIFIER
  ",
        ] {
            let (_rest, node) = parse_tc(tctext).unwrap();
            if let MibNode::Tc(tc) = node {
                tcs.insert(tc.name, tc);
            }
        }
        tcs
    }

    #[test]
    fn test_fixdef() {
        let mut resolver = resolver::Resolver::new();
        resolver.try_add("a", "zeroDotZero", &[2u32]);
        let tcs = tcs_fixture();
        // tcs.insert("tca", TextConvention{name: "tca", hint: "", status: "current"});
        for (arg, syntax, val_ref) in [
            ("'text'H", "ignored", "simple_from_str(b\"text\")"),
            ("a", "RowPointer", "simple_from_vec(&[0, 0, 2])"),
            ("zeroDotZero", "RowPointer", "simple_from_vec(&[0, 0])"),
            ("'asdf'h", "DisplayString", "simple_from_str(b\"asdf\")"),
            ("a", "OBJECT IDENTIFIER", "simple_from_vec(&[0, 0, 2])"),
            (
                "zeroDotZero",
                "OBJECT IDENTIFIER",
                "simple_from_vec(&[0, 0])",
            ),
            (
                "snakeMe",
                "OBJECT IDENTIFIER",
                "simple_from_vec(&ARC_SNAKE_ME)",
            ),
            ("27", "Integer32", "simple_from_int(27)"),
            ("dummy", "BITS {a(0),\n b(1) }", "simple_from_str(b\"\0\")"),
            ("17", "Tca", "simple_from_int(17)"),
            ("a", "Tcb", "simple_from_vec(&[0, 0, 2])"),
        ] {
            let val = fix_def(arg, syntax, &tcs, &resolver);
            assert_eq!(val, val_ref);
        }
    }

    // Big question is how to check writing functions? Use temp file somewhere?
    fn object_id_fixture() -> Option<ObjectIdentity<'static>> {
        let (_, node) = parse_object_identity(
            "c OBJECT-IDENTITY
    STATUS  current
    DESCRIPTION
            \"The OID assigned to DNS MIB work by the IANA.\"
    ::= { b-2 32 }
",
        )
        .unwrap();
        if let MibNode::ObIdy(obj) = node {
            Some(obj)
        } else {
            None
        }
    }

    fn mod_comp_fixture() -> Option<ModuleCompliance<'static>> {
        let (_, node) = parse_mod_comp(
            "c MODULE-COMPLIANCE
      STATUS  current
      DESCRIPTION
          \"The compliance statement for systems supporting
          the Alarm MIB.\"
      MODULE -- this module
          MANDATORY-GROUPS {
           alarmActiveGroup,
           alarmModelGroup
          }
      GROUP       alarmActiveStatsGroup
       DESCRIPTION
           \"This group is optional.\"
   ::= { a 1 }
",
        )
        .unwrap();
        if let MibNode::ModCp(obj) = node {
            Some(obj)
        } else {
            None
        }
    }

    fn entry_fixture() -> Option<Entry<'static>> {
        let (_, node) = parse_entry(
            "AlarmModelEntry ::= SEQUENCE {
   alarmModelIndex                 Unsigned32,
   alarmModelState                 Unsigned32,
   alarmModelNotificationId        OBJECT IDENTIFIER,
   alarmModelVarbindIndex          Unsigned32,
   alarmModelVarbindValue          Integer32,
   alarmModelDescription           SnmpAdminString,
   alarmModelSpecificPointer       RowPointer,
   alarmModelVarbindSubtree        OBJECT IDENTIFIER,
   alarmModelResourcePrefix        OBJECT IDENTIFIER,
   alarmModelRowStatus             RowStatus
   }

",
        )
        .unwrap();
        if let MibNode::Ent(obj) = node {
            Some(obj)
        } else {
            None
        }
    }

    #[test]
    fn test_write_arcs() {
        let mut out = tempfile().unwrap(); // Checked #[test]
        let mut resolve = resolver::Resolver::new();

        resolve.try_add("a", "zeroDotZero", &[2u32]);
        resolve.try_add("b", "zeroDotZero", &[3u32]);
        resolve.try_add("c", "zeroDotZero", &[4u32]);
        let obj = object_id_fixture().unwrap(); // Checked #[test]
        let object_ids = vec![obj];
        let names = vec!["a"];
        let mod_comps = vec![mod_comp_fixture().unwrap()];
        let write_res = write_arcs(&mut out, &object_ids, &resolve, &names, &mod_comps);
        assert!(write_res.is_ok());
        let w2 = write_object_ids(&mut out, &object_ids);
        assert!(w2.is_ok());
        let w3 = write_module_compliances(&mut out, &mod_comps);
        assert!(w3.is_ok());
    }

    fn object_type_fixture() -> Option<ObjectType<'static>> {
        let (_, node) = parse_obj_type(
            "scal OBJECT-TYPE
    SYNTAX      DisplayString
    MAX-ACCESS  read-only
    STATUS      current
    DESCRIPTION
            \"The implementation identification string for the DNS
            server software in use on the system, for example;
            `FNS-2.1'\"
    ::= { dnsServConfig 1 }

",
        )
        .unwrap();
        if let MibNode::ObTy(obj) = node {
            Some(obj)
        } else {
            None
        }
    }
    #[test]
    fn test_write_scalar() {
        let mut out = tempfile().unwrap(); // Checked #[test]
        let mut resolve = resolver::Resolver::new();
        resolve.try_add("a", "zeroDotZero", &[2u32]);
        let tcs = tcs_fixture();
        let data = object_type_fixture().unwrap();
        let w = write_scalar_struct(&mut out, "scal", &data, &tcs);
        assert!(w.is_ok());
    }

    #[test]
    fn test_write_table() {
        let mut out = tempfile().unwrap(); // Checked #[test]
        let mut resolve = resolver::Resolver::new();
        resolve.try_add("a", "zeroDotZero", &[2u32]);
        let tcs = tcs_fixture();
        let data = object_type_fixture().unwrap();
        let mut otm = HashMap::<&str, ObjectType>::new();
        otm.insert("a", data.clone());
        let ent = vec![("a", "b")];
        let w = write_table_struct(&mut out, "scal", &otm, data, ent, &tcs, &resolve);
        assert!(w.is_ok());
    }

    #[test]
    fn test_write_ot_structs() {
        let mut out = tempfile().unwrap(); // Checked #[test]
        let mut resolve = resolver::Resolver::new();
        resolve.try_add("a", "zeroDotZero", &[2u32]);
        let tcs = tcs_fixture();
        let data = object_type_fixture().unwrap();
        let mut otm = HashMap::<&str, ObjectType>::new();
        otm.insert("a", data.clone());
        let mut ent = HashMap::<&str, Entry>::new();
        ent.insert("z", entry_fixture().unwrap());
        let w = write_ot_structs(&mut out, &otm, &tcs, &ent, &vec!["a"], &resolve);
        assert!(w.is_ok());
        let w2 = write_object_types(&mut out, &otm, &vec!["a"]);
        assert!(w2.is_ok());
    }
}