pipechecker 0.2.6

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

//! CI/CD provider parsers - converts provider-specific YAML to common Pipeline model
//!
//! # Providers
//! - GitHub Actions (implemented)
//! - GitLab CI (implemented)
//! - CircleCI (implemented)

pub mod circleci;
pub mod github;
pub mod gitlab;

use crate::error::{PipecheckError, Result};
use crate::models::{Pipeline, Provider};
use serde_yaml::Value;

/// Detect CI/CD provider from YAML content
///
/// Uses YAML structure inspection first, falling back to string matching for ambiguous cases.
///
/// # Detection criteria
/// - GitHub Actions: `on` key + (`jobs` or `runs-on`)
/// - GitLab CI: `stages` or `image` or `before_script` (without `on` or `workflows`)
/// - CircleCI: `version` + (`workflows` or `jobs`) (without `on`)
pub fn detect_provider(content: &str) -> Result<Provider> {
    let yaml: Value = match serde_yaml::from_str(content) {
        Ok(v) => v,
        Err(_) => {
            return Err(PipecheckError::UnknownProvider(
                "Not a valid YAML file".to_string(),
            ))
        }
    };

    if let Some(map) = yaml.as_mapping() {
        // GitHub Actions: 'on' and ('jobs' or 'runs-on')
        if map.contains_key("on") && (map.contains_key("jobs") || map.contains_key("runs-on")) {
            return Ok(Provider::GitHubActions);
        }

        // GitLab CI: 'stages' or any job with 'script' (though we check top-level keys mainly)
        // More specific GitLab indicators: 'stages', 'image', 'before_script', 'after_script'
        if map.contains_key("stages")
            || map.contains_key("image")
            || map.contains_key("before_script")
        {
            // To be sure, check if it's not CircleCI or GitHub
            if !map.contains_key("on") && !map.contains_key("workflows") {
                return Ok(Provider::GitLabCI);
            }
        }

        // CircleCI: 'version' and ('workflows' or 'jobs')
        if map.contains_key("version")
            && (map.contains_key("workflows") || map.contains_key("jobs"))
            && !map.contains_key("on")
        {
            return Ok(Provider::CircleCI);
        }
    }

    // Fallback to naive string matching if YAML structure is ambiguous
    if content.contains("on:") && (content.contains("jobs:") || content.contains("runs-on:")) {
        Ok(Provider::GitHubActions)
    } else if content.contains("stages:") && content.contains("script:") {
        Ok(Provider::GitLabCI)
    } else if content.contains("version:")
        && (content.contains("workflows:") || content.contains("jobs:"))
    {
        Ok(Provider::CircleCI)
    } else {
        Err(PipecheckError::UnknownProvider(
            "Could not detect CI/CD provider".to_string(),
        ))
    }
}

/// Parse pipeline configuration based on provider
///
/// # Errors
/// Returns `InvalidPipeline` if the YAML cannot be parsed by the appropriate parser.
pub fn parse(content: &str, provider: Provider) -> Result<Pipeline> {
    match provider {
        Provider::GitHubActions => github::parse(content),
        Provider::GitLabCI => gitlab::parse(content),
        Provider::CircleCI => circleci::parse(content),
    }
}