mithril_build_script/
lib.rs

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
use std::fs;
use std::path::{Path, PathBuf};

pub mod fake_aggregator;
pub mod open_api;

pub fn get_package_path(package_name: &str) -> PathBuf {
    let cargo_pkgid_output = std::process::Command::new(env!("CARGO"))
        .args(["pkgid", "--quiet", "-p", package_name])
        .output()
        .unwrap();

    match cargo_pkgid_output.status.success() {
        true => {
            let output_string = std::str::from_utf8(&cargo_pkgid_output.stdout)
                .unwrap()
                .trim();
            let package_path = extract_package_path(output_string);

            PathBuf::from(package_path)
        }
        false => {
            panic!(
                "cargo pkgid failed: stderr: {}",
                std::str::from_utf8(&cargo_pkgid_output.stderr)
                    .unwrap()
                    .trim()
            )
        }
    }
}

const PKGID_OUTPUT_PREFIX: &str = "file://";

fn extract_package_path<'a>(pkgid_output: &'a str) -> &'a str {
    let output_without_prefix = pkgid_output
        .split(PKGID_OUTPUT_PREFIX)
        .collect::<Vec<&'a str>>();

    output_without_prefix
        .last()
        .unwrap_or_else(|| {
            panic!("Could not remove '{PKGID_OUTPUT_PREFIX}' prefix from `cargo pkgid` output: {pkgid_output}")
        })
        .split('#')
        .collect::<Vec<_>>()
        .first()
        .unwrap_or_else(|| panic!("Could not remove '#x.y.z' suffix from `cargo pkgid` output: {pkgid_output}"))
}

pub(crate) fn list_files_in_folder(folder: &Path) -> impl Iterator<Item = fs::DirEntry> + '_ {
    fs::read_dir(folder)
        .unwrap_or_else(|_| panic!("Could not read `{}` dir", folder.display()))
        .filter_map(move |e| {
            let entry = e.unwrap_or_else(|_| {
                panic!("Failed to read a file in the `{}` dir", folder.display())
            });
            match entry.file_type() {
                Ok(file_type) if file_type.is_file() => Some(entry),
                _ => None,
            }
        })
}

#[cfg(test)]
// Note: adding `mithril-common` as a dev-dependency would lead to a circular dependency, so
// we can't use its `TempDir` api.
pub(crate) fn get_temp_dir(dir_name: &str) -> PathBuf {
    let dir = std::env::temp_dir()
        .join("mithril_test")
        .join("build_script")
        .join(dir_name);

    if dir.exists() {
        fs::remove_dir_all(&dir).unwrap();
    }
    fs::create_dir_all(&dir).unwrap();

    dir
}

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

    #[test]
    fn get_package_path_should_return_path_of_existing_package() {
        let expected = PathBuf::from("./../../mithril-aggregator/")
            .canonicalize()
            .unwrap();

        let package_path = get_package_path("mithril-aggregator");

        assert_eq!(package_path, expected);
    }

    #[test]
    #[should_panic]
    fn get_package_path_panic_if_valid_name_of_not_existing_package() {
        get_package_path("it-does-not-exist");
    }

    #[test]
    #[should_panic]
    fn get_package_path_panic_if_invalid_package_name() {
        get_package_path("Invalid Package Name ~~~");
    }

    #[test]
    fn extract_package_path_from_multiple_pkid_formats() {
        let expected = "/dev/package_path/crate";

        assert_eq!(
            extract_package_path(&format!("{PKGID_OUTPUT_PREFIX}{expected}#version")),
            expected
        );
        assert_eq!(
            extract_package_path(&format!("path+{PKGID_OUTPUT_PREFIX}{expected}#version")),
            expected
        );
    }
}