mom-task 1.3.0

Task runner for teams and individuals.
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

#[cfg(test)]
#[path = "errors_test.rs"]
mod errors_test;

use std::error::Error;
use std::fmt;

/// Represents an error that can occur in a task
#[derive(Debug, PartialEq, Eq)]
pub(crate) enum TaskError {
    /// Raised when there is an error running a task
    RuntimeError(String),
    /// Raised when the task is improperly configured
    ConfigError(String),
    NotFound(String),
}

impl fmt::Display for TaskError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            TaskError::RuntimeError(ref reason) => {
                write!(f, "Runtime error:\n{}", reason)
            }
            TaskError::ConfigError(ref reason) => {
                write!(f, "Improperly configured:\n{}", reason)
            }
            TaskError::NotFound(ref name) => {
                write!(f, "Task `{}` not found.", name)
            }
        }
    }
}

impl Error for TaskError {}

impl From<tera::Error> for TaskError {
    fn from(err: tera::Error) -> TaskError {
        let mut full_error = err.to_string();
        let mut source = err.source();
        while let Some(inner) = source {
            full_error.push_str(&format!("\nCaused by: {}", inner));
            source = inner.source();
        }
        TaskError::ConfigError(full_error)
    }
}

impl From<std::io::Error> for TaskError {
    fn from(err: std::io::Error) -> TaskError {
        TaskError::RuntimeError(err.to_string())
    }
}

// We convert back to TaskError in case a subtask fails
// TODO: Use source() instead
impl From<AwareTaskError> for TaskError {
    fn from(err: AwareTaskError) -> TaskError {
        TaskError::RuntimeError(err.to_string())
    }
}

/// Task error aware of the task name
#[derive(Debug, PartialEq, Eq)]
pub(crate) struct AwareTaskError {
    /// Name of the task that failed
    pub(crate) task_name: String,
    /// The error that caused the task to fail
    pub(crate) error: TaskError,
}

impl fmt::Display for AwareTaskError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Task `{}` failed:\n{}", self.task_name, self.error)
    }
}

impl Error for AwareTaskError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        Some(&self.error)
    }
}

impl AwareTaskError {
    /// Creates a new AwareTaskError
    /// # Arguments
    /// * `task_name` - Name of the task that failed
    /// * `error` - The error that caused the task to fail
    pub(crate) fn new(task_name: &str, error: TaskError) -> AwareTaskError {
        AwareTaskError {
            task_name: task_name.to_string(),
            error,
        }
    }
}