ic-build 0.17.2

Cargo and Wasm builds, exact inputs and retained artifact caches
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

//! Typed recipe choices shared by Cargo metadata and build commands.

use std::{
    collections::BTreeSet,
    ffi::OsString,
    path::{Component, Path},
};

#[cfg(test)]
mod tests;

/// Caller-selected features for one Cargo graph.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CargoFeatureSelection {
    /// Features to activate, ordered and deduplicated before passing to Cargo.
    pub features: BTreeSet<String>,
    /// Activate every feature in the selected packages.
    pub all_features: bool,
    /// Whether Cargo activates the selected packages' default features.
    pub default_features: bool,
}

impl Default for CargoFeatureSelection {
    fn default() -> Self {
        Self {
            features: BTreeSet::new(),
            default_features: true,
            all_features: false,
        }
    }
}

impl CargoFeatureSelection {
    pub(crate) fn arguments(&self) -> Vec<OsString> {
        let mut arguments = Vec::new();
        if self.all_features {
            arguments.push("--all-features".into());
        }
        if !self.default_features {
            arguments.push("--no-default-features".into());
        }
        if !self.features.is_empty() {
            arguments.push(
                format!(
                    "--features={}",
                    self.features
                        .iter()
                        .map(String::as_str)
                        .collect::<Vec<_>>()
                        .join(",")
                )
                .into(),
            );
        }
        arguments
    }
}

/// Caller-selected profile, features and network/lock policy for one recipe.
///
/// Package, target, manifest, output paths and message format belong to the
/// enclosing build specification. Arbitrary Cargo arguments are not accepted.
/// Use both locked and offline for Cargo's frozen policy.
/// Defaults select Cargo's dev profile and default features, with network and
/// lockfile policy inherited from the caller's environment/command factory.
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct CargoSelection {
    /// Named Cargo profile; None selects dev. Release renders as --release.
    pub profile: Option<String>,
    /// Explicit features and whether default features are enabled.
    pub features: CargoFeatureSelection,
    /// Require Cargo to preserve the selected lockfile.
    pub locked: bool,
    /// Prevent Cargo from accessing the network.
    pub offline: bool,
}

impl CargoSelection {
    pub(crate) fn profile_target_dir(&self) -> Result<&str, &'static str> {
        let profile = self.profile.as_deref().unwrap_or("dev");
        let directory = match profile {
            "dev" | "test" => "debug",
            "bench" => "release",
            custom => custom,
        };
        let mut components = Path::new(directory).components();
        if !matches!(
            (components.next(), components.next()),
            (Some(Component::Normal(_)), None)
        ) {
            return Err("Cargo profile must select one normal output directory component");
        }
        Ok(directory)
    }

    pub(crate) fn metadata_arguments(&self) -> Vec<OsString> {
        graph_arguments(&self.features, self.locked, self.offline)
    }

    pub(crate) fn build_arguments(&self) -> Vec<OsString> {
        let mut arguments = Vec::new();
        if let Some(profile) = &self.profile {
            arguments.push(if profile == "release" {
                "--release".into()
            } else {
                format!("--profile={profile}").into()
            });
        }
        arguments.extend(self.metadata_arguments());
        arguments
    }
}

/// Encode graph choices identically for observations and build recipes.
pub(crate) fn graph_arguments(
    features: &CargoFeatureSelection,
    locked: bool,
    offline: bool,
) -> Vec<OsString> {
    let mut arguments = Vec::new();
    for (enabled, flag) in [(locked, "--locked"), (offline, "--offline")] {
        if enabled {
            arguments.push(flag.into());
        }
    }
    arguments.extend(features.arguments());
    arguments
}