ironflow-runtime 2.1.20

Runtime daemon for ironflow: webhooks (axum) and cron scheduling
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

//! Typed error for the ironflow runtime.

use thiserror::Error;
use tokio_cron_scheduler::JobSchedulerError;

/// Error returned by [`Runtime::serve`](crate::runtime::Runtime::serve) and
/// [`Runtime::run_crons`](crate::runtime::Runtime::run_crons).
#[derive(Debug, Error)]
pub enum RuntimeError {
    /// Failed to bind the TCP listener to the requested address.
    #[error("failed to bind address: {0}")]
    Bind(std::io::Error),
    /// A cron expression is invalid or the scheduler failed to start.
    #[error("cron scheduler error: {0}")]
    Cron(#[from] JobSchedulerError),
    /// The Axum server encountered a fatal I/O error.
    #[error("http server error: {0}")]
    Serve(std::io::Error),
    /// The cron scheduler failed to shut down cleanly.
    #[error("scheduler shutdown error: {0}")]
    Shutdown(JobSchedulerError),
}

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

    #[test]
    fn bind_error_display() {
        let err = RuntimeError::Bind(std::io::Error::new(
            std::io::ErrorKind::AddrInUse,
            "port taken",
        ));
        assert_eq!(err.to_string(), "failed to bind address: port taken");
    }

    #[test]
    fn serve_error_display() {
        let err = RuntimeError::Serve(std::io::Error::other("fatal"));
        assert_eq!(err.to_string(), "http server error: fatal");
    }

    #[test]
    fn runtime_error_implements_std_error() {
        let err = RuntimeError::Bind(std::io::Error::other("x"));
        let _: &dyn std::error::Error = &err;
    }

    #[test]
    fn cron_error_display() {
        // Create a cron error through the From implementation
        // by providing a JobSchedulerError (ParseSchedule variant for cron parse failures)
        let err = RuntimeError::Cron(JobSchedulerError::ParseSchedule);
        let msg = err.to_string();
        assert!(msg.contains("cron scheduler error"));
    }

    #[test]
    fn cron_error_from_impl() {
        // Test From implementation: JobSchedulerError -> RuntimeError::Cron
        let cron_err = JobSchedulerError::ParseSchedule;
        let err: RuntimeError = cron_err.into();
        let msg = err.to_string();
        assert!(msg.contains("cron scheduler error"));
    }

    #[test]
    fn shutdown_error_display() {
        // Test Shutdown variant with a JobSchedulerError
        let err = RuntimeError::Shutdown(JobSchedulerError::ParseSchedule);
        let msg = err.to_string();
        assert!(msg.contains("scheduler shutdown error"));
    }

    #[test]
    fn cron_error_debug() {
        let err = RuntimeError::Cron(JobSchedulerError::ParseSchedule);
        let debug_str = format!("{:?}", err);
        assert!(debug_str.contains("Cron"));
    }

    #[test]
    fn shutdown_error_debug() {
        let err = RuntimeError::Shutdown(JobSchedulerError::ParseSchedule);
        let debug_str = format!("{:?}", err);
        assert!(debug_str.contains("Shutdown"));
    }

    #[test]
    fn bind_error_debug() {
        let err = RuntimeError::Bind(std::io::Error::other("test"));
        let debug_str = format!("{:?}", err);
        assert!(debug_str.contains("Bind"));
    }

    #[test]
    fn serve_error_debug() {
        let err = RuntimeError::Serve(std::io::Error::other("test"));
        let debug_str = format!("{:?}", err);
        assert!(debug_str.contains("Serve"));
    }

    #[test]
    fn error_variants_are_error() {
        use std::error::Error;

        let err_bind: Box<dyn Error> = Box::new(RuntimeError::Bind(std::io::Error::other("x")));
        let err_serve: Box<dyn Error> = Box::new(RuntimeError::Serve(std::io::Error::other("x")));

        assert!(!err_bind.to_string().is_empty());
        assert!(!err_serve.to_string().is_empty());
    }
}