swf-runtime 1.0.0-alpha9

Runtime engine for Serverless Workflow DSL — execute, validate, and orchestrate workflows
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
use super::*;
use crate::context::WorkflowContext;
use base64::Engine;
use serde_json::json;
use std::collections::HashMap;
use swf_core::models::call::{
    CallHTTPDefinition, HTTPArguments, OneOfHeadersOrExpression, OneOfQueryOrExpression,
};
use swf_core::models::resource::OneOfEndpointDefinitionOrUri;
use swf_core::models::task::TaskDefinitionFields;
use swf_core::models::workflow::WorkflowDefinition;

fn make_http_task(method: &str, uri: &str) -> CallHTTPDefinition {
    CallHTTPDefinition {
        call: "http".to_string(),
        with: HTTPArguments {
            method: method.to_string(),
            endpoint: OneOfEndpointDefinitionOrUri::Uri(uri.to_string()),
            headers: None,
            body: None,
            query: None,
            output: None,
            redirect: None,
        },
        common: TaskDefinitionFields::default(),
    }
}

#[test]
fn test_call_runner_new() {
    let task = make_http_task("GET", "https://example.com/api");
    let runner = CallTaskRunner::new("testCall", &CallTaskDefinition::HTTP(task));
    assert!(runner.is_ok());
    assert_eq!(runner.unwrap().task_name(), "testCall");
}

#[test]
fn test_call_runner_function_not_found() {
    let func_task = swf_core::models::call::CallFunctionDefinition {
        call: "myFunc".to_string(),
        with: None,
        common: TaskDefinitionFields::default(),
    };
    let runner = CallTaskRunner::new("funcCall", &CallTaskDefinition::Function(func_task)).unwrap();

    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut support = TaskSupport::new(&workflow, &mut context);

    let rt = tokio::runtime::Runtime::new().unwrap();
    let result = rt.block_on(runner.run(json!({}), &mut support));
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("not found"));
}

#[tokio::test]
async fn test_call_http_with_headers_and_query() {
    let mut headers_map = HashMap::new();
    headers_map.insert("X-Custom".to_string(), "value".to_string());

    let mut query_map = HashMap::new();
    query_map.insert("page".to_string(), "1".to_string());

    let task = CallHTTPDefinition {
        call: "http".to_string(),
        with: HTTPArguments {
            method: "GET".to_string(),
            endpoint: OneOfEndpointDefinitionOrUri::Uri("https://httpbin.org/get".to_string()),
            headers: Some(OneOfHeadersOrExpression::Map(headers_map)),
            body: None,
            query: Some(OneOfQueryOrExpression::Map(query_map)),
            output: Some("response".to_string()),
            redirect: None,
        },
        common: TaskDefinitionFields::default(),
    };

    let runner = CallTaskRunner::new("httpCall", &CallTaskDefinition::HTTP(task)).unwrap();
    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut support = TaskSupport::new(&workflow, &mut context);

    // This test makes a real HTTP request; skip in offline environments
    let result = runner.run(json!({}), &mut support).await;
    if let Ok(output) = result {
        // If the request succeeded, verify response format
        assert!(output.get("statusCode").is_some());
        assert!(output.get("body").is_some());
    }
    // If it fails due to network, that's acceptable for this test
}

#[tokio::test]
async fn test_call_http_unsupported_method() {
    let task = make_http_task("TRACE", "https://example.com/api");
    let runner = CallTaskRunner::new("badMethod", &CallTaskDefinition::HTTP(task)).unwrap();
    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut support = TaskSupport::new(&workflow, &mut context);

    let result = runner.run(json!({}), &mut support).await;
    assert!(result.is_err());
}

#[tokio::test]
async fn test_call_grpc_no_handler() {
    let task = CallTaskDefinition::GRPC(Box::default());
    let runner = CallTaskRunner::new("grpcTest", &task).unwrap();
    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut support = TaskSupport::new(&workflow, &mut context);

    let result = runner.run(json!({}), &mut support).await;
    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(err_msg.contains("grpc"));
    assert!(err_msg.contains("CallHandler"));
}

#[tokio::test]
async fn test_call_openapi_no_handler() {
    use swf_core::models::call::CallOpenAPIDefinition;
    let task = CallTaskDefinition::OpenAPI(CallOpenAPIDefinition::default());
    let runner = CallTaskRunner::new("openapiTest", &task).unwrap();
    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut support = TaskSupport::new(&workflow, &mut context);

    let result = runner.run(json!({}), &mut support).await;
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("openapi"));
}

#[tokio::test]
async fn test_call_grpc_with_custom_handler() {
    use crate::handler::CallHandler;
    use crate::handler::HandlerContext;

    struct MockGrpcHandler;

    #[async_trait::async_trait]
    impl CallHandler for MockGrpcHandler {
        fn call_type(&self) -> &str {
            "grpc"
        }

        async fn handle(
            &self,
            _task_name: &str,
            _config: &Value,
            input: &Value,
            _context: &HandlerContext,
        ) -> WorkflowResult<Value> {
            Ok(json!({"grpcResponse": input}))
        }
    }

    let task = CallTaskDefinition::GRPC(Box::default());
    let runner = CallTaskRunner::new("grpcWithHandler", &task).unwrap();

    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut registry = crate::handler::HandlerRegistry::new();
    registry.register_call_handler(Box::new(MockGrpcHandler));
    context.set_handler_registry(registry);
    let mut support = TaskSupport::new(&workflow, &mut context);

    let output = runner
        .run(json!({"request": "data"}), &mut support)
        .await
        .unwrap();
    assert_eq!(output["grpcResponse"]["request"], json!("data"));
}

#[tokio::test]
async fn test_call_openapi_with_custom_handler() {
    use crate::handler::CallHandler;
    use crate::handler::HandlerContext;
    use swf_core::models::call::CallOpenAPIDefinition;

    struct MockOpenApiHandler;

    #[async_trait::async_trait]
    impl CallHandler for MockOpenApiHandler {
        fn call_type(&self) -> &str {
            "openapi"
        }

        async fn handle(
            &self,
            _task_name: &str,
            _config: &Value,
            input: &Value,
            _context: &HandlerContext,
        ) -> WorkflowResult<Value> {
            Ok(json!({"openapiResult": input}))
        }
    }

    let task = CallTaskDefinition::OpenAPI(CallOpenAPIDefinition::default());
    let runner = CallTaskRunner::new("openapiWithHandler", &task).unwrap();

    let workflow = WorkflowDefinition::default();
    let mut context = WorkflowContext::new(&workflow).unwrap();
    let mut registry = crate::handler::HandlerRegistry::new();
    registry.register_call_handler(Box::new(MockOpenApiHandler));
    context.set_handler_registry(registry);
    let mut support = TaskSupport::new(&workflow, &mut context);

    let output = runner
        .run(json!({"operationId": "getUser"}), &mut support)
        .await
        .unwrap();
    assert_eq!(output["openapiResult"]["operationId"], json!("getUser"));
}

#[tokio::test]
async fn test_apply_authentication_sets_authorization_basic() {
    use swf_core::models::authentication::{
        AuthenticationPolicyDefinition, BasicAuthenticationSchemeDefinition,
        ReferenceableAuthenticationPolicy,
    };

    let basic = BasicAuthenticationSchemeDefinition {
        username: Some("admin".to_string()),
        password: Some("secret123".to_string()),
        ..Default::default()
    };
    let policy_def = AuthenticationPolicyDefinition {
        basic: Some(basic),
        ..Default::default()
    };

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::new(policy_def));

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result = auth::apply_authentication(
        builder,
        &policy,
        None,
        &json!({}),
        &HashMap::new(),
        "testAuth",
    )
    .await
    .unwrap();

    // Check that authorization info was returned
    let (_, auth_info) = result;
    assert!(auth_info.is_some());
    let (scheme, parameter) = auth_info.unwrap();
    assert_eq!(scheme, "Basic");
    // Parameter is Base64-encoded credentials (matches Java SDK behavior)
    assert_eq!(
        parameter,
        base64::engine::general_purpose::STANDARD.encode("admin:secret123")
    );
}

#[tokio::test]
async fn test_apply_authentication_sets_authorization_bearer() {
    use swf_core::models::authentication::{
        AuthenticationPolicyDefinition, BearerAuthenticationSchemeDefinition,
        ReferenceableAuthenticationPolicy,
    };

    let bearer = BearerAuthenticationSchemeDefinition {
        token: Some("my-jwt-token".to_string()),
        ..Default::default()
    };
    let policy_def = AuthenticationPolicyDefinition {
        bearer: Some(bearer),
        ..Default::default()
    };

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::new(policy_def));

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result = auth::apply_authentication(
        builder,
        &policy,
        None,
        &json!({}),
        &HashMap::new(),
        "testAuth",
    )
    .await
    .unwrap();

    let (_, auth_info) = result;
    assert!(auth_info.is_some());
    let (scheme, parameter) = auth_info.unwrap();
    assert_eq!(scheme, "Bearer");
    assert_eq!(parameter, "my-jwt-token");
}

#[tokio::test]
async fn test_apply_authentication_no_auth_returns_none() {
    use swf_core::models::authentication::ReferenceableAuthenticationPolicy;

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::default());

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result = auth::apply_authentication(
        builder,
        &policy,
        None,
        &json!({}),
        &HashMap::new(),
        "testAuth",
    )
    .await
    .unwrap();

    let (_, auth_info) = result;
    assert!(auth_info.is_none());
}

#[tokio::test]
async fn test_apply_authentication_basic_with_secret() {
    use swf_core::models::authentication::{
        AuthenticationPolicyDefinition, BasicAuthenticationSchemeDefinition,
        ReferenceableAuthenticationPolicy,
    };

    let basic = BasicAuthenticationSchemeDefinition {
        use_: Some("mySecret".to_string()),
        ..Default::default()
    };
    let policy_def = AuthenticationPolicyDefinition {
        basic: Some(basic),
        ..Default::default()
    };

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::new(policy_def));

    // Set up vars with $secret.mySecret containing username/password
    let mut vars = HashMap::new();
    vars.insert(
        "$secret".to_string(),
        json!({
            "mySecret": {
                "username": "admin",
                "password": "s3cret"
            }
        }),
    );

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result = auth::apply_authentication(builder, &policy, None, &json!({}), &vars, "testAuth")
        .await
        .unwrap();

    let (_, auth_info) = result;
    assert!(auth_info.is_some());
    let (scheme, parameter) = auth_info.unwrap();
    assert_eq!(scheme, "Basic");
    // Parameter is Base64-encoded credentials, not plaintext
    assert_eq!(
        parameter,
        base64::engine::general_purpose::STANDARD.encode("admin:s3cret")
    );
}

#[tokio::test]
async fn test_apply_authentication_bearer_with_secret() {
    use swf_core::models::authentication::{
        AuthenticationPolicyDefinition, BearerAuthenticationSchemeDefinition,
        ReferenceableAuthenticationPolicy,
    };

    let bearer = BearerAuthenticationSchemeDefinition {
        use_: Some("apiToken".to_string()),
        ..Default::default()
    };
    let policy_def = AuthenticationPolicyDefinition {
        bearer: Some(bearer),
        ..Default::default()
    };

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::new(policy_def));

    // Set up vars with $secret.apiToken containing a token
    let mut vars = HashMap::new();
    vars.insert(
        "$secret".to_string(),
        json!({
            "apiToken": {
                "token": "my-jwt-from-secret"
            }
        }),
    );

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result = auth::apply_authentication(builder, &policy, None, &json!({}), &vars, "testAuth")
        .await
        .unwrap();

    let (_, auth_info) = result;
    assert!(auth_info.is_some());
    let (scheme, parameter) = auth_info.unwrap();
    assert_eq!(scheme, "Bearer");
    assert_eq!(parameter, "my-jwt-from-secret");
}

#[tokio::test]
async fn test_apply_authentication_basic_secret_not_found() {
    use swf_core::models::authentication::{
        AuthenticationPolicyDefinition, BasicAuthenticationSchemeDefinition,
        ReferenceableAuthenticationPolicy,
    };

    let basic = BasicAuthenticationSchemeDefinition {
        use_: Some("missingSecret".to_string()),
        ..Default::default()
    };
    let policy_def = AuthenticationPolicyDefinition {
        basic: Some(basic),
        ..Default::default()
    };

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::new(policy_def));

    let vars = HashMap::new();

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result =
        auth::apply_authentication(builder, &policy, None, &json!({}), &vars, "testAuth").await;

    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("missingSecret"));
}

#[tokio::test]
async fn test_apply_authentication_digest_with_secret() {
    use swf_core::models::authentication::{
        AuthenticationPolicyDefinition, DigestAuthenticationSchemeDefinition,
        ReferenceableAuthenticationPolicy,
    };

    let digest = DigestAuthenticationSchemeDefinition {
        use_: Some("digestCreds".to_string()),
        ..Default::default()
    };
    let policy_def = AuthenticationPolicyDefinition {
        digest: Some(digest),
        ..Default::default()
    };

    let policy = ReferenceableAuthenticationPolicy::Policy(Box::new(policy_def));

    let mut vars = HashMap::new();
    vars.insert(
        "$secret".to_string(),
        json!({
            "digestCreds": {
                "username": "digestuser",
                "password": "digestpass"
            }
        }),
    );

    let client = reqwest::Client::new();
    let builder = client.get("https://example.com/api");
    let result = auth::apply_authentication(builder, &policy, None, &json!({}), &vars, "testAuth")
        .await
        .unwrap();

    let (_, auth_info) = result;
    assert!(auth_info.is_some());
    let (scheme, parameter) = auth_info.unwrap();
    assert_eq!(scheme, "Digest");
    // Parameter is Base64-encoded credentials, not plaintext
    assert_eq!(
        parameter,
        base64::engine::general_purpose::STANDARD.encode("digestuser:digestpass")
    );
}