unreal_log_parser 1.1.1

A simple log parser for Unreal Engine logs, which can be used to extract useful information from logs.
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

// Kyryl Sydorov, 2024

use anyhow::Result;
use unreal_log_parser::*;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_log_entry_with_verbosity() -> Result<()> {
        let log_line = "[2024.04.27-12.34.56:789][  1]LogTemp: Warning: This is a warning message.";

        let parsed = LogEntry::parse(log_line).expect("Failed to parse log line");

        let expected = LogEntry {
            timestamp: Timestamp {
                year: 2024,
                month: 4,
                day: 27,
                hour: 12,
                minute: 34,
                second: 56,
                millisecond: 789,
            },
            frame_num: 1,
            category: "LogTemp".to_string(),
            verbosity: Verbosity::Warning,
            message: "This is a warning message.".to_string(),
        };

        assert_eq!(parsed, expected);

        Ok(())
    }

    #[test]
    fn test_parse_log_entry_without_verbosity() -> Result<()> {
        let log_line = "[2024.04.27-12.34.56:789][  1]LogTemp: This is a log message.";

        let parsed = LogEntry::parse(log_line).expect("Failed to parse log line");

        let expected = LogEntry {
            timestamp: Timestamp {
                year: 2024,
                month: 4,
                day: 27,
                hour: 12,
                minute: 34,
                second: 56,
                millisecond: 789,
            },
            frame_num: 1,
            category: "LogTemp".to_string(),
            verbosity: Verbosity::Log,
            message: "This is a log message.".to_string(),
        };

        assert_eq!(parsed, expected);

        Ok(())
    }

    #[test]
    fn test_parse_log_minimal() -> Result<()> {
        let log_line = "LogCore: Very small log";

        let parsed = LogEntry::parse(log_line).expect("Failed to parse log line");

        let expected = LogEntry {
            timestamp: Timestamp::new(),
            frame_num: 0,
            category: "LogCore".to_string(),
            verbosity: Verbosity::Log,
            message: "Very small log".to_string(),
        };

        assert_eq!(parsed, expected);

        Ok(())
    }

    #[test]
    fn test_invalid_string() -> Result<()> {
        let log_line = "This is not a log line";
        let parsed = LogEntry::parse(log_line);
        assert_eq!(parsed, Err(UnrealLogParserError::ParseError));

        Ok(())
    }

    #[test]
    fn test_invalid_timestamp() -> Result<()> {
        let log_line = "[2024.04.27][  1]LogTemp: This is a log message.";
        let parsed = LogEntry::parse(log_line);
        assert_eq!(parsed, Err(UnrealLogParserError::ParseError));

        Ok(())
    }

    #[test]
    fn test_invalid_verbosity() -> Result<()> {
        let log_line =
            "[2024.04.27-12.34.56:789][  1]LogTemp: InvalidVerbosity: This is a log message.";
        let parsed = LogEntry::parse(log_line);
        assert!(parsed.is_ok()); // Invalid verbosity is ignored (treated like part of a message)

        Ok(())
    }

    #[test]
    fn test_file() -> Result<()> {
        let file_path = "tests/Data/SmallTestFile.log";
        let mut file = LogFile::new(file_path.parse().unwrap());

        let parsed_result = file.parse();
        assert!(parsed_result.is_ok());

        assert_eq!(
            file.entries[0],
            LogEntry {
                timestamp: Timestamp {
                    year: 2024,
                    month: 10,
                    day: 4,
                    hour: 19,
                    minute: 09,
                    second: 47,
                    millisecond: 074,
                },
                frame_num: 0,
                category: "LogAssetRegistry".to_string(),
                verbosity: Verbosity::Display,
                message: "Triggering cache save on discovery complete".to_string(),
            }
        );

        Ok(())
    }

    #[test]
    fn test_no_file() -> Result<()> {
        let file_path = "tests/Data/NonExistentFile.log";
        let mut file = LogFile::new(file_path.parse().unwrap());

        let parsed_result = file.parse();
        assert_eq!(parsed_result, Err(UnrealLogParserError::NoSuchFile));

        Ok(())
    }

    #[test]
    fn test_empty_file() -> Result<()> {
        let file_path = "tests/Data/EmptyFile.log";
        let mut file = LogFile::new(file_path.parse().unwrap());

        let parsed_result = file.parse();
        assert_eq!(parsed_result, Err(UnrealLogParserError::NoLogEntriesFound));

        Ok(())
    }

    #[test]
    fn test_huge_file() -> Result<()> {
        let file_path = "tests/Data/TestLogFile.log";
        let mut file = LogFile::new(file_path.parse().unwrap());

        let parsed_result = file.parse();
        assert!(parsed_result.is_ok());

        Ok(())
    }
}