pipechecker 0.2.9

CI/CD Pipeline Auditor - Catch errors before you push
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

//! Timeout auditor — warns when jobs lack `timeout-minutes` (or equivalent)
//!
//! Jobs without timeouts risk running forever if something hangs,
//! wasting CI minutes and money.
//!
//! Platform keywords:
//! - GitHub Actions: `timeout-minutes`
//! - GitLab CI:      `timeout`
//! - CircleCI:       `max_time`

use crate::error::Result;
use crate::models::{Issue, Pipeline, Severity};

/// Audit a pipeline for missing job timeouts
pub fn audit(pipeline: &Pipeline) -> Result<Vec<Issue>> {
    let mut issues = Vec::new();

    for job in &pipeline.jobs {
        if job.timeout_minutes.is_none() {
            let (line, col) = pipeline.find_job_line(&job.id, "steps");
            let keyword = match pipeline.provider {
                crate::models::Provider::GitHubActions => "timeout-minutes",
                crate::models::Provider::GitLabCI => "timeout",
                crate::models::Provider::CircleCI => "max_time",
            };
            issues.push(Issue::for_job(
                Severity::Warning,
                &format!(
                    "Job '{}' has no '{}' — may run indefinitely if something hangs",
                    job.id, keyword
                ),
                &job.id,
                line,
                col,
                Some(format!(
                    "Add '{}' to prevent runaway jobs (e.g. 30)",
                    keyword
                )),
            ));
        }
    }

    Ok(issues)
}

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

    #[test]
    fn test_no_timeout_warns() {
        let pipeline = Pipeline {
            provider: Provider::GitHubActions,
            jobs: vec![crate::models::Job {
                id: "build".to_string(),
                name: None,
                depends_on: vec![],
                steps: vec![],
                env: vec![],
                container_image: None,
                service_images: vec![],
                timeout_minutes: None,
            }],
            env: vec![],
            source: "jobs:\n  build:\n    steps:\n      - run: echo hi\n".to_string(),
        };

        let issues = audit(&pipeline).unwrap();
        assert_eq!(issues.len(), 1);
        assert_eq!(issues[0].severity, Severity::Warning);
        assert!(issues[0].message.contains("build"));
    }

    #[test]
    fn test_with_timeout_ok() {
        let pipeline = Pipeline {
            provider: Provider::GitHubActions,
            jobs: vec![crate::models::Job {
                id: "build".to_string(),
                name: None,
                depends_on: vec![],
                steps: vec![],
                env: vec![],
                container_image: None,
                service_images: vec![],
                timeout_minutes: Some(30),
            }],
            env: vec![],
            source: "jobs:\n  build:\n    timeout-minutes: 30\n    steps: []\n".to_string(),
        };

        let issues = audit(&pipeline).unwrap();
        assert!(issues.is_empty());
    }

    #[test]
    fn test_multiple_jobs_mixed() {
        let pipeline = Pipeline {
            provider: Provider::GitHubActions,
            jobs: vec![
                crate::models::Job {
                    id: "build".to_string(),
                    name: None,
                    depends_on: vec![],
                    steps: vec![],
                    env: vec![],
                    container_image: None,
                    service_images: vec![],
                    timeout_minutes: Some(15),
                },
                crate::models::Job {
                    id: "deploy".to_string(),
                    name: None,
                    depends_on: vec!["build".to_string()],
                    steps: vec![],
                    env: vec![],
                    container_image: None,
                    service_images: vec![],
                    timeout_minutes: None,
                },
            ],
            env: vec![],
            source: "jobs:\n  build:\n    timeout-minutes: 15\n  deploy:\n    needs: [build]\n"
                .to_string(),
        };

        let issues = audit(&pipeline).unwrap();
        assert_eq!(issues.len(), 1);
        assert!(issues[0].message.contains("deploy"));
        assert!(!issues[0].message.contains("build"));
    }
}