ironflow-store 2.6.0

Storage abstraction and implementations for ironflow run tracking
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

//! [`StepStatus`] — lifecycle states for a workflow step.

use serde::{Deserialize, Serialize};

/// Status of an individual step within a run.
///
/// # Examples
///
/// ```
/// use ironflow_store::entities::StepStatus;
///
/// assert!(!StepStatus::Pending.is_terminal());
/// assert!(StepStatus::Completed.is_terminal());
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum StepStatus {
    /// Waiting to execute.
    Pending,
    /// Currently executing.
    Running,
    /// Executed successfully.
    Completed,
    /// Execution failed.
    Failed,
    /// Skipped (e.g. when a prior step failed).
    Skipped,
    /// Waiting for human approval before continuing.
    AwaitingApproval,
    /// Human rejected the approval request.
    Rejected,
}

impl StepStatus {
    /// Returns `true` if this is a terminal state.
    pub fn is_terminal(&self) -> bool {
        matches!(
            self,
            StepStatus::Completed | StepStatus::Failed | StepStatus::Skipped | StepStatus::Rejected
        )
    }
}

impl std::fmt::Display for StepStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            StepStatus::Pending => f.write_str("Pending"),
            StepStatus::Running => f.write_str("Running"),
            StepStatus::Completed => f.write_str("Completed"),
            StepStatus::Failed => f.write_str("Failed"),
            StepStatus::Skipped => f.write_str("Skipped"),
            StepStatus::AwaitingApproval => f.write_str("AwaitingApproval"),
            StepStatus::Rejected => f.write_str("Rejected"),
        }
    }
}

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

    #[test]
    fn terminal() {
        assert!(StepStatus::Completed.is_terminal());
        assert!(StepStatus::Failed.is_terminal());
        assert!(StepStatus::Skipped.is_terminal());
        assert!(!StepStatus::Pending.is_terminal());
        assert!(!StepStatus::Running.is_terminal());
        assert!(!StepStatus::AwaitingApproval.is_terminal());
        assert!(StepStatus::Rejected.is_terminal());
    }

    #[test]
    fn display() {
        assert_eq!(StepStatus::Pending.to_string(), "Pending");
        assert_eq!(StepStatus::Running.to_string(), "Running");
        assert_eq!(StepStatus::Completed.to_string(), "Completed");
        assert_eq!(StepStatus::Failed.to_string(), "Failed");
        assert_eq!(StepStatus::Skipped.to_string(), "Skipped");
        assert_eq!(StepStatus::AwaitingApproval.to_string(), "AwaitingApproval");
        assert_eq!(StepStatus::Rejected.to_string(), "Rejected");
    }
}