unfault 1.0.6

Unfault — a cognitive context engine for thoughtful engineers
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

//! # Exit Codes
//!
//! Standard exit codes for the Unfault CLI.
//!
//! These codes follow common Unix conventions and provide meaningful
//! feedback to scripts and CI/CD pipelines.

/// Successful execution
pub const EXIT_SUCCESS: i32 = 0;

/// General error (unspecified)
pub const EXIT_ERROR: i32 = 1;

/// Configuration error (missing or invalid config)
pub const EXIT_CONFIG_ERROR: i32 = 2;

/// Authentication error (invalid or expired credentials)
pub const EXIT_AUTH_ERROR: i32 = 3;

/// Network error (connection failed, timeout, etc.)
pub const EXIT_NETWORK_ERROR: i32 = 4;

/// Analysis found issues (findings detected)
pub const EXIT_FINDINGS_FOUND: i32 = 5;

/// Invalid input (bad arguments, invalid files, etc.)
pub const EXIT_INVALID_INPUT: i32 = 6;

/// Service unavailable (API down, maintenance, etc.)
pub const EXIT_SERVICE_UNAVAILABLE: i32 = 7;

/// Session error (session not found, expired, etc.)
pub const EXIT_SESSION_ERROR: i32 = 8;

/// Subscription required for this operation (402 Payment Required)
///
/// Used when free Insights queries are exhausted and subscription is needed.
pub const EXIT_SUBSCRIPTION_REQUIRED: i32 = 10;

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

    #[test]
    fn test_exit_codes_are_distinct() {
        let codes = [
            EXIT_SUCCESS,
            EXIT_ERROR,
            EXIT_CONFIG_ERROR,
            EXIT_AUTH_ERROR,
            EXIT_NETWORK_ERROR,
            EXIT_FINDINGS_FOUND,
            EXIT_INVALID_INPUT,
            EXIT_SERVICE_UNAVAILABLE,
            EXIT_SESSION_ERROR,
            EXIT_SUBSCRIPTION_REQUIRED,
        ];

        // Check all codes are unique
        for (i, &code1) in codes.iter().enumerate() {
            for (j, &code2) in codes.iter().enumerate() {
                if i != j {
                    assert_ne!(code1, code2, "Exit codes {} and {} are not unique", i, j);
                }
            }
        }
    }

    #[test]
    fn test_success_is_zero() {
        assert_eq!(EXIT_SUCCESS, 0);
    }

    #[test]
    fn test_error_codes_are_positive() {
        assert!(EXIT_ERROR > 0);
        assert!(EXIT_CONFIG_ERROR > 0);
        assert!(EXIT_AUTH_ERROR > 0);
        assert!(EXIT_NETWORK_ERROR > 0);
        assert!(EXIT_FINDINGS_FOUND > 0);
        assert!(EXIT_INVALID_INPUT > 0);
        assert!(EXIT_SERVICE_UNAVAILABLE > 0);
        assert!(EXIT_SESSION_ERROR > 0);
        assert!(EXIT_SUBSCRIPTION_REQUIRED > 0);
    }
}