fetter 3.3.0

System-wide Python package discovery, validation, vulnerability scanning, and allow-listing.
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

use crate::util::url_strip_user;
use crate::util::ResultDynError;
use serde::{Deserialize, Serialize};
use std::fs::File;
use std::path::PathBuf;

// see https://packaging.python.org/en/latest/specifications/direct-url/

// NOTE: DirectURL includes url and one of three other keys:
// vcs_info: VCS request
// archive_info: direct download from a url to a whl or similar
// dir_info: url is a local directory
// assume we only need vcs_info for matching rquirements

#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Clone)]
pub struct VcsInfo {
    pub commit_id: String,
    pub vcs: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub revision: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Clone)]
pub struct DirectURL {
    pub url: String,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub vcs_info: Option<VcsInfo>,
}

impl DirectURL {
    pub(crate) fn from_file(path: &PathBuf) -> ResultDynError<Self> {
        let file = File::open(path).map_err(|e| format!("failed to open file: {e}"));
        serde_json::from_reader(file.unwrap())
            .map_err(|e| format!("failed to parse JSON: {e}").into())
    }

    // Alternate constructor for test.
    #[cfg(test)]
    pub(crate) fn from_url_vcs_cid(
        url: String,
        vcs: Option<String>,
        commit_id: Option<String>,
    ) -> ResultDynError<Self> {
        let vcs_info = if let (Some(vcs), Some(commit_id)) = (vcs, commit_id) {
            Some(VcsInfo {
                vcs,
                commit_id,
                revision: None,
            })
        } else {
            None
        };

        Ok(DirectURL { url, vcs_info })
    }

    //--------------------------------------------------------------------------

    // Given a URL from a DepSpec, validate against this URL from a Package's DirectURL. We strip the user in comparison from both sides as inconsistencies are found in how DirectURL records these.
    pub(crate) fn validate(&self, url: &String) -> bool {
        let url_dep_spec = url_strip_user(url);
        let url_durl = url_strip_user(&self.url);

        if let Some(vcs_info) = &self.vcs_info {
            // use revision if defined, else commit_id
            if let Some(revision) = &vcs_info.revision {
                if format!("{}+{}@{}", vcs_info.vcs, url_durl, revision) == url_dep_spec {
                    return true;
                }
            }
            if format!("{}+{}@{}", vcs_info.vcs, url_durl, vcs_info.commit_id)
                == url_dep_spec
            {
                return true;
            }
            return false;
        }
        url_durl == url_dep_spec
    }
}

//------------------------------------------------------------------------------
#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Write;
    use tempfile::tempdir;

    #[test]
    fn test_durl_a() {
        // from pip3 install "git+ssh://git@github.com/uqfoundation/dill.git"
        let json_str = r#"
        {
            "url": "ssh://git@github.com/uqfoundation/dill.git",
            "vcs_info": {
                "commit_id": "15d7c6d6ccf4781c624ffbf54c90d23c6e94dc52",
                "vcs": "git"
            }
        }
        "#;

        let durl: DirectURL =
            serde_json::from_str(json_str).expect("Failed to parse JSON");
        assert_eq!("ssh://git@github.com/uqfoundation/dill.git", durl.url);
        assert_eq!("git", durl.vcs_info.as_ref().unwrap().vcs);
        assert_eq!(
            "15d7c6d6ccf4781c624ffbf54c90d23c6e94dc52",
            durl.vcs_info.as_ref().unwrap().commit_id
        );
        assert!(durl.vcs_info.as_ref().unwrap().revision.is_none());
    }

    #[test]
    fn test_durl_b() {
        // from pip3 install "git+ssh://git@github.com/uqfoundation/dill.git@0.3.8"
        let json_str = r#"
        {"url": "ssh://git@github.com/uqfoundation/dill.git", "vcs_info": {"commit_id": "a0a8e86976708d0436eec5c8f7d25329da727cb5", "revision": "0.3.8", "vcs": "git"}}
        "#;

        let durl: DirectURL =
            serde_json::from_str(json_str).expect("Failed to parse JSON");
        assert_eq!("ssh://git@github.com/uqfoundation/dill.git", durl.url);
        assert_eq!("git", durl.vcs_info.as_ref().unwrap().vcs);
        assert_eq!(
            "a0a8e86976708d0436eec5c8f7d25329da727cb5",
            durl.vcs_info.as_ref().unwrap().commit_id
        );
        assert_eq!(
            "0.3.8",
            durl.vcs_info.as_ref().unwrap().revision.as_ref().unwrap()
        );
    }

    #[test]
    fn test_durl_c() {
        // from: pip install https://files.pythonhosted.org/packages/d9/5a/e7c31adbe875f2abbb91bd84cf2dc52d792b5a01506781dbcf25c91daf11/six-1.16.0-py2.py3-none-any.whl
        let json_str = r#"
          {
            "archive_info": {
              "hash": "sha256=8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254",
              "hashes": {
                "sha256": "8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"
              }
            },
            "url": "https://files.pythonhosted.org/packages/d9/5a/e7c31adbe875f2abbb91bd84cf2dc52d792b5a01506781dbcf25c91daf11/six-1.16.0-py2.py3-none-any.whl"
          }
          "#;
        let durl: DirectURL = serde_json::from_str(json_str).unwrap();
        assert_eq!("https://files.pythonhosted.org/packages/d9/5a/e7c31adbe875f2abbb91bd84cf2dc52d792b5a01506781dbcf25c91daf11/six-1.16.0-py2.py3-none-any.whl", durl.url);
    }

    //--------------------------------------------------------------------------
    #[test]
    fn test_durl_from_file_a() {
        let temp_dir = tempdir().unwrap();
        let fp_durl = temp_dir.path().join("direct_url.json");
        let content = r#"
        {"url": "ssh://git@github.com/uqfoundation/dill.git", "vcs_info": {"commit_id": "a0a8e86976708d0436eec5c8f7d25329da727cb5", "revision": "0.3.8", "vcs": "git"}}
        "#;
        let mut file = File::create(&fp_durl).unwrap();
        write!(file, "{}", content).unwrap();

        let durl = DirectURL::from_file(&fp_durl).unwrap();
        assert_eq!("ssh://git@github.com/uqfoundation/dill.git", durl.url);
    }

    //--------------------------------------------------------------------------
    #[test]
    fn test_validate_a() {
        // from pip3 install "git+ssh://git@github.com/uqfoundation/dill.git@0.3.8"
        let json_str = r#"
        {"url": "ssh://git@github.com/uqfoundation/dill.git", "vcs_info": {"commit_id": "a0a8e86976708d0436eec5c8f7d25329da727cb5", "revision": "0.3.8", "vcs": "git"}}
        "#;
        let durl: DirectURL = serde_json::from_str(json_str).unwrap();
        assert!(durl.validate(
            &"git+ssh://git@github.com/uqfoundation/dill.git@0.3.8".to_string()
        ),);
        assert!(!durl.validate(
            &"git+ssh://git@github.com/uqfoundation/dill.git@0.3.7".to_string()
        ),);
        assert!(durl
            .validate(&"git+ssh://github.com/uqfoundation/dill.git@0.3.8".to_string()),);
        assert!(
            durl.validate(&"git+ssh://github.com/uqfoundation/dill.git@a0a8e86976708d0436eec5c8f7d25329da727cb5".to_string()),
        );
        assert!(
            !durl.validate(&"git+ssh://github.com/uqfoundation/dill.git@a0a8e86976708d0436e5c8f7d25329da727cb5".to_string()),

        );
    }
}