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
//! [![github]](https://github.com/ebakoba/depper) [![crates-io]](https://crates.io/crates/depper) [![docs-rs]](https://docs.rs/depper)
//!
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K
//!
//! <br>
//!
//! Library for detecting dependency cycles and finding missing dependencies. It also allows to sort
//! dependencies into tranches, which can be used as a hierarchy dependency resolution.
//!
//!
//! <br>
//!
//! # Details
//!
//! - It exposes two structs `DependencyBuilder` and `Dependencies`. First is for building up the list of dependencies
//! and building (calling the `.build()` function also validates the entire list) the second struct. Second is for
//! generating tranches of dependencies for deployment hierarchies.
//!
//!
//!   ```
//!   use depper::Dependencies;
//!
//!   fn main() {
//!     let mut dependencies_builder = Dependencies::builder()
//!       .add_element("b", &["d"])
//!       .add_element("c", &["d"])
//!       .add_element("a", &["d", "e", "y"])
//!       .add_element("d", &["e"])
//!       .add_element("e", &[])
//!       .add_element("y", &[]);
//!     
//!     // Calling the `.build()` function validates the list of dependencies.
//!     let dependencies = dependencies_builder.build().unwrap();
//!    
//!    // The `.tranches()` function returns a list of tranches.
//!     println!("{:?}", dependencies.generate_tranches().unwrap());
//!   }
//!   ```
//!
//!   ```console
//!   [["e", "y"], ["d"], ["b", "c", "a"]]
//!   ```
//!

use anyhow::{Ok, Result};
use petgraph::{
    algo::is_cyclic_directed,
    graph::{DiGraph, NodeIndex},
    visit::{IntoNodeReferences, NodeIndexable},
    Direction,
};
use std::collections::{HashMap, HashSet};

pub struct DependenciesBuilder<'a> {
    all_elements: Vec<&'a str>,
    all_dependencies: Vec<&'a str>,
    graph: DiGraph<&'a str, ()>,
    dependency_map: HashMap<&'a str, (NodeIndex, &'a [&'a str])>,
}

impl<'a> DependenciesBuilder<'a> {
    pub fn add_element(mut self, name: &'a str, dependecies: &'a [&str]) -> Self {
        self.all_elements.push(name);
        self.all_dependencies.extend(dependecies);
        let node = self.graph.add_node(name);
        self.dependency_map.insert(name, (node, dependecies));
        self
    }

    fn add_edges(&mut self) {
        for (node, dependencies) in self.dependency_map.values() {
            for dependency in *dependencies {
                let dependency_node = self.dependency_map[dependency].0;
                self.graph.add_edge(*node, dependency_node, ());
            }
        }
    }

    fn dependencies_are_met(&self) -> bool {
        let elements_set: HashSet<_> = self.all_elements.iter().collect();
        self.all_dependencies
            .iter()
            .all(|dependency| elements_set.contains(dependency))
    }

    fn no_cyclic_dependencies(&self) -> bool {
        !is_cyclic_directed(&self.graph)
    }

    fn validate(&mut self) -> Result<()> {
        if !self.dependencies_are_met() {
            return Err(anyhow::anyhow!(
                "Some dependencies do not exist as elements"
            ));
        }
        self.add_edges();
        if !self.no_cyclic_dependencies() {
            return Err(anyhow::anyhow!("Cyclic dependency detected"));
        }
        self.graph.clear_edges();

        Ok(())
    }

    pub fn build(&mut self) -> Result<Dependencies> {
        self.validate()?;
        self.add_edges();
        Ok(Dependencies {
            graph: self.graph.clone(),
        })
    }
}

#[derive(Debug)]
pub struct Dependencies<'a> {
    graph: DiGraph<&'a str, ()>,
}

impl<'a> Dependencies<'a> {
    pub fn generate_tranches(&self) -> Result<Vec<Vec<String>>> {
        let mut tranches: Vec<Vec<String>> = vec![];
        let mut traverse_graph = self.graph.clone();
        while traverse_graph.node_count() > 0 {
            let mut node_to_remove: Vec<(NodeIndex, String)> = vec![];
            let mut new_layer: Vec<String> = Vec::new();
            for (node_index, node_name) in traverse_graph.node_references() {
                if traverse_graph
                    .neighbors_directed(node_index, Direction::Outgoing)
                    .count()
                    == 0
                {
                    node_to_remove.push((node_index, node_name.to_string()));
                }
            }
            for (node_index, node_name) in node_to_remove {
                let adjusted_index = traverse_graph.to_index(node_index) - new_layer.len();
                traverse_graph.remove_node(traverse_graph.from_index(adjusted_index));

                new_layer.push(node_name.to_string())
            }
            tranches.push(new_layer);
        }
        Ok(tranches)
    }

    pub fn builder() -> DependenciesBuilder<'a> {
        DependenciesBuilder {
            all_elements: Vec::new(),
            all_dependencies: Vec::new(),
            graph: DiGraph::new(),
            dependency_map: HashMap::new(),
        }
    }
}

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

    #[test]
    fn can_validate_simple_tree() {
        let mut dependencies_builder = Dependencies::builder()
            .add_element("a", &["b", "c"])
            .add_element("b", &["c"])
            .add_element("c", &[]);

        assert!(dependencies_builder.build().is_ok());
    }

    #[test]
    fn can_validate_complex_tree() {
        let mut dependencies_builder = Dependencies::builder()
            .add_element("a", &["b", "c"])
            .add_element("b", &["c"])
            .add_element("c", &["d", "e"])
            .add_element("d", &["e"])
            .add_element("e", &[]);

        assert!(dependencies_builder.build().is_ok());
    }

    #[test]
    fn detects_missing_dependencies() {
        let mut dependencies_builder = Dependencies::builder()
            .add_element("a", &["b", "c"])
            .add_element("b", &["c"]);

        assert_eq!(
            dependencies_builder.build().unwrap_err().to_string(),
            "Some dependencies do not exist as elements"
        );
    }

    #[test]
    fn detects_cyclic_dependencies() {
        let mut dependencies_builder = Dependencies::builder()
            .add_element("a", &["b", "c"])
            .add_element("b", &["c"])
            .add_element("c", &["a", "b"]);

        assert_eq!(
            dependencies_builder.build().unwrap_err().to_string(),
            "Cyclic dependency detected"
        );
    }

    #[test]
    fn can_divide_into_tranches() {
        let mut dependencies_builder = Dependencies::builder()
            .add_element("b", &["d"])
            .add_element("c", &["d"])
            .add_element("a", &["d", "e", "y"])
            .add_element("d", &["e"])
            .add_element("e", &[])
            .add_element("y", &[]);

        let dependencies = dependencies_builder.build().unwrap();

        assert!(dependencies.generate_tranches().is_ok());
    }
}