qubit-progress 0.8.3

Generic progress reporting abstractions for Qubit Rust libraries
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Stage metadata behavior.

use qubit_progress::Metric;
use qubit_progress::Progress;
use qubit_progress::Stage;
use qubit_progress::TextReporter;
#[cfg(feature = "serde")]
use serde_json::from_value;
#[cfg(feature = "serde")]
use serde_json::json;

/// Verifies that stage builders retain their supplied optional position.
#[test]
fn test_stage_retains_position_metadata() {
    let stage = Stage::new("copy", "Copy").position(2, 3);
    assert_eq!(stage.id(), "copy");
    assert_eq!(stage.name(), "Copy");
    assert_eq!(stage.position_value(), Some(2));
    assert_eq!(stage.total(), Some(3));
}

/// Verifies a stage without optional position metadata is accepted by start.
#[test]
fn test_progress_accepts_stage_without_position() {
    let reporter = TextReporter::new(Vec::new());
    let progress = Progress::builder(&reporter)
        .stage(Stage::new("copy", "Copy"))
        .metric(Metric::new("tasks", "Tasks"))
        .start()
        .expect("stage without position must be valid");
    assert!(progress.is_enabled());
}

/// Verifies standalone stage deserialization rejects invalid metadata.
#[cfg(feature = "serde")]
#[test]
fn test_stage_deserialization_rejects_invalid_metadata() {
    for value in [
        json!({"id": "", "name": "Copy", "position": null, "total": null}),
        json!({"id": "copy", "name": "", "position": null, "total": null}),
        json!({"id": "copy", "name": "Copy", "position": 1, "total": null}),
        json!({"id": "copy", "name": "Copy", "position": 0, "total": 1}),
        json!({"id": "copy", "name": "Copy", "position": 2, "total": 1}),
    ] {
        assert!(from_value::<Stage>(value).is_err());
    }
}