swf-core 1.0.0-alpha9

Serverless Workflow DSL models — data structures, serialization, and validation
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

use super::one_of_validators::validate_schedule_one_of;
use super::{
    is_valid_hostname, is_valid_semver, validate_required_hostname, validate_required_semver,
    ValidationResult, ValidationRule,
};
use crate::models::duration::OneOfDurationOrIso8601Expression;
use crate::models::workflow::*;

/// Validates a complete workflow definition
pub fn validate_workflow(workflow: &WorkflowDefinition) -> ValidationResult {
    let mut result = ValidationResult::new();

    // Validate document
    validate_document(&workflow.document, &mut result);

    // Validate input if present
    if let Some(ref input) = workflow.input {
        validate_input(input, "input", &mut result);
    }

    // Validate timeout if present
    if let Some(ref timeout) = workflow.timeout {
        validate_timeout(timeout, "timeout", &mut result);
    }

    // Validate schedule if present
    if let Some(ref schedule) = workflow.schedule {
        validate_schedule_one_of(schedule, "schedule", &mut result);
    }

    // Validate tasks
    super::task::validate_task_map(&workflow.do_, "do", &mut result);

    result
}

/// Validates workflow document metadata
pub(crate) fn validate_document(doc: &WorkflowDefinitionMetadata, result: &mut ValidationResult) {
    validate_required_hostname(&doc.name, "document.name", result);
    validate_required_semver(&doc.version, "document.version", result);
    if !doc.dsl.is_empty() && !is_valid_semver(&doc.dsl) {
        result.add_error(
            "document.dsl",
            ValidationRule::Semver,
            "DSL version must be a valid semantic version",
        );
    }
    if !doc.namespace.is_empty() && !is_valid_hostname(&doc.namespace) {
        result.add_error(
            "document.namespace",
            ValidationRule::Hostname,
            "namespace must be a valid RFC 1123 hostname",
        );
    }
}

/// Validates an input data model definition
pub(crate) fn validate_input(
    input: &crate::models::input::InputDataModelDefinition,
    prefix: &str,
    result: &mut ValidationResult,
) {
    if let Some(ref from) = input.from {
        if from.is_null() {
            result.add_error(
                &format!("{}.from", prefix),
                ValidationRule::Required,
                "input 'from' must not be null",
            );
        }
    }
}

/// Validates a timeout definition or reference
pub(crate) fn validate_timeout(
    timeout: &crate::models::timeout::OneOfTimeoutDefinitionOrReference,
    prefix: &str,
    result: &mut ValidationResult,
) {
    match timeout {
        crate::models::timeout::OneOfTimeoutDefinitionOrReference::Timeout(t) => {
            validate_duration(&t.after, &format!("{}.after", prefix), result);
        }
        crate::models::timeout::OneOfTimeoutDefinitionOrReference::Reference(_) => {
            // References are assumed valid at this level
        }
    }
}

/// Validates a duration value
pub(crate) fn validate_duration(
    duration: &OneOfDurationOrIso8601Expression,
    prefix: &str,
    result: &mut ValidationResult,
) {
    match duration {
        OneOfDurationOrIso8601Expression::Iso8601Expression(expr) => {
            if !crate::models::duration::is_iso8601_duration_valid(expr) {
                result.add_error(
                    prefix,
                    ValidationRule::Iso8601Duration,
                    &format!("'{}' is not a valid ISO 8601 duration", expr),
                );
            }
        }
        OneOfDurationOrIso8601Expression::Duration(_) => {
            // Structured duration is always valid
        }
    }
}