pinner 0.0.5

Secure CI/CD workflows by pinning mutable tags to immutable SHA-1 hashes. A high-performance Rust CLI that preserves YAML formatting and comments. Supports GitHub, GitLab, Bitbucket, Forgejo, and Docker image pinning.
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

use thiserror::Error;

/// Custom error type for Pinner operations.
#[derive(Error, Debug)]
pub enum PinnerError {
    /// IO-related errors (file reading, writing, etc.).
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),
    /// Errors returned by the GitHub API or HTTP client.
    #[error("API error: {0}")]
    Api(String),
    /// Errors during YAML parsing (tree-sitter).
    #[error("Parse error: {0}")]
    Parse(String),
    /// Specified workflow path not found.
    #[error("Path not found: {0}")]
    PathNotFound(String),
    /// Unpinned dependencies found during verification.
    #[error("Verification failed: {0}")]
    VerificationFailed(String),
    /// Errors from the `ignore` crate during directory walking.
    #[error("Ignore error: {0}")]
    Ignore(#[from] ignore::Error),
    /// Config file errors
    #[error("Config error: {0}")]
    Config(String),
    /// API rate limit errors
    #[error("Rate limit error: {0}")]
    RateLimit(String),
}

impl PinnerError {
    /// Returns true if the error is a PathNotFound error.
    pub fn is_path_not_found(&self) -> bool {
        matches!(self, PinnerError::PathNotFound(_))
    }

    /// Returns true if the error should stop the entire process (e.g., rate limits).
    pub fn is_fatal(&self) -> bool {
        match self {
            PinnerError::RateLimit(_) => true,
            PinnerError::Config(_) => true,
            PinnerError::Io(_) => true,
            PinnerError::Parse(_) => true,
            PinnerError::PathNotFound(_) => true,
            PinnerError::VerificationFailed(_) => true,
            PinnerError::Ignore(_) => true,
            // Generic API errors (like 404) are not fatal for the whole process
            PinnerError::Api(_) => false,
        }
    }
}

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

    #[test]
    fn test_error_display() {
        let err = PinnerError::Api("failed".to_string());
        assert_eq!(format!("{}", err), "API error: failed");
        assert!(!err.is_path_not_found());

        let err = PinnerError::Parse("yaml".to_string());
        assert_eq!(format!("{}", err), "Parse error: yaml");

        let err = PinnerError::PathNotFound("path/to/wf".to_string());
        assert_eq!(format!("{}", err), "Path not found: path/to/wf");
        assert!(err.is_path_not_found());

        let err = PinnerError::Config("invalid".to_string());
        assert_eq!(format!("{}", err), "Config error: invalid");

        let err = PinnerError::VerificationFailed("unpinned".to_string());
        assert_eq!(format!("{}", err), "Verification failed: unpinned");
    }

    #[test]
    fn test_error_from_io() {
        let io_err = io::Error::new(io::ErrorKind::NotFound, "not found");
        let err = PinnerError::from(io_err);
        assert!(matches!(err, PinnerError::Io(_)));
        assert!(format!("{}", err).contains("IO error: not found"));
    }

    #[test]
    fn test_error_from_ignore() {
        let io_err = io::Error::other("ignore err");
        let err = PinnerError::Ignore(ignore::Error::Io(io_err));
        assert!(format!("{}", err).contains("Ignore error"));
    }
}