qubit-progress 0.5.0

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
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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Tests for `ProgressEvent`.

use std::time::Duration;

use qubit_progress::model::{
    ProgressCounter,
    ProgressEvent,
    ProgressMetric,
    ProgressPhase,
    ProgressSchema,
    ProgressStage,
};

fn schema() -> ProgressSchema {
    ProgressSchema::new(vec![ProgressMetric::new("entries", "Entries")])
}

fn counters() -> Vec<ProgressCounter> {
    vec![ProgressCounter::new("entries").total(8).completed(2)]
}

#[test]
fn test_progress_event_carries_schema_phase_stage_counters_and_timing() {
    let stage = ProgressStage::new("copy", "Copy files")
        .with_index(1)
        .with_total_stages(4)
        .with_weight(0.5);
    let event = ProgressEvent::running(schema(), counters(), Duration::from_secs(3)).with_stage(stage.clone());

    assert_eq!(event.phase(), ProgressPhase::Running);
    assert_eq!(event.stage(), Some(&stage));
    assert_eq!(event.schema().metric_name("entries"), Some("Entries"));
    assert_eq!(event.counter("entries").map(ProgressCounter::completed_count), Some(2));
    assert_eq!(event.elapsed(), Duration::from_secs(3));
}

#[test]
fn test_progress_event_constructors_cover_terminal_phases() {
    let started = ProgressEvent::started(schema(), counters(), Duration::ZERO);
    let finished = ProgressEvent::finished(schema(), counters(), Duration::from_secs(1));
    let failed = ProgressEvent::failed(schema(), counters(), Duration::from_secs(2));
    let canceled = ProgressEvent::canceled(schema(), counters(), Duration::from_secs(3));

    assert_eq!(started.phase(), ProgressPhase::Started);
    assert_eq!(started.stage(), None);
    assert_eq!(
        started.counter("entries").map(ProgressCounter::completed_count),
        Some(2)
    );
    assert_eq!(finished.phase(), ProgressPhase::Finished);
    assert_eq!(failed.phase(), ProgressPhase::Failed);
    assert_eq!(canceled.phase(), ProgressPhase::Canceled);
}

#[test]
fn test_progress_event_from_phase_creates_matching_event() {
    let elapsed = Duration::from_millis(125);

    for phase in [
        ProgressPhase::Started,
        ProgressPhase::Running,
        ProgressPhase::Finished,
        ProgressPhase::Failed,
        ProgressPhase::Canceled,
    ] {
        let event = ProgressEvent::from_phase(schema(), phase, counters(), elapsed);

        assert_eq!(event.phase(), phase);
        assert_eq!(event.stage(), None);
        assert_eq!(event.counter("entries").map(ProgressCounter::completed_count), Some(2));
        assert_eq!(event.elapsed(), elapsed);
    }
}

#[test]
fn test_progress_event_builder_and_new_constructor() {
    let built = ProgressEvent::builder(schema())
        .phase(ProgressPhase::Finished)
        .counter("entries", |counter| counter.total(2).completed(2))
        .elapsed(Duration::from_millis(250))
        .build();
    assert_eq!(built.phase(), ProgressPhase::Finished);
    assert_eq!(
        built.counter("entries").map(ProgressCounter::total_count),
        Some(Some(2))
    );
    assert_eq!(built.counter("entries").map(ProgressCounter::completed_count), Some(2));
    assert_eq!(built.elapsed(), Duration::from_millis(250));

    let rebuilt = ProgressEvent::new(
        ProgressEvent::builder(schema())
            .phase(ProgressPhase::Failed)
            .counter("entries", |counter| counter.completed(1).failed(1)),
    );
    assert_eq!(rebuilt.phase(), ProgressPhase::Failed);
    assert_eq!(
        rebuilt.counter("entries").map(ProgressCounter::completed_count),
        Some(1)
    );
    assert_eq!(rebuilt.counter("entries").map(ProgressCounter::failed_count), Some(1));
}

#[test]
fn test_progress_event_serializes_to_self_describing_json() {
    let event = ProgressEvent::builder(schema())
        .running()
        .counter("entries", |counter| counter.total(5).completed(2))
        .elapsed(Duration::from_millis(110))
        .build();

    let json = serde_json::to_string(&event).expect("event should serialize");
    assert!(json.contains("\"schema\""));
    assert!(json.contains("\"metric_id\":\"entries\""));
    assert!(json.contains("\"elapsed\":\"110ms\""));

    let decoded: ProgressEvent = serde_json::from_str(&json).expect("event should deserialize");
    assert_eq!(decoded.elapsed(), Duration::from_millis(110));
    assert_eq!(
        decoded.counter("entries").map(ProgressCounter::completed_count),
        Some(2)
    );
}

#[test]
fn test_progress_types_are_reexported_from_crate_root() {
    let event: qubit_progress::ProgressEvent = ProgressEvent::running(
        qubit_progress::ProgressSchema::single("entries", "Entries"),
        vec![qubit_progress::ProgressCounter::new("entries")],
        Duration::ZERO,
    );
    let phase: qubit_progress::ProgressPhase = event.phase();

    assert_eq!(phase, ProgressPhase::Running);
}