ghastoolkit 0.12.2

GitHub Advanced Security Toolkit in Rust
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

use std::{collections::HashMap, fmt::Display, str::FromStr};

use purl::GenericPurl;

use crate::{Repository, supplychain::licenses::Licenses};

/// Supply Chain Dependency struct used to represent a dependency in a supply chain.
///
/// # Example
///
/// ```rust
/// use ghastoolkit::Dependency;
/// // Create a new Dependency from a PURL
/// let dependency = Dependency::from("pkg:generic/namespace/name@version");
///
/// println!("{}", dependency);
///
/// ```
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct Dependency {
    /// Manager / Type of the dependency
    pub manager: String,
    /// Name of the dependency
    pub name: String,
    /// Namespace of the dependency
    pub namespace: Option<String>,
    /// Version of the dependency
    pub version: Option<String>,
    /// Path to the dependency
    path: Option<String>,
    /// Qualifiers for the dependency
    qualifiers: HashMap<String, String>,
    /// SPDX licenses for the dependency
    pub licenses: Licenses,

    repository: Option<Repository>,
    /// PURL
    purl: Option<GenericPurl<String>>,
}

impl Dependency {
    /// Create a new Dependency
    pub fn new() -> Self {
        Default::default()
    }

    /// Get the PURL for the dependency
    pub fn purl(&self) -> String {
        if let Some(purl) = &self.purl {
            purl.to_string()
        } else {
            format!("pkg:{}@{}", self.manager, self.name)
        }
    }
}

impl Display for Dependency {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.purl())
    }
}

impl From<&str> for Dependency {
    fn from(value: &str) -> Self {
        Dependency::from(GenericPurl::<String>::from_str(value).expect("Failed to parse PURL"))
    }
}

impl From<String> for Dependency {
    fn from(value: String) -> Self {
        Dependency::from(value.as_str())
    }
}

impl From<GenericPurl<String>> for Dependency {
    fn from(value: GenericPurl<String>) -> Self {
        Dependency {
            name: value.name().to_string(),
            namespace: value.namespace().map(|s| s.to_string()),
            version: value.version().map(|s| s.to_string()),
            manager: value.package_type().clone(),
            purl: Some(value),
            ..Default::default()
        }
    }
}

impl From<(&str, &str)> for Dependency {
    fn from(value: (&str, &str)) -> Self {
        let mut dependency = Dependency::from(value.0);
        dependency.licenses = Licenses::from(value.1);
        dependency
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_dependency_from_str() {
        let dependency = Dependency::from("pkg:generic/namespace/name@version");
        assert_eq!(dependency.name, "name");
        assert_eq!(dependency.namespace, Some("namespace".to_string()));
        assert_eq!(dependency.version, Some("version".to_string()));
        assert_eq!(dependency.manager, "generic".to_string());

        assert_eq!(
            dependency.purl(),
            "pkg:generic/namespace/name@version".to_string()
        );
    }
}