gouqi 0.20.0

Rust interface for Jira
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

//! Additional tests to improve coverage for cache functionality

#[cfg(feature = "cache")]
mod cache_tests {
    use gouqi::cache::{
        Cache, CacheStats, MemoryCache, RuntimeCacheConfig, RuntimeCacheStrategy,
        generate_cache_key, jira_cache_key,
    };
    use std::collections::HashMap;
    use std::thread;
    use std::time::Duration;

    #[test]
    fn test_memory_cache_new() {
        let cache = MemoryCache::new(Duration::from_secs(60));
        let stats = cache.stats();

        assert_eq!(stats.total_entries, 0);
        assert_eq!(stats.active_entries, 0);
        assert_eq!(cache.default_ttl(), Duration::from_secs(60));
    }

    #[test]
    fn test_memory_cache_with_capacity() {
        let cache = MemoryCache::with_capacity(10, Duration::from_secs(30));
        let stats = cache.stats();

        assert_eq!(stats.max_capacity, 10);
        assert_eq!(cache.default_ttl(), Duration::from_secs(30));
    }

    #[test]
    fn test_cache_set_and_get() {
        let cache = MemoryCache::new(Duration::from_secs(60));

        let key = "test_key";
        let value = b"test_value".to_vec();

        cache.set(key, value.clone(), Duration::from_secs(60));

        let retrieved = cache.get(key);
        assert!(retrieved.is_some());
        assert_eq!(retrieved.unwrap(), value);
    }

    #[test]
    fn test_cache_expiration() {
        let cache = MemoryCache::new(Duration::from_secs(60));

        let key = "expiring_key";
        let value = b"expiring_value".to_vec();

        // Set with very short TTL
        cache.set(key, value, Duration::from_millis(10));

        // Should be available immediately
        assert!(cache.get(key).is_some());

        // Wait for expiration
        thread::sleep(Duration::from_millis(20));

        // Should be expired
        assert!(cache.get(key).is_none());
    }

    #[test]
    fn test_cache_delete() {
        let cache = MemoryCache::new(Duration::from_secs(60));

        let key = "delete_key";
        let value = b"delete_value".to_vec();

        cache.set(key, value, Duration::from_secs(60));
        assert!(cache.get(key).is_some());

        cache.delete(key);
        assert!(cache.get(key).is_none());
    }

    #[test]
    fn test_cache_clear() {
        let cache = MemoryCache::new(Duration::from_secs(60));

        cache.set("key1", b"value1".to_vec(), Duration::from_secs(60));
        cache.set("key2", b"value2".to_vec(), Duration::from_secs(60));
        cache.set("key3", b"value3".to_vec(), Duration::from_secs(60));

        let stats = cache.stats();
        assert_eq!(stats.total_entries, 3);

        cache.clear();

        let stats_after = cache.stats();
        assert_eq!(stats_after.total_entries, 0);
    }

    #[test]
    fn test_cache_stats() {
        let cache = MemoryCache::new(Duration::from_secs(60));

        cache.set("key1", b"short".to_vec(), Duration::from_secs(60));
        cache.set("key2", b"longer_value".to_vec(), Duration::from_millis(10));

        let stats = cache.stats();
        assert_eq!(stats.total_entries, 2);
        assert!(stats.total_size_bytes > 0);

        // Wait for one to expire
        thread::sleep(Duration::from_millis(20));

        let stats_after = cache.stats();
        assert_eq!(stats_after.total_entries, 2); // Still 2 total
        assert_eq!(stats_after.active_entries, 1); // Only 1 active
        assert_eq!(stats_after.expired_entries, 1); // 1 expired
    }

    #[test]
    fn test_cache_cleanup_expired() {
        let cache = MemoryCache::new(Duration::from_secs(60));

        cache.set("active", b"value1".to_vec(), Duration::from_secs(60));
        cache.set("expiring", b"value2".to_vec(), Duration::from_millis(10));

        thread::sleep(Duration::from_millis(20));

        // Before cleanup, both entries exist
        let stats_before = cache.stats();
        assert_eq!(stats_before.total_entries, 2);

        // Cleanup expired entries
        cache.cleanup_expired();

        // After cleanup, only active entry remains
        let stats_after = cache.stats();
        assert_eq!(stats_after.total_entries, 1);
        assert_eq!(stats_after.active_entries, 1);
    }

    #[test]
    fn test_cache_lru_eviction() {
        let cache = MemoryCache::with_capacity(3, Duration::from_secs(60));

        // Fill cache to capacity
        cache.set("key1", b"value1".to_vec(), Duration::from_secs(60));
        thread::sleep(Duration::from_millis(10));
        cache.set("key2", b"value2".to_vec(), Duration::from_secs(60));
        thread::sleep(Duration::from_millis(10));
        cache.set("key3", b"value3".to_vec(), Duration::from_secs(60));

        let stats = cache.stats();
        assert_eq!(stats.total_entries, 3);

        // Adding one more should evict the oldest (key1)
        cache.set("key4", b"value4".to_vec(), Duration::from_secs(60));

        // key1 should be evicted
        assert!(cache.get("key1").is_none());
        // Others should still be there
        assert!(cache.get("key2").is_some());
        assert!(cache.get("key3").is_some());
        assert!(cache.get("key4").is_some());

        let stats_after = cache.stats();
        assert_eq!(stats_after.total_entries, 3);
    }

    #[test]
    fn test_cache_stats_utilization() {
        let stats = CacheStats {
            total_entries: 5,
            active_entries: 8,
            expired_entries: 2,
            total_size_bytes: 1000,
            max_capacity: 10,
        };

        assert_eq!(stats.utilization_percent(), 80.0);
    }

    #[test]
    fn test_cache_stats_avg_entry_size() {
        let stats = CacheStats {
            total_entries: 5,
            active_entries: 4,
            expired_entries: 1,
            total_size_bytes: 400,
            max_capacity: 10,
        };

        assert_eq!(stats.avg_entry_size_bytes(), 100.0);
    }

    #[test]
    fn test_cache_stats_empty() {
        let stats = CacheStats::empty();

        assert_eq!(stats.total_entries, 0);
        assert_eq!(stats.active_entries, 0);
        assert_eq!(stats.expired_entries, 0);
        assert_eq!(stats.total_size_bytes, 0);
        assert_eq!(stats.max_capacity, 0);
        assert_eq!(stats.utilization_percent(), 0.0);
        assert_eq!(stats.avg_entry_size_bytes(), 0.0);
    }

    #[test]
    fn test_generate_cache_key() {
        let key1 = generate_cache_key("/rest/api/2/issue/TEST-1", "");
        let key2 = generate_cache_key("/rest/api/2/issue/TEST-1", "expand=changelog");
        let key3 = generate_cache_key("/rest/api/2/issue/TEST-2", "");

        // Same endpoint and params should generate same key
        let key1_again = generate_cache_key("/rest/api/2/issue/TEST-1", "");
        assert_eq!(key1, key1_again);

        // Different params should generate different key
        assert_ne!(key1, key2);

        // Different endpoint should generate different key
        assert_ne!(key1, key3);

        // Keys should be readable (contain endpoint)
        assert!(key1.contains("_rest_api_2_issue_TEST-1"));
    }

    #[test]
    fn test_jira_cache_key() {
        let key1 = jira_cache_key("issues", "TEST-1", "");
        let key2 = jira_cache_key("issues", "TEST-1", "expand=changelog");
        let key3 = jira_cache_key("issues", "TEST-2", "");
        let key4 = jira_cache_key("issues", "", "jql=project=TEST");

        // Same operation and resource should generate same key
        let key1_again = jira_cache_key("issues", "TEST-1", "");
        assert_eq!(key1, key1_again);

        // Different params should generate different key
        assert_ne!(key1, key2);

        // Different resource should generate different key
        assert_ne!(key1, key3);

        // Empty resource should work
        assert!(key4.contains("issues"));
    }

    #[test]
    fn test_runtime_cache_config_default() {
        let config = RuntimeCacheConfig::default();

        assert!(config.enabled);
        assert_eq!(config.default_ttl, Duration::from_secs(300));
        assert_eq!(config.max_entries, 1000);
        assert!(config.strategies.contains_key("issues"));
        assert!(config.strategies.contains_key("projects"));
        assert!(config.strategies.contains_key("users"));
        assert!(config.strategies.contains_key("search"));
    }

    #[test]
    fn test_runtime_cache_config_strategy_for_endpoint() {
        let config = RuntimeCacheConfig::default();

        // Should find matching strategy for issues
        let issues_strategy = config.strategy_for_endpoint("/rest/api/2/issues/TEST-1");
        assert_eq!(issues_strategy.ttl, Duration::from_secs(300));

        // Should find matching strategy for projects
        let projects_strategy = config.strategy_for_endpoint("/rest/api/2/projects");
        assert_eq!(projects_strategy.ttl, Duration::from_secs(3600));

        // Should find matching strategy for users
        let users_strategy = config.strategy_for_endpoint("/rest/api/2/users/john");
        assert_eq!(users_strategy.ttl, Duration::from_secs(1800));

        // Should return default for unknown endpoint
        let unknown_strategy = config.strategy_for_endpoint("/rest/api/2/unknown");
        assert_eq!(unknown_strategy.ttl, config.default_ttl);
    }

    #[test]
    fn test_runtime_cache_config_should_cache_endpoint() {
        let config = RuntimeCacheConfig::default();

        // Should cache regular endpoints
        assert!(config.should_cache_endpoint("/rest/api/2/issues/TEST-1"));
        assert!(config.should_cache_endpoint("/rest/api/2/projects"));

        // Should not cache search endpoints by default
        assert!(!config.should_cache_endpoint("/rest/api/2/search"));
    }

    #[test]
    fn test_runtime_cache_config_disabled() {
        let config = RuntimeCacheConfig {
            enabled: false,
            ..Default::default()
        };

        // Should not cache any endpoint when disabled
        assert!(!config.should_cache_endpoint("/rest/api/2/issues/TEST-1"));
        assert!(!config.should_cache_endpoint("/rest/api/2/projects"));
    }

    #[test]
    fn test_runtime_cache_strategy() {
        let strategy = RuntimeCacheStrategy {
            ttl: Duration::from_secs(600),
            cache_errors: true,
            use_etag: false,
        };

        assert_eq!(strategy.ttl, Duration::from_secs(600));
        assert!(strategy.cache_errors);
        assert!(!strategy.use_etag);
    }

    #[test]
    fn test_runtime_cache_config_custom_strategies() {
        let mut strategies = HashMap::new();
        strategies.insert(
            "custom".to_string(),
            RuntimeCacheStrategy {
                ttl: Duration::from_secs(120),
                cache_errors: false,
                use_etag: true,
            },
        );

        let config = RuntimeCacheConfig {
            enabled: true,
            default_ttl: Duration::from_secs(60),
            max_entries: 500,
            strategies,
        };

        let custom_strategy = config.strategy_for_endpoint("/rest/api/2/custom");
        assert_eq!(custom_strategy.ttl, Duration::from_secs(120));
    }
}