loggit 0.1.9

Loggit is a lightweight, easy-to-use logging library 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
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

//! Comprehensive tests for `logger::from_file_config::read_from_env_file`
//! covering every supported key (valid & invalid cases) and verifying the
//! effect on the global `CONFIG`.
//!
//! Add `mod from_file_config;` to `src/tests/mod.rs` to include these.

// TODO: rewrite for the new system

use std::{
    fs::{self, File},
    io::Write,
    path::PathBuf,
    time::{SystemTime, UNIX_EPOCH},
};

use crate::{
    logger::{init, load_config_from_file, set_errors::ReadFromConfigFileError},
    Level, CONFIG,
};

use crate::logger::formatter::LogFormatter;

/// Writes `contents` to a unique temporary file and returns its [`PathBuf`].
fn temp_env_file(contents: &str) -> PathBuf {
    let mut path = std::env::temp_dir();
    let ts = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap()
        .as_secs();
    path.push(format!("loggit_env_test_{}.env", ts));

    let mut file = File::create(&path).expect("failed to create temp env‑file");
    write!(file, "{}", contents).expect("failed to write temp env‑file");
    path
}

/// Helper that returns a cloned snapshot of CONFIG after acquiring a read lock.
fn config_snapshot() -> crate::Config {
    CONFIG.read().expect("CONFIG should be initialised").clone()
}

#[test]
fn env_enabled_variants() {
    // enabled=false → DisabledToBeUsed
    init();
    let p = temp_env_file("enabled=false\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::DisabledToBeUsed)
    ));
    fs::remove_file(p).ok();

    // enabled missing (not set) should simply work (Ok)
    init();
    let p = temp_env_file("level=info\n");
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());
    fs::remove_file(p).ok();

    // enabled=invalid → IncorrectValue
    init();
    let p = temp_env_file("enabled=maybe\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(res, Err(ReadFromConfigFileError::ParseError(_))));
    fs::remove_file(p).ok();
}

#[test]
fn env_all_levels_valid() {
    let cases = [
        ("trace", Level::TRACE),
        ("debug", Level::DEBUG),
        ("info", Level::INFO),
        ("warn", Level::WARN),
        ("error", Level::ERROR),
    ];

    for (lvl_str, lvl_enum) in cases {
        init();
        let p = temp_env_file(&format!("enabled=true\nlevel={}\n", lvl_str));
        assert!(load_config_from_file(p.to_str().unwrap()).is_ok());
        let cfg = config_snapshot();
        assert_eq!(cfg.level, lvl_enum, "level `{}` not applied", lvl_str);
        fs::remove_file(p).ok();
    }

    // invalid level value
    init();
    let p = temp_env_file("level=verbose\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(res, Err(ReadFromConfigFileError::ParseError(_))));
    fs::remove_file(p).ok();
}

#[test]
fn env_print_to_terminal_variants() {
    // true
    init();
    let p = temp_env_file("print_to_terminal=true\n");
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());
    assert!(config_snapshot().print_to_terminal);
    fs::remove_file(p).ok();

    // false
    init();
    let p = temp_env_file("print_to_terminal=false\n");
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());
    assert!(!config_snapshot().print_to_terminal);
    fs::remove_file(p).ok();

    // invalid → IncorrectValue
    init();
    let p = temp_env_file("print_to_terminal=nope\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(res, Err(ReadFromConfigFileError::ParseError(_))));
    fs::remove_file(p).ok();
}

#[test]
fn env_colorized_variants() {
    // true
    init();
    let p = temp_env_file("colorized=true\n");
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());
    assert!(config_snapshot().colorized);
    fs::remove_file(p).ok();

    // false
    init();
    let p = temp_env_file("colorized=false\n");
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());
    assert!(!config_snapshot().colorized);
    fs::remove_file(p).ok();

    // invalid
    init();
    let p = temp_env_file("colorized=rainbow\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(res, Err(ReadFromConfigFileError::ParseError(_))));
    fs::remove_file(p).ok();
}

#[test]
fn env_global_formatting_ok_and_bad() {
    // Valid global formatting – should update every level formatter
    init();
    let fmt_txt = "[{level}] {message}";
    let p = temp_env_file(&format!("global_formatting=\"{}\"\n", fmt_txt));
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());

    let cfg = config_snapshot();
    let expected = LogFormatter::parse_from_string(fmt_txt).unwrap();
    assert_eq!(cfg.trace_log_format.parts, expected.parts);
    assert_eq!(cfg.debug_log_format.parts, expected.parts);
    assert_eq!(cfg.error_log_format.parts, expected.parts);
    fs::remove_file(p).ok();

    // Invalid formatting – unmatched brackets → SetLevelFormatting error
    init();
    let bad_fmt = "<red>[{level}]"; // missing closing <red>
    let p = temp_env_file(&format!("global_formatting={}\n", bad_fmt));
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::SetLevelFormatting(_))
    ));
    fs::remove_file(p).ok();
}

#[test]
fn env_individual_level_formatting_invalid() {
    // invalid debug_formatting should surface the same SetLevelFormatting error
    init();
    let p = temp_env_file("debug_formatting=<blue>{message}\n"); // missing closing <blue>
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::SetLevelFormatting(_))
    ));
    fs::remove_file(p).ok();
}

#[test]
fn env_file_and_compression_and_rotations() {
    // Everything valid
    init();
    let p = temp_env_file(
        "file_name=app_{date}_{time}.txt\ncompression=zip\nrotations=\"1 day,500 MB,12:30\"\n",
    );
    assert!(load_config_from_file(p.to_str().unwrap()).is_ok());

    let cfg = config_snapshot();
    assert!(
        cfg.file_manager.is_some(),
        "file_manager should be configured"
    );
    let fm_dbg = format!("{:?}", cfg.file_manager.as_ref().unwrap());
    assert!(
        fm_dbg.contains("rotation: ["),
        "rotations should be present"
    );
    fs::remove_file(p).ok();
}

#[test]
fn env_file_invalid_format() {
    init();
    // forbidden character '<' inside file format
    let p = temp_env_file("file_name=bad<name>.txt\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(res, Err(ReadFromConfigFileError::SetFile(_))));
    fs::remove_file(p).ok();
}

#[test]
fn env_compression_without_file() {
    init();
    let p = temp_env_file("compression=zip\n"); // no file configured first
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::SetCompression(_))
    ));
    fs::remove_file(p).ok();
}

#[test]
fn env_invalid_compression_value() {
    init();
    // configure file properly, but give unsupported compression algorithm
    let p = temp_env_file("file_name=app_{date}.txt\ncompression=rar\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::SetCompression(_))
    ));
    fs::remove_file(p).ok();
}

#[test]
fn env_rotations_invalid() {
    init();
    let p = temp_env_file("file_name=app_{date}.txt\nrotations=invalid\n");
    let res = load_config_from_file(p.to_str().unwrap());
    assert!(matches!(res, Err(ReadFromConfigFileError::AddRotation(_))));
    fs::remove_file(p).ok();
}

#[test]
fn env_missing_file() {
    init();
    let bogus_path = "/no/such/path/to_env_file.loggit";
    let res = load_config_from_file(bogus_path);
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::IncorrectFileExtension)
    ));

    let bogus_path = "/no/such/path/to_env_file.env";
    let res = load_config_from_file(bogus_path);
    assert!(matches!(
        res,
        Err(ReadFromConfigFileError::ReadFileError(_))
    ));
}