homeboy 0.27.1

CLI for multi-component deployment and development workflow automation
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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
use std::collections::{HashMap, VecDeque};
use std::sync::Arc;

use serde::{Deserialize, Serialize};

use crate::error::{Error, Result};

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelineStep {
    pub id: String,
    #[serde(rename = "type")]
    pub step_type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub label: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub needs: Vec<String>,
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub config: HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelinePlan {
    pub steps: Vec<PipelinePlanStep>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub warnings: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelinePlanStep {
    pub id: String,
    #[serde(rename = "type")]
    pub step_type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub label: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub needs: Vec<String>,
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub config: HashMap<String, serde_json::Value>,
    pub status: PipelineStepStatus,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub missing: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]

pub enum PipelineStepStatus {
    Ready,
    Missing,
    Disabled,
}

pub trait PipelineCapabilityResolver: Send + Sync {
    fn is_supported(&self, step_type: &str) -> bool;
    fn missing(&self, step_type: &str) -> Vec<String>;
}

pub trait PipelineStepExecutor: Send + Sync {
    fn execute_step(&self, step: &PipelineStep) -> Result<PipelineStepResult>;
}

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelineRunPlan {
    pub steps: Vec<PipelineStep>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub warnings: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelineStepResult {
    pub id: String,
    #[serde(rename = "type")]
    pub step_type: String,
    pub status: PipelineRunStatus,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub missing: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub warnings: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub hints: Vec<crate::error::Hint>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelineRunResult {
    pub steps: Vec<PipelineStepResult>,
    pub status: PipelineRunStatus,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub warnings: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<PipelineRunSummary>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]

pub struct PipelineRunSummary {
    pub total_steps: usize,
    pub succeeded: usize,
    pub failed: usize,
    pub skipped: usize,
    pub missing: usize,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub next_actions: Vec<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]

pub enum PipelineRunStatus {
    Success,
    PartialSuccess,
    Failed,
    Skipped,
    Missing,
}

pub fn plan(
    steps: &[PipelineStep],
    resolver: &dyn PipelineCapabilityResolver,
    enabled: bool,
    field: &str,
) -> Result<PipelinePlan> {
    let (ordered, warnings) = order_steps(steps, field)?;
    let planned_steps = ordered
        .into_iter()
        .map(|step| to_plan_step(step, resolver, enabled))
        .collect();

    Ok(PipelinePlan {
        steps: planned_steps,
        warnings,
    })
}

pub fn plan_run(steps: &[PipelineStep], field: &str) -> Result<PipelineRunPlan> {
    let (ordered, warnings) = order_steps(steps, field)?;
    Ok(PipelineRunPlan {
        steps: ordered,
        warnings,
    })
}

fn order_steps(steps: &[PipelineStep], field: &str) -> Result<(Vec<PipelineStep>, Vec<String>)> {
    if steps.len() <= 1 {
        return Ok((steps.to_vec(), Vec::new()));
    }

    let mut id_index = HashMap::new();
    for (idx, step) in steps.iter().enumerate() {
        if id_index.contains_key(&step.id) {
            return Err(Error::validation_invalid_argument(
                field,
                format!("Duplicate step id '{}'", step.id),
                None,
                None,
            ));
        }
        id_index.insert(step.id.clone(), idx);
    }

    let mut indegree = vec![0usize; steps.len()];
    let mut dependents: Vec<Vec<usize>> = vec![Vec::new(); steps.len()];

    for (idx, step) in steps.iter().enumerate() {
        for need in &step.needs {
            if let Some(&parent_idx) = id_index.get(need) {
                indegree[idx] += 1;
                dependents[parent_idx].push(idx);
            } else {
                return Err(Error::validation_invalid_argument(
                    field,
                    format!("Step '{}' depends on unknown step '{}'", step.id, need),
                    None,
                    None,
                ));
            }
        }
    }

    let mut queue = VecDeque::new();
    for (idx, count) in indegree.iter().enumerate() {
        if *count == 0 {
            queue.push_back(idx);
        }
    }

    let mut ordered = Vec::with_capacity(steps.len());
    while let Some(idx) = queue.pop_front() {
        ordered.push(steps[idx].clone());
        for &child in &dependents[idx] {
            if indegree[child] > 0 {
                indegree[child] -= 1;
            }
            if indegree[child] == 0 {
                queue.push_back(child);
            }
        }
    }

    if ordered.len() != steps.len() {
        let pending: Vec<String> = steps
            .iter()
            .enumerate()
            .filter(|(idx, _)| indegree[*idx] > 0)
            .map(|(_, step)| step.id.clone())
            .collect();
        return Err(Error::validation_invalid_argument(
            field,
            "Steps contain a cycle".to_string(),
            None,
            Some(pending),
        ));
    }

    let mut warnings = Vec::new();
    if steps.iter().any(|step| !step.needs.is_empty()) {
        warnings.push("Steps reordered based on dependencies".to_string());
    }

    Ok((ordered, warnings))
}

fn to_plan_step(
    step: PipelineStep,
    resolver: &dyn PipelineCapabilityResolver,
    enabled: bool,
) -> PipelinePlanStep {
    let (status, missing) = if !enabled {
        (PipelineStepStatus::Disabled, Vec::new())
    } else if resolver.is_supported(&step.step_type) {
        (PipelineStepStatus::Ready, Vec::new())
    } else {
        (
            PipelineStepStatus::Missing,
            resolver.missing(&step.step_type),
        )
    };

    PipelinePlanStep {
        id: step.id,
        step_type: step.step_type,
        label: step.label,
        needs: step.needs,
        config: step.config,
        status,
        missing,
    }
}

pub fn run(
    steps: &[PipelineStep],
    executor: Arc<dyn PipelineStepExecutor>,
    resolver: Arc<dyn PipelineCapabilityResolver>,
    enabled: bool,
    field: &str,
) -> Result<PipelineRunResult> {
    if !enabled {
        let results: Vec<PipelineStepResult> = steps
            .iter()
            .map(|step| PipelineStepResult {
                id: step.id.clone(),
                step_type: step.step_type.clone(),
                status: PipelineRunStatus::Skipped,
                missing: Vec::new(),
                warnings: Vec::new(),
                hints: Vec::new(),
                data: None,
                error: None,
            })
            .collect();
        let summary = build_summary(&results, &PipelineRunStatus::Skipped);
        return Ok(PipelineRunResult {
            steps: results,
            status: PipelineRunStatus::Skipped,
            warnings: Vec::new(),
            summary: Some(summary),
        });
    }

    let plan = plan_run(steps, field)?;
    let mut results = Vec::with_capacity(plan.steps.len());
    let mut overall_status = PipelineRunStatus::Success;
    let mut pending_steps: Vec<PipelineStep> = Vec::new();

    for step in plan.steps {
        if resolver.is_supported(&step.step_type) {
            pending_steps.push(step);
        } else {
            results.push(PipelineStepResult {
                id: step.id.clone(),
                step_type: step.step_type.clone(),
                status: PipelineRunStatus::Missing,
                missing: resolver.missing(&step.step_type),
                warnings: Vec::new(),
                hints: Vec::new(),
                data: None,
                error: None,
            });
            overall_status = PipelineRunStatus::Missing;
        }
    }

    while !pending_steps.is_empty() {
        let (ready, blocked, skipped) = split_ready_steps(&pending_steps, &results);
        results.extend(skipped);

        if ready.is_empty() {
            if blocked.is_empty() {
                break;
            }
            return Err(Error::validation_invalid_argument(
                field,
                "Steps blocked by missing dependencies".to_string(),
                None,
                None,
            ));
        }

        let batch_results = execute_batch(&ready, Arc::clone(&executor), Arc::clone(&resolver))?;
        for result in batch_results {
            if matches!(result.status, PipelineRunStatus::Failed) {
                overall_status = PipelineRunStatus::Failed;
            }
            results.push(result);
        }

        pending_steps = blocked;
    }

    let final_status = derive_overall_status(&results, overall_status);
    let summary = build_summary(&results, &final_status);

    Ok(PipelineRunResult {
        steps: results,
        status: final_status,
        warnings: plan.warnings,
        summary: Some(summary),
    })
}

fn split_ready_steps(
    pending: &[PipelineStep],
    results: &[PipelineStepResult],
) -> (
    Vec<PipelineStep>,
    Vec<PipelineStep>,
    Vec<PipelineStepResult>,
) {
    let mut ready = Vec::new();
    let mut blocked = Vec::new();
    let mut skipped = Vec::new();

    let mut status_map: HashMap<String, PipelineRunStatus> = results
        .iter()
        .map(|result| (result.id.clone(), result.status.clone()))
        .collect();

    for step in pending {
        let mut unmet = false;
        let mut failed_dependency: Option<String> = None;

        for need in &step.needs {
            match status_map.get(need) {
                Some(PipelineRunStatus::Success) | Some(PipelineRunStatus::PartialSuccess) => {}
                Some(PipelineRunStatus::Failed)
                | Some(PipelineRunStatus::Missing)
                | Some(PipelineRunStatus::Skipped) => {
                    failed_dependency = Some(need.clone());
                    break;
                }
                None => {
                    unmet = true;
                }
            }
        }

        if let Some(dep) = failed_dependency {
            let result = PipelineStepResult {
                id: step.id.clone(),
                step_type: step.step_type.clone(),
                status: PipelineRunStatus::Skipped,
                missing: Vec::new(),
                warnings: vec![format!("Skipped because '{}' did not succeed", dep)],
                hints: Vec::new(),
                data: None,
                error: None,
            };
            status_map.insert(step.id.clone(), PipelineRunStatus::Skipped);
            skipped.push(result);
            continue;
        }

        if unmet {
            blocked.push(step.clone());
        } else {
            ready.push(step.clone());
        }
    }

    (ready, blocked, skipped)
}

fn derive_overall_status(
    results: &[PipelineStepResult],
    current: PipelineRunStatus,
) -> PipelineRunStatus {
    let has_success = results
        .iter()
        .any(|result| matches!(result.status, PipelineRunStatus::Success));
    let has_failed = results
        .iter()
        .any(|result| matches!(result.status, PipelineRunStatus::Failed));
    let has_missing = results
        .iter()
        .any(|result| matches!(result.status, PipelineRunStatus::Missing));

    if has_failed && has_success {
        return PipelineRunStatus::PartialSuccess;
    }
    if has_failed {
        return PipelineRunStatus::Failed;
    }
    if has_missing && has_success {
        return PipelineRunStatus::PartialSuccess;
    }
    if has_missing {
        return PipelineRunStatus::Missing;
    }
    if matches!(current, PipelineRunStatus::Skipped) {
        return PipelineRunStatus::Skipped;
    }
    PipelineRunStatus::Success
}

fn build_summary(results: &[PipelineStepResult], status: &PipelineRunStatus) -> PipelineRunSummary {
    let succeeded = results
        .iter()
        .filter(|r| matches!(r.status, PipelineRunStatus::Success))
        .count();
    let failed = results
        .iter()
        .filter(|r| matches!(r.status, PipelineRunStatus::Failed))
        .count();
    let skipped = results
        .iter()
        .filter(|r| matches!(r.status, PipelineRunStatus::Skipped))
        .count();
    let missing = results
        .iter()
        .filter(|r| matches!(r.status, PipelineRunStatus::Missing))
        .count();

    let next_actions = match status {
        PipelineRunStatus::PartialSuccess | PipelineRunStatus::Failed => {
            vec![
                "Fix the issue and re-run (idempotent - completed steps will succeed again)"
                    .to_string(),
            ]
        }
        PipelineRunStatus::Missing => {
            vec!["Install missing modules or actions to resolve missing steps".to_string()]
        }
        _ => Vec::new(),
    };

    PipelineRunSummary {
        total_steps: results.len(),
        succeeded,
        failed,
        skipped,
        missing,
        next_actions,
    }
}

fn execute_batch(
    steps: &[PipelineStep],
    executor: Arc<dyn PipelineStepExecutor>,
    resolver: Arc<dyn PipelineCapabilityResolver>,
) -> Result<Vec<PipelineStepResult>> {
    if steps.len() <= 1 {
        if let Some(step) = steps.first() {
            return Ok(vec![execute_single_step(
                step.clone(),
                executor.as_ref(),
                resolver.as_ref(),
            )?]);
        }
        return Ok(Vec::new());
    }

    use std::thread;

    let handles: Vec<_> = steps
        .iter()
        .cloned()
        .map(|step| {
            let executor = Arc::clone(&executor);
            let resolver = Arc::clone(&resolver);
            thread::spawn(move || execute_single_step(step, executor.as_ref(), resolver.as_ref()))
        })
        .collect();

    let mut results = Vec::with_capacity(steps.len());
    for handle in handles {
        results.push(handle.join().map_err(|_| {
            Error::validation_invalid_argument(
                "pipeline",
                "Step execution thread panicked".to_string(),
                None,
                None,
            )
        })??);
    }

    Ok(results)
}

fn execute_single_step(
    step: PipelineStep,
    executor: &dyn PipelineStepExecutor,
    resolver: &dyn PipelineCapabilityResolver,
) -> Result<PipelineStepResult> {
    if !resolver.is_supported(&step.step_type) {
        let step_type = step.step_type.clone();
        let missing = resolver.missing(&step.step_type);
        return Ok(PipelineStepResult {
            id: step.id,
            step_type,
            status: PipelineRunStatus::Missing,
            missing,
            warnings: Vec::new(),
            hints: Vec::new(),
            data: None,
            error: None,
        });
    }

    match executor.execute_step(&step) {
        Ok(mut result) => {
            if result.status == PipelineRunStatus::Success {
                result.missing = Vec::new();
                result.error = None;
            }
            Ok(result)
        }
        Err(err) => Ok(PipelineStepResult {
            id: step.id,
            step_type: step.step_type,
            status: PipelineRunStatus::Failed,
            missing: Vec::new(),
            warnings: Vec::new(),
            hints: err.hints.clone(),
            data: None,
            error: Some(err.message.clone()),
        }),
    }
}