openlark 0.15.0

飞书开放平台 Rust SDK - 企业级高覆盖率 API 客户端,极简依赖一条命令
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
//! IM 模型单元测试
//!
//! 测试 IM 模块中的所有数据模型,包括序列化、反序列化、枚举转换等

use rstest::*;
use serde_json::{json, Value};
use open_lark::service::im::v1::models::*;

/// 测试消息类型枚举
mod message_type_tests {
    use super::*;
    
    #[rstest]
    #[case(MessageType::Text, r#""text""#)]
    #[case(MessageType::Post, r#""post""#)]
    #[case(MessageType::Image, r#""image""#)]
    #[case(MessageType::File, r#""file""#)]
    #[case(MessageType::Audio, r#""audio""#)]
    #[case(MessageType::Media, r#""media""#)]
    #[case(MessageType::Sticker, r#""sticker""#)]
    #[case(MessageType::Interactive, r#""interactive""#)]
    #[case(MessageType::ShareChat, r#""share_chat""#)]
    #[case(MessageType::ShareUser, r#""share_user""#)]
    #[case(MessageType::System, r#""system""#)]
    fn test_message_type_serialization(#[case] msg_type: MessageType, #[case] expected_json: &str) {
        let serialized = serde_json::to_string(&msg_type).unwrap();
        assert_eq!(serialized, expected_json);
    }

    #[rstest]
    #[case(r#""text""#, MessageType::Text)]
    #[case(r#""post""#, MessageType::Post)]
    #[case(r#""image""#, MessageType::Image)]
    #[case(r#""file""#, MessageType::File)]
    #[case(r#""audio""#, MessageType::Audio)]
    #[case(r#""media""#, MessageType::Media)]
    #[case(r#""sticker""#, MessageType::Sticker)]
    #[case(r#""interactive""#, MessageType::Interactive)]
    #[case(r#""share_chat""#, MessageType::ShareChat)]
    #[case(r#""share_user""#, MessageType::ShareUser)]
    #[case(r#""system""#, MessageType::System)]
    fn test_message_type_deserialization(#[case] json_str: &str, #[case] expected: MessageType) {
        let deserialized: MessageType = serde_json::from_str(json_str).unwrap();
        assert_eq!(deserialized, expected);
    }

    #[test]
    fn test_message_type_equality() {
        assert_eq!(MessageType::Text, MessageType::Text);
        assert_ne!(MessageType::Text, MessageType::Post);
    }

    #[test]
    fn test_message_type_clone() {
        let original = MessageType::Interactive;
        let cloned = original.clone();
        assert_eq!(original, cloned);
    }
}

/// 测试用户ID类型枚举
mod user_id_type_tests {
    use super::*;

    #[rstest]
    #[case(UserIdType::UserId, "user_id")]
    #[case(UserIdType::UnionId, "union_id")]
    #[case(UserIdType::OpenId, "open_id")]
    fn test_user_id_type_as_str(#[case] id_type: UserIdType, #[case] expected: &str) {
        assert_eq!(id_type.as_str(), expected);
    }

    #[rstest]
    #[case(UserIdType::UserId, r#""user_id""#)]
    #[case(UserIdType::UnionId, r#""union_id""#)]
    #[case(UserIdType::OpenId, r#""open_id""#)]
    fn test_user_id_type_serialization(#[case] id_type: UserIdType, #[case] expected: &str) {
        let serialized = serde_json::to_string(&id_type).unwrap();
        assert_eq!(serialized, expected);
    }
}

/// 测试接收ID类型枚举
mod receive_id_type_tests {
    use super::*;

    #[rstest]
    #[case(ReceiveIdType::OpenId, "open_id")]
    #[case(ReceiveIdType::UserId, "user_id")]
    #[case(ReceiveIdType::UnionId, "union_id")]
    #[case(ReceiveIdType::Email, "email")]
    #[case(ReceiveIdType::ChatId, "chat_id")]
    fn test_receive_id_type_as_str(#[case] id_type: ReceiveIdType, #[case] expected: &str) {
        assert_eq!(id_type.as_str(), expected);
    }

    #[test]
    fn test_receive_id_type_comprehensive_coverage() {
        // 确保我们覆盖了所有枚举变体
        let all_types = vec![
            ReceiveIdType::OpenId,
            ReceiveIdType::UserId,
            ReceiveIdType::UnionId,
            ReceiveIdType::Email,
            ReceiveIdType::ChatId,
        ];

        for id_type in all_types {
            // 每个类型都应该有有效的字符串表示
            assert!(!id_type.as_str().is_empty());
            // 每个类型都应该能够序列化
            assert!(serde_json::to_string(&id_type).is_ok());
        }
    }
}

/// 测试批量消息状态枚举
mod batch_message_status_tests {
    use super::*;

    #[rstest]
    #[case(BatchMessageStatus::Processing, 0)]
    #[case(BatchMessageStatus::PartialSuccess, 1)]
    #[case(BatchMessageStatus::Success, 2)]
    #[case(BatchMessageStatus::Failed, 3)]
    fn test_batch_message_status_values(#[case] status: BatchMessageStatus, #[case] expected_value: u8) {
        let serialized = serde_json::to_string(&status).unwrap();
        assert_eq!(serialized, expected_value.to_string());
    }

    #[rstest]
    #[case("0", BatchMessageStatus::Processing)]
    #[case("1", BatchMessageStatus::PartialSuccess)]
    #[case("2", BatchMessageStatus::Success)]
    #[case("3", BatchMessageStatus::Failed)]
    fn test_batch_message_status_deserialization(#[case] json_str: &str, #[case] expected: BatchMessageStatus) {
        let deserialized: BatchMessageStatus = serde_json::from_str(json_str).unwrap();
        assert_eq!(deserialized, expected);
    }
}

/// 测试表情类型结构
mod emoji_type_tests {
    use super::*;

    #[test]
    fn test_emoji_type_new() {
        let emoji = EmojiType::new();
        assert_eq!(emoji.emoji_type, None);
    }

    #[test] 
    fn test_emoji_type_default() {
        let emoji = EmojiType::default();
        assert_eq!(emoji.emoji_type, None);
    }

    #[test]
    fn test_emoji_type_with_emoji_type() {
        let emoji = EmojiType::new().with_emoji_type("SMILE");
        assert_eq!(emoji.emoji_type, Some("SMILE".to_string()));
    }

    #[test]
    fn test_emoji_type_with_emoji_type_string() {
        let emoji_string = String::from("HEART");
        let emoji = EmojiType::new().with_emoji_type(emoji_string);
        assert_eq!(emoji.emoji_type, Some("HEART".to_string()));
    }

    #[test]
    fn test_emoji_type_serialization() {
        let emoji = EmojiType::new().with_emoji_type("LAUGH");
        let serialized = serde_json::to_string(&emoji).unwrap();
        let expected = json!({"emoji_type": "LAUGH"});
        let actual: Value = serde_json::from_str(&serialized).unwrap();
        assert_eq!(actual, expected);
    }

    #[test]
    fn test_emoji_type_serialization_none() {
        let emoji = EmojiType::new();
        let serialized = serde_json::to_string(&emoji).unwrap();
        let expected = json!({});
        let actual: Value = serde_json::from_str(&serialized).unwrap();
        assert_eq!(actual, expected);
    }
}

/// 测试消息反应结构
mod message_reaction_tests {
    use super::*;

    #[test]
    fn test_message_reaction_serialization_with_all_fields() {
        let reaction_user = ReactionUser {
            user_id: Some("user123".to_string()),
            name: Some("John Doe".to_string()),
            avatar: Some("http://example.com/avatar.jpg".to_string()),
            reaction_time: Some("1640995200".to_string()),
        };

        let reaction = MessageReaction {
            message_id: Some("msg123".to_string()),
            emoji_type: Some(EmojiType::new().with_emoji_type("SMILE")),
            reaction_count: Some(5),
            has_reacted: Some(true),
            reaction_users: Some(vec![reaction_user]),
        };

        let serialized = serde_json::to_string(&reaction).unwrap();
        assert!(serialized.contains("msg123"));
        assert!(serialized.contains("SMILE"));
        assert!(serialized.contains("5"));
        assert!(serialized.contains("true"));
        assert!(serialized.contains("user123"));
    }

    #[test] 
    fn test_message_reaction_serialization_with_none_fields() {
        let reaction = MessageReaction {
            message_id: None,
            emoji_type: None,
            reaction_count: None,
            has_reacted: None,
            reaction_users: None,
        };

        let serialized = serde_json::to_string(&reaction).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();
        assert_eq!(parsed, json!({}));
    }
}

/// 测试反应用户结构
mod reaction_user_tests {
    use super::*;

    #[test]
    fn test_reaction_user_complete_serialization() {
        let user = ReactionUser {
            user_id: Some("user456".to_string()),
            name: Some("Jane Smith".to_string()),
            avatar: Some("http://example.com/jane.jpg".to_string()),
            reaction_time: Some("1640995300".to_string()),
        };

        let serialized = serde_json::to_string(&user).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();
        
        assert_eq!(parsed["user_id"], "user456");
        assert_eq!(parsed["name"], "Jane Smith");
        assert_eq!(parsed["avatar"], "http://example.com/jane.jpg");
        assert_eq!(parsed["reaction_time"], "1640995300");
    }

    #[test]
    fn test_reaction_user_partial_serialization() {
        let user = ReactionUser {
            user_id: Some("user789".to_string()),
            name: None,
            avatar: None,
            reaction_time: Some("1640995400".to_string()),
        };

        let serialized = serde_json::to_string(&user).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();
        
        assert_eq!(parsed["user_id"], "user789");
        assert_eq!(parsed["reaction_time"], "1640995400");
        assert!(parsed.get("name").is_none());
        assert!(parsed.get("avatar").is_none());
    }
}

/// 测试Pin消息结构
mod pin_tests {
    use super::*;

    #[test]
    fn test_pin_complete_data() {
        let pin = Pin {
            pin_id: Some("pin123".to_string()),
            message_id: Some("msg456".to_string()),
            chat_id: Some("chat789".to_string()),
            operator_id: Some("user123".to_string()),
            pin_type: Some("message".to_string()),
            create_time: Some("1640995500".to_string()),
        };

        let serialized = serde_json::to_string(&pin).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["pin_id"], "pin123");
        assert_eq!(parsed["message_id"], "msg456");
        assert_eq!(parsed["chat_id"], "chat789");
        assert_eq!(parsed["operator_id"], "user123");
        assert_eq!(parsed["pin_type"], "message");
        assert_eq!(parsed["create_time"], "1640995500");
    }
}

/// 测试批量消息结构
mod batch_message_tests {
    use super::*;

    #[test]
    fn test_batch_message_with_progress() {
        let batch_msg = BatchMessage {
            batch_message_id: Some("batch123".to_string()),
            message_id: Some("msg789".to_string()),
            status: Some(BatchMessageStatus::PartialSuccess),
            sent_count: Some(150),
            read_count: Some(120),
            total_count: Some(200),
            progress: Some(0.75),
        };

        let serialized = serde_json::to_string(&batch_msg).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["batch_message_id"], "batch123");
        assert_eq!(parsed["status"], 1); // PartialSuccess = 1
        assert_eq!(parsed["sent_count"], 150);
        assert_eq!(parsed["read_count"], 120);
        assert_eq!(parsed["total_count"], 200);
        assert_eq!(parsed["progress"], 0.75);
    }
}

/// 测试图片信息结构
mod image_info_tests {
    use super::*;

    #[test]
    fn test_image_info_complete() {
        let image_info = ImageInfo {
            image_key: Some("img_key_123".to_string()),
            image_type: Some("png".to_string()),
            image_size: Some(1048576), // 1MB
            width: Some(1920),
            height: Some(1080),
        };

        let serialized = serde_json::to_string(&image_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["image_key"], "img_key_123");
        assert_eq!(parsed["image_type"], "png");
        assert_eq!(parsed["image_size"], 1048576);
        assert_eq!(parsed["width"], 1920);
        assert_eq!(parsed["height"], 1080);
    }

    #[test]
    fn test_image_info_minimal() {
        let image_info = ImageInfo {
            image_key: Some("img_key_456".to_string()),
            image_type: None,
            image_size: None,
            width: None,
            height: None,
        };

        let serialized = serde_json::to_string(&image_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["image_key"], "img_key_456");
        assert!(parsed.get("image_type").is_none());
        assert!(parsed.get("image_size").is_none());
        assert!(parsed.get("width").is_none());
        assert!(parsed.get("height").is_none());
    }
}

/// 测试文件信息结构
mod file_info_tests {
    use super::*;

    #[test]
    fn test_file_info_complete() {
        let file_info = FileInfo {
            file_key: Some("file_key_789".to_string()),
            file_name: Some("document.pdf".to_string()),
            file_type: Some("pdf".to_string()),
            file_size: Some(2097152), // 2MB
            file_token: Some("token_abc123".to_string()),
        };

        let serialized = serde_json::to_string(&file_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["file_key"], "file_key_789");
        assert_eq!(parsed["file_name"], "document.pdf");
        assert_eq!(parsed["file_type"], "pdf");
        assert_eq!(parsed["file_size"], 2097152);
        assert_eq!(parsed["file_token"], "token_abc123");
    }
}

/// 测试加急类型枚举
mod urgent_type_tests {
    use super::*;

    #[rstest]
    #[case(UrgentType::App, r#""app""#)]
    #[case(UrgentType::Sms, r#""sms""#)]
    #[case(UrgentType::Phone, r#""phone""#)]
    fn test_urgent_type_serialization(#[case] urgent_type: UrgentType, #[case] expected: &str) {
        let serialized = serde_json::to_string(&urgent_type).unwrap();
        assert_eq!(serialized, expected);
    }

    #[rstest]
    #[case(r#""app""#, UrgentType::App)]
    #[case(r#""sms""#, UrgentType::Sms)]
    #[case(r#""phone""#, UrgentType::Phone)]
    fn test_urgent_type_deserialization(#[case] json_str: &str, #[case] expected: UrgentType) {
        let deserialized: UrgentType = serde_json::from_str(json_str).unwrap();
        assert_eq!(deserialized, expected);
    }
}

/// 测试加急信息结构
mod urgent_info_tests {
    use super::*;

    #[test]
    fn test_urgent_info_sms_type() {
        let urgent_info = UrgentInfo {
            urgent_type: Some(UrgentType::Sms),
            user_id_list: Some(vec!["user1".to_string(), "user2".to_string()]),
            message: Some("紧急通知:请立即查看".to_string()),
        };

        let serialized = serde_json::to_string(&urgent_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["urgent_type"], "sms");
        assert_eq!(parsed["user_id_list"][0], "user1");
        assert_eq!(parsed["user_id_list"][1], "user2");
        assert_eq!(parsed["message"], "紧急通知:请立即查看");
    }
}

/// 测试URL预览信息
mod url_preview_tests {
    use super::*;

    #[test]
    fn test_url_preview_complete() {
        let url_preview = UrlPreview {
            url: Some("https://example.com".to_string()),
            title: Some("Example Website".to_string()),
            description: Some("This is an example website".to_string()),
            image_url: Some("https://example.com/image.jpg".to_string()),
            preview_type: Some("website".to_string()),
        };

        let serialized = serde_json::to_string(&url_preview).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["url"], "https://example.com");
        assert_eq!(parsed["title"], "Example Website");
        assert_eq!(parsed["description"], "This is an example website");
        assert_eq!(parsed["image_url"], "https://example.com/image.jpg");
        assert_eq!(parsed["preview_type"], "website");
    }
}

/// 测试分页信息
mod page_info_tests {
    use super::*;

    #[test]
    fn test_page_info_with_more_data() {
        let page_info = PageInfo {
            page_token: Some("token_next_page".to_string()),
            has_more: Some(true),
        };

        let serialized = serde_json::to_string(&page_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["page_token"], "token_next_page");
        assert_eq!(parsed["has_more"], true);
    }

    #[test]
    fn test_page_info_no_more_data() {
        let page_info = PageInfo {
            page_token: None,
            has_more: Some(false),
        };

        let serialized = serde_json::to_string(&page_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();

        assert_eq!(parsed["has_more"], false);
        assert!(parsed.get("page_token").is_none());
    }
}

/// 属性测试 - 使用 proptest 进行随机化测试
#[cfg(test)]
mod property_tests {
    use super::*;
    use proptest::prelude::*;

    proptest! {
        #[test]
        fn test_message_type_roundtrip_serialization(msg_type in prop::sample::select(vec![
            MessageType::Text,
            MessageType::Post,
            MessageType::Image,
            MessageType::File,
            MessageType::Audio,
            MessageType::Media,
            MessageType::Sticker,
            MessageType::Interactive,
            MessageType::ShareChat,
            MessageType::ShareUser,
            MessageType::System,
        ])) {
            let serialized = serde_json::to_string(&msg_type).unwrap();
            let deserialized: MessageType = serde_json::from_str(&serialized).unwrap();
            prop_assert_eq!(msg_type, deserialized);
        }

        #[test]
        fn test_user_id_type_as_str_not_empty(id_type in prop::sample::select(vec![
            UserIdType::UserId,
            UserIdType::UnionId,
            UserIdType::OpenId,
        ])) {
            prop_assert!(!id_type.as_str().is_empty());
        }

        #[test]
        fn test_batch_message_status_roundtrip(status in prop::sample::select(vec![
            BatchMessageStatus::Processing,
            BatchMessageStatus::PartialSuccess,
            BatchMessageStatus::Success,
            BatchMessageStatus::Failed,
        ])) {
            let serialized = serde_json::to_string(&status).unwrap();
            let deserialized: BatchMessageStatus = serde_json::from_str(&serialized).unwrap();
            prop_assert_eq!(status, deserialized);
        }

        #[test]
        fn test_emoji_type_with_random_string(emoji_str in "\\PC{1,20}") {
            let emoji = EmojiType::new().with_emoji_type(emoji_str.clone());
            prop_assert_eq!(emoji.emoji_type, Some(emoji_str));
        }
    }
}

/// 边界条件和错误处理测试
#[cfg(test)]
mod edge_cases_tests {
    use super::*;

    #[test]
    fn test_invalid_message_type_deserialization() {
        let result: Result<MessageType, _> = serde_json::from_str(r#""invalid_type""#);
        assert!(result.is_err());
    }

    #[test]
    fn test_invalid_user_id_type_deserialization() {
        let result: Result<UserIdType, _> = serde_json::from_str(r#""invalid_id_type""#);
        assert!(result.is_err());
    }

    #[test]
    fn test_invalid_batch_message_status_deserialization() {
        let result: Result<BatchMessageStatus, _> = serde_json::from_str("999");
        assert!(result.is_err());
    }

    #[test]
    fn test_emoji_type_empty_string() {
        let emoji = EmojiType::new().with_emoji_type("");
        assert_eq!(emoji.emoji_type, Some("".to_string()));
    }

    #[test]
    fn test_very_long_emoji_string() {
        let long_string = "A".repeat(1000);
        let emoji = EmojiType::new().with_emoji_type(long_string.clone());
        assert_eq!(emoji.emoji_type, Some(long_string));
    }

    #[test]
    fn test_special_characters_in_emoji() {
        let special_emoji = "😀🎉💯";
        let emoji = EmojiType::new().with_emoji_type(special_emoji);
        assert_eq!(emoji.emoji_type, Some(special_emoji.to_string()));
    }

    #[test]
    fn test_message_reaction_large_count() {
        let reaction = MessageReaction {
            message_id: Some("msg123".to_string()),
            emoji_type: None,
            reaction_count: Some(i32::MAX),
            has_reacted: Some(false),
            reaction_users: None,
        };

        let serialized = serde_json::to_string(&reaction).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();
        assert_eq!(parsed["reaction_count"], i32::MAX);
    }

    #[test]
    fn test_image_info_zero_dimensions() {
        let image_info = ImageInfo {
            image_key: Some("test".to_string()),
            image_type: Some("png".to_string()),
            image_size: Some(0),
            width: Some(0),
            height: Some(0),
        };

        let serialized = serde_json::to_string(&image_info).unwrap();
        let parsed: Value = serde_json::from_str(&serialized).unwrap();
        assert_eq!(parsed["width"], 0);
        assert_eq!(parsed["height"], 0);
        assert_eq!(parsed["image_size"], 0);
    }
}