wfe-core 1.9.2

Core traits, models, builder, and executor for the WFE workflow engine
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

use std::collections::HashMap;
use std::time::Duration;

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
/// Httpmethod.
pub enum HttpMethod {
    #[default]
    /// Get.
    Get,
    /// Post.
    Post,
    /// Put.
    Put,
    /// Patch.
    Patch,
    /// Delete.
    Delete,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
/// Pollcondition.
pub enum PollCondition {
    /// Check a JSON path equals a value: e.g. JsonPathEquals("$.status", "complete")
    JsonPathEquals {
        path: String,
        value: serde_json::Value,
    },
    /// Check HTTP status code
    StatusCode(u16),
    /// Check response body contains string
    BodyContains(String),
}

impl Default for PollCondition {
    fn default() -> Self {
        Self::StatusCode(200)
    }
}

#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
/// Pollendpointconfig.
pub struct PollEndpointConfig {
    /// URL template. Supports `{placeholder}` interpolation from workflow data.
    pub url: String,
    /// Method.
    pub method: HttpMethod,
    #[serde(default)]
    /// Headers.
    pub headers: HashMap<String, String>,
    #[serde(default)]
    /// Body.
    pub body: Option<serde_json::Value>,
    #[serde(with = "super::duration_millis")]
    /// Interval.
    pub interval: Duration,
    #[serde(with = "super::duration_millis")]
    /// Timeout.
    pub timeout: Duration,
    /// Condition.
    pub condition: PollCondition,
}

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

    #[test]
    fn poll_config_serde_round_trip() {
        let config = PollEndpointConfig {
            url: "https://api.example.com/status/{id}".into(),
            method: HttpMethod::Get,
            headers: HashMap::from([("Authorization".into(), "Bearer token123".into())]),
            body: None,
            interval: Duration::from_secs(30),
            timeout: Duration::from_secs(3600),
            condition: PollCondition::JsonPathEquals {
                path: "$.status".into(),
                value: serde_json::Value::String("complete".into()),
            },
        };
        let json = serde_json::to_string(&config).unwrap();
        let deserialized: PollEndpointConfig = serde_json::from_str(&json).unwrap();
        assert_eq!(config, deserialized);
    }

    #[test]
    fn poll_condition_status_code() {
        let cond = PollCondition::StatusCode(200);
        let json = serde_json::to_string(&cond).unwrap();
        let deserialized: PollCondition = serde_json::from_str(&json).unwrap();
        assert_eq!(cond, deserialized);
    }

    #[test]
    fn poll_condition_body_contains() {
        let cond = PollCondition::BodyContains("success".into());
        let json = serde_json::to_string(&cond).unwrap();
        let deserialized: PollCondition = serde_json::from_str(&json).unwrap();
        assert_eq!(cond, deserialized);
    }
}