runkon-flow 0.6.1-alpha

Portable workflow execution engine — DSL, traits, and in-memory reference implementations
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

mod common;

use std::collections::HashMap;
use std::sync::Arc;

use runkon_flow::status::WorkflowStepStatus;
use runkon_flow::traits::persistence::WorkflowPersistence;
use runkon_flow::FlowEngineBuilder;

use common::{
    call_node, make_def, make_def_with_always, make_persistence, make_state, named_executors,
    ActionExecutor, ForwardSink, MockExecutor, VecSink,
};

// ---------------------------------------------------------------------------
// parse → validate → run
// ---------------------------------------------------------------------------

#[test]
fn parse_validate_run_single_step() {
    let dsl = r#"workflow single-step {
  meta {
    description = "one-step smoke test"
    trigger     = "manual"
  }
  call my-agent
}"#;

    let def = runkon_flow::dsl::parse_workflow_str(dsl, "test.wf")
        .expect("DSL should parse without errors");

    let engine = FlowEngineBuilder::new()
        .action(Box::new(MockExecutor::new("my-agent")))
        .build()
        .expect("engine build failed");

    engine.validate(&def).expect("workflow should be valid");

    let persistence = make_persistence();
    let mut state = make_state(
        "single-step",
        Arc::clone(&persistence),
        named_executors([Box::new(MockExecutor::new("my-agent")) as Box<dyn ActionExecutor>]),
    );

    let result = engine.run(&def, &mut state).expect("run should succeed");

    assert!(result.all_succeeded, "all steps should succeed");
    let steps = persistence
        .get_steps(&result.workflow_run_id)
        .expect("get_steps failed");
    assert_eq!(steps.len(), 1, "exactly one step should be recorded");
    assert_eq!(
        steps[0].status,
        WorkflowStepStatus::Completed,
        "step should be Completed"
    );
}

// ---------------------------------------------------------------------------
// Multi-step sequential execution
// ---------------------------------------------------------------------------

#[test]
fn multi_step_sequential_all_succeed() {
    let engine = FlowEngineBuilder::new()
        .action(Box::new(MockExecutor::new("alpha")))
        .action(Box::new(MockExecutor::new("beta")))
        .action(Box::new(MockExecutor::new("gamma")))
        .build()
        .expect("engine build failed");

    let def = make_def(
        "multi-step",
        vec![call_node("alpha"), call_node("beta"), call_node("gamma")],
    );

    let persistence = make_persistence();
    let mut state = make_state(
        "multi-step",
        Arc::clone(&persistence),
        named_executors([
            Box::new(MockExecutor::new("alpha")) as Box<dyn ActionExecutor>,
            Box::new(MockExecutor::new("beta")) as Box<dyn ActionExecutor>,
            Box::new(MockExecutor::new("gamma")) as Box<dyn ActionExecutor>,
        ]),
    );

    let result = engine.run(&def, &mut state).expect("run should succeed");

    assert!(result.all_succeeded);

    let steps = persistence
        .get_steps(&result.workflow_run_id)
        .expect("get_steps failed");
    assert_eq!(steps.len(), 3);
    // Steps are stored in insertion order; positions 0, 1, 2.
    let completed = steps
        .iter()
        .filter(|s| s.status == WorkflowStepStatus::Completed)
        .count();
    assert_eq!(completed, 3, "all three steps should be Completed");
}

// ---------------------------------------------------------------------------
// Empty workflow — no steps
// ---------------------------------------------------------------------------

#[test]
fn empty_workflow_succeeds() {
    let engine = FlowEngineBuilder::new()
        .build()
        .expect("engine build failed");

    let def = make_def("empty", vec![]);
    let persistence = make_persistence();
    let mut state = make_state("empty", Arc::clone(&persistence), HashMap::new());

    let result = engine
        .run(&def, &mut state)
        .expect("empty run should succeed");

    assert!(result.all_succeeded);
    let steps = persistence
        .get_steps(&result.workflow_run_id)
        .expect("get_steps failed");
    assert!(
        steps.is_empty(),
        "empty workflow should produce no step records"
    );
}

// ---------------------------------------------------------------------------
// Persistence state assertions
// ---------------------------------------------------------------------------

#[test]
fn persistence_step_statuses_after_run() {
    let engine = FlowEngineBuilder::new()
        .action(Box::new(MockExecutor::new("step-a")))
        .action(Box::new(MockExecutor::new("step-b")))
        .build()
        .expect("engine build failed");

    let def = make_def("two-step", vec![call_node("step-a"), call_node("step-b")]);

    let persistence = make_persistence();
    let mut state = make_state(
        "two-step",
        Arc::clone(&persistence),
        named_executors([
            Box::new(MockExecutor::new("step-a")) as Box<dyn ActionExecutor>,
            Box::new(MockExecutor::new("step-b")) as Box<dyn ActionExecutor>,
        ]),
    );

    let result = engine.run(&def, &mut state).expect("run should succeed");

    let steps = persistence
        .get_steps(&result.workflow_run_id)
        .expect("get_steps failed");

    assert_eq!(steps.len(), 2);
    for step in &steps {
        assert_eq!(
            step.status,
            WorkflowStepStatus::Completed,
            "step '{}' should be Completed",
            step.step_name
        );
    }
    // Verify step names were recorded
    let names: Vec<&str> = steps.iter().map(|s| s.step_name.as_str()).collect();
    assert!(names.contains(&"step-a"), "step-a should be in records");
    assert!(names.contains(&"step-b"), "step-b should be in records");
}

// ---------------------------------------------------------------------------
// Always block runs on success
// ---------------------------------------------------------------------------

#[test]
fn always_block_runs_on_success() {
    let engine = FlowEngineBuilder::new()
        .action(Box::new(MockExecutor::new("work")))
        .action(Box::new(MockExecutor::new("cleanup")))
        .build()
        .expect("engine build failed");

    let def = make_def_with_always(
        "always-success",
        vec![call_node("work")],
        vec![call_node("cleanup")],
    );

    let persistence = make_persistence();
    let mut state = make_state(
        "always-success",
        Arc::clone(&persistence),
        named_executors([
            Box::new(MockExecutor::new("work")) as Box<dyn ActionExecutor>,
            Box::new(MockExecutor::new("cleanup")) as Box<dyn ActionExecutor>,
        ]),
    );

    let result = engine.run(&def, &mut state).expect("run should succeed");

    assert!(result.all_succeeded);
    let steps = persistence
        .get_steps(&result.workflow_run_id)
        .expect("get_steps failed");

    let names: Vec<&str> = steps.iter().map(|s| s.step_name.as_str()).collect();
    assert!(names.contains(&"work"), "body step should run");
    assert!(
        names.contains(&"cleanup"),
        "always step should run after body success"
    );
}

// ---------------------------------------------------------------------------
// Event sink receives events during run
// ---------------------------------------------------------------------------

#[test]
fn event_sink_captures_run_lifecycle() {
    let sink = VecSink::new();
    let sink_ref = Arc::clone(&sink);

    let engine = FlowEngineBuilder::new()
        .action(Box::new(MockExecutor::new("worker")))
        .event_sink(Box::new(ForwardSink(sink_ref)))
        .build()
        .expect("engine build failed");

    let def = make_def("event-test", vec![call_node("worker")]);

    let persistence = make_persistence();
    let mut state = make_state(
        "event-test",
        Arc::clone(&persistence),
        named_executors([Box::new(MockExecutor::new("worker")) as Box<dyn ActionExecutor>]),
    );

    engine.run(&def, &mut state).expect("run should succeed");

    let events = sink.collected();
    assert!(!events.is_empty(), "event sink should receive events");

    let has_run_started = events
        .iter()
        .any(|e| matches!(e.event, runkon_flow::EngineEvent::RunStarted { .. }));
    let has_run_completed = events
        .iter()
        .any(|e| matches!(e.event, runkon_flow::EngineEvent::RunCompleted { .. }));
    assert!(has_run_started, "RunStarted event should be emitted");
    assert!(has_run_completed, "RunCompleted event should be emitted");
}