hocon-parser 1.10.0

Full Lightbend HOCON specification-compliant parser for Rust
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

//! Cross-impl fix for go.hocon#105 — empty / whitespace-only / comment-only /
//! BOM-only INCLUDED files contribute an empty config. Originally a narrow
//! include-path carve-out while top-level parses still rejected; since the
//! S3.1 correction (xx.hocon E10, 2026-07-23) the same rule applies
//! everywhere — an empty document parses to `{}` at top level too
//! (HOCON.md §Omit root braces L134-136).

use tempfile::tempdir;

#[test]
fn issue105_zero_byte_include_is_noop() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    std::fs::write(dir.path().join("empty.conf"), "").unwrap();
    let input = format!("include \"{}/empty.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
}

#[test]
fn issue105_hash_comment_only_include_is_noop() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    std::fs::write(dir.path().join("c.conf"), "# only a comment\n# another\n").unwrap();
    let input = format!("include \"{}/c.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
}

#[test]
fn issue105_slash_comment_only_include_is_noop() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    std::fs::write(dir.path().join("c.conf"), "// only a comment\n").unwrap();
    let input = format!("include \"{}/c.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
}

#[test]
fn issue105_whitespace_only_include_is_noop() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    std::fs::write(dir.path().join("ws.conf"), "   \n\t\n\n").unwrap();
    let input = format!("include \"{}/ws.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
}

#[test]
fn issue105_unicode_whitespace_only_include_is_noop() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    // NBSP (U+00A0) + en-quad (U+2000) + line separator (U+2028) + LF
    std::fs::write(dir.path().join("uws.conf"), "\u{A0}\u{2000}\u{2028}\n").unwrap();
    let input = format!("include \"{}/uws.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
}

#[test]
fn issue105_bom_only_include_is_noop() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    // UTF-8 BOM bytes + newline
    std::fs::write(dir.path().join("bom.conf"), [0xEF, 0xBB, 0xBF, b'\n']).unwrap();
    let input = format!("include \"{}/bom.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
}

#[test]
fn issue105_top_level_empty_parses_to_empty_object() {
    // Corrected S3.1: top-level parity with the include path — an empty
    // document parses to {} everywhere (xx.hocon E10).
    for (input, label) in [
        ("", "empty"),
        ("   \n\t  ", "whitespace-only"),
        ("# only a comment\n", "hash-comment-only"),
        ("// only a comment\n", "slash-comment-only"),
    ] {
        let cfg = hocon::parse(input).unwrap_or_else(|e| {
            panic!(
                "{} top-level must parse to {{}} per corrected S3.1, got error: {}",
                label, e
            )
        });
        let keys = cfg.keys();
        assert!(
            keys.is_empty(),
            "{} top-level must produce an empty config, got keys {:?}",
            label,
            keys
        );
    }
}

#[test]
fn issue105_non_empty_include_still_parses() {
    let dir = tempdir().unwrap();
    let dir_str = dir.path().display().to_string().replace('\\', "/");
    std::fs::write(dir.path().join("c.conf"), "# leading\nb = 2\n# trailing\n").unwrap();
    let input = format!("include \"{}/c.conf\"\na = 1\n", dir_str);
    let cfg = hocon::parse(&input).unwrap();
    assert_eq!(cfg.get_i64("a").unwrap(), 1);
    assert_eq!(cfg.get_i64("b").unwrap(), 2);
}