archunit/slices/assertion/
diagram_adherence.rs

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
use crate::{common::ProjectedEdge, slices::PlantUmlDiagram};

use super::{DiagramAdherenceOptions, SliceDependencyRule, SliceDependencyViolation};

/// Collects actual slice dependencies not permitted by the supplied diagram.
#[must_use]
pub fn gather_diagram_adherence_violations(
    edges: &[ProjectedEdge],
    diagram: &PlantUmlDiagram,
    options: &DiagramAdherenceOptions,
) -> Vec<SliceDependencyViolation> {
    edges
        .iter()
        .filter(|edge| !ignored(edge, diagram, options))
        .filter(|edge| !diagram.allows(&edge.source_label, &edge.target_label))
        .cloned()
        .map(|edge| {
            let source = edge.source_label.clone();
            let target = edge.target_label.clone();
            SliceDependencyViolation::new(
                edge,
                source,
                target,
                SliceDependencyRule::AdhereToDiagram,
                false,
            )
        })
        .collect()
}

fn ignored(
    edge: &ProjectedEdge,
    diagram: &PlantUmlDiagram,
    options: &DiagramAdherenceOptions,
) -> bool {
    if options.ignore_external_slices && edge.cumulated_edges.iter().any(|edge| edge.external) {
        return true;
    }
    options.ignore_orphan_slices
        && (!diagram.components.contains(&edge.source_label)
            || !diagram.components.contains(&edge.target_label))
}

#[cfg(test)]
mod tests {
    use crate::{
        common::{Edge, ImportKind, ProjectedEdge},
        slices::{PlantUmlDependency, PlantUmlDiagram},
    };

    use super::{DiagramAdherenceOptions, gather_diagram_adherence_violations};

    fn edge(source: &str, target: &str, external: bool) -> ProjectedEdge {
        ProjectedEdge::new(
            source,
            target,
            [Edge::new(source, target, external, [ImportKind::Use])],
        )
    }

    fn diagram() -> PlantUmlDiagram {
        PlantUmlDiagram::new(
            ["api", "services", "database"]
                .into_iter()
                .map(str::to_owned),
            [PlantUmlDependency::new("api", "services")
                .expect("fixture dependency should be valid")],
        )
        .expect("fixture diagram should be valid")
    }

    #[test]
    fn reports_every_actual_dependency_the_diagram_does_not_allow() {
        let edges = [
            edge("api", "services", false),
            edge("api", "database", false),
            edge("api", "serde", true),
        ];

        let violations = gather_diagram_adherence_violations(
            &edges,
            &diagram(),
            &DiagramAdherenceOptions::default(),
        );

        assert_eq!(
            violations
                .iter()
                .map(|violation| violation.target_slice.as_str())
                .collect::<Vec<_>>(),
            ["database", "serde"]
        );
        assert!(violations.iter().all(|violation| !violation.is_negated));
    }

    #[test]
    fn external_and_orphan_modifiers_are_independent_immutable_values() {
        let edges = [edge("api", "database", false), edge("api", "serde", true)];
        let base = DiagramAdherenceOptions::new();
        let external = base.with_external_slices_ignored(true);
        let orphans = base.with_orphan_slices_ignored(true);

        assert_eq!(
            gather_diagram_adherence_violations(&edges, &diagram(), &external).len(),
            1
        );
        assert_eq!(
            gather_diagram_adherence_violations(&edges, &diagram(), &orphans).len(),
            1
        );
        assert!(!base.ignore_external_slices);
        assert!(!base.ignore_orphan_slices);
    }
}