aria2-core 0.3.7

aria2-rust core download engine: multi-protocol segmented downloads, rate limiting, configuration, session persistence, and BitTorrent seeding
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
//! Tests for BtRequestFactory.

#![allow(dead_code)] // test infrastructure reused across suites

use super::*;
use crate::segment::piece::Piece;
use std::sync::Arc;

// -- Mock PieceStorageProvider for testing --

/// Mock piece storage provider that tracks cancel_piece calls.
#[derive(Debug)]
struct MockPieceStorage {
    cancelled: Arc<std::sync::Mutex<Vec<(usize, u64)>>>,
}

impl MockPieceStorage {
    fn new() -> Self {
        Self {
            cancelled: Arc::new(std::sync::Mutex::new(Vec::new())),
        }
    }

    fn cancelled_pieces(&self) -> Vec<(usize, u64)> {
        self.cancelled.lock().unwrap().clone()
    }
}

impl PieceStorageProvider for MockPieceStorage {
    fn cancel_piece(&self, piece_index: usize, cuid: u64) {
        self.cancelled.lock().unwrap().push((piece_index, cuid));
    }
}

// -- Helper: create a piece with the given index and length --

fn make_piece(index: usize, length: u64) -> Piece {
    Piece::new(index, length)
}

// -- Construction tests --

#[test]
fn test_new_factory() {
    let factory = BtRequestFactory::new(16384);
    assert_eq!(factory.count_target_piece(), 0);
    assert_eq!(factory.count_missing_block(), 0);
    assert!(factory.get_target_piece_indexes().is_empty());
}

#[test]
fn test_set_cuid() {
    let mut factory = BtRequestFactory::new(16384);
    factory.set_cuid(42);
    assert_eq!(factory.cuid, 42);
}

// -- Add/remove target piece tests --

#[test]
fn test_add_target_piece() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));
    assert_eq!(factory.count_target_piece(), 2);
    assert_eq!(factory.get_target_piece_indexes(), vec![0, 1]);
}

#[test]
fn test_remove_target_piece() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));
    factory.add_target_piece(make_piece(2, 65536));

    let removed = factory.remove_target_piece(1);
    assert!(removed.is_some());
    assert_eq!(removed.unwrap().index(), 1);
    assert_eq!(factory.count_target_piece(), 2);
    assert_eq!(factory.get_target_piece_indexes(), vec![0, 2]);
}

#[test]
fn test_remove_target_piece_not_found() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    let removed = factory.remove_target_piece(99);
    assert!(removed.is_none());
    assert_eq!(factory.count_target_piece(), 1);
}

#[test]
fn test_remove_target_piece_cancels_in_storage() {
    let mut factory = BtRequestFactory::new(16384);
    let mock_storage = MockPieceStorage::new();
    factory.set_piece_storage(Box::new(MockPieceStorage {
        cancelled: mock_storage.cancelled.clone(),
    }));
    factory.set_cuid(42);

    factory.add_target_piece(make_piece(5, 65536));
    factory.remove_target_piece(5);

    let cancelled = mock_storage.cancelled_pieces();
    assert_eq!(cancelled.len(), 1);
    assert_eq!(cancelled[0], (5, 42));
}

#[test]
fn test_remove_all_target_pieces() {
    let mut factory = BtRequestFactory::new(16384);
    let mock_storage = MockPieceStorage::new();
    factory.set_piece_storage(Box::new(MockPieceStorage {
        cancelled: mock_storage.cancelled.clone(),
    }));
    factory.set_cuid(10);

    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));
    factory.add_target_piece(make_piece(2, 65536));

    let removed = factory.remove_all_target_pieces();
    assert_eq!(removed.len(), 3);
    assert_eq!(factory.count_target_piece(), 0);

    // All pieces should be cancelled in storage
    let cancelled = mock_storage.cancelled_pieces();
    assert_eq!(cancelled.len(), 3);
    assert_eq!(cancelled[0], (0, 10));
    assert_eq!(cancelled[1], (1, 10));
    assert_eq!(cancelled[2], (2, 10));
}

#[test]
fn test_remove_all_target_pieces_empty() {
    let mut factory = BtRequestFactory::new(16384);
    let removed = factory.remove_all_target_pieces();
    assert!(removed.is_empty());
}

// -- Count missing block tests --

#[test]
fn test_count_missing_block_empty() {
    let factory = BtRequestFactory::new(16384);
    assert_eq!(factory.count_missing_block(), 0);
}

#[test]
fn test_count_missing_block_aggregation() {
    let mut factory = BtRequestFactory::new(16384);
    // Two pieces with 4 blocks each = 8 missing blocks
    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));
    assert_eq!(factory.count_missing_block(), 8);
}

#[test]
fn test_count_missing_block_after_partial_completion() {
    let mut factory = BtRequestFactory::new(16384);
    let mut piece = make_piece(0, 65536);
    piece.complete_block(0); // 1 of 4 blocks complete
    piece.complete_block(1); // 2 of 4 blocks complete
    factory.add_target_piece(piece);
    assert_eq!(factory.count_missing_block(), 2);
}

// -- Remove completed piece tests --

#[test]
fn test_remove_completed_piece() {
    let mut factory = BtRequestFactory::new(16384);

    let mut piece0 = make_piece(0, 65536);
    piece0.complete_block(0);
    piece0.complete_block(1);
    piece0.complete_block(2);
    piece0.complete_block(3);

    let piece1 = make_piece(1, 65536); // Not complete

    factory.add_target_piece(piece0);
    factory.add_target_piece(piece1);

    let removed = factory.remove_completed_piece();
    assert_eq!(removed, vec![0]);
    assert_eq!(factory.count_target_piece(), 1);
    assert_eq!(factory.get_target_piece_indexes(), vec![1]);
}

#[test]
fn test_remove_completed_piece_none_complete() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    let removed = factory.remove_completed_piece();
    assert!(removed.is_empty());
    assert_eq!(factory.count_target_piece(), 1);
}

#[test]
fn test_remove_completed_piece_all_complete() {
    let mut factory = BtRequestFactory::new(16384);

    let mut piece0 = make_piece(0, 65536);
    let mut piece1 = make_piece(1, 65536);
    // Complete all blocks
    for i in 0..4 {
        piece0.complete_block(i);
        piece1.complete_block(i);
    }

    factory.add_target_piece(piece0);
    factory.add_target_piece(piece1);

    let removed = factory.remove_completed_piece();
    assert_eq!(removed.len(), 2);
    assert!(removed.contains(&0));
    assert!(removed.contains(&1));
    assert_eq!(factory.count_target_piece(), 0);
}

// -- do_choked_action tests --

#[test]
fn test_do_choked_action_removes_non_allowed() {
    let mut factory = BtRequestFactory::new(16384);
    let mock_storage = MockPieceStorage::new();
    factory.set_piece_storage(Box::new(MockPieceStorage {
        cancelled: mock_storage.cancelled.clone(),
    }));
    factory.set_cuid(5);

    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));
    factory.add_target_piece(make_piece(2, 65536));

    // Only piece 1 is in allowed-fast
    let removed = factory.do_choked_action(|idx| idx == 1);
    assert_eq!(removed.len(), 2);
    assert!(removed.contains(&0));
    assert!(removed.contains(&2));
    assert_eq!(factory.count_target_piece(), 1);
    assert_eq!(factory.get_target_piece_indexes(), vec![1]);

    // Cancelled in storage
    let cancelled = mock_storage.cancelled_pieces();
    assert_eq!(cancelled.len(), 2);
}

#[test]
fn test_do_choked_action_all_allowed() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));

    let removed = factory.do_choked_action(|_| true);
    assert!(removed.is_empty());
    assert_eq!(factory.count_target_piece(), 2);
}

#[test]
fn test_do_choked_action_none_allowed() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));

    let removed = factory.do_choked_action(|_| false);
    assert_eq!(removed.len(), 2);
    assert_eq!(factory.count_target_piece(), 0);
}

// -- create_request_messages normal mode tests --

#[test]
fn test_create_request_messages_normal() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536)); // 4 blocks

    let requests = factory.create_request_messages(2, false, |_, _| false);
    assert_eq!(requests.len(), 2);
    assert_eq!(requests[0].index, 0);
    assert_eq!(requests[0].begin, 0);
    assert_eq!(requests[0].length, 16384);
    assert_eq!(requests[1].index, 0);
    assert_eq!(requests[1].begin, 16384);
    assert_eq!(requests[1].length, 16384);
}

#[test]
fn test_create_request_messages_normal_multiple_pieces() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 32768)); // 2 blocks
    factory.add_target_piece(make_piece(1, 32768)); // 2 blocks

    let requests = factory.create_request_messages(3, false, |_, _| false);
    assert_eq!(requests.len(), 3);
    // First 2 from piece 0
    assert_eq!(requests[0].index, 0);
    assert_eq!(requests[1].index, 0);
    // Third from piece 1
    assert_eq!(requests[2].index, 1);
}

#[test]
fn test_create_request_messages_max_count_zero() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));

    let requests = factory.create_request_messages(0, false, |_, _| false);
    assert!(requests.is_empty());
}

#[test]
fn test_create_request_messages_marks_blocks_in_use() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536)); // 4 blocks

    // First call: request 2 blocks
    let requests = factory.create_request_messages(2, false, |_, _| false);
    assert_eq!(requests.len(), 2);

    // Second call: blocks 0 and 1 are already in-use, so we get blocks 2 and 3
    let requests2 = factory.create_request_messages(2, false, |_, _| false);
    assert_eq!(requests2.len(), 2);
    assert_eq!(requests2[0].begin, 32768);
    assert_eq!(requests2[1].begin, 49152);

    // Third call: all blocks are either completed or in-use
    let requests3 = factory.create_request_messages(2, false, |_, _| false);
    assert!(requests3.is_empty());
}

#[test]
fn test_create_request_messages_empty_factory() {
    let mut factory = BtRequestFactory::new(16384);
    let requests = factory.create_request_messages(10, false, |_, _| false);
    assert!(requests.is_empty());
}

#[test]
fn test_create_request_messages_all_blocks_in_use() {
    let mut factory = BtRequestFactory::new(16384);
    let mut piece = make_piece(0, 32768); // 2 blocks
    // Mark both blocks as in-use
    piece.set_block_in_use(0);
    piece.set_block_in_use(1);
    factory.add_target_piece(piece);

    let requests = factory.create_request_messages(2, false, |_, _| false);
    assert!(requests.is_empty());
}

// -- create_request_messages endgame mode tests --

#[test]
fn test_create_request_messages_endgame() {
    let mut factory = BtRequestFactory::new(16384);
    let mut piece = make_piece(0, 65536); // 4 blocks
    // Complete block 0, leave blocks 1-3 missing
    piece.complete_block(0);
    factory.add_target_piece(piece);

    // In endgame mode, missing blocks 1-3 should be requested
    // (blocks 1-3 are all "missing" even if in-use)
    let requests = factory.create_request_messages(10, true, |_, _| false);
    // Should get requests for the 3 missing blocks
    assert_eq!(requests.len(), 3);
    // Verify all are for piece 0
    for req in &requests {
        assert_eq!(req.index, 0);
    }
}

#[test]
fn test_create_request_messages_endgame_skips_outstanding() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536)); // 4 blocks

    // Block 1 is outstanding (already requested by another peer)
    let requests = factory.create_request_messages(10, true, |piece_idx, block_idx| {
        piece_idx == 0 && block_idx == 1
    });

    // Should get requests for blocks 0, 2, 3 (block 1 is outstanding)
    assert_eq!(requests.len(), 3);
    let requested_blocks: Vec<u32> = requests.iter().map(|r| r.begin / 16384).collect();
    assert!(!requested_blocks.contains(&1));
}

#[test]
fn test_create_request_messages_endgame_max_count() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536)); // 4 blocks

    let requests = factory.create_request_messages(2, true, |_, _| false);
    assert_eq!(requests.len(), 2);
}

#[test]
fn test_create_request_messages_endgame_all_outstanding() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536)); // 4 blocks

    // All blocks are outstanding
    let requests = factory.create_request_messages(10, true, |_, _| true);
    assert!(requests.is_empty());
}

#[test]
fn test_create_request_messages_endgame_does_not_mark_in_use() {
    // In endgame mode, blocks are NOT marked as in-use on the Piece,
    // because multiple peers may request the same block.
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 32768)); // 2 blocks

    let _ = factory.create_request_messages(10, true, |_, _| false);

    // Verify the blocks are NOT marked as in-use (endgame doesn't mark)
    // We check by calling normal mode and seeing all blocks are still available
    let requests = factory.create_request_messages(2, false, |_, _| false);
    assert_eq!(requests.len(), 2);
}

// -- Edge case tests --

#[test]
fn test_get_target_piece_indexes() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(5, 65536));
    factory.add_target_piece(make_piece(10, 65536));
    factory.add_target_piece(make_piece(3, 65536));

    let indexes = factory.get_target_piece_indexes();
    assert_eq!(indexes, vec![5, 10, 3]); // Order preserved (FIFO)
}

#[test]
fn test_create_request_messages_piece_with_non_aligned_length() {
    let mut factory = BtRequestFactory::new(16384);
    // 50000 bytes = 4 blocks (last block is 848 bytes)
    factory.add_target_piece(make_piece(0, 50000));

    let requests = factory.create_request_messages(4, false, |_, _| false);
    assert_eq!(requests.len(), 4);
    // Last block length should be 848
    assert_eq!(requests[3].length, 848);
    assert_eq!(requests[3].begin, 49152);
}

#[test]
fn test_count_target_piece() {
    let mut factory = BtRequestFactory::new(16384);
    assert_eq!(factory.count_target_piece(), 0);
    factory.add_target_piece(make_piece(0, 65536));
    assert_eq!(factory.count_target_piece(), 1);
    factory.add_target_piece(make_piece(1, 65536));
    assert_eq!(factory.count_target_piece(), 2);
    factory.remove_target_piece(0);
    assert_eq!(factory.count_target_piece(), 1);
}

#[test]
fn test_remove_all_then_add() {
    let mut factory = BtRequestFactory::new(16384);
    factory.add_target_piece(make_piece(0, 65536));
    factory.add_target_piece(make_piece(1, 65536));
    factory.remove_all_target_pieces();
    assert_eq!(factory.count_target_piece(), 0);

    factory.add_target_piece(make_piece(2, 65536));
    assert_eq!(factory.count_target_piece(), 1);
    assert_eq!(factory.get_target_piece_indexes(), vec![2]);
}

#[test]
fn test_do_choked_action_empty_factory() {
    let mut factory = BtRequestFactory::new(16384);
    let removed = factory.do_choked_action(|_| false);
    assert!(removed.is_empty());
}

#[test]
fn test_create_request_messages_endgame_empty_factory() {
    let mut factory = BtRequestFactory::new(16384);
    let requests = factory.create_request_messages(10, true, |_, _| false);
    assert!(requests.is_empty());
}