drft-cli 0.7.0

A structural integrity checker for linked file systems
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 crate::diagnostic::Diagnostic;
use crate::rules::{Rule, RuleContext};

pub struct SymlinkEdgeRule;

impl Rule for SymlinkEdgeRule {
    fn name(&self) -> &str {
        "symlink-edge"
    }

    fn evaluate(&self, ctx: &RuleContext) -> Vec<Diagnostic> {
        let graph = &ctx.graph.graph;

        graph
            .edges
            .iter()
            .filter_map(|edge| {
                // Skip URIs
                if crate::graph::is_uri(&edge.target) {
                    return None;
                }

                // Check if the target node is a symlink
                let target_node = graph.nodes.get(&edge.target)?;
                if target_node.node_type != Some(crate::graph::NodeType::Symlink) {
                    return None;
                }

                // Find the filesystem edge from this node to get the symlink target
                let symlink_target = graph.forward.get(&edge.target)
                    .and_then(|indices| indices.iter()
                        .find_map(|&idx| {
                            let fs_edge = &graph.edges[idx];
                            if fs_edge.parser == "filesystem" { Some(fs_edge.target.clone()) } else { None }
                        }));

                let resolved = symlink_target.as_deref().unwrap_or("unknown");
                Some(Diagnostic {
                    rule: "symlink-edge".into(),
                    message: format!("target is a symlink to {resolved}"),
                    source: Some(edge.source.clone()),
                    target: Some(edge.target.clone()),
                    fix: Some(format!(
                        "{} is a symlink to {resolved} \u{2014} consider linking to the actual file directly in {}",
                        edge.target, edge.source
                    )),
                    ..Default::default()
                })
            })
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::graph::test_helpers::{make_enriched, make_node};
    use crate::graph::{Edge, Graph, Node, NodeType};
    use crate::rules::RuleContext;
    use std::collections::HashMap;

    #[test]
    fn detects_symlink_target() {
        let mut graph = Graph::new();
        graph.add_node(make_node("index.md"));
        graph.add_node(Node {
            path: "setup.md".into(),
            node_type: Some(NodeType::Symlink),
            included: true,
            hash: None,
            metadata: HashMap::new(),
        });
        graph.add_node(Node {
            path: "/shared/setup.md".into(),
            node_type: Some(NodeType::File),
            included: false,
            hash: None,
            metadata: HashMap::new(),
        });
        // Filesystem edge from symlink to its target
        graph.add_edge(Edge {
            source: "setup.md".into(),
            target: "/shared/setup.md".into(),
            link: None,
            parser: "filesystem".into(),
        });
        // Content edge from index.md to the symlink
        graph.add_edge(Edge {
            source: "index.md".into(),
            target: "setup.md".into(),
            link: None,
            parser: "markdown".into(),
        });

        let enriched = make_enriched(graph);
        let ctx = RuleContext {
            graph: &enriched,
            options: None,
        };
        let diagnostics = SymlinkEdgeRule.evaluate(&ctx);
        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].rule, "symlink-edge");
        assert!(diagnostics[0].message.contains("symlink"));
    }

    #[test]
    fn no_diagnostic_for_regular_file() {
        let mut graph = Graph::new();
        graph.add_node(make_node("index.md"));
        graph.add_node(Node {
            path: "setup.md".into(),
            node_type: Some(NodeType::File),
            included: false,
            hash: None,
            metadata: HashMap::new(),
        });
        graph.add_edge(Edge {
            source: "index.md".into(),
            target: "setup.md".into(),
            link: None,
            parser: "markdown".into(),
        });

        let enriched = make_enriched(graph);
        let ctx = RuleContext {
            graph: &enriched,
            options: None,
        };
        let diagnostics = SymlinkEdgeRule.evaluate(&ctx);
        assert!(diagnostics.is_empty());
    }
}