cli_xtask/
cargo.rs

1//! Utilities for Cargo command execution.
2
3use std::{
4    io::BufReader,
5    iter,
6    process::{Command, Stdio},
7};
8
9use cargo_metadata::{
10    camino::Utf8PathBuf, Artifact, Message, Metadata, MetadataCommand, Package, Target, TargetKind,
11};
12use eyre::{bail, ensure, eyre};
13
14use crate::{Error, Result};
15
16/// Executes a `cargo build` command and returns paths to the build artifacts.
17///
18/// # Examples
19///
20/// ```no_run
21/// # fn main() -> cli_xtask::Result<()> {
22/// // executes cargo build
23/// let workspace = cli_xtask::workspace::current();
24/// for bin in cli_xtask::cargo::build(workspace, None, None, None, None, false, None)? {
25///     let bin = bin?;
26///     println!("{bin}");
27/// }
28///
29/// // executes cross build --profile target --bin foo --target aarch64-unknown-linux-gnu
30/// let workspace = cli_xtask::workspace::current();
31/// let package = workspace.root_package().unwrap();
32/// let target = package.targets.iter().find(|t| t.name == "foo").unwrap();
33/// for bin in cli_xtask::cargo::build(
34///     workspace,
35///     Some(&package),
36///     Some(target),
37///     Some("release"),
38///     vec!["--features", "feature-a"],
39///     true,
40///     Some("aarch64-unknown-linux-gnu"),
41/// )? {
42///     let bin = bin?;
43///     println!("{bin}");
44/// }
45/// # Ok(())
46/// # }
47/// ```
48#[tracing::instrument(name = "cargo::build", skip_all, err)]
49pub fn build<'a>(
50    metadata: &'a Metadata,
51    package: Option<&'a Package>,
52    target: Option<&'a Target>,
53    profile: Option<&'a str>,
54    build_options: impl IntoIterator<Item = &'a str>,
55    use_cross: bool,
56    target_triple: Option<&'a str>,
57) -> Result<impl Iterator<Item = Result<Utf8PathBuf>> + 'a> {
58    let cmd_name = if use_cross { "cross" } else { "cargo" };
59    let mut args = vec!["build"];
60
61    if let Some(package) = package {
62        args.extend(["--package", package.name.as_str()]);
63    }
64
65    if let Some(target) = target {
66        for kind in &target.kind {
67            match kind {
68                TargetKind::Bin => args.extend(["--bin", target.name.as_str()]),
69                TargetKind::Example => args.extend(["--example", target.name.as_str()]),
70                TargetKind::Test => args.extend(["--test", target.name.as_str()]),
71                TargetKind::Bench => args.extend(["--bench", target.name.as_str()]),
72                TargetKind::Lib => args.extend(["--lib"]),
73                _ => bail!("unsupported target kind: {}", kind),
74            }
75        }
76    }
77
78    if let Some(profile) = profile {
79        args.extend(["--profile", profile]);
80    }
81
82    if let Some(target_triple) = target_triple {
83        args.extend(["--target", target_triple]);
84    }
85
86    args.extend(build_options);
87
88    let cross_target_dir = if use_cross {
89        let mut cmd = MetadataCommand::new();
90        cmd.cargo_path("cross").no_deps();
91        if let Some(target_triple) = target_triple {
92            cmd.other_options(["--target".to_string(), target_triple.to_string()]);
93        }
94        Some(cmd.exec()?.target_directory)
95    } else {
96        None
97    };
98
99    tracing::info!("{} {}", cmd_name, args.join(" "));
100    args.push("--message-format=json-render-diagnostics");
101
102    let mut cmd = Command::new(cmd_name);
103    cmd.args(&args);
104
105    let mut cmd = cmd.stdout(Stdio::piped()).spawn()?;
106    let stdout = cmd.stdout.take().unwrap();
107
108    let reader = BufReader::new(stdout);
109    let it = Message::parse_stream(reader)
110        .map(|res| res.map_err(Error::from))
111        .filter_map(|res| match res {
112            Ok(Message::CompilerArtifact(Artifact { executable, .. })) => executable.map(Ok),
113            Err(e) => Some(Err(e)),
114            _ => None,
115        })
116        .map(move |res| {
117            res.and_then(|mut exe| {
118                if let Some(target_dir) = &cross_target_dir {
119                    let relative = exe.strip_prefix(target_dir)?;
120                    exe = metadata.target_directory.join(relative);
121                }
122                ensure!(exe.is_file(), "Artifact is not a file: {exe}");
123                Ok(exe)
124            })
125        })
126        .chain(
127            iter::once_with(move || cmd.wait()).filter_map(|res| match res {
128                Ok(status) if status.success() => None,
129                Ok(status) => Some(Err(eyre!("cargo build failed: {status}"))),
130                Err(e) => Some(Err(e.into())),
131            }),
132        );
133    Ok(it)
134}
cli_xtask/cargo.rs

cli_xtask/
cargo.rs
