garrison 0.7.3

Garrison - 面向 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
//! Copyright (c) 2026 Kirky.X. All rights reserved.
//! See LICENSE for full license text.

//! `web_warp` 模块测试套件。
//!
//! 覆盖:
//! - `impl Reply for GarrisonError`:错误码 → HTTP 状态码映射 + JSON content-type
//! - `extract_token_from_headers`:Bearer/cookie 提取与优先级
//! - `GarrisonRejection`:包装 `GarrisonError` 接入 warp 拒绝链
//! - `GarrisonRouter`:构建器 + `into_filter` 守卫 Filter
//! - `check_login` / `check_role` / `check_permission`:per-handler guard Filter
//!
//! 通过 `#[cfg(test)] mod tests;` 在 `mod.rs` 引入,仅测试编译。

use super::mock::{MockDao, MockInterface};
use super::*;
use crate::context::tenant::with_default_tenant;
use crate::context::token_extract::extract_token_from_headers;
use crate::dao::GarrisonDao;
use crate::error::GarrisonResult;
use crate::manager::GarrisonManager;
use crate::stp::{GarrisonInterface, GarrisonUtil};
use serial_test::serial;
use warp::http::header;
use warp::http::header::HeaderValue;
use warp::http::StatusCode;
use warp::reply::Reply;

// ========================================================================
// Reply impl 测试
// ========================================================================

/// NotLogin → 401 响应。
#[test]
fn reply_not_login_returns_401() {
    let err = GarrisonError::NotLogin("test".to_string());
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

/// NotPermission → 403 响应。
#[test]
fn reply_not_permission_returns_403() {
    let err = GarrisonError::NotPermission("test".to_string());
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::FORBIDDEN);
}

/// NotRole → 403 响应。
#[test]
fn reply_not_role_returns_403() {
    let err = GarrisonError::NotRole("test".to_string());
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::FORBIDDEN);
}

/// InvalidToken → 401 响应。
#[test]
fn reply_invalid_token_returns_401() {
    let err = GarrisonError::InvalidToken("test".to_string());
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

/// NotImplemented → 501 响应。
#[test]
fn reply_not_implemented_returns_501() {
    let err = GarrisonError::NotImplemented("test".to_string());
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::NOT_IMPLEMENTED);
}

/// Exception code=-1 → 401(与 axum/actix-web 一致)。
#[test]
fn reply_exception_code_minus1_returns_401() {
    let ex = crate::exception::GarrisonException::new(-1, "未登录");
    let err = GarrisonError::Exception(ex);
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

/// Exception code=-2 → 403(与 axum/actix-web 一致)。
#[test]
fn reply_exception_code_minus2_returns_403() {
    let ex = crate::exception::GarrisonException::new(-2, "无权限");
    let err = GarrisonError::Exception(ex);
    let resp = err.into_response();
    assert_eq!(resp.status(), StatusCode::FORBIDDEN);
}

/// into_response() 返回 JSON content-type。
#[test]
fn reply_returns_json_content_type() {
    let err = GarrisonError::NotLogin("internal detail".to_string());
    let resp = err.into_response();
    assert_eq!(
        resp.headers()
            .get("content-type")
            .and_then(|v| v.to_str().ok()),
        Some("application/json")
    );
}

// ========================================================================
// extract_token_from_headers 测试
// ========================================================================

/// 从 Authorization: Bearer 提取 token。
#[test]
fn extract_token_from_bearer_header() {
    let mut headers = warp::http::HeaderMap::new();
    headers.insert(
        header::AUTHORIZATION,
        HeaderValue::from_static("Bearer my_token_123"),
    );
    let config = GarrisonConfig::default_config();
    let token = extract_token_from_headers(&headers, &config).unwrap();
    assert_eq!(token, Some("my_token_123".to_string()));
}

/// Bearer 前缀大小写不敏感(RFC 7235)。
#[test]
fn extract_token_bearer_case_insensitive() {
    let config = GarrisonConfig::default_config();
    for prefix in &["Bearer", "bearer", "BEARER", "BeArEr"] {
        let mut headers = warp::http::HeaderMap::new();
        headers.insert(
            header::AUTHORIZATION,
            HeaderValue::from_str(&format!("{} tok_{}", prefix, prefix)).unwrap(),
        );
        let token = extract_token_from_headers(&headers, &config).unwrap();
        assert_eq!(
            token,
            Some(format!("tok_{}", prefix)),
            "前缀 '{}' 应能提取 token",
            prefix
        );
    }
}

/// 从 cookie 提取 token。
#[test]
fn extract_token_from_cookie() {
    let mut headers = warp::http::HeaderMap::new();
    headers.insert(
        header::COOKIE,
        HeaderValue::from_static("garrison_token=cookie_tok_456"),
    );
    let config = GarrisonConfig::default_config();
    let token = extract_token_from_headers(&headers, &config).unwrap();
    assert_eq!(token, Some("cookie_tok_456".to_string()));
}

/// 无 token 时返回 None。
#[test]
fn extract_token_returns_none_when_missing() {
    let headers = warp::http::HeaderMap::new();
    let config = GarrisonConfig::default_config();
    let token = extract_token_from_headers(&headers, &config).unwrap();
    assert_eq!(token, None);
}

/// header 优先级高于 cookie。
#[test]
fn extract_token_header_priority_over_cookie() {
    let mut headers = warp::http::HeaderMap::new();
    headers.insert(
        header::AUTHORIZATION,
        HeaderValue::from_static("Bearer header_tok"),
    );
    headers.insert(
        header::COOKIE,
        HeaderValue::from_static("garrison_token=cookie_tok"),
    );
    let config = GarrisonConfig::default_config();
    let token = extract_token_from_headers(&headers, &config).unwrap();
    assert_eq!(token, Some("header_tok".to_string()));
}

/// is_read_header=false 时不从 header 提取。
#[test]
fn extract_token_skips_header_when_disabled() {
    let mut headers = warp::http::HeaderMap::new();
    headers.insert(
        header::AUTHORIZATION,
        HeaderValue::from_static("Bearer header_tok"),
    );
    let mut config = GarrisonConfig::default_config();
    config.is_read_header = false;
    config.is_read_cookie = false;
    let token = extract_token_from_headers(&headers, &config).unwrap();
    assert_eq!(token, None);
}

// ========================================================================
// GarrisonRejection 测试
// ========================================================================

/// GarrisonRejection 包装 GarrisonError。
#[test]
fn rejection_wraps_error() {
    let err = GarrisonError::NotLogin("test".to_string());
    let rej = GarrisonRejection(err);
    // Reject trait 无方法可调用,仅验证类型可构造
    // 通过 format! 验证内部错误可访问
    assert!(format!("{:?}", rej).contains("NotLogin"));
}

// ========================================================================
// GarrisonRouter 测试
// ========================================================================

/// GarrisonRouter::new 初始化空规则。
#[test]
fn router_new_initializes_defaults() {
    let router = GarrisonRouter::new(Arc::new(GarrisonConfig::default_config()));
    assert!(router.rules.is_empty());
}

/// route_protected 注册路径 + 注解。
#[test]
fn router_route_protected_adds_rule() {
    let router = GarrisonRouter::new(Arc::new(GarrisonConfig::default_config()))
        .route_protected("/api/user", Annotation::CheckLogin)
        .route_protected("/api/admin", Annotation::CheckRole("admin".to_string()));
    assert_eq!(router.rules.len(), 2);
    assert!(router.rules.contains_key("/api/user"));
    assert!(router.rules.contains_key("/api/admin"));
}

/// with_interceptor 设置自定义拦截器。
#[test]
fn router_with_interceptor_replaces_default() {
    struct CustomInterceptor;
    #[async_trait::async_trait]
    impl GarrisonInterceptor for CustomInterceptor {
        async fn pre_handle(&self, _path: &str, _annotation: &Annotation) -> GarrisonResult<()> {
            Ok(())
        }
    }
    let router = GarrisonRouter::new(Arc::new(GarrisonConfig::default_config()))
        .with_interceptor(CustomInterceptor);
    // 验证 interceptor 已替换(通过 Arc strong_count >= 1)
    assert!(Arc::strong_count(&router.interceptor) >= 1);
}

/// Default impl 创建默认配置的路由器。
#[test]
fn router_default_impl() {
    let router = GarrisonRouter::default();
    assert!(router.rules.is_empty());
}

// ========================================================================
// into_filter / check_login / check_role / check_permission Filter 测试
// ========================================================================

// ----------------------------------------------------------------
// 辅助函数
// ----------------------------------------------------------------

/// 创建测试配置。
fn make_config() -> GarrisonConfig {
    let mut config = GarrisonConfig::default_config();
    config.timeout = 3600;
    config.active_timeout = -1;
    config.throw_on_not_login = false;
    config
}

/// 初始化 GarrisonManager(带权限/角色数据)。
fn init_manager(permissions: &[(&str, &[&str])], roles: &[(&str, &[&str])]) {
    GarrisonManager::reset_for_test();
    let dao: Arc<dyn GarrisonDao> = Arc::new(MockDao::new());
    let config = Arc::new(make_config());
    let mut interface = MockInterface::new();
    for (id, perms) in permissions {
        interface = interface.with_permission(id, perms);
    }
    for (id, roles) in roles {
        interface = interface.with_role(id, roles);
    }
    let interface: Arc<dyn GarrisonInterface> = Arc::new(interface);
    GarrisonManager::init(dao, config, interface).unwrap();
}

// ----------------------------------------------------------------
// GarrisonRouter::into_filter 测试
// ----------------------------------------------------------------

/// 验证 into_filter 放行未注册路径(无鉴权规则 → Ok)。
#[tokio::test]
#[serial]
async fn into_filter_allows_unprotected_path() {
    init_manager(&[], &[]);
    let router = GarrisonRouter::new(Arc::new(make_config()))
        .route_protected("/protected", Annotation::CheckLogin);
    let filter = router.into_filter();

    let result = warp::test::request()
        .path("/unprotected")
        .filter(&filter)
        .await;
    assert!(result.is_ok());

    GarrisonManager::reset_for_test();
}

/// 验证 into_filter 阻断受保护路径(无 token → Rejection)。
#[tokio::test]
#[serial]
async fn into_filter_blocks_protected_path_without_token() {
    init_manager(&[], &[]);
    let router = GarrisonRouter::new(Arc::new(make_config()))
        .route_protected("/protected", Annotation::CheckLogin);
    let filter = router.into_filter();

    let result = warp::test::request()
        .path("/protected")
        .filter(&filter)
        .await;
    assert!(result.is_err());
    let rej = result.unwrap_err();
    assert!(rej.find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 into_filter 放行受保护路径(有效 token → Ok)。
#[tokio::test]
#[serial]
async fn into_filter_allows_protected_path_with_valid_token() {
    init_manager(&[], &[]);
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let router = GarrisonRouter::new(Arc::new(make_config()))
        .route_protected("/protected", Annotation::CheckLogin);
    let filter = router.into_filter();

    let result = warp::test::request()
        .path("/protected")
        .header("authorization", format!("Bearer {}", token))
        .filter(&filter)
        .await;
    assert!(result.is_ok());

    GarrisonManager::reset_for_test();
}

/// 验证 into_filter 阻断无权限访问(有效 token 但无权限 → Rejection)。
#[tokio::test]
#[serial]
async fn into_filter_blocks_permission_denied() {
    init_manager(&[], &[]); // 无权限数据
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let router = GarrisonRouter::new(Arc::new(make_config())).route_protected(
        "/admin",
        Annotation::CheckPermission("admin:read".to_string()),
    );
    let filter = router.into_filter();

    let result = warp::test::request()
        .path("/admin")
        .header("authorization", format!("Bearer {}", token))
        .filter(&filter)
        .await;
    assert!(result.is_err());
    let rej = result.unwrap_err();
    assert!(rej.find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 `into_filter` 对 `Ignore` 路径无 token 也能通过。
///
/// `into_filter` 现在与 actix-web middleware 对齐,
/// `Ignore` 注解的 `pre_handle` 直接返回 `Ok(())`,token 为可选。
#[tokio::test]
#[serial]
async fn into_filter_allows_ignore_path_without_token() {
    init_manager(&[], &[]);
    let router =
        GarrisonRouter::new(Arc::new(make_config())).route_protected("/public", Annotation::Ignore);
    let filter = router.into_filter();

    let result = warp::test::request().path("/public").filter(&filter).await;
    assert!(result.is_ok());

    GarrisonManager::reset_for_test();
}

// ----------------------------------------------------------------
// check_login Filter 测试
// ----------------------------------------------------------------

/// 验证 check_login filter 在无 token 时返回 Rejection。
#[tokio::test]
#[serial]
async fn check_login_filter_rejects_without_token() {
    init_manager(&[], &[]);
    let filter = check_login(Arc::new(make_config()));

    let result = warp::test::request().filter(&filter).await;
    assert!(result.is_err());
    let rej = result.unwrap_err();
    assert!(rej.find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 check_login filter 在有效 token 时通过。
#[tokio::test]
#[serial]
async fn check_login_filter_passes_with_valid_token() {
    init_manager(&[], &[]);
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let filter = check_login(Arc::new(make_config()));

    let result = warp::test::request()
        .header("authorization", format!("Bearer {}", token))
        .filter(&filter)
        .await;
    assert!(result.is_ok());

    GarrisonManager::reset_for_test();
}

// ----------------------------------------------------------------
// check_role Filter 测试
// ----------------------------------------------------------------

/// 验证 check_role filter 在无 token 时返回 Rejection。
#[tokio::test]
#[serial]
async fn check_role_filter_rejects_without_token() {
    init_manager(&[], &[]);
    let filter = check_role(Arc::new(make_config()), "admin".to_string());

    let result = warp::test::request().filter(&filter).await;
    assert!(result.is_err());
    assert!(result.unwrap_err().find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 check_role filter 在无角色时返回 Rejection。
#[tokio::test]
#[serial]
async fn check_role_filter_rejects_without_role() {
    init_manager(&[], &[]); // 无角色数据
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let filter = check_role(Arc::new(make_config()), "admin".to_string());

    let result = warp::test::request()
        .header("authorization", format!("Bearer {}", token))
        .filter(&filter)
        .await;
    assert!(result.is_err());
    assert!(result.unwrap_err().find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 check_role filter 在持有角色时通过。
#[tokio::test]
#[serial]
async fn check_role_filter_passes_with_valid_role() {
    init_manager(&[], &[("1001", &["admin"])]); // 注入 admin 角色
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let filter = check_role(Arc::new(make_config()), "admin".to_string());

    let result = warp::test::request()
        .header("authorization", format!("Bearer {}", token))
        .filter(&filter)
        .await;
    assert!(result.is_ok());

    GarrisonManager::reset_for_test();
}

// ----------------------------------------------------------------
// check_permission Filter 测试
// ----------------------------------------------------------------

/// 验证 check_permission filter 在无 token 时返回 Rejection。
#[tokio::test]
#[serial]
async fn check_permission_filter_rejects_without_token() {
    init_manager(&[], &[]);
    let filter = check_permission(Arc::new(make_config()), "user:read".to_string());

    let result = warp::test::request().filter(&filter).await;
    assert!(result.is_err());
    assert!(result.unwrap_err().find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 check_permission filter 在无权限时返回 Rejection。
#[tokio::test]
#[serial]
async fn check_permission_filter_rejects_without_permission() {
    init_manager(&[], &[]); // 无权限数据
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let filter = check_permission(Arc::new(make_config()), "user:read".to_string());

    let result = warp::test::request()
        .header("authorization", format!("Bearer {}", token))
        .filter(&filter)
        .await;
    assert!(result.is_err());
    assert!(result.unwrap_err().find::<GarrisonRejection>().is_some());

    GarrisonManager::reset_for_test();
}

/// 验证 check_permission filter 在持有权限时通过。
#[tokio::test]
#[serial]
async fn check_permission_filter_passes_with_valid_permission() {
    init_manager(&[("1001", &["user:read"])], &[]); // 注入权限
    let token = GarrisonUtil::login_simple("1001").await.unwrap();
    let filter = check_permission(Arc::new(make_config()), "user:read".to_string());

    let result = with_default_tenant(async {
        warp::test::request()
            .header("authorization", format!("Bearer {}", token))
            .filter(&filter)
            .await
    })
    .await;
    assert!(result.is_ok());

    GarrisonManager::reset_for_test();
}