rebecca 0.3.0

Cross-platform cleanup CLI and Rust library surface for Rebecca cleanup planning, rules, and platform adapters.
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

use anyhow::{Context, Result};
use rebecca::core::scan::ScanCancellationToken;

#[derive(Debug, Clone)]
pub(crate) struct CliRuntime {
    cancellation: ScanCancellationToken,
}

impl CliRuntime {
    #[cfg(test)]
    pub(crate) fn new(cancellation: ScanCancellationToken) -> Self {
        Self { cancellation }
    }

    pub(crate) fn child_task(&self) -> Self {
        Self {
            cancellation: self.cancellation.child_token(),
        }
    }

    pub(crate) fn with_ctrlc_handler() -> Result<Self> {
        let cancellation = ScanCancellationToken::new();
        ctrlc::set_handler({
            let cancellation = cancellation.clone();
            move || cancellation.cancel()
        })
        .context("failed to install Ctrl+C handler")?;

        Ok(Self { cancellation })
    }

    pub(crate) fn cancellation(&self) -> &ScanCancellationToken {
        &self.cancellation
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn runtime_exposes_shared_cancellation_token() {
        let token = ScanCancellationToken::new();
        let runtime = CliRuntime::new(token.clone());

        assert!(!runtime.cancellation().is_cancelled());

        token.cancel();

        assert!(runtime.cancellation().is_cancelled());
    }

    #[test]
    fn task_runtime_can_cancel_without_poisoning_parent() {
        let token = ScanCancellationToken::new();
        let runtime = CliRuntime::new(token.clone());
        let task_runtime = runtime.child_task();

        task_runtime.cancellation().cancel();

        assert!(task_runtime.cancellation().is_cancelled());
        assert!(!runtime.cancellation().is_cancelled());

        token.cancel();

        assert!(runtime.cancellation().is_cancelled());
    }
}