tracel-xtask 4.16.0

Reusable and Extensible xtask commands to manage repositories.
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

use std::process::Command;

use anyhow::Ok;
use regex::Regex;

use crate::{endgroup, group, utils::process::run_process};

/// Ensure that a cargo crate is installed
pub fn ensure_cargo_crate_is_installed(
    crate_name: &str,
    features: Option<&str>,
    version: Option<&str>,
    locked: bool,
) -> anyhow::Result<()> {
    if !is_cargo_crate_installed(crate_name) {
        group!("Cargo: install crate '{}'", crate_name);
        let mut args = vec!["install", crate_name];
        if locked {
            args.push("--locked");
        }
        if let Some(features) = features {
            if !features.is_empty() {
                args.extend(vec!["--features", features]);
            }
        }
        if let Some(version) = version {
            args.extend(vec!["--version", version]);
        }
        run_process(
            "cargo",
            &args,
            None,
            None,
            &format!("crate '{crate_name}' should be installed"),
        )?;
        endgroup!();
    }
    Ok(())
}

/// Returns true if the passed cargo crate is installed locally
pub fn is_cargo_crate_installed(crate_name: &str) -> bool {
    let output = Command::new("cargo")
        .arg("install")
        .arg("--list")
        .output()
        .expect("Should get the list of installed cargo commands");
    let output_str = String::from_utf8_lossy(&output.stdout);
    output_str.lines().any(|line| line.contains(crate_name))
}

pub fn parse_cargo_search_output(output: &str) -> Option<(String, String)> {
    // First strip ANSI color codes
    let ansi_re = Regex::new(r"\x1b\[[0-9;]*m").expect("should compile regex for ANSI codes");
    let cleaned_output = ansi_re.replace_all(output, "");
    // Then retrieve the crate name and version in the output.
    // Examples of accepted format:
    //   - x.y.z
    //   - x.y.z-123
    //   - x.y.z-pre.1
    let re = Regex::new(
        r#"(?P<name>[a-zA-Z0-9_-]+)\s*=\s*"(?P<version>\d+\.\d+\.\d+(?:-(?:\d+|pre\.\d+))?)""#,
    )
    .expect("should compile regex");
    if let Some(captures) = re.captures(&cleaned_output) {
        if let (Some(name), Some(version)) = (captures.name("name"), captures.name("version")) {
            return Some((name.as_str().to_owned(), version.as_str().to_owned()));
        }
    }
    None
}

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

        fn expect_pair(e: Option<(&str, &str)>) -> Option<(String, String)> {
            e.map(|(n, v)| (n.to_owned(), v.to_owned()))
        }

        macro_rules! cases {
            ( $( { $name:ident, $input:expr, $expected:expr } ),* $(,)? ) => {
                $(
                    #[test]
                    fn $name() {
                        let expected = expect_pair($expected);
                        let result = parse_cargo_search_output($input);
                        assert_eq!(result, expected);
                    }
                )*
            };
        }

        cases! {
            { valid_input, "tracel-xtask-macros = \"1.0.1\"", Some(("tracel-xtask-macros", "1.0.1")) },
            { valid_input_with_comments, "heat-sdk-cli-macros = \"0.1.0\"    # Macros for Tracel Heat SDK CLI.\n", Some(("heat-sdk-cli-macros", "0.1.0")) },
            { valid_input_with_comments_and_color_codes, "\u{1b}[1m\u{1b}[32mheat-sdk-cli-macros\u{1b}[0m = \"0.1.0\"    # Macros for Tracel Heat SDK CLI.\n", Some(("heat-sdk-cli-macros", "0.1.0")) },
            { missing_version, "tracel-xtask-macros =", None },
            { invalid_format, "tracel-xtask-macros: \"1.0.1\"", None },
            { extra_whitespace, "   tracel-xtask-macros    =    \"1.0.1\"  ", Some(("tracel-xtask-macros", "1.0.1")) },
            { no_quotes, "tracel-xtask-macros = 1.0.1", None },
            { wrong_version_format, "tracel-xtask-macros = \"1.0\"", None },
            { valid_input_with_release_suffix, "tracel-xtask-macros = \"20.1.4-1\"", Some(("tracel-xtask-macros", "20.1.4-1")) },
            { valid_input_with_release_suffix_multiple_digits, "tracel-xtask-macros = \"20.1.4-103\"", Some(("tracel-xtask-macros", "20.1.4-103")) },
            { valid_input_with_pre_release_suffix, "tracel-xtask-macros = \"20.1.4-pre.1\"", Some(("tracel-xtask-macros", "20.1.4-pre.1")) },
        }
    }
}