nparse 0.0.10

Parser in rust for specific use-cases
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

mod dotted_tree_document;
mod indent_document;
mod kev_str_document;
mod kv_str_document;
mod multiline_kv_str_document;

use serde_json::Value;

pub trait IndentToJson {
    fn indent_to_json(&self) -> Result<Value, String>;
}

impl IndentToJson for String {
    fn indent_to_json(&self) -> Result<Value, String> {
        //! Convert a well Indented String to a Json Document
        //!
        //! ## Example usage
        //!
        //! ```
        //! use std::{fs::File, io::Read};
        //! use nparse::IndentToJson;
        //!
        //! let path = "data/dmidecode.txt";
        //! let mut out = String::new();
        //! {
        //!     let mut f = File::open(path).unwrap();
        //!     f.read_to_string(&mut out).unwrap();
        //! }
        //! let result = out.indent_to_json();
        //! println!("{:#?}", result.unwrap());
        //! ```
        let s = self.to_string() + "\n"; // adding a `\n` for safe parsing
        let doc = indent_document::parse_indent_string(&s);
        match doc {
            Ok(res) => Ok(res.1),
            Err(e) => Err(e.to_string()),
        }
    }
}

pub trait KVStrToJson {
    fn kv_str_to_json(&self) -> Result<Value, String>;
}

impl KVStrToJson for String {
    fn kv_str_to_json(&self) -> Result<Value, String> {
        //! Convert a Key Value String into a Json Document
        //!
        //! ## Example usage
        //!
        //! ```
        //! use std::{fs::File, io::Read};
        //! use nparse::KVStrToJson;
        //!
        //!let path = "data/lscpu.txt";
        //!let mut out = String::new();
        //!{
        //!    let mut f = File::open(path).unwrap();
        //!    f.read_to_string(&mut out).unwrap();
        //!}
        //!let result = out.kv_str_to_json();
        //!println!("{:#?}", result.unwrap());
        //! ```
        let doc = kv_str_document::parse_kv_str_string(self);
        match doc {
            Ok(res) => Ok(res.1),
            Err(e) => Err(e.to_string()),
        }
    }
}

pub trait MultilineKVStrToJson {
    fn multiline_kv_str_to_json(&self) -> Result<Value, String>;
}

impl MultilineKVStrToJson for String {
    fn multiline_kv_str_to_json(&self) -> Result<Value, String> {
        //! Convert a Key Value String into a Json Document
        //!
        //! ## Example usage
        //!
        //! ```
        //! use std::{fs::File, io::Read};
        //! use nparse::MultilineKVStrToJson;
        //!
        //!let path = "data/win-systeminfo.txt";
        //!let mut out = String::new();
        //!{
        //!    let mut f = File::open(path).unwrap();
        //!    f.read_to_string(&mut out).unwrap();
        //!}
        //!let result = out.multiline_kv_str_to_json();
        //!println!("{:#?}", result.unwrap());
        //! ```
        let doc = multiline_kv_str_document::parse_multiline_kv_str(self);
        match doc {
            Ok(res) => Ok(res),
            Err(e) => Err(e.to_string()),
        }
    }
}

pub trait DottedTreeToJson {
    fn dotted_tree_to_json(&self) -> Result<Value, String>;
}

impl DottedTreeToJson for String {
    fn dotted_tree_to_json(&self) -> Result<Value, String> {
        //! Convert a dotted tree String into a Json Document
        //!
        //! ## Example usage
        //!
        //! ```
        //! use std::{fs::File, io::Read};
        //! use nparse::DottedTreeToJson;
        //!
        //!let path = "data/sysctl.txt";
        //!let mut out = String::new();
        //!{
        //!    let mut f = File::open(path).unwrap();
        //!    f.read_to_string(&mut out).unwrap();
        //!}
        //!let result = out.dotted_tree_to_json();
        //!println!("{:#?}", result.unwrap());
        //! ```
        dotted_tree_document::parse_doted_tree(self)
    }
}

pub trait KEVStrToJson {
    fn kev_str_to_json(&self) -> Result<Value, String>;
}

impl KEVStrToJson for String {
    fn kev_str_to_json(&self) -> Result<Value, String> {
        //! Convert a dotted tree String into a Json Document
        //!
        //! ## Example usage
        //!
        //! ```
        //! use std::{fs::File, io::Read};
        //! use nparse::KEVStrToJson;
        //!
        //!let path = "data/os-release.txt";
        //!let mut out = String::new();
        //!{
        //!   let mut f = File::open(path).unwrap();
        //!   f.read_to_string(&mut out).unwrap();
        //!}
        //!let result = out.kev_str_to_json();
        //!println!("{:#?}", result.unwrap());
        //! ```
        let res = kev_str_document::parse_kev_str_string(self);
        match res {
            Ok(res) => Ok(res.1),
            Err(e) => Err(e.to_string()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::{fs::File, io::Read};

    fn read(path: &str) -> String {
        let mut out = String::new();
        {
            let mut f = File::open(path).unwrap();
            f.read_to_string(&mut out).unwrap();
        }
        out
    }

    #[test]
    fn test_indent_document() {
        let out = read("data/indent_test.txt");
        let result = out.indent_to_json();
        assert!(result.is_ok());

        let v = result.unwrap();
        let v = v.as_array().unwrap().iter().nth(1).unwrap();
        let parent = v.get("parent");
        assert!(parent.is_some());

        let child = parent.unwrap().as_object();
        assert!(child.is_some());

        let grand_children = child.unwrap().get("child");
        assert!(grand_children.is_some());
        let children = grand_children.unwrap().as_array().unwrap();
        assert_eq!(children.len(), 2);

        let child_name = children.iter().nth(0);
        assert!(child_name.is_some());
        assert_eq!(child_name.unwrap(), "grandchild1");
    }

    #[test]
    fn test_dmidecode_indent_document() {
        let out = read("data/dmidecode.txt");
        let result = out.indent_to_json();
        assert!(result.is_ok());

        let v = result.unwrap();
        let v = v.as_object();
        assert!(v.is_some());

        let bios_info = v.unwrap().get("BIOS Information");
        assert!(bios_info.is_some());

        let vendor_info = bios_info.unwrap().get("Vendor");
        assert!(vendor_info.is_some());
        let val = vendor_info.unwrap().as_str().unwrap().trim();
        let excepted = "Phoenix Technologies LTD";
        assert_eq!(val, excepted);
    }

    #[test]
    fn test_lscpu_kv_document() {
        let out = read("data/lscpu.txt");
        let result = out.kv_str_to_json();
        assert!(result.is_ok());

        let result = result.unwrap();
        let result = result.as_object();
        assert!(result.is_some());

        let result = result.unwrap();

        let arch_val = result.get("Architecture");
        assert!(arch_val.is_some());
        assert_eq!(arch_val.unwrap(), "x86_64");

        let model_val = result.get("Model");
        assert!(model_val.is_some());
        assert_eq!(model_val.unwrap(), "142");
    }

    #[test]
    fn test_win_systeminfo_multiline_kv_document() {
        let out = read("data/win-systeminfo.txt");
        let result = out.multiline_kv_str_to_json();
        assert!(result.is_ok());
        let result = result.unwrap();
        assert!(result.is_object());
        let result = result.as_object();
        assert!(result.is_some());

        let result = result.unwrap();
        let owner = result.get("Registered Owner").unwrap().as_str().unwrap();
        assert_eq!(owner, "test-user");

        let processor = result.get("Processor(s)").unwrap().as_array();
        assert!(processor.is_some());
        let processor = processor.unwrap();
        let processor = processor
            .iter()
            .nth(0)
            .unwrap()
            .get("[01]")
            .unwrap()
            .as_str()
            .unwrap();
        assert_eq!(
            processor,
            "x64 Family 6 Model 142 Stepping 10 GenuineIntel ~2808 Mhz"
        );
    }

    #[test]
    fn test_sysctl_dotted_document() {
        let out = read("data/sysctl.txt");
        let result = out.dotted_tree_to_json();
        assert!(result.is_ok());

        let result = result.unwrap();
        let result = result.as_object();
        assert!(result.is_some());

        let result = result.unwrap();

        // get a random value from `user` key -> 2 levels deep
        let user_val = result.get("user");
        assert!(user_val.is_some());

        let user_sub_val = user_val.unwrap().as_object();
        assert!(user_sub_val.is_some());

        let user_sub_val = user_sub_val.unwrap().get("bc_base_max");
        assert!(user_sub_val.is_some());
        let val = user_sub_val.unwrap().as_str().unwrap();
        let excepted = "99";
        assert_eq!(val, excepted);

        // get a random value from `machdep` key -> 3 levels deep
        let machdep_val = result.get("machdep");
        assert!(machdep_val.is_some());

        let machdep_sub_val = machdep_val.unwrap().as_object();
        assert!(machdep_sub_val.is_some());

        let machdep_sub_val = machdep_sub_val.unwrap().get("cpu");
        assert!(machdep_sub_val.is_some());

        let machdep_sub_sub_val = machdep_sub_val.unwrap().as_object();
        assert!(machdep_sub_sub_val.is_some());

        let machdep_sub_sub_val = machdep_sub_sub_val.unwrap().get("vendor");
        assert!(machdep_sub_sub_val.is_some());

        let val = machdep_sub_sub_val.unwrap().as_str().unwrap().trim();
        let excepted = "GenuineIntel";
        assert_eq!(val, excepted);
    }

    #[test]
    fn test_os_release_kev_document() {
        let out = read("data/os-release.txt");
        let result = out.kev_str_to_json();
        assert!(result.is_ok());

        let result = result.unwrap();
        let result = result.as_object();
        assert!(result.is_some());

        let result = result.unwrap();

        let version = result.get("VERSION");
        assert!(version.is_some());
        assert_eq!(version.unwrap(), "12 (bookworm)");

        let bug_report_url = result.get("BUG_REPORT_URL");
        assert!(bug_report_url.is_some());
        assert_eq!(bug_report_url.unwrap(), "https://bugs.debian.org/");
    }
}