log2src 0.1.0

log2src maps logs back to source code
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

use regex::{Captures, Regex, RegexBuilder};

use crate::LogError;

#[derive(Clone, Debug)]
pub struct LogFormat {
    regex: Regex,
}

impl LogFormat {
    pub fn has_src_hint(self: LogFormat) -> bool {
        let mut flatten = self.regex.capture_names().flatten();
        flatten.any(|name| name == "line") && flatten.any(|name| name == "file")
    }

    pub fn is_match(&self, line: &str) -> bool {
        self.regex.is_match(line)
    }

    pub fn captures<'a>(&self, line: &'a str) -> Option<Captures<'a>> {
        self.regex.captures(line)
    }
}

impl TryFrom<&str> for LogFormat {
    type Error = LogError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        fn check_captures(regex: &Regex) -> Result<(), LogError> {
            let mut seen = Vec::new();
            for name in regex.capture_names().flatten() {
                match name {
                    "timestamp" | "thread" | "method" | "file" | "line" | "body" | "level" => {
                        seen.push(name)
                    }
                    _ => {
                        return Err(LogError::UnknownFormatCapture {
                            name: name.to_string(),
                        })
                    }
                }
            }
            if !seen.contains(&"body") {
                return Err(LogError::FormatMissingCapture {
                    name: "body".to_string(),
                });
            }
            Ok(())
        }

        RegexBuilder::new(value)
            // XXX: This is kinda a hack to support multiline matching in lnav, but
            // not really useful for log2src atm because its still filtering line-by-line,
            // so this case would never come up
            .dot_matches_new_line(true)
            .build()
            .map_err(|source| LogError::InvalidFormatRegex { source })
            .and_then(|regex| {
                check_captures(&regex)?;
                Ok(LogFormat { regex })
            })
    }
}

#[cfg(test)]
mod tests {
    use crate::LogFormat;
    use insta::assert_snapshot;
    use miette::{IntoDiagnostic, NarratableReportHandler, Report};

    fn get_pretty_report_string(error: Report) -> String {
        let mut buffer = String::new();
        let handler = NarratableReportHandler::new();
        let handler = if let Some(help) = error.help() {
            handler.with_footer(help.to_string())
        } else {
            handler
        };
        let _ = handler.render_report(&mut buffer, error.as_ref());
        buffer
    }

    #[test]
    fn test_invalid_regex() {
        let res = Report::from(LogFormat::try_from("abc(").unwrap_err());
        let rep = get_pretty_report_string(res);
        assert_snapshot!(rep);
    }

    #[test]
    fn test_no_body() {
        let res = LogFormat::try_from("abc").into_diagnostic();
        let rep = get_pretty_report_string(res.unwrap_err());
        assert_snapshot!(rep);
    }

    #[test]
    fn test_unknown_cap() {
        let res = LogFormat::try_from("abc(?<extra>def)").into_diagnostic();
        let rep = get_pretty_report_string(res.unwrap_err());
        assert_snapshot!(rep);
    }
}