only-engine 0.2.0

Execution planning and runtime engine for only tasks.
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

use std::fmt;
use std::process::ExitCode;

/// Engine-level runtime and host execution errors.
///
/// Args:
/// None.
///
/// Returns:
/// Stable typed error values for planner/runtime consumers.
#[derive(Debug)]
pub enum EngineError {
    CommandFailed {
        task: String,
        step: usize,
        total: usize,
        command: String,
        code: ExitCode,
    },
    CommandBlockFailed {
        task: String,
        step: usize,
        total: usize,
        code: ExitCode,
    },
    CommandBlockStartFailed {
        shell: String,
        source: Box<EngineError>,
    },
    Interpolation(String),
    ShellNotFound(String),
    UnsupportedShell(String),
    Runtime(String),
    Io {
        message: &'static str,
        path: String,
        source: std::io::Error,
    },
}

impl fmt::Display for EngineError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::CommandFailed {
                task,
                step,
                total,
                command,
                code,
            } => write!(
                f,
                "task '{task}' failed at step [{step}/{total}]\ncommand: `{command}`\nexit code: {code:?}"
            ),
            Self::CommandBlockFailed {
                task,
                step,
                total,
                code,
            } => write!(
                f,
                "task '{task}' failed at step [{step}/{total}]\ncommand block failed\nexit code: {code:?}"
            ),
            Self::CommandBlockStartFailed { shell, source } => {
                write!(
                    f,
                    "could not start command block with shell '{shell}'\n{source}"
                )
            }
            Self::Interpolation(message) => f.write_str(message),
            Self::ShellNotFound(message) => f.write_str(message),
            Self::UnsupportedShell(shell) => write!(f, "shell '{shell}' is not supported"),
            Self::Runtime(message) => f.write_str(message),
            Self::Io {
                message,
                path,
                source,
            } => write!(f, "{message}: {path}: {source}"),
        }
    }
}

pub(crate) fn command_block_failed(
    task: &str,
    step_index: usize,
    step_total: usize,
    code: ExitCode,
) -> EngineError {
    EngineError::CommandBlockFailed {
        task: task.to_string(),
        step: step_index,
        total: step_total,
        code,
    }
}

impl std::error::Error for EngineError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Io { source, .. } => Some(source),
            Self::CommandBlockStartFailed { source, .. } => Some(source.as_ref()),
            _ => None,
        }
    }
}

pub(crate) fn command_block_start_failed(shell: &str, source: EngineError) -> EngineError {
    match source {
        EngineError::ShellNotFound(_)
        | EngineError::UnsupportedShell(_)
        | EngineError::Io { .. } => EngineError::CommandBlockStartFailed {
            shell: shell.to_string(),
            source: Box::new(source),
        },
        other => other,
    }
}

pub(crate) fn command_failed(
    task: &str,
    step_index: usize,
    step_total: usize,
    command: &str,
    code: ExitCode,
) -> EngineError {
    EngineError::CommandFailed {
        task: task.to_string(),
        step: step_index,
        total: step_total,
        command: command.to_string(),
        code,
    }
}