Skip to main content

rns_git/
logging.rs

1use std::fs::{self, OpenOptions};
2use std::path::Path;
3
4use crate::{Error, Result};
5
6pub const DEFAULT_LOG_LEVEL: u8 = 4;
7
8pub fn init_file_logger(path: &Path, log_level: u8) -> Result<()> {
9    if let Some(parent) = path.parent() {
10        fs::create_dir_all(parent)?;
11    }
12    let file = OpenOptions::new().create(true).append(true).open(path)?;
13    let filter = rns_net::logging::numeric_log_filter(log_level);
14    let mut builder = env_logger::Builder::new();
15    builder
16        .filter_level(filter.default)
17        .filter_module(rns_net::logging::PATHING_LOG_TARGET, filter.pathing)
18        .format_timestamp_secs()
19        .target(env_logger::Target::Pipe(Box::new(file)));
20    builder
21        .try_init()
22        .map_err(|err| Error::msg(format!("failed to initialize logging: {err}")))
23}
24
25pub fn level_filter(log_level: u8) -> log::LevelFilter {
26    rns_net::logging::numeric_log_filter(log_level).default
27}
28
29pub fn pathing_level_filter(log_level: u8) -> log::LevelFilter {
30    rns_net::logging::numeric_log_filter(log_level).pathing
31}
32
33#[cfg(test)]
34mod tests {
35    use super::*;
36
37    #[test]
38    fn maps_rngit_log_levels_to_rust_filters() {
39        assert_eq!(level_filter(0), log::LevelFilter::Error);
40        assert_eq!(level_filter(2), log::LevelFilter::Warn);
41        assert_eq!(level_filter(4), log::LevelFilter::Info);
42        assert_eq!(level_filter(6), log::LevelFilter::Debug);
43        assert_eq!(level_filter(7), log::LevelFilter::Debug);
44        assert_eq!(level_filter(8), log::LevelFilter::Trace);
45        assert_eq!(level_filter(u8::MAX), log::LevelFilter::Trace);
46    }
47
48    #[test]
49    fn pathing_filter_is_distinct_at_level_seven() {
50        assert_eq!(pathing_level_filter(6), log::LevelFilter::Debug);
51        assert_eq!(pathing_level_filter(7), log::LevelFilter::Trace);
52        assert_eq!(pathing_level_filter(8), log::LevelFilter::Trace);
53    }
54}