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

//! DL3055: Label `org.opencontainers.image.documentation` is not a valid URL
//!
//! The documentation label should contain a valid URL.

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(
        "DL3055",
        Severity::Warning,
        "Label `org.opencontainers.image.documentation` is not a valid URL.",
        |instr, _shell| match instr {
            Instruction::Label(pairs) => {
                for (key, value) in pairs {
                    if key == "org.opencontainers.image.documentation" && !is_valid_url(value) {
                        return false;
                    }
                }
                true
            }
            _ => true,
        },
    )
}

fn is_valid_url(url: &str) -> bool {
    if url.is_empty() {
        return false;
    }

    // Basic URL validation - must start with http:// or https://
    url.starts_with("http://") || url.starts_with("https://")
}

#[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_valid_url() {
        let result = lint_dockerfile(
            "FROM ubuntu:20.04\nLABEL org.opencontainers.image.documentation=\"https://example.com/docs\"",
        );
        assert!(!result.failures.iter().any(|f| f.code.as_str() == "DL3055"));
    }

    #[test]
    fn test_invalid_url() {
        let result = lint_dockerfile(
            "FROM ubuntu:20.04\nLABEL org.opencontainers.image.documentation=\"not-a-url\"",
        );
        assert!(result.failures.iter().any(|f| f.code.as_str() == "DL3055"));
    }
}