timberjack 0.1.0-beta.1

A CLI tool that fells log files with speed and insight
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

use assert_cmd::Command;
use predicates::prelude::*;
use std::io::Write;
use tempfile::NamedTempFile;

#[test]
fn test_cli_json_output() {
    // Create a temporary log file
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:00:00,123 [ERROR] NullPointerException"
    )
    .unwrap();
    writeln!(temp_file, "2025-03-21 14:01:00,456 [WARN] Some warning").unwrap();

    let file_path = temp_file.path().to_str().unwrap();

    // Run timber with JSON output
    let mut cmd = Command::cargo_bin("timber").unwrap();
    let assert = cmd.arg("--json").arg("--stats").arg(file_path).assert();

    // Check that the output looks like valid JSON
    assert
        .success()
        .stdout(predicates::str::contains("{"))
        .stdout(predicates::str::contains("}"))
        .stdout(predicates::str::contains("\"matched_lines\""))
        .stdout(predicates::str::contains("\"count\""))
        .stdout(predicates::str::contains("\"stats\""));
}

#[test]
fn test_cli_top_errors_option() {
    // Create a temporary log file with multiple errors
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:00:00,123 [ERROR] NullPointerException"
    )
    .unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:01:00,456 [ERROR] Connection timeout"
    )
    .unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:02:00,789 [ERROR] OutOfMemoryError"
    )
    .unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:03:00,123 [ERROR] FileNotFoundException"
    )
    .unwrap();

    let file_path = temp_file.path().to_str().unwrap();

    // Run timber with custom top_errors limit
    let mut cmd = Command::cargo_bin("timber").unwrap();
    let assert = cmd
        .arg("--stats")
        .arg("--top-errors")
        .arg("2")
        .arg(file_path)
        .assert();

    // Should only show the top 2 errors
    assert
        .success()
        .stdout(predicates::str::contains("Top error types:"))
        .stdout(predicates::str::contains("1."))
        .stdout(predicates::str::contains("2."))
        .stdout(predicates::str::contains("3.").not()); // Shouldn't show 3rd error
}

#[test]
fn test_cli_show_unique_option() {
    // Create a temporary log file
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:00:00,123 [ERROR] NullPointerException"
    )
    .unwrap();
    writeln!(temp_file, "2025-03-21 14:01:00,456 [WARN] Some warning").unwrap();

    let file_path = temp_file.path().to_str().unwrap();

    // Run timber with show_unique option
    let mut cmd = Command::cargo_bin("timber").unwrap();
    let assert = cmd
        .arg("--stats")
        .arg("--show-unique")
        .arg(file_path)
        .assert();

    // Check that unique messages section appears
    assert
        .success()
        .stdout(predicates::str::contains("Unique messages:"))
        .stdout(predicates::str::contains("NullPointerException")) // Just check for the content
        .stdout(predicates::str::contains("Some warning")); // without assuming formatting
}

#[test]
fn test_cli_json_with_new_options() {
    // Create a temporary log file
    let mut temp_file = NamedTempFile::new().unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:00:00,123 [ERROR] NullPointerException"
    )
    .unwrap();
    writeln!(temp_file, "2025-03-21 14:01:00,456 [WARN] Some warning").unwrap();
    writeln!(
        temp_file,
        "2025-03-21 14:02:00,789 [ERROR] Connection timeout"
    )
    .unwrap();

    let file_path = temp_file.path().to_str().unwrap();

    // Run timber with JSON output and new options
    let mut cmd = Command::cargo_bin("timber").unwrap();
    let assert = cmd
        .arg("--json")
        .arg("--stats")
        .arg("--show-unique")
        .arg("--top-errors")
        .arg("1")
        .arg(file_path)
        .assert();

    // Check that JSON includes unique messages and has limited error types
    assert
        .success()
        .stdout(predicates::str::contains("\"unique_messages\""))
        .stdout(predicates::str::contains("\"error_types\""));

    // In a more comprehensive test, we would parse the JSON and verify:
    // 1. That unique_messages is an array containing the unique messages
    // 2. That error_types contains only one entry (from --top-errors 1)
}