xplan 0.1.0

CLI tool to visualize task dependency
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

use std::collections::HashMap;

use thiserror::Error;

use crate::task::{TaskId, TaskType, Task};

#[derive(Debug)]
pub struct Store {
    pub tasks: HashMap<TaskId, Task>,
    pub task_types: Vec<TaskType>
}

impl Store {
    pub fn builder() -> StoreBuilder {
        StoreBuilder::new()
    }

    pub fn get(&self, id: &TaskId) -> &Task {
        // Unwrap is safe, because all ids were validated by StoreBuilder
        self.tasks.get(id).unwrap()
    }
}

#[derive(Debug, Error)]
pub enum StoreBuilderError {
    #[error("Task '{host}' refers to '{dep}', but '{dep}' is not defined.")]
    MissingDependecy {
        host: TaskId,
        dep: TaskId
    }
}

#[derive(Debug)]
pub struct StoreBuilder {
    tasks: Vec<Task>,
    task_types: Vec<TaskType>
}

impl StoreBuilder {
    fn new() -> Self {
        Self {
            tasks: vec![] ,
            task_types: vec![],
        }
    }

    pub fn add(mut self, task: Task) -> Self {
        if let Some(tp) = &task.task_type {
            if !self.task_types.contains(tp) {
                self.task_types.push((*tp).clone())
            }
        }
        self.tasks.push(task);
        self
    }

    pub fn build(self) -> Result<Store, StoreBuilderError> {
        let mut tasks_map: HashMap<TaskId, Task> = HashMap::new();

        let known_ids: Vec<TaskId> = self.tasks.iter().map(|u| u.id.clone()).collect();

        for task in self.tasks.into_iter() {
            // Check dependencies
            for dep_id in task.deps.iter() {
                if !known_ids.contains(dep_id) {
                    let e = StoreBuilderError::MissingDependecy { host: task.id.clone(), dep: dep_id.clone() };
                    return Err(e);
                }
            }

            // Add to HashMap
            tasks_map.insert(task.id.clone(), task);
        }

        let store = Store { tasks: tasks_map, task_types: self.task_types };
        Ok(store)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn task<S: Into<TaskId>>(id: S) -> Task {
        task_with_deps(id, Vec::new())
    }

    fn task_with_deps<T: Into<TaskId>>(id: T, deps: Vec<T>) -> Task {
        Task {
            id: id.into(),
            name: None,
            deps: deps.into_iter().map(|d| d.into()).collect(),
            task_type: None
        }
    }

    #[test]
    fn test_builder_ok() {
        let store = Store::builder()
            .add(task("A"))
            .add(task("B"))
            .build()
            .unwrap();

        let a_id = TaskId::from("A");
        assert_eq!(store.get(&a_id), &task("A"));

        let b_id = TaskId::from("B");
        assert_eq!(store.get(&b_id), &task("B"));
    }

    #[test]
    fn test_builder_err() {
        let err = Store::builder()
            .add(task("A"))
            .add(task_with_deps("B", vec!["Z"]))
            .build()
            .unwrap_err();

        assert_eq!(
            format!("{}", err),
            "Task 'B' refers to 'Z', but 'Z' is not defined."
        )
    }
}