auditmysite 1.7.3

Resource-efficient WCAG 2.2 AA Accessibility Checker in Rust
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
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Error types for AuditMySit
//!
//! Centralized error handling using thiserror for derive macros
//! and anyhow for error context propagation.

use std::path::PathBuf;
use thiserror::Error;

/// Main error type for the auditmysite application
#[derive(Debug, Error)]
pub enum AuditError {
    /// The process received an operating-system shutdown signal.
    #[error("Audit interrupted by {signal}; in-progress work was discarded")]
    Interrupted { signal: String },
    /// No compatible Chromium-based browser found on the system
    #[error("No compatible browser found!\n\nSupported browsers: Chrome, Edge, Chromium\n\nInstallation options:\n  macOS:   brew install --cask google-chrome\n  Linux:   sudo apt install chromium-browser\n  Windows: Download from https://www.google.com/chrome/\n\nOr install a managed browser:\n  auditmysite browser install\n\nOr specify manually:\n  auditmysite --browser-path /path/to/chrome <url>\n\nRun diagnostics:\n  auditmysite doctor")]
    ChromeNotFound,

    /// Chrome binary exists but is not executable
    #[error("Chrome binary at '{path}' is not executable. Try: chmod +x {path}")]
    ChromeNotExecutable { path: PathBuf },

    /// Browser failed to launch
    #[error("Failed to launch browser: {reason}")]
    BrowserLaunchFailed { reason: String },

    /// Navigation to URL failed
    #[error("Failed to navigate to '{url}': {reason}")]
    NavigationFailed { url: String, reason: String },

    /// The server did not serve the site's content: an access denial or a
    /// bot challenge. Auditing it would score the block page.
    #[error("Access to '{url}' was blocked: {reason}. That page is not the site's content and was not audited")]
    AccessBlocked { url: String, reason: String },

    /// Page load timeout
    #[error("Page load timeout for '{url}' after {timeout_secs} seconds")]
    PageLoadTimeout { url: String, timeout_secs: u64 },

    /// Accessibility tree extraction failed
    #[error("Failed to extract accessibility tree: {reason}")]
    AXTreeExtractionFailed { reason: String },

    /// Invalid URL provided
    #[error("Invalid URL: {url} - {reason}")]
    InvalidUrl { url: String, reason: String },

    /// Sitemap parsing failed
    #[error("Failed to parse sitemap from '{url}': {reason}")]
    SitemapParseFailed { url: String, reason: String },

    /// File read/write error
    #[error("File operation failed for '{path}': {reason}")]
    FileError { path: PathBuf, reason: String },

    /// Configuration error
    #[error("Configuration error: {0}")]
    ConfigError(String),

    /// CDP (Chrome DevTools Protocol) error
    #[error("CDP error: {0}")]
    CdpError(String),

    /// Report generation failed
    #[error("Failed to generate report: {reason}")]
    ReportGenerationFailed { reason: String },

    /// Output formatting/writing failed
    #[error("Output error: {reason}")]
    OutputError { reason: String },

    /// Generic IO error wrapper
    #[error("IO error: {0}")]
    IoError(#[from] std::io::Error),

    /// URL parsing error
    #[error("URL parse error: {0}")]
    UrlParseError(#[from] url::ParseError),

    /// JSON serialization/deserialization error
    #[error("JSON error: {0}")]
    JsonError(#[from] serde_json::Error),

    /// HTTP request error
    #[error("HTTP request failed: {0}")]
    HttpError(#[from] reqwest::Error),

    /// Chromiumoxide error
    #[error("Browser automation error: {0}")]
    ChromiumError(String),

    /// Browser pool timeout
    #[error("Browser pool timeout: no page available after {timeout_secs} seconds")]
    PoolTimeout { timeout_secs: u64 },

    /// Browser pool closed
    #[error("Browser pool has been closed")]
    PoolClosed,

    /// Browser pool exhausted
    #[error("Browser pool exhausted: all pages are in use")]
    PoolExhausted,

    /// Accessibility-Journey-Layer interaction failed (keyboard/pointer dispatch).
    #[error("Interaction failed: {reason}")]
    InteractionFailed { reason: String },

    /// Per-page audit exceeded the total time budget.
    #[error("Audit timed out for '{url}' after {timeout_secs} seconds")]
    AuditTimeout { url: String, timeout_secs: u64 },
}

/// Result type alias for AuditError
pub type Result<T> = std::result::Result<T, AuditError>;

impl From<chromiumoxide::error::CdpError> for AuditError {
    fn from(err: chromiumoxide::error::CdpError) -> Self {
        AuditError::CdpError(err.to_string())
    }
}

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

    #[test]
    fn test_chrome_not_found_error_message() {
        let err = AuditError::ChromeNotFound;
        let msg = err.to_string();
        assert!(msg.contains("No compatible browser found"));
        assert!(msg.contains("brew install"));
        assert!(msg.contains("auditmysite browser install"));
        assert!(msg.contains("--browser-path"));
        assert!(msg.contains("auditmysite doctor"));
    }

    #[test]
    fn test_navigation_failed_error() {
        let err = AuditError::NavigationFailed {
            url: "https://example.com".to_string(),
            reason: "Connection refused".to_string(),
        };
        assert!(err.to_string().contains("example.com"));
        assert!(err.to_string().contains("Connection refused"));
    }
}