provenant-cli 0.0.8

Provenant is a high-performance Rust scanner for licenses, packages, and source provenance.
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
133
134
135
136
137
138
139
140
141
142

#[cfg(test)]
mod tests {
    use super::super::PackageParser;
    use super::super::docker::{DockerfileParser, parse_dockerfile};
    use crate::models::{DatasourceId, PackageType};
    use std::path::PathBuf;

    #[test]
    fn test_is_match_dockerfile_and_containerfile_variants() {
        assert!(DockerfileParser::is_match(&PathBuf::from("Dockerfile")));
        assert!(DockerfileParser::is_match(&PathBuf::from("dockerfile")));
        assert!(DockerfileParser::is_match(&PathBuf::from("Containerfile")));
        assert!(DockerfileParser::is_match(&PathBuf::from(
            "containerfile.core"
        )));

        assert!(!DockerfileParser::is_match(&PathBuf::from(
            "Dockerfile.dev"
        )));
        assert!(!DockerfileParser::is_match(&PathBuf::from(
            "docker-compose.yml"
        )));
        assert!(!DockerfileParser::is_match(&PathBuf::from(
            "my-Containerfile.txt"
        )));
    }

    #[test]
    fn test_parse_oci_labels_from_dockerfile() {
        let content = r#"
FROM docker.io/library/debian:bookworm-slim

LABEL org.opencontainers.image.title="Jitsi Broadcasting Infrastructure (jibri)" \
      org.opencontainers.image.description="Components for recording and/or streaming a conference." \
      org.opencontainers.image.url="https://github.com/jitsi/jibri" \
      org.opencontainers.image.source="https://github.com/jitsi/docker-jitsi-meet" \
      org.opencontainers.image.documentation="https://jitsi.github.io/handbook/" \
      org.opencontainers.image.version="stable-8960-1" \
      org.opencontainers.image.licenses="Apache-2.0" \
      org.opencontainers.image.revision="abcdef123456"
"#;

        let package = parse_dockerfile(content);

        assert_eq!(package.package_type, Some(PackageType::Docker));
        assert_eq!(package.primary_language, Some("Dockerfile".to_string()));
        assert_eq!(package.datasource_id, Some(DatasourceId::Dockerfile));
        assert_eq!(
            package.name.as_deref(),
            Some("Jitsi Broadcasting Infrastructure (jibri)")
        );
        assert_eq!(
            package.description.as_deref(),
            Some("Components for recording and/or streaming a conference.")
        );
        assert_eq!(
            package.homepage_url.as_deref(),
            Some("https://github.com/jitsi/jibri")
        );
        assert_eq!(
            package.vcs_url.as_deref(),
            Some("https://github.com/jitsi/docker-jitsi-meet")
        );
        assert_eq!(package.version.as_deref(), Some("stable-8960-1"));
        assert_eq!(
            package.extracted_license_statement.as_deref(),
            Some("Apache-2.0")
        );
        assert_eq!(
            package.declared_license_expression.as_deref(),
            Some("apache-2.0")
        );
        assert_eq!(
            package.declared_license_expression_spdx.as_deref(),
            Some("Apache-2.0")
        );
        assert_eq!(package.license_detections.len(), 1);
        assert_eq!(
            package.license_detections[0].license_expression_spdx,
            "Apache-2.0"
        );

        let oci_labels = package
            .extra_data
            .as_ref()
            .and_then(|extra| extra.get("oci_labels"))
            .and_then(|value| value.as_object())
            .expect("oci_labels should be collected");

        assert_eq!(
            oci_labels
                .get("org.opencontainers.image.documentation")
                .and_then(|value| value.as_str()),
            Some("https://jitsi.github.io/handbook/")
        );
        assert_eq!(
            oci_labels
                .get("org.opencontainers.image.revision")
                .and_then(|value| value.as_str()),
            Some("abcdef123456")
        );
    }

    #[test]
    fn test_parse_old_style_label_value() {
        let package =
            parse_dockerfile("LABEL org.opencontainers.image.title \"Example Container\"\n");

        assert_eq!(package.name.as_deref(), Some("Example Container"));
    }

    #[test]
    fn test_parse_old_style_label_value_with_equals_sign() {
        let package = parse_dockerfile(
            "LABEL org.opencontainers.image.description \"mode=a=b compatibility\"\n",
        );

        assert_eq!(
            package.description.as_deref(),
            Some("mode=a=b compatibility")
        );
    }

    #[test]
    fn test_parse_repeated_labels_override_previous_values() {
        let package = parse_dockerfile(
            "LABEL org.opencontainers.image.title=\"First\"\nLABEL org.opencontainers.image.title=\"Second\"\n",
        );

        assert_eq!(package.name.as_deref(), Some("Second"));
    }

    #[test]
    fn test_parse_dockerfile_without_oci_labels_still_returns_package_data() {
        let package = parse_dockerfile("FROM scratch\nRUN echo hello\n");

        assert_eq!(package.package_type, Some(PackageType::Docker));
        assert_eq!(package.primary_language, Some("Dockerfile".to_string()));
        assert_eq!(package.datasource_id, Some(DatasourceId::Dockerfile));
        assert!(package.extra_data.is_none());
    }
}