openchecks 0.2.0

A simple checks framework
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

//! The scheduler system
//!
//! The scheduler system is responsible for processing checks either
//! sequentially (via the [SerialScheduler]), threaded
//! (via the [ThreadedScheduler]), or async (via the [AsyncTokioScheduler]).
//!
//! While it is possible, and valid, to process each check by hand, this will
//! abstract away the need to manage the checks and their results.

use crate::{AsyncCheck, Check, CheckResult};

mod serial_scheduler;
pub use serial_scheduler::SerialScheduler;

#[cfg(feature = "threaded-scheduler")]
mod threaded_scheduler;
#[cfg(feature = "threaded-scheduler")]
pub use threaded_scheduler::ThreadedScheduler;

#[cfg(feature = "async-tokio-scheduler")]
mod async_tokio_scheduler;
#[cfg(feature = "async-tokio-scheduler")]
pub use async_tokio_scheduler::AsyncTokioScheduler;

/// A trait for building schedulers.
///
/// A type implementing the scheduler should avoid requiring any state except
/// for the most absolute bare necessities such as thread or worker count. The
/// methods of this trait should also do as little work as possible and just
/// handle taking in a vector of checks and outputting the results of the
/// checks/fixes.
pub trait Scheduler {
    /// Run all of the input checks and return back the checks and the
    /// associated result.
    ///
    /// This should call the [run](crate::runner::run) function to handle
    /// getting the result from the check.
    fn run<Item: crate::Item + Send, Items: std::iter::IntoIterator<Item = Item> + Send>(
        &self,
        checks: Vec<Box<dyn Check<Item = Item, Items = Items> + Send>>,
    ) -> Vec<(
        Box<dyn Check<Item = Item, Items = Items> + Send>,
        CheckResult<Item, Items>,
    )>;

    /// Run the auto fix for all of the input checks and return back the checks
    /// and the associated result.
    ///
    /// This should call the [auto_fix](crate::runner::auto_fix) function to
    /// handle attempting to fix the issue and getting the result from the
    /// check.
    fn auto_fix<Item: crate::Item + Send, Items: std::iter::IntoIterator<Item = Item> + Send>(
        &self,
        checks: Vec<Box<dyn Check<Item = Item, Items = Items> + Send>>,
    ) -> Vec<(
        Box<dyn Check<Item = Item, Items = Items> + Send>,
        CheckResult<Item, Items>,
    )>;
}

/// A trait for building asynchronous schedulers.
///
/// A type implementing the scheduler should avoid requiring any state except
/// for the most absolute bare necessities such as thread or worker count. The
/// methods of this trait should also do as little work as possible and just
/// handle taking in a vector of checks and outputting the results of the
/// checks/fixes.
#[async_trait::async_trait]
pub trait AsyncScheduler {
    /// Run all of the input checks and return back the checks and the
    /// associated result.
    ///
    /// This should call the [async_run](crate::runner::async_run) function to
    /// handle getting the result from the check.
    async fn async_run<
        Item: crate::Item + Send + Sync + 'static,
        Items: std::iter::IntoIterator<Item = Item> + Send + Sync + 'static,
    >(
        &self,
        checks: Vec<Box<dyn AsyncCheck<Item = Item, Items = Items> + Send + Sync>>,
    ) -> Vec<(
        Box<dyn AsyncCheck<Item = Item, Items = Items> + Send + Sync>,
        CheckResult<Item, Items>,
    )>;

    /// Run the auto fix for all of the input checks and return back the checks
    /// and the associated result.
    ///
    /// This should call the [async_auto_fix](crate::runner::async_auto_fix)
    /// function to handle attempting to fix the issue and getting the result
    /// from the check.
    async fn async_auto_fix<
        Item: crate::Item + Send + Sync + 'static,
        Items: std::iter::IntoIterator<Item = Item> + Send + Sync + 'static,
    >(
        &self,
        checks: Vec<Box<dyn AsyncCheck<Item = Item, Items = Items> + Send + Sync>>,
    ) -> Vec<(
        Box<dyn AsyncCheck<Item = Item, Items = Items> + Send + Sync>,
        CheckResult<Item, Items>,
    )>;
}