shuck-linter 0.0.43

Lint rule engine and checker for shell scripts
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

use crate::{Checker, Rule, Violation};

pub struct RmRootishTarget;

impl Violation for RmRootishTarget {
    fn rule() -> Rule {
        Rule::RmRootishTarget
    }

    fn message(&self) -> String {
        "recursive `rm` targets a root-like directory".to_owned()
    }
}

pub fn rm_rootish_target(checker: &mut Checker) {
    let spans = checker
        .facts()
        .command_facts()
        .structural_commands()
        .filter(|fact| fact.effective_name_is("rm"))
        .filter_map(|fact| fact.options().rm())
        .flat_map(|rm| rm.rootish_path_spans(checker.source()).iter().copied())
        .collect::<Vec<_>>();

    checker.report_all(spans, || RmRootishTarget);
}

#[cfg(test)]
mod tests {
    use crate::test::test_snippet;
    use crate::{LinterSettings, Rule};

    #[test]
    fn reports_recursive_rm_on_root_or_home_roots() {
        let source = "#!/bin/sh\nrm -rf /\nrm -rf /*\nrm -rf /**\nrm -rf /./\nrm -rf /./*\nrm -rf /..\nrm -rf /../*\nrm -rf \"$HOME\"\nrm -rf \"${HOME}\"/*\nrm -rf \"${HOME}\"/**\nrm -rf \"$HOME\"/.\nrm -rf \"$HOME\"/./*\nrm -rf \"${HOME:?}\"\nrm -rf \"${HOME:?}\"/*\nrm -rf \"${HOME:?}\"/.\nrm -rf ~\nrm -rf ~/*\nrm -rf ~/**\nrm -rf ~/.\nrm -rf ~/./*\nrm -rf ~root/*\n";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::RmRootishTarget));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec![
                "/",
                "/*",
                "/**",
                "/./",
                "/./*",
                "/..",
                "/../*",
                "\"$HOME\"",
                "\"${HOME}\"/*",
                "\"${HOME}\"/**",
                "\"$HOME\"/.",
                "\"$HOME\"/./*",
                "\"${HOME:?}\"",
                "\"${HOME:?}\"/*",
                "\"${HOME:?}\"/.",
                "~",
                "~/*",
                "~/**",
                "~/.",
                "~/./*",
                "~root/*"
            ]
        );
    }

    #[test]
    fn ignores_non_recursive_and_bounded_rm_targets() {
        let source = "#!/bin/sh\ndir=/tmp\nrm -f \"$HOME\"/*\nrm -rf \"$HOME\"/.cache\nrm -rf \"${HOME%/*}\"\nrm -rf \"${HOME%%/*}\"\nrm -rf \"$HOME\"/..\nrm -rf \"$HOME\"/../*\nrm -rf ~/..\nrm -rf ~/../*\nrm -rf ~0\nrm -rf ~1/*\nrm -rf ~/Downloads/*\nrm -rf /tmp/*\nrm -rf /tmp/../*\nrm -rf ~/tmp/../*\nrm -rf ~root/tmp/../*\nrm -rf \"$dir\"/*\nrm -rf \"~\"/*\nrm -rf \"$HOME\"/\"*\"\n";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::RmRootishTarget));

        assert!(diagnostics.is_empty(), "diagnostics: {diagnostics:?}");
    }
}