canic-host 0.70.1

Host-side build, install, deployment, and fleet-template library for Canic workspaces
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

use std::{io, path::Path, process::Command};

use super::{
    command::command_display,
    error::IcpCommandError,
    model::{IcpCli, IcpCliVersion},
    run::{command_stderr, run_output_unchecked},
};

impl IcpCli {
    /// Resolve the installed ICP CLI version.
    pub fn version(&self) -> Result<String, IcpCommandError> {
        let mut command = self.command();
        command.arg("--version");
        run_output_unchecked(&mut command)
    }

    /// Resolve and validate the installed ICP CLI version.
    pub fn compatible_version(&self) -> Result<String, IcpCommandError> {
        compatible_version_output(&self.executable, self.cwd.as_deref())
    }

    /// Ensure this command context points at a supported ICP CLI.
    pub fn ensure_compatible(&self) -> Result<(), IcpCommandError> {
        self.compatible_version().map(|_| ())
    }
}

/// Parse an ICP CLI semantic version from `icp --version` output.
#[must_use]
pub fn parse_icp_cli_version(output: &str) -> Option<IcpCliVersion> {
    output
        .split_whitespace()
        .find_map(parse_icp_cli_version_token)
}

/// Return whether an ICP CLI version is supported by this Canic release.
#[must_use]
pub const fn is_supported_icp_cli_version(version: IcpCliVersion) -> bool {
    version.major == 1
}

pub(super) fn compatible_version_output(
    executable: &str,
    cwd: Option<&Path>,
) -> Result<String, IcpCommandError> {
    let output = icp_version_output(executable, cwd)?;
    if let Some(version) = parse_icp_cli_version(&output)
        && is_supported_icp_cli_version(version)
    {
        return Ok(output);
    }
    Err(IcpCommandError::IncompatibleCliVersion {
        executable: executable.to_string(),
        found: output,
    })
}

fn icp_version_output(executable: &str, cwd: Option<&Path>) -> Result<String, IcpCommandError> {
    let mut command = Command::new(executable);
    if let Some(cwd) = cwd {
        command.current_dir(cwd);
    }
    command.arg("--version");
    let display = command_display(&command);
    let output = command.output().map_err(|err| {
        if err.kind() == io::ErrorKind::NotFound {
            IcpCommandError::MissingCli {
                executable: executable.to_string(),
            }
        } else {
            IcpCommandError::Io(err)
        }
    })?;
    if output.status.success() {
        Ok(String::from_utf8_lossy(&output.stdout).trim().to_string())
    } else {
        Err(IcpCommandError::Failed {
            command: display,
            stderr: command_stderr(&output),
        })
    }
}

fn parse_icp_cli_version_token(token: &str) -> Option<IcpCliVersion> {
    let token = token
        .trim_matches(|c: char| matches!(c, ',' | ';' | ')' | '('))
        .trim_start_matches('v');
    let mut parts = token.split('.');
    let major = parts.next()?.parse::<u64>().ok()?;
    let minor = parts.next()?.parse::<u64>().ok()?;
    let patch_token = parts.next()?;
    let patch_digits = patch_token
        .chars()
        .take_while(char::is_ascii_digit)
        .collect::<String>();
    if patch_digits.is_empty() || parts.next().is_some() {
        return None;
    }
    Some(IcpCliVersion {
        major,
        minor,
        patch: patch_digits.parse::<u64>().ok()?,
    })
}