qubit-progress 0.5.0

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

use std::{
    panic::{
        AssertUnwindSafe,
        catch_unwind,
    },
    sync::{
        Arc,
        Mutex,
        atomic::{
            AtomicUsize,
            Ordering,
        },
    },
    thread,
    time::Duration,
};

use qubit_progress::{
    Progress,
    ProgressCounter,
    ProgressEvent,
    ProgressPhase,
    ProgressReporter,
    ProgressSchema,
    RunningProgressGuard,
    RunningProgressPointHandle,
};

#[derive(Debug, Default)]
struct RecordingReporter {
    events: Mutex<Vec<ProgressEvent>>,
}

impl RecordingReporter {
    fn events(&self) -> Vec<ProgressEvent> {
        self.events
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .clone()
    }
}

impl ProgressReporter for RecordingReporter {
    fn report(&self, event: &ProgressEvent) {
        self.events
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .push(event.clone());
    }
}

#[derive(Debug)]
struct PanickingReporter;

impl ProgressReporter for PanickingReporter {
    fn report(&self, _event: &ProgressEvent) {
        panic!("progress reporter panic");
    }
}

fn schema() -> ProgressSchema {
    ProgressSchema::single("entries", "Entries")
}

#[test]
fn test_running_progress_guard_reports_zero_interval_running_points() {
    let reporter = RecordingReporter::default();
    let completed_count = Arc::new(AtomicUsize::new(0));

    thread::scope(|scope| {
        let loop_completed_count = Arc::clone(&completed_count);
        let progress = Progress::new(&reporter, Duration::ZERO, schema());
        let running_progress: RunningProgressGuard<'_> = progress.spawn_running_reporter(scope, move || {
            vec![
                ProgressCounter::new("entries")
                    .total(2)
                    .completed(loop_completed_count.load(Ordering::Acquire) as u64),
            ]
        });
        let progress_point_handle: RunningProgressPointHandle = running_progress.point_handle();

        completed_count.store(1, Ordering::Release);
        assert!(progress_point_handle.report());
        running_progress.stop_and_join();
    });

    let events = reporter.events();
    assert!(events.iter().any(|event| {
        event.phase() == ProgressPhase::Running
            && event.counter("entries").map(ProgressCounter::completed_count) == Some(1)
    }));
}

#[test]
fn test_running_progress_guard_stop_and_join_propagates_reporter_panic() {
    let reporter = PanickingReporter;
    let panic_result = catch_unwind(AssertUnwindSafe(|| {
        thread::scope(|scope| {
            let progress = Progress::new(&reporter, Duration::ZERO, schema());
            let running_progress =
                progress.spawn_running_reporter(scope, || vec![ProgressCounter::new("entries").total(1)]);
            let progress_point_handle = running_progress.point_handle();

            assert!(progress_point_handle.report());
            running_progress.stop_and_join();
        });
    }));

    assert!(panic_result.is_err());
}