shuck-linter 0.0.41

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
77
78
79
80
81

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

pub struct TautologyChain;

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

    fn message(&self) -> String {
        "these alternatives make the OR chain unable to fail".to_owned()
    }
}

pub fn tautology_chain(checker: &mut Checker) {
    if checker.shell() == ShellDialect::Zsh {
        return;
    }

    let spans = checker
        .facts()
        .command_facts()
        .tautology_chain_operator_spans()
        .to_vec();
    checker.report_all_dedup(spans, || TautologyChain);
}

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

    #[test]
    fn anchors_on_the_operator_before_the_later_conflicting_test() {
        let source = "\
#!/bin/bash
[[ a != \"$x\" ]] || [[ b != \"$x\" ]]
[ \"$n\" -ne 1 ] || [ 2 -ne \"$n\" ]
[ \"$n\" -ne 010 ] || [ \"$n\" -ne 8 ]
[[ \"$n\" -ne 010 ]] || [[ \"$n\" -ne 10 ]]
[[ \"$x\" != \"a*\" ]] || [[ \"$x\" != \"b*\" ]]
[[ \"$x\" != 'a*' ]] || [[ \"$x\" != 'b*' ]]
[[ \"$n\" -ne 64#@ ]] || [[ \"$n\" -ne 63 ]]
[[ a != \"$x\" ]] || maybe || [[ b != \"$x\" ]]
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::TautologyChain));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["||", "||", "||", "||", "||", "||", "||", "||"]
        );
    }

    #[test]
    fn ignores_non_tautological_and_oracle_incompatible_shapes() {
        let source = "\
#!/bin/bash
[[ \"$x\" == a ]] || [[ \"$x\" == b ]]
[[ \"$x\" != a ]] || [[ \"$y\" != b ]]
[[ \"$x\" != a ]] || [[ \"$x\" != a ]]
[ \"$n\" -ne 01 ] || [ \"$n\" -ne 1 ]
[ \"$n\" -ne 010 ] || [ \"$n\" -ne 10 ]
[[ \"$n\" -ne 01 ]] || [[ \"$n\" -ne 1 ]]
[[ \"$n\" -ne 010 ]] || [[ \"$n\" -ne 8 ]]
[[ \"$n\" -ne 36#Z ]] || [[ \"$n\" -ne 35 ]]
[[ \"$n\" -ne 64#_ ]] || [[ \"$n\" -ne 63 ]]
[ \"$n\" -ne x ] || [ \"$n\" -ne y ]
[[ \"$n\" -ne x ]] || [[ \"$n\" -ne y ]]
[[ \"$n\" -ne 8#9 ]] || [[ \"$n\" -ne 10 ]]
[[ a != \"$x\" ]] || [[ b != $x ]]
[[ \"$x\" != a* ]] || [[ \"$x\" != b* ]]
test \"$x\" != a || test \"$x\" != b
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::TautologyChain));

        assert!(diagnostics.is_empty());
    }
}