ghtool 0.3.0

A command-line tool for interacting with Github API with some specialized features oriented around Checks
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

use lazy_static::lazy_static;
use regex::Regex;

const TIMESTAMP_PATTERN: &str = r"(?P<timestamp>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+Z)";

lazy_static! {
    /// Regex to match a timestamp
    static ref TIMESTAMP: Regex = Regex::new(TIMESTAMP_PATTERN).unwrap();

    /// Regex to match a failing jest test. The path needs to contain at least one slash.
    /// Example: 2021-05-04T18:24:29.000Z FAIL src/components/MyComponent/MyComponent.test.tsx
    static ref JEST_FAIL_LINE: Regex = Regex::new(&format!(
        r"{TIMESTAMP_PATTERN}\s+(?P<fail>FAIL)\s+(?P<path>[a-zA-Z0-9._-]*/[a-zA-Z0-9./_-]*)",
    ))
    .unwrap();
}

/// Collect failing tests from the logs by reading lines from a line that matches JEST_FAIL
/// until there is a line where there is something else than whitespace in the same column
/// as the FAIL match.
///
/// 2021-05-04T18:24:29.000Z FAIL src/components/MyComponent/MyComponent.test.tsx
/// 2021-05-04T18:24:29.000Z   ● Test suite failed to run
/// 2021-05-04T18:24:29.000Z     TypeError: Cannot read property 'foo' of undefined
/// 2021-05-04T18:24:29.000Z
/// 2021-05-04T18:24:29.000Z       1 | import React from 'react';
/// 2021-05-04T18:24:29.000Z PASS src/components/MyComponent/MyComponent.test.tsx
pub fn extract_failing_tests(logs: &str) -> Result<Vec<Vec<String>>, eyre::Error> {
    let mut fail_start_col = 0;
    let mut in_test_case = false;
    let mut current_fail_lines = Vec::new();
    let mut failing_tests_inner = Vec::new();

    let get_line_without_ts = |line: &str, fail_start_col: usize| -> String {
        line.chars().skip(fail_start_col).collect()
    };

    for full_line in logs.lines() {
        let line_no_ansi = String::from_utf8(strip_ansi_escapes::strip(full_line.as_bytes())?)?;

        if let Some(caps) = JEST_FAIL_LINE.captures(&line_no_ansi) {
            fail_start_col = caps.name("fail").unwrap().start();
            let line_no_timestamp = get_line_without_ts(&line_no_ansi, fail_start_col);
            current_fail_lines.push(line_no_timestamp.to_string());
            in_test_case = true;
        } else if in_test_case {
            if line_no_ansi.len() > fail_start_col
                && line_no_ansi.chars().nth(fail_start_col) != Some(' ')
            {
                failing_tests_inner.push(current_fail_lines);
                current_fail_lines = Vec::new();
                in_test_case = false;
            } else {
                let line_no_timestamp = get_line_without_ts(&line_no_ansi, fail_start_col);
                current_fail_lines.push(line_no_timestamp.to_string());
            }
        }
    }

    Ok(failing_tests_inner)
}

pub fn extract_failing_test_files(logs: &str) -> Result<Vec<String>, eyre::Error> {
    let mut test_files = Vec::new();

    for full_line in logs.lines() {
        let line_no_ansi = String::from_utf8(
            strip_ansi_escapes::strip(full_line.as_bytes())
                .map_err(|_| eyre::eyre!("Error when stripping ansi escapes"))?,
        )?;

        if let Some(caps) = JEST_FAIL_LINE.captures(&line_no_ansi) {
            test_files.push(caps.name("path").unwrap().as_str().to_string());
        }
    }

    Ok(test_files)
}

// Tests
#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;

    #[test]
    fn test_extract_failing_tests() {
        let logs = r#"
2021-05-04T18:24:29.000Z FAIL src/components/MyComponent/MyComponent.test.tsx
2021-05-04T18:24:29.000Z   ● Test suite failed to run
2021-05-04T18:24:29.000Z     TypeError: Cannot read property 'foo' of undefined
2021-05-04T18:24:29.000Z
2021-05-04T18:24:29.000Z       1 | import React from 'react';
2021-05-04T18:24:29.000Z PASS src/components/MyComponent/MyComponent.test.tsx
2021-05-04T18:24:29.000Z FAIL src/components/MyComponent/MyComponent2.test.tsx
2021-05-04T18:24:29.000Z   ● Test suite failed to run
2021-05-04T18:24:29.000Z     TypeError: Cannot read property 'foo' of undefined
2021-05-04T18:24:29.000Z
2021-05-04T18:24:29.000Z       1 | import React from 'react';
2021-05-04T18:24:29.000Z PASS src/components/MyComponent/MyComponent2.test.tsx"#;

        let failing_tests = extract_failing_tests(logs).unwrap();
        assert_eq!(
            failing_tests,
            vec![
                vec![
                    "FAIL src/components/MyComponent/MyComponent.test.tsx".to_string(),
                    "  ● Test suite failed to run".to_string(),
                    "    TypeError: Cannot read property 'foo' of undefined".to_string(),
                    "".to_string(),
                    "      1 | import React from 'react';".to_string(),
                ],
                vec![
                    "FAIL src/components/MyComponent/MyComponent2.test.tsx".to_string(),
                    "  ● Test suite failed to run".to_string(),
                    "    TypeError: Cannot read property 'foo' of undefined".to_string(),
                    "".to_string(),
                    "      1 | import React from 'react';".to_string(),
                ],
            ]
        );
    }

    #[test]
    fn test_extract_failing_test_files() {
        let logs = r#"
2021-05-04T18:24:29.000Z FAIL src/components/MyComponent/MyComponent.test.tsx
2021-05-04T18:24:29.000Z   ● Test suite failed to run
2021-05-04T18:24:29.000Z     TypeError: Cannot read property 'foo' of undefined
2021-05-04T18:24:29.000Z
2021-05-04T18:24:29.000Z       1 | import React from 'react';
2021-05-04T18:24:29.000Z PASS src/components/MyComponent/MyComponent2.test.tsx
2021-05-04T18:24:29.000Z FAIL src/components/MyComponent/MyComponent3.test.tsx
2021-05-04T18:24:29.000Z   ● Test suite failed to run
2021-05-04T18:24:29.000Z     TypeError: Cannot read property 'foo' of undefined
2021-05-04T18:24:29.000Z
2021-05-04T18:24:29.000Z       1 | import React from 'react';
2021-05-04T18:24:29.000Z PASS src/components/MyComponent/MyComponent4.test.tsx"#;

        let failing_tests = extract_failing_test_files(logs).unwrap();
        assert_eq!(
            failing_tests,
            vec![
                "src/components/MyComponent/MyComponent.test.tsx".to_string(),
                "src/components/MyComponent/MyComponent3.test.tsx".to_string(),
            ]
        );
    }
}