caesura 0.29.0

An all-in-one command line tool to transcode FLAC audio files and upload to gazelle based indexers/trackers
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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
#![allow(clippy::indexing_slicing)] // Indexing is safe in tests after length checks

use super::super::Queue;
use crate::testing_prelude::*;
use flat_db::Hash;

/// Test that `Queue::set` adds an item successfully.
#[tokio::test]
async fn queue_set_adds_item() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_set_adds_item");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let item = QueueItem {
        name: "Test Item".to_owned(),
        path: PathBuf::from("/test/path.torrent"),
        hash,
        ..QueueItem::default()
    };

    // Act
    queue.set(item.clone()).await?;

    // Assert
    let retrieved = queue.get(hash).await?;
    assert!(retrieved.is_some());
    let retrieved = retrieved.expect("should have item");
    assert_eq!(retrieved.name, "Test Item");
    assert_eq!(retrieved.indexer, None);
    Ok(())
}

/// Test that `Queue::set_many` adds multiple items.
#[tokio::test]
async fn queue_set_many_adds_items() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_set_many_adds_items");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash1 = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let hash2 = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;

    let items = BTreeMap::from([
        (
            hash1,
            QueueItem {
                name: "Item One".to_owned(),
                path: PathBuf::from("/test/one.torrent"),
                hash: hash1,
                ..QueueItem::default()
            },
        ),
        (
            hash2,
            QueueItem {
                name: "Item Two".to_owned(),
                path: PathBuf::from("/test/two.torrent"),
                hash: hash2,
                ..QueueItem::default()
            },
        ),
    ]);

    // Act
    let added = queue.set_many(items, false).await?;

    // Assert
    assert_eq!(added, 2);
    assert!(queue.get(hash1).await?.is_some());
    assert!(queue.get(hash2).await?.is_some());
    Ok(())
}

/// Test that `Queue::set_many` with replace=false does not overwrite existing items.
#[tokio::test]
async fn queue_set_many_no_replace_skips_existing() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_set_many_no_replace");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;

    let original = QueueItem {
        name: "Original".to_owned(),
        path: PathBuf::from("/test/original.torrent"),
        hash,
        ..QueueItem::default()
    };
    queue.set(original).await?;

    let updated = BTreeMap::from([(
        hash,
        QueueItem {
            name: "Updated".to_owned(),
            path: PathBuf::from("/test/updated.torrent"),
            hash,
            ..QueueItem::default()
        },
    )]);

    // Act
    let added = queue.set_many(updated, false).await?;

    // Assert
    assert_eq!(added, 0); // Should not add since item exists
    let retrieved = queue.get(hash).await?.expect("should have item");
    assert_eq!(retrieved.name, "Original"); // Should keep original
    Ok(())
}

/// Test that `Queue::set_many` with replace=true overwrites existing items.
#[tokio::test]
async fn queue_set_many_with_replace_overwrites() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_set_many_with_replace");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;

    let original = QueueItem {
        name: "Original".to_owned(),
        path: PathBuf::from("/test/original.torrent"),
        hash,
        ..QueueItem::default()
    };
    queue.set(original).await?;

    let updated = BTreeMap::from([(
        hash,
        QueueItem {
            name: "Updated".to_owned(),
            path: PathBuf::from("/test/updated.torrent"),
            hash,
            ..QueueItem::default()
        },
    )]);

    // Act
    let added = queue.set_many(updated, true).await?;

    // Assert
    assert_eq!(added, 1); // Should replace
    let retrieved = queue.get(hash).await?.expect("should have item");
    assert_eq!(retrieved.name, "Updated"); // Should have new name
    Ok(())
}

/// Test that `Queue::get_all` returns all items.
#[tokio::test]
async fn queue_get_all_returns_all_items() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_get_all");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash1 = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let hash2 = Hash::<20>::from_string("ff00000000000000000000000000000000000000")?;

    queue
        .set(QueueItem {
            name: "Item 1".to_owned(),
            hash: hash1,
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Item 2".to_owned(),
            hash: hash2,
            ..QueueItem::default()
        })
        .await?;

    // Act
    let all = queue.get_all().await?;

    // Assert
    assert_eq!(all.len(), 2);
    Ok(())
}

/// Test that `Queue::remove` removes an existing item.
#[tokio::test]
async fn queue_remove_removes_existing_item() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_remove_existing");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let item = QueueItem {
        name: "Test Item".to_owned(),
        path: PathBuf::from("/test/path.torrent"),
        hash,
        ..QueueItem::default()
    };
    queue.set(item).await?;

    // Verify item exists
    assert!(queue.get(hash).await?.is_some());

    // Act
    let removed = queue.remove(hash).await?;

    // Assert
    assert!(removed.is_some());
    let removed = removed.expect("should have removed item");
    assert_eq!(removed.name, "Test Item");

    // Verify item no longer exists
    assert!(queue.get(hash).await?.is_none());
    Ok(())
}

/// Test that `Queue::remove` returns None for non-existent item.
#[tokio::test]
async fn queue_remove_nonexistent_returns_none() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_remove_nonexistent");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;

    // Act
    let removed = queue.remove(hash).await?;

    // Assert
    assert!(removed.is_none());
    Ok(())
}

/// Test that `Queue::remove` only removes the specified item.
#[tokio::test]
async fn queue_remove_only_affects_specified_item() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_remove_specific");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash1 = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let hash2 = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;

    queue
        .set(QueueItem {
            name: "Item One".to_owned(),
            path: PathBuf::from("/test/one.torrent"),
            hash: hash1,
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Item Two".to_owned(),
            path: PathBuf::from("/test/two.torrent"),
            hash: hash2,
            ..QueueItem::default()
        })
        .await?;

    // Act
    let removed = queue.remove(hash1).await?;

    // Assert
    assert!(removed.is_some());
    assert!(queue.get(hash1).await?.is_none()); // First item removed
    assert!(queue.get(hash2).await?.is_some()); // Second item still exists
    Ok(())
}

/// Test `get_unprocessed` filters by processing status.
#[tokio::test]
#[allow(deprecated)]
async fn queue_get_unprocessed() -> Result<(), TestError> {
    // Arrange
    let new = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let verified = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;
    let not_verified = Hash::<20>::from_string("0300000000000000000000000000000000000000")?;
    let transcoded = Hash::<20>::from_string("0400000000000000000000000000000000000000")?;
    let not_transcoded = Hash::<20>::from_string("0500000000000000000000000000000000000000")?;
    let uploaded = Hash::<20>::from_string("0600000000000000000000000000000000000000")?;
    let not_uploaded = Hash::<20>::from_string("0700000000000000000000000000000000000000")?;
    let temp = TempDirectory::create("queue_get_unprocessed");
    let queue = Queue::from_path(temp.to_path_buf());
    queue
        .set(QueueItem {
            name: "NEW".to_owned(),
            path: PathBuf::new(),
            hash: new,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "VERIFIED".to_owned(),
            path: PathBuf::new(),
            hash: verified,
            indexer: Some(Indexer::Red),
            verify: Some(VerifyStatus::verified()),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "VERIFY FAILURE".to_owned(),
            path: PathBuf::new(),
            hash: not_verified,
            indexer: Some(Indexer::Red),
            verify: Some(VerifyStatus::from_issue(SourceIssue::IdError {
                details: "missing id".to_owned(),
            })),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "TRANSCODED".to_owned(),
            path: PathBuf::new(),
            hash: transcoded,
            indexer: Some(Indexer::Red),
            verify: Some(VerifyStatus::verified()),
            transcode: Some(TranscodeStatus {
                success: true,
                completed: TimeStamp::now(),
                formats: None,
                error: None,
            }),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "TRANSCODE FAILURE".to_owned(),
            path: PathBuf::new(),
            hash: not_transcoded,
            indexer: Some(Indexer::Red),
            verify: Some(VerifyStatus::verified()),
            transcode: Some(TranscodeStatus {
                success: false,
                completed: TimeStamp::now(),
                formats: None,
                error: None,
            }),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "UPLOADED".to_owned(),
            path: PathBuf::new(),
            hash: uploaded,
            indexer: Some(Indexer::Red),
            verify: Some(VerifyStatus::verified()),
            transcode: Some(TranscodeStatus {
                success: true,
                completed: TimeStamp::now(),
                formats: None,
                error: None,
            }),
            upload: Some(UploadStatus {
                success: true,
                completed: TimeStamp::now(),
                formats: None,
                errors: None,
            }),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "UPLOAD FAILURE".to_owned(),
            path: PathBuf::new(),
            hash: not_uploaded,
            indexer: Some(Indexer::Red),
            verify: Some(VerifyStatus::verified()),
            transcode: Some(TranscodeStatus {
                success: true,
                completed: TimeStamp::now(),
                formats: None,
                error: None,
            }),
            upload: Some(UploadStatus {
                success: false,
                completed: TimeStamp::now(),
                formats: None,
                errors: None,
            }),
            ..QueueItem::default()
        })
        .await?;

    // Assert
    let verify = queue
        .get_unprocessed(Indexer::Red, false, false, false)
        .await?;
    assert_eq!(verify, vec![new]);
    let transcode = queue
        .get_unprocessed(Indexer::Red, true, false, false)
        .await?;
    assert_eq!(transcode, vec![new, verified]);
    let transcode_with_failed = queue
        .get_unprocessed(Indexer::Red, true, false, true)
        .await?;
    assert_eq!(transcode_with_failed, vec![new, not_transcoded, verified]);
    let upload = queue
        .get_unprocessed(Indexer::Red, true, true, false)
        .await?;
    assert_eq!(upload, vec![new, transcoded, verified]);
    let upload_with_failed = queue
        .get_unprocessed(Indexer::Red, true, true, true)
        .await?;
    assert_eq!(
        upload_with_failed,
        vec![new, not_transcoded, transcoded, verified]
    );
    Ok(())
}

/// Test `get_unprocessed` filters by indexer.
#[tokio::test]
async fn queue_get_unprocessed_filters_by_indexer() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_filter_indexer");
    let queue = Queue::from_path(temp.to_path_buf());
    let red_hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let ops_hash = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;

    queue
        .set(QueueItem {
            name: "RED Item".to_owned(),
            hash: red_hash,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "OPS Item".to_owned(),
            hash: ops_hash,
            indexer: Some(Indexer::Ops),
            ..QueueItem::default()
        })
        .await?;

    // Act
    let red_items = queue
        .get_unprocessed(Indexer::Red, false, false, false)
        .await?;
    let ops_items = queue
        .get_unprocessed(Indexer::Ops, false, false, false)
        .await?;

    // Assert
    assert_eq!(red_items.len(), 1);
    assert_eq!(red_items[0], red_hash);
    assert_eq!(ops_items.len(), 1);
    assert_eq!(ops_items[0], ops_hash);
    Ok(())
}

/// Test `get_unprocessed` includes PTH items when indexer is RED.
#[tokio::test]
async fn queue_get_unprocessed_red_includes_pth() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_red_includes_pth");
    let queue = Queue::from_path(temp.to_path_buf());
    let red_hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let pth_hash = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;

    queue
        .set(QueueItem {
            name: "RED Item".to_owned(),
            hash: red_hash,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "PTH Item".to_owned(),
            hash: pth_hash,
            indexer: Some(Indexer::Pth),
            ..QueueItem::default()
        })
        .await?;

    // Act
    let items = queue
        .get_unprocessed(Indexer::Red, false, false, false)
        .await?;

    // Assert - RED includes both RED and PTH items
    assert_eq!(items.len(), 2);
    Ok(())
}

/// Test `get_unprocessed` excludes items with [`None`] or unknown indexer.
///
/// Items with `None`, [`Indexer::Other(String::new())`] (the legacy unknown
/// sentinel from pre-`Option` queue files), or any other [`Indexer::Other`]
/// must never match a query for a known indexer.
#[tokio::test]
async fn queue_get_unprocessed_excludes_unknown_indexer() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_excludes_unknown_indexer");
    let queue = Queue::from_path(temp.to_path_buf());
    let none_hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let legacy_empty_hash = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;
    let other_hash = Hash::<20>::from_string("0300000000000000000000000000000000000000")?;
    let red_hash = Hash::<20>::from_string("0400000000000000000000000000000000000000")?;
    queue
        .set(QueueItem {
            name: "None Indexer".to_owned(),
            hash: none_hash,
            indexer: None,
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Legacy Empty Indexer".to_owned(),
            hash: legacy_empty_hash,
            indexer: Some(Indexer::Other(String::new())),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Other Indexer".to_owned(),
            hash: other_hash,
            indexer: Some(Indexer::Other("xyz".to_owned())),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "RED Item".to_owned(),
            hash: red_hash,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;

    // Act
    let items = queue
        .get_unprocessed(Indexer::Red, false, false, false)
        .await?;

    // Assert
    assert_eq!(items, vec![red_hash]);
    Ok(())
}

/// Test `get_unprocessed` sorts items by name.
#[tokio::test]
async fn queue_get_unprocessed_sorts_by_name() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_sorts_by_name");
    let queue = Queue::from_path(temp.to_path_buf());
    let hash_z = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let hash_a = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;
    let hash_m = Hash::<20>::from_string("0300000000000000000000000000000000000000")?;

    // Insert in non-alphabetical order
    queue
        .set(QueueItem {
            name: "Zebra Album".to_owned(),
            hash: hash_z,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Apple Album".to_owned(),
            hash: hash_a,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Mango Album".to_owned(),
            hash: hash_m,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;

    // Act
    let items = queue
        .get_unprocessed(Indexer::Red, false, false, false)
        .await?;

    // Assert - Should be sorted alphabetically: Apple, Mango, Zebra
    assert_eq!(items.len(), 3);
    assert_eq!(items[0], hash_a); // Apple
    assert_eq!(items[1], hash_m); // Mango
    assert_eq!(items[2], hash_z); // Zebra
    Ok(())
}

/// Test `get_unprocessed` excludes uploaded items.
#[tokio::test]
async fn queue_get_unprocessed_excludes_uploaded() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_excludes_uploaded");
    let queue = Queue::from_path(temp.to_path_buf());
    let uploaded_hash = Hash::<20>::from_string("0100000000000000000000000000000000000000")?;
    let pending_hash = Hash::<20>::from_string("0200000000000000000000000000000000000000")?;

    queue
        .set(QueueItem {
            name: "Uploaded Item".to_owned(),
            hash: uploaded_hash,
            indexer: Some(Indexer::Red),
            upload: Some(UploadStatus {
                success: true,
                completed: TimeStamp::now(),
                formats: None,
                errors: None,
            }),
            ..QueueItem::default()
        })
        .await?;
    queue
        .set(QueueItem {
            name: "Pending Item".to_owned(),
            hash: pending_hash,
            indexer: Some(Indexer::Red),
            ..QueueItem::default()
        })
        .await?;

    // Act
    let items = queue
        .get_unprocessed(Indexer::Red, true, true, false)
        .await?;

    // Assert - Should only return pending item
    assert_eq!(items.len(), 1);
    assert_eq!(items[0], pending_hash);
    Ok(())
}

/// Test `get_unprocessed` with empty queue returns empty list.
#[tokio::test]
async fn queue_get_unprocessed_empty_queue() -> Result<(), TestError> {
    // Arrange
    let temp = TempDirectory::create("queue_empty");
    let queue = Queue::from_path(temp.to_path_buf());

    // Act
    let items = queue
        .get_unprocessed(Indexer::Red, true, true, false)
        .await?;

    // Assert
    assert!(items.is_empty());
    Ok(())
}