dream-ini 0.2.0

Import Morrowind.ini settings into OpenMW configuration files
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

// SPDX-License-Identifier: GPL-3.0-only

use std::fs;

use crate::plugin::{apply_morrowind_expansion_order, dependency_sort};
use crate::test_support::{tes3_bytes, tes3_bytes_from_master_bytes, unique_test_dir};
use crate::{ImportError, PluginFormat, TextEncoding, read_plugin_header};

#[test]
fn dependency_sort_places_masters_before_dependents() {
    let sorted = dependency_sort(vec![
        ("Patch.esp".to_owned(), vec!["Base.esm".to_owned()]),
        ("Base.esm".to_owned(), vec![]),
    ]);
    assert_eq!(sorted, vec!["Base.esm".to_owned(), "Patch.esp".to_owned()]);
}

#[test]
fn applies_morrowind_expansion_order() {
    let mut files = vec![
        "Morrowind.esm".to_owned(),
        "Bloodmoon.esm".to_owned(),
        "Tribunal.esm".to_owned(),
    ];
    apply_morrowind_expansion_order(&mut files);
    assert_eq!(
        files,
        vec!["Morrowind.esm", "Tribunal.esm", "Bloodmoon.esm"]
    );
}

#[test]
fn reads_tes3_header_masters() {
    let dir = unique_test_dir("tes3-header");
    fs::create_dir_all(&dir).unwrap();
    let plugin = dir.join("Patch.esp");
    fs::write(&plugin, tes3_bytes(&["Morrowind.esm", "Tribunal.esm"])).unwrap();

    let header = read_plugin_header(&plugin, PluginFormat::Tes3, TextEncoding::Win1252).unwrap();

    assert_eq!(header.name, "Patch.esp");
    assert_eq!(header.masters, vec!["Morrowind.esm", "Tribunal.esm"]);
    fs::remove_dir_all(dir).unwrap();
}

#[test]
fn reads_tes3_header_masters_with_selected_encoding() {
    let dir = unique_test_dir("tes3-header-encoding");
    fs::create_dir_all(&dir).unwrap();
    let plugin = dir.join("Patch.esp");
    fs::write(&plugin, tes3_bytes_from_master_bytes(&[b"caf\xe9.esm"])).unwrap();

    let header = read_plugin_header(&plugin, PluginFormat::Tes3, TextEncoding::Win1252).unwrap();

    assert_eq!(header.masters, vec!["caf\u{e9}.esm"]);
    fs::remove_dir_all(dir).unwrap();
}

#[test]
fn rejects_invalid_tes3_header() {
    let dir = unique_test_dir("tes3-invalid");
    fs::create_dir_all(&dir).unwrap();
    let plugin = dir.join("Bad.esp");
    fs::write(&plugin, b"TES4").unwrap();

    let error = read_plugin_header(&plugin, PluginFormat::Tes3, TextEncoding::Win1252).unwrap_err();
    assert!(matches!(error, ImportError::InvalidPluginHeader { .. }));
    fs::remove_dir_all(dir).unwrap();
}

#[test]
fn rejects_truncated_tes3_record() {
    let dir = unique_test_dir("tes3-truncated-record");
    fs::create_dir_all(&dir).unwrap();
    let plugin = dir.join("Bad.esp");
    let mut bytes = Vec::new();
    bytes.extend_from_slice(b"TES3");
    bytes.extend_from_slice(&8u32.to_le_bytes());
    bytes.extend_from_slice(&0u32.to_le_bytes());
    bytes.extend_from_slice(&0u32.to_le_bytes());
    fs::write(&plugin, bytes).unwrap();

    let error = read_plugin_header(&plugin, PluginFormat::Tes3, TextEncoding::Win1252)
        .unwrap_err()
        .to_string();
    assert!(error.contains("TES3 record extends past end of file"));
    fs::remove_dir_all(dir).unwrap();
}

#[test]
fn rejects_truncated_tes3_subrecord() {
    let dir = unique_test_dir("tes3-truncated-subrecord");
    fs::create_dir_all(&dir).unwrap();
    let plugin = dir.join("Bad.esp");
    let mut record = Vec::new();
    record.extend_from_slice(b"MAST");
    record.extend_from_slice(&8u32.to_le_bytes());
    record.extend_from_slice(b"short");
    let mut bytes = Vec::new();
    bytes.extend_from_slice(b"TES3");
    bytes.extend_from_slice(&u32::try_from(record.len()).unwrap().to_le_bytes());
    bytes.extend_from_slice(&0u32.to_le_bytes());
    bytes.extend_from_slice(&0u32.to_le_bytes());
    bytes.extend_from_slice(&record);
    fs::write(&plugin, bytes).unwrap();

    let error = read_plugin_header(&plugin, PluginFormat::Tes3, TextEncoding::Win1252)
        .unwrap_err()
        .to_string();
    assert!(error.contains("subrecord extends past TES3 record"));
    fs::remove_dir_all(dir).unwrap();
}

#[test]
fn rejects_truncated_non_master_tes3_subrecord_data() {
    let dir = unique_test_dir("tes3-truncated-non-master-data");
    fs::create_dir_all(&dir).unwrap();
    let plugin = dir.join("Bad.esp");
    let mut record = Vec::new();
    record.extend_from_slice(b"HEDR");
    record.extend_from_slice(&300u32.to_le_bytes());
    record.extend_from_slice(&[0; 8]);
    let mut bytes = Vec::new();
    bytes.extend_from_slice(b"TES3");
    bytes.extend_from_slice(&308u32.to_le_bytes());
    bytes.extend_from_slice(&0u32.to_le_bytes());
    bytes.extend_from_slice(&0u32.to_le_bytes());
    bytes.extend_from_slice(&record);
    fs::write(&plugin, bytes).unwrap();

    let error = read_plugin_header(&plugin, PluginFormat::Tes3, TextEncoding::Win1252)
        .unwrap_err()
        .to_string();
    assert!(error.contains("TES3 record extends past end of file"));
    fs::remove_dir_all(dir).unwrap();
}