nbted 1.5.2

Command-line NBT editor
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

/// Various testing of the reading of files in the pretty text format into
/// binary NBT files. This is only used for testing abnormally formatted but
/// otherwise valid text files, and for testing failure states of the string
/// reading.
///
/// Testing of valid and regularly formatted files are conducted in the main
/// file with its "loops".
use std::io::Cursor;

use crate::data::NBTFile;
use crate::Result;

/// Convenience method
fn try_parse_string(original: &str) -> Result<NBTFile> {
    let mut cursor = Cursor::new(original.as_bytes());
    crate::string_read::read_file(&mut cursor)
}

fn try_parse_string_get_err_msg(original: &str) -> String {
    let err = match try_parse_string(original) {
        Ok(_) => {
            panic!("try_parse_string_get_err_msg test expected the file to be Err but it was Ok")
        }
        Err(e) => e,
    };
    format!("{:?}", err)
}

#[test]
fn empty_file() {
    let err_msg = try_parse_string_get_err_msg("   ");
    assert!(err_msg.contains("NBT file in text format does not contain any tags at all"));
}

#[test]
fn text_file_with_no_trailing_bytes() {
    /* I experienced an error with the new tokenizer where it would ignore the
     * last tag unless there was at least 1 byte following it */
    let _: NBTFile = try_parse_string("None End").unwrap();
}

#[test]
fn incomplete_string() {
    let err_msg = try_parse_string_get_err_msg(
        r#"None Compound "A quotation mark at the end has been removed from this otherwise valid NBT file End End"#,
    );
    assert!(err_msg.contains("EOF when trying to read the name of a Compound tag in a compound"));
}

#[test]
fn escaped_unescapable_char() {
    let err_msg = try_parse_string_get_err_msg(r#"None Compound "\k" End End"#);
    assert!(err_msg.contains("Invalid string, tried to escape the character"));
}

#[test]
fn eof_when_reading() {
    let err_msg = try_parse_string_get_err_msg(r#"None Compound "" Short """#);
    assert!(err_msg.contains("EOF when trying to read a short"));
}

#[test]
fn invalid_int() {
    let err_msg = try_parse_string_get_err_msg(r#"Zlib Compound "" Int "" NotAnInt End End"#);
    assert!(err_msg.contains("Invalid Int NotAnInt"));
}

#[test]
fn invalid_tag_type() {
    let err_msg =
        try_parse_string_get_err_msg(r#"Gzip Compound "" List "" NotATagType 1 9 End End"#);
    assert!(err_msg.contains("Unknown tag type NotATagType"));
}

#[test]
fn long_array() {
    /* LongArray should compile */
    let _: NBTFile =
        try_parse_string(r#"None Compound "tag" Compound "BlockEntityTag" LongArray "Items" 0 String "id" "minecraft:shulker_box" End End End"#).unwrap();
}

#[test]
fn unquoted_string() {
    /* Since the rewrite of the tokenizer, strings without quotation marks have
     * become valid syntax. I'm not sure if I want to keep this valid or not,
     * so I'll leave it undocumented except for this test testing that they are
     * parsed */
    let _: NBTFile =
        try_parse_string(r#"None Compound ForgotQuotationMarksAroundThisString End End"#).unwrap();
}