summer-sa-token 0.5.3

Sa-Token authentication and authorization plugin for summer-rs
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
//! Integration tests for summer-sa-token middleware and extractors
//!
//! Uses AppBuilder and Plugin pattern for proper initialization

use sa_token_core::token::TokenValue;
#[cfg(feature = "with-summer-redis")]
use std::time::{SystemTime, UNIX_EPOCH};
use summer::app::AppBuilder;
use summer::async_trait;
use summer::plugin::{ComponentRegistry, MutableComponentRegistry, Plugin};
use summer_sa_token::sa_token_plugin_axum::{
    OptionalSaTokenExtractor, SaTokenLayer, SaTokenState, StpUtil,
};
use summer_web::axum::{
    body::Body,
    http::{Request, StatusCode},
    response::IntoResponse,
    routing::get,
    Router,
};
use tower::ServiceExt;

#[cfg(feature = "with-summer-redis")]
use summer_sa_token::storage::SummerRedisStorage;

#[cfg(feature = "with-summer-redis")]
use summer_redis::redis::AsyncCommands;

/// Test plugin that initializes SaTokenState for testing
struct TestSaTokenPlugin;

#[async_trait]
impl Plugin for TestSaTokenPlugin {
    async fn build(&self, app: &mut AppBuilder) {
        let state = SaTokenState::builder()
            .storage(std::sync::Arc::new(
                summer_sa_token::sa_token_plugin_axum::MemoryStorage::new(),
            ))
            .token_name("Authorization".to_string())
            .timeout(3600)
            .build();

        app.add_component(state);
    }

    fn name(&self) -> &str {
        "TestSaTokenPlugin"
    }
}

/// Combined integration test for all SaTokenState functionality
#[tokio::test]
async fn test_sa_token_integration() {
    // Initialize app with test plugin
    let mut app = AppBuilder::default();
    TestSaTokenPlugin.build(&mut app).await;

    // Get state from app
    let state = app
        .get_component::<SaTokenState>()
        .expect("SaTokenState should be registered");

    // =========================================================================
    // Test 1: Layer creation
    // =========================================================================
    {
        let _layer = SaTokenLayer::new(state.clone());
    }

    // =========================================================================
    // Test 2: Login and token validation
    // =========================================================================
    {
        let token = state.manager.login("test_user").await.unwrap();
        assert!(!token.as_str().is_empty());

        let is_valid = state.manager.is_valid(&token).await;
        assert!(is_valid);

        let token_info = state.manager.get_token_info(&token).await;
        assert!(token_info.is_ok());
        assert_eq!(token_info.unwrap().login_id, "test_user");
    }

    // =========================================================================
    // Test 3: Logout
    // =========================================================================
    {
        let token = state.manager.login("logout_user").await.unwrap();
        assert!(state.manager.is_valid(&token).await);

        state
            .manager
            .logout_by_login_id("logout_user")
            .await
            .unwrap();
        assert!(!state.manager.is_valid(&token).await);
    }

    // =========================================================================
    // Test 4: Multiple tokens same user
    // =========================================================================
    {
        let token1 = state.manager.login("multi_user").await.unwrap();
        let token2 = state.manager.login("multi_user").await.unwrap();

        assert!(state.manager.is_valid(&token1).await);
        assert!(state.manager.is_valid(&token2).await);
    }

    // =========================================================================
    // Test 5: Token info
    // =========================================================================
    {
        let token = state.manager.login("info_user").await.unwrap();
        let info = state.manager.get_token_info(&token).await.unwrap();
        assert_eq!(info.login_id, "info_user");
    }

    // =========================================================================
    // Test 6: Invalid token
    // =========================================================================
    {
        let fake_token = TokenValue::new("fake-token-12345");
        assert!(!state.manager.is_valid(&fake_token).await);
    }

    // =========================================================================
    // Test 7: Roles and permissions
    // =========================================================================
    {
        let _token = state.manager.login("role_user").await.unwrap();

        StpUtil::set_roles("role_user", vec!["admin".to_string(), "user".to_string()])
            .await
            .unwrap();

        StpUtil::set_permissions(
            "role_user",
            vec!["user:read".to_string(), "user:write".to_string()],
        )
        .await
        .unwrap();

        assert!(StpUtil::has_role("role_user", "admin").await);
        assert!(StpUtil::has_role("role_user", "user").await);
        assert!(!StpUtil::has_role("role_user", "superadmin").await);

        assert!(StpUtil::has_permission("role_user", "user:read").await);
        assert!(StpUtil::has_permission("role_user", "user:write").await);
        assert!(!StpUtil::has_permission("role_user", "user:delete").await);

        let roles = StpUtil::get_roles("role_user").await;
        assert_eq!(roles.len(), 2);
        assert!(roles.contains(&"admin".to_string()));

        let permissions = StpUtil::get_permissions("role_user").await;
        assert_eq!(permissions.len(), 2);
        assert!(permissions.contains(&"user:read".to_string()));
    }

    // =========================================================================
    // Test 8: Middleware with valid token
    // =========================================================================
    {
        let token = state.manager.login("middleware_user").await.unwrap();

        async fn handler(optional_token: OptionalSaTokenExtractor) -> impl IntoResponse {
            match optional_token.0 {
                Some(token) => format!("Token: {}", token.as_str()),
                None => "No token".to_string(),
            }
        }

        let app = Router::new()
            .route("/test", get(handler))
            .layer(SaTokenLayer::new(state.clone()));

        let response = app
            .oneshot(
                Request::builder()
                    .uri("/test")
                    .header("Authorization", token.as_str())
                    .body(Body::empty())
                    .unwrap(),
            )
            .await
            .unwrap();

        assert_eq!(response.status(), StatusCode::OK);
    }

    // =========================================================================
    // Test 9: Middleware without token
    // =========================================================================
    {
        async fn handler(optional_token: OptionalSaTokenExtractor) -> impl IntoResponse {
            match optional_token.0 {
                Some(_) => "Has token",
                None => "No token",
            }
        }

        let app = Router::new()
            .route("/test", get(handler))
            .layer(SaTokenLayer::new(state.clone()));

        let response = app
            .oneshot(Request::builder().uri("/test").body(Body::empty()).unwrap())
            .await
            .unwrap();

        assert_eq!(response.status(), StatusCode::OK);
    }
}

#[cfg(feature = "with-summer-redis")]
async fn create_redis_connection() -> Option<summer_redis::Redis> {
    let url = std::env::var("REDIS_URL").ok()?;
    let client = summer_redis::redis::Client::open(url).expect("redis client should open");
    Some(
        client
            .get_connection_manager()
            .await
            .expect("redis connection manager should connect"),
    )
}

#[cfg(feature = "with-summer-redis")]
fn unique_storage_prefix(tag: &str) -> String {
    let nanos = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .expect("time should be after epoch")
        .as_nanos();
    format!("demo-{tag}-{nanos}")
}

#[cfg(feature = "with-summer-redis")]
#[tokio::test]
async fn test_redis_storage_rewrites_prefix_for_physical_keys() {
    let Some(mut redis) = create_redis_connection().await else {
        eprintln!("skipping: REDIS_URL is not set");
        return;
    };
    let prefix = unique_storage_prefix("rewrite");
    let storage = SummerRedisStorage::new(redis.clone(), Some(prefix.clone()), true);

    storage.clear().await.expect("clear should succeed");

    storage
        .set("sa:login:token:user1", "token-123", None)
        .await
        .expect("set should succeed");

    let rewritten_key = format!("{prefix}:login:token:user1");
    let raw: Option<String> = redis
        .get(&rewritten_key)
        .await
        .expect("prefixed key should be readable");
    assert_eq!(raw.as_deref(), Some("token-123"));

    let legacy_key = format!("{prefix}:sa:login:token:user1");
    let old_raw: Option<String> = redis
        .get(&legacy_key)
        .await
        .expect("old prefixed key should be readable");
    assert!(old_raw.is_none());

    storage.clear().await.expect("clear should succeed");
}

#[cfg(feature = "with-summer-redis")]
#[tokio::test]
async fn test_redis_storage_keys_and_clear_work_with_rewritten_prefix() {
    let Some(mut redis) = create_redis_connection().await else {
        eprintln!("skipping: REDIS_URL is not set");
        return;
    };
    let prefix = unique_storage_prefix("keys");
    let storage = SummerRedisStorage::new(redis.clone(), Some(prefix.clone()), true);

    storage.clear().await.expect("clear should succeed");

    redis
        .set::<_, _, ()>(format!("{prefix}:token:one"), "a")
        .await
        .expect("set should succeed");
    redis
        .set::<_, _, ()>(format!("{prefix}:session:user1"), "b")
        .await
        .expect("set should succeed");
    redis
        .set::<_, _, ()>(format!("{prefix}:refresh:token-1"), "c")
        .await
        .expect("set should succeed");

    let mut keys = storage.keys("sa:*").await.expect("keys should succeed");
    keys.sort();

    assert_eq!(
        keys,
        vec![
            "sa:refresh:token-1".to_string(),
            "sa:session:user1".to_string(),
            "sa:token:one".to_string()
        ]
    );

    storage.clear().await.expect("clear should succeed");

    let remaining: Vec<String> = redis
        .keys(format!("{prefix}:*"))
        .await
        .expect("keys should succeed");
    assert!(remaining.is_empty());
}

mod test_config_conversion {
    use summer_sa_token::{CoreConfig, SaTokenConfig};

    #[test]
    fn test_config_into_core_config() {
        let config = SaTokenConfig {
            token_name: "TestToken".to_string(),
            timeout: 7200,
            auto_renew: true,
            ..Default::default()
        };

        let core_config: CoreConfig = config.into();
        assert_eq!(core_config.token_name, "TestToken");
        assert_eq!(core_config.timeout, 7200);
        assert!(core_config.auto_renew);
    }
}

mod test_path_auth_builder {
    use summer_sa_token::PathAuthBuilder;

    #[test]
    fn test_path_auth_builder_creation() {
        let builder = PathAuthBuilder::new();
        assert!(!builder.is_configured());
    }

    #[test]
    fn test_path_auth_builder_include() {
        let builder = PathAuthBuilder::new()
            .include("/api/**")
            .include("/admin/**");

        assert!(builder.is_configured());
    }

    #[test]
    fn test_path_auth_builder_exclude() {
        let builder = PathAuthBuilder::new()
            .include("/api/**")
            .exclude("/api/public/**")
            .exclude("/login");

        assert!(builder.is_configured());
    }

    #[test]
    fn test_path_auth_builder_include_all() {
        let builder = PathAuthBuilder::new().include_all(["/api/**", "/admin/**", "/user/**"]);

        assert!(builder.is_configured());
    }

    #[test]
    fn test_path_auth_builder_exclude_all() {
        let builder = PathAuthBuilder::new()
            .include("/api/**")
            .exclude_all(["/api/public/**", "/api/health"]);

        assert!(builder.is_configured());
    }

    #[test]
    fn test_path_auth_builder_aliases() {
        let builder = PathAuthBuilder::new()
            .authenticated("/api/**")
            .permit_all("/api/public/**");

        assert!(builder.is_configured());
    }

    #[test]
    fn test_path_auth_builder_merge() {
        let builder1 = PathAuthBuilder::new().include("/api/**");
        let builder2 = PathAuthBuilder::new().include("/admin/**");

        let merged = builder1.merge(builder2);
        assert!(merged.is_configured());
    }

    #[test]
    fn test_path_auth_builder_build() {
        let builder = PathAuthBuilder::new()
            .include("/api/**")
            .exclude("/api/public/**");

        // PathAuthConfig is built successfully
        let _config = builder.build();
    }
}