Skip to main content

gitflow_core/
auth_checker.rs

1//! 认证检查器 trait 和类型定义。
2//!
3//! 提供同步版本的认证检查接口,用于 CLI 前置检查。
4
5/// 认证检查器 trait(同步版本,用于前置检查)。
6///
7/// # Examples
8///
9/// ```ignore
10/// use gitflow_core::AuthChecker;
11///
12/// fn check_auth(checker: &dyn AuthChecker) {
13///     if checker.is_authenticated() {
14///         println!("User is authenticated");
15///     }
16/// }
17/// ```
18pub trait AuthChecker: Send + Sync {
19    /// 快速检查是否已认证(不查询 API,仅检查本地凭据)。
20    ///
21    /// # Returns
22    ///
23    /// 如果已认证返回 `true`,否则返回 `false`。
24    fn is_authenticated(&self) -> bool;
25
26    /// 获取认证检查的详细状态。
27    ///
28    /// # Returns
29    ///
30    /// 包含认证状态、用户名、失败原因和修复建议的 [`AuthCheckResult`]。
31    fn check_status(&self) -> AuthCheckResult;
32}
33
34/// 认证检查结果。
35///
36/// 包含认证状态的详细信息,用于生成用户友好的错误消息。
37#[derive(Debug, Clone)]
38pub struct AuthCheckResult {
39    /// 是否已认证。
40    pub authenticated: bool,
41    /// 用户名(如果已认证)。
42    pub user: Option<String>,
43    /// 失败原因(如果未认证)。
44    pub reason: Option<String>,
45    /// 修复建议。
46    pub hint: Option<String>,
47}
48
49#[cfg(test)]
50mod tests {
51    use super::*;
52
53    #[test]
54    fn test_should_create_authenticated_result() {
55        let result = AuthCheckResult {
56            authenticated: true,
57            user: Some("testuser".to_string()),
58            reason: None,
59            hint: None,
60        };
61        assert!(result.authenticated);
62        assert_eq!(result.user, Some("testuser".to_string()));
63    }
64
65    #[test]
66    fn test_should_create_not_authenticated_result() {
67        let result = AuthCheckResult {
68            authenticated: false,
69            user: None,
70            reason: Some("Not logged in".to_string()),
71            hint: Some("Run `gc auth login`".to_string()),
72        };
73        assert!(!result.authenticated);
74        assert!(result.reason.is_some());
75        assert!(result.hint.is_some());
76    }
77
78    #[test]
79    fn test_auth_checker_trait_is_object_safe() {
80        // 验证 trait 是 object-safe 的
81        fn _takes_checker(_checker: &dyn AuthChecker) {}
82    }
83}