syncable-cli 0.37.1

A Rust-based CLI that analyzes code repositories and generates Infrastructure as Code configurations
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

//! DL3014: Use the -y switch to avoid manual input
//!
//! apt-get install should use -y to avoid prompts during build.

use crate::analyzer::hadolint::parser::instruction::Instruction;
use crate::analyzer::hadolint::rules::{SimpleRule, simple_rule};
use crate::analyzer::hadolint::shell::ParsedShell;
use crate::analyzer::hadolint::types::Severity;

pub fn rule() -> SimpleRule<impl Fn(&Instruction, Option<&ParsedShell>) -> bool + Send + Sync> {
    simple_rule(
        "DL3014",
        Severity::Warning,
        "Use the `-y` switch to avoid manual input `apt-get -y install <package>`.",
        |instr, shell| {
            match instr {
                Instruction::Run(_) => {
                    if let Some(shell) = shell {
                        // Check all apt-get install commands
                        !shell.any_command(|cmd| {
                            if cmd.name == "apt-get" && cmd.has_any_arg(&["install"]) {
                                // Must have -y, --yes, or --assume-yes
                                !cmd.has_any_flag(&["y", "yes", "assume-yes"])
                            } else {
                                false
                            }
                        })
                    } else {
                        true
                    }
                }
                _ => true,
            }
        },
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::analyzer::hadolint::config::HadolintConfig;
    use crate::analyzer::hadolint::lint::{LintResult, lint};

    fn lint_dockerfile(content: &str) -> LintResult {
        lint(content, &HadolintConfig::default())
    }

    #[test]
    fn test_apt_get_without_y() {
        let result = lint_dockerfile("FROM ubuntu:20.04\nRUN apt-get install nginx");
        assert!(result.failures.iter().any(|f| f.code.as_str() == "DL3014"));
    }

    #[test]
    fn test_apt_get_with_y() {
        let result = lint_dockerfile("FROM ubuntu:20.04\nRUN apt-get install -y nginx");
        assert!(!result.failures.iter().any(|f| f.code.as_str() == "DL3014"));
    }

    #[test]
    fn test_apt_get_with_yes() {
        let result = lint_dockerfile("FROM ubuntu:20.04\nRUN apt-get install --yes nginx");
        assert!(!result.failures.iter().any(|f| f.code.as_str() == "DL3014"));
    }

    #[test]
    fn test_apt_get_with_assume_yes() {
        let result = lint_dockerfile("FROM ubuntu:20.04\nRUN apt-get install --assume-yes nginx");
        assert!(!result.failures.iter().any(|f| f.code.as_str() == "DL3014"));
    }

    #[test]
    fn test_apt_get_update_no_y() {
        // apt-get update doesn't need -y
        let result = lint_dockerfile("FROM ubuntu:20.04\nRUN apt-get update");
        assert!(!result.failures.iter().any(|f| f.code.as_str() == "DL3014"));
    }
}