nbt-sniffer 0.2.0

A command-line tool designed to scan Minecraft Java Edition world data.
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
pub mod aggregation;
pub mod builder;
pub mod item_conversion;
pub mod json_printer;
pub mod structures;
pub mod table_printer;

use std::collections::HashMap;

use crate::{
    cli::{CliArgs, OutputFormat},
    counter::{Counter, CounterMap},
};
use aggregation::{AggregationResult, IsEmpty};
use serde::Serialize;
use serde_json::json;

use builder::generate_report_data;
use item_conversion::{to_detailed_item_entries, to_id_item_entries, to_nbt_item_entries};
use json_printer::print_json_output;
use table_printer::{
    print_detailed_counter, print_id_map, print_nbt_counter, print_report_as_tables,
};

/// Generic helper to generate and output a report based on the view mode.
fn generate_and_output_report<TAggregable, FConvert, FPrintTable, TReportItem>(
    counter_map: &CounterMap,
    args: &CliArgs,
    item_converter: FConvert,
    table_printer: FPrintTable,
    grand_total_calculator: impl Fn(&TAggregable) -> u64,
) where
    TAggregable: aggregation::Aggregable,
    FConvert: Fn(&TAggregable) -> Vec<TReportItem>,
    FPrintTable: FnMut(&[TReportItem]),
    TReportItem: Serialize + Clone,
{
    let data_provider = AggregationResult::<TAggregable>::new(counter_map);
    let grand_total_numeric_count = grand_total_calculator(&data_provider.total_combined);

    let report_data = generate_report_data(
        &data_provider,
        args,
        item_converter,
        grand_total_numeric_count,
    );

    if args.format.is_json() {
        let json_value = serde_json::to_value(&report_data).unwrap_or_else(|e| {
            eprintln!("Error serializing report to JSON: {e}");
            json!({ "error": format!("Failed to serialize report: {e}") })
        });
        print_json_output(&json_value, args.format == OutputFormat::PrettyJson);
    } else {
        print_report_as_tables(&report_data, args, table_printer);
    }
}

pub fn view_detailed(counter_map: &CounterMap, args: &CliArgs) {
    generate_and_output_report(
        counter_map,
        args,
        to_detailed_item_entries,
        print_detailed_counter,
        |counter: &Counter| counter.total(),
    );
}

pub fn view_by_nbt(counter_map: &CounterMap, args: &CliArgs) {
    generate_and_output_report(
        counter_map,
        args,
        to_nbt_item_entries,
        print_nbt_counter,
        |counter: &Counter| counter.total(),
    );
}

pub fn view_by_id(counter_map: &CounterMap, args: &CliArgs) {
    generate_and_output_report(
        counter_map,
        args,
        to_id_item_entries,
        print_id_map,
        |map: &HashMap<String, u64>| map.values().sum(),
    );
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        DataType, Scope,
        cli::{CliArgs, OutputFormat, ViewMode},
        counter::{Counter, CounterMap},
        view::aggregation::SummaryDataProvider,
    };
    use std::{collections::HashMap, path::PathBuf};
    use valence_nbt::Value;

    fn nbt_val(s: &str) -> Value {
        valence_nbt::snbt::from_snbt_str(s).expect("Failed to parse SNBT for test")
    }

    fn create_sample_counter_map() -> CounterMap {
        let mut map = CounterMap::new();

        let scope_ow_be = Scope {
            dimension: "overworld".to_string(),
            data_type: DataType::BlockEntity,
        };
        let mut counter_ow_be = Counter::new();
        counter_ow_be.add("minecraft:chest".to_string(), None, 10);
        counter_ow_be.add("minecraft:furnace".to_string(), None, 5);
        map.merge_scope(scope_ow_be, &counter_ow_be);

        let scope_ow_e = Scope {
            dimension: "overworld".to_string(),
            data_type: DataType::Entity,
        };
        let mut counter_ow_e = Counter::new();
        let nbt_damaged_sword = nbt_val("{components:{\"minecraft:damage\":50}}");
        counter_ow_e.add(
            "minecraft:iron_sword".to_string(),
            Some(&nbt_damaged_sword),
            5,
        );
        counter_ow_e.add("minecraft:rotten_flesh".to_string(), None, 15);
        map.merge_scope(scope_ow_e, &counter_ow_e);

        let scope_nether_be = Scope {
            dimension: "nether".to_string(),
            data_type: DataType::BlockEntity,
        };
        let mut counter_nether_be = Counter::new();
        counter_nether_be.add("minecraft:chest".to_string(), None, 3);
        map.merge_scope(scope_nether_be, &counter_nether_be);

        let scope_player = Scope {
            dimension: "playerdata".to_string(),
            data_type: DataType::Player,
        };
        let mut counter_player = Counter::new();
        counter_player.add("minecraft:diamond_sword".to_string(), None, 1);
        let nbt_ender_pearls_comp =
            nbt_val("{components:{\"minecraft:custom_data\":{stack_size:16}}}");
        counter_player.add(
            "minecraft:ender_pearl".to_string(),
            Some(&nbt_ender_pearls_comp),
            1,
        );
        map.merge_scope(scope_player, &counter_player);

        map
    }

    #[test]
    fn test_aggregation_result_counter_new() {
        let counter_map = create_sample_counter_map();
        let agg_data = AggregationResult::<Counter>::new(&counter_map);

        assert_eq!(agg_data.grouped.len(), 3);
        assert_eq!(
            agg_data.total_combined.total(),
            (10 + 5) + (5 + 15) + 3 + (1 + 1) // 15 + 20 + 3 + 2 = 40
        );
    }

    #[test]
    fn test_aggregation_result_id_counts_new() {
        let counter_map = create_sample_counter_map();
        let agg_id_data = AggregationResult::<HashMap<String, u64>>::new(&counter_map);
        assert_eq!(
            agg_id_data.total_combined.values().sum::<u64>(),
            13 + 5 + 5 + 15 + 1 + 1 // chest(10+3) + furnace(5) + iron_sword(5) + rotten_flesh(15) + diamond_sword(1) + ender_pearl(1)
        );
    }

    fn mock_cli_args() -> CliArgs {
        CliArgs {
            world_path: PathBuf::from("dummy"),
            all: true,
            items: vec![],
            view: ViewMode::ById,
            show_nbt: false,
            per_source_summary: false,
            per_dimension_summary: false,
            per_data_type_summary: false,
            verbose: false,
            format: OutputFormat::Table,
        }
    }

    #[test]
    fn test_print_report_as_tables_logic() {
        let counter_map = create_sample_counter_map();
        let mut args = mock_cli_args();
        args.view = ViewMode::ById;

        let data_provider = AggregationResult::<HashMap<String, u64>>::new(&counter_map);
        let mut printed_labels_counts: HashMap<String, usize> = HashMap::new();

        // Case 1: No dimension/type flags
        let report_data_case1 = generate_report_data(
            &data_provider,
            &args,
            to_id_item_entries,
            data_provider.get_total_combined_summary().values().sum(),
        );
        print_report_as_tables(&report_data_case1, &args, |items| {
            if !items.is_empty() {
                *printed_labels_counts
                    .entry("section_processed_case1".to_string())
                    .or_insert(0) += 1;
            }
        });
        assert_eq!(
            printed_labels_counts.get("section_processed_case1"),
            Some(&1) // Only grand total
        );
        printed_labels_counts.clear();

        // Case 2: Per dimension only
        args.per_dimension_summary = true;
        let report_data_case2 = generate_report_data(
            &data_provider,
            &args,
            to_id_item_entries,
            data_provider.get_total_combined_summary().values().sum(),
        );
        print_report_as_tables(&report_data_case2, &args, |items| {
            if !items.is_empty() {
                *printed_labels_counts
                    .entry("section_processed_case2".to_string())
                    .or_insert(0) += 1;
            }
        });
        assert_eq!(
            printed_labels_counts.get("section_processed_case2"),
            Some(&4) // 3 dimensions + grand total
        );
        printed_labels_counts.clear();
        args.per_dimension_summary = false;

        // Case 3: Per data type only
        args.per_data_type_summary = true;
        let report_data_case3 = generate_report_data(
            &data_provider,
            &args,
            to_id_item_entries,
            data_provider.get_total_combined_summary().values().sum(),
        );
        print_report_as_tables(&report_data_case3, &args, |items| {
            if !items.is_empty() {
                *printed_labels_counts
                    .entry("section_processed_case3".to_string())
                    .or_insert(0) += 1;
            }
        });
        assert_eq!(
            printed_labels_counts.get("section_processed_case3"),
            Some(&4) // 3 data types + grand total
        );
        printed_labels_counts.clear();
        args.per_data_type_summary = false;

        // Case 4: Both per dimension and per data type
        args.per_dimension_summary = true;
        args.per_data_type_summary = true;
        let report_data_case4 = generate_report_data(
            &data_provider,
            &args,
            to_id_item_entries,
            data_provider.get_total_combined_summary().values().sum(),
        );
        print_report_as_tables(&report_data_case4, &args, |items| {
            if !items.is_empty() {
                *printed_labels_counts
                    .entry("section_processed_case4".to_string())
                    .or_insert(0) += 1;
            }
        });
        assert_eq!(
            printed_labels_counts.get("section_processed_case4"),
            Some(&11)
        );
    }

    #[test]
    fn test_json_report_serialization_structure_detailed_view_no_flags() {
        let counter_map = create_sample_counter_map();
        let mut args = mock_cli_args();
        args.format = OutputFormat::Json;
        args.view = ViewMode::Detailed;

        let grand_total_numeric_count = counter_map.combined().total();
        let data_provider = AggregationResult::<Counter>::new(&counter_map);

        let report_data = generate_report_data(
            &data_provider,
            &args,
            to_detailed_item_entries,
            grand_total_numeric_count,
        );

        let json_value = serde_json::to_value(&report_data).unwrap();

        assert!(json_value.is_object());
        let obj = json_value.as_object().unwrap();
        assert!(obj.get("per_dimension_summary").is_none());
        assert!(obj.get("per_data_type_summary").is_none());
        assert!(obj.get("per_dimension_detail").is_none());
        assert!(obj.get("grand_total").is_some());
        assert_eq!(
            obj.get("grand_total_count"),
            Some(&json!(grand_total_numeric_count))
        );

        let grand_total_arr = obj.get("grand_total").unwrap().as_array().unwrap();
        let expected_distinct_items_in_grand_total = data_provider
            .get_total_combined_summary()
            .detailed_counts()
            .len();
        assert_eq!(
            grand_total_arr.len(),
            expected_distinct_items_in_grand_total,
            "Grand total array length mismatch"
        );

        let mut iron_sword_found_and_checked = false;
        let mut rotten_flesh_found_and_checked = false;

        for item_value in grand_total_arr {
            let item_obj = item_value.as_object().unwrap();
            assert!(item_obj.contains_key("count"), "Item missing 'count' field");
            assert!(item_obj.contains_key("id"), "Item missing 'id' field");

            let id = item_obj.get("id").unwrap().as_str().unwrap();
            if id == "minecraft:iron_sword" {
                // This item has NBT in sample data
                assert!(
                    item_obj.contains_key("nbt"),
                    "Iron sword should have NBT field"
                );
                assert!(
                    item_obj.get("nbt").unwrap().is_string(),
                    "Iron sword NBT should be a string"
                );
                iron_sword_found_and_checked = true;
            } else if id == "minecraft:rotten_flesh" {
                // This item does not have NBT
                assert!(
                    !item_obj.contains_key("nbt"),
                    "Rotten flesh should not have NBT field"
                );
                rotten_flesh_found_and_checked = true;
            }
        }
        assert!(
            iron_sword_found_and_checked,
            "Iron sword with NBT not found or checked in grand total"
        );
        assert!(
            rotten_flesh_found_and_checked,
            "Rotten flesh without NBT not found or checked in grand total"
        );
    }

    #[test]
    fn test_json_report_serialization_structure_by_id_view_all_flags() {
        let counter_map = create_sample_counter_map();
        let mut args = mock_cli_args();
        args.format = OutputFormat::Json;
        args.view = ViewMode::ById;
        args.per_dimension_summary = true;
        args.per_data_type_summary = true;

        let data_provider = AggregationResult::<HashMap<String, u64>>::new(&counter_map);
        let grand_total_numeric_count = data_provider.get_total_combined_summary().values().sum();

        let report_data = generate_report_data(
            &data_provider,
            &args,
            to_id_item_entries,
            grand_total_numeric_count,
        );
        let json_value = serde_json::to_value(&report_data).unwrap();

        assert!(json_value.is_object());
        let obj = json_value.as_object().unwrap();
        assert!(obj.get("per_dimension_summary").is_some());
        assert!(obj.get("per_data_type_summary").is_some());
        assert!(obj.get("per_dimension_detail").is_some());
        assert!(obj.get("grand_total").is_some());
        assert_eq!(
            obj.get("grand_total_count"),
            Some(&json!(grand_total_numeric_count))
        );

        let per_dim = obj
            .get("per_dimension_summary")
            .unwrap()
            .as_object()
            .unwrap();
        assert!(per_dim.contains_key("overworld"));
        let overworld_summary = per_dim.get("overworld").unwrap().as_array().unwrap();
        if !overworld_summary.is_empty() {
            let first_item = overworld_summary[0].as_object().unwrap();
            assert!(first_item.contains_key("count"));
            assert!(first_item.contains_key("id"));
            assert!(!first_item.contains_key("nbt")); // ById view doesn't have NBT in items
        }

        // Check that per_data_type_summary keys are serialized as strings by serde_json
        let per_type_summary = obj
            .get("per_data_type_summary")
            .unwrap()
            .as_object()
            .unwrap();
        assert!(per_type_summary.contains_key("BlockEntity")); // strum::Display is "Block Entity", but serde_json uses variant name for enum keys
        assert!(per_type_summary.contains_key("Entity"));
        assert!(per_type_summary.contains_key("Player"));
    }
}