use crate::DEFAULT_PKG_METADATA_SECTION;
use crate::cfg_eval::CfgEvaluator;
use crate::cli::{CargoSubcommand, Options, cargo_subcommand};
use crate::config::Config;
use crate::implication::PrunedCombination;
use crate::package::{FeatureCombinationError, Package};
use crate::print_warning;
use crate::target::{EffectiveTarget, TargetSource, TargetTriple};
use crate::target_plan::{PlannedPackage, TargetPlan, TargetPlans};
use color_eyre::eyre;
use itertools::Itertools;
use regex::Regex;
use std::collections::{BTreeMap, HashMap, HashSet};
use std::io::{self, Write};
use std::process;
use std::sync::LazyLock;
use std::time::{Duration, Instant};
use termcolor::{Color, ColorChoice, ColorSpec, StandardStream, WriteColor};
static CYAN: LazyLock<ColorSpec> = LazyLock::new(|| color_spec(Color::Cyan, true));
static RED: LazyLock<ColorSpec> = LazyLock::new(|| color_spec(Color::Red, true));
static YELLOW: LazyLock<ColorSpec> = LazyLock::new(|| color_spec(Color::Yellow, true));
static GREEN: LazyLock<ColorSpec> = LazyLock::new(|| color_spec(Color::Green, true));
static DIMMED: LazyLock<ColorSpec> = LazyLock::new(|| {
let mut spec = ColorSpec::new();
spec.set_dimmed(true);
spec
});
pub type ExitCode = Option<i32>;
#[must_use]
pub fn color_spec(color: Color, bold: bool) -> ColorSpec {
let mut spec = ColorSpec::new();
spec.set_fg(Some(color));
spec.set_bold(bold);
spec
}
fn force_color(cmd: &mut process::Command) {
cmd.env("CARGO_TERM_COLOR", "always");
cmd.env("FORCE_COLOR", "1");
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum SummaryTarget {
Hidden,
Single(TargetTriple),
Group(Vec<TargetTriple>),
}
impl SummaryTarget {
fn field_prefix(&self) -> String {
match self {
Self::Hidden => String::new(),
Self::Single(triple) => format!("target = {triple}, "),
Self::Group(triples) => format!("targets = [{}], ", triples.iter().join(", ")),
}
}
}
#[derive(Debug, Clone)]
pub struct Summary {
package_name: String,
target: SummaryTarget,
features: Vec<String>,
exit_code: Option<i32>,
pedantic_success: bool,
num_warnings: usize,
num_errors: usize,
num_suppressed: usize,
equivalent_to: Option<Vec<String>>,
}
impl Summary {
fn is_pruned(&self) -> bool {
self.equivalent_to.is_some()
}
}
pub fn warning_counts(output: &str) -> impl Iterator<Item = usize> + '_ {
static WARNING_REGEX: LazyLock<Regex> = LazyLock::new(|| {
#[allow(
clippy::expect_used,
reason = "hard-coded regex pattern is expected to be valid"
)]
Regex::new(r"warning: .* generated (\d+) warnings?").expect("valid warning regex")
});
WARNING_REGEX
.captures_iter(output)
.filter_map(|cap| cap.get(1))
.map(|m| m.as_str().parse::<usize>().unwrap_or(0))
}
pub fn error_counts(output: &str) -> impl Iterator<Item = usize> + '_ {
static ERROR_REGEX: LazyLock<Regex> = LazyLock::new(|| {
#[allow(
clippy::expect_used,
reason = "hard-coded regex pattern is expected to be valid"
)]
Regex::new(r"error: could not compile `[^`]*`.*due to\s*(\d*)\s*previous errors?")
.expect("valid error regex")
});
ERROR_REGEX
.captures_iter(output)
.filter_map(|cap| cap.get(1))
.map(|m| m.as_str().parse::<usize>().unwrap_or(1))
}
pub(crate) struct ProcessResult {
pub num_warnings: usize,
pub num_errors: usize,
pub num_suppressed: usize,
pub output: Vec<u8>,
}
fn capture_stderr(
child: &mut process::Child,
summary_only: bool,
stdout: &mut StandardStream,
) -> io::Result<ProcessResult> {
let output_buffer = Vec::<u8>::new();
let mut output_cursor = io::Cursor::new(output_buffer);
if let Some(proc_stderr) = child.stderr.take() {
let mut proc_reader = io::BufReader::new(proc_stderr);
if summary_only {
io::copy(&mut proc_reader, &mut output_cursor)?;
} else {
let mut tee_reader = crate::tee::Reader::new(proc_reader, stdout, true);
io::copy(&mut tee_reader, &mut output_cursor)?;
}
} else {
eprintln!("ERROR: failed to redirect stderr");
}
let stripped = strip_ansi_escapes::strip(output_cursor.get_ref());
let stripped = String::from_utf8_lossy(&stripped);
let num_warnings = warning_counts(&stripped).sum::<usize>();
let num_errors = error_counts(&stripped).sum::<usize>();
Ok(ProcessResult {
num_warnings,
num_errors,
num_suppressed: 0,
output: output_cursor.into_inner(),
})
}
pub(crate) fn print_feature_combination_error(err: &FeatureCombinationError) {
let mut stderr = StandardStream::stderr(ColorChoice::Auto);
let _ = stderr.set_color(&RED);
let _ = write!(&mut stderr, "error");
let _ = stderr.reset();
let _ = writeln!(&mut stderr, ": feature matrix generation failed");
match err {
FeatureCombinationError::TooManyConfigurations {
package,
num_features,
num_configurations,
limit,
} => {
let _ = stderr.set_color(&YELLOW);
let _ = writeln!(&mut stderr, " reason: too many configurations");
let _ = stderr.reset();
let _ = stderr.set_color(&CYAN);
let _ = write!(&mut stderr, " package:");
let _ = stderr.reset();
let _ = writeln!(&mut stderr, " {package}");
let _ = stderr.set_color(&CYAN);
let _ = write!(&mut stderr, " features considered:");
let _ = stderr.reset();
let _ = writeln!(&mut stderr, " {num_features}");
let _ = stderr.set_color(&CYAN);
let _ = write!(&mut stderr, " combinations:");
let _ = stderr.reset();
let _ = writeln!(
&mut stderr,
" {}",
num_configurations.map_or_else(|| "unbounded".to_string(), |v| v.to_string())
);
let _ = stderr.set_color(&CYAN);
let _ = write!(&mut stderr, " limit:");
let _ = stderr.reset();
let _ = writeln!(&mut stderr, " {limit}");
let _ = stderr.set_color(&GREEN);
let _ = writeln!(&mut stderr, " hint:");
let _ = stderr.reset();
let _ = writeln!(
&mut stderr,
" Consider restricting the matrix using [{DEFAULT_PKG_METADATA_SECTION}].only_features",
);
let _ = writeln!(
&mut stderr,
" or splitting features into isolated_feature_sets, or excluding features via exclude_features."
);
}
}
}
#[must_use]
pub fn print_summary(
summary: &[Summary],
show_pruned: bool,
stdout: &mut termcolor::StandardStream,
elapsed: Duration,
) -> ExitCode {
let num_packages = summary
.iter()
.map(|s| &s.package_name)
.collect::<HashSet<_>>()
.len();
let num_total = summary
.iter()
.map(|s| {
(
&s.package_name,
&s.target,
s.features.iter().collect::<Vec<_>>(),
)
})
.collect::<HashSet<_>>()
.len();
let num_pruned = summary.iter().filter(|s| s.is_pruned()).count();
let num_executed = num_total - num_pruned;
let mut target_set: HashSet<&TargetTriple> = HashSet::new();
for s in summary {
match &s.target {
SummaryTarget::Hidden => {}
SummaryTarget::Single(triple) => {
target_set.insert(triple);
}
SummaryTarget::Group(triples) => {
target_set.extend(triples.iter());
}
}
}
let num_targets = target_set.len();
let targets_clause = if num_targets > 1 {
format!(" across {num_targets} targets")
} else {
String::new()
};
println!();
stdout.set_color(&CYAN).ok();
print!(" Finished ");
stdout.reset().ok();
if num_pruned > 0 {
print!(
"{num_executed} of {num_total} feature combination{} for {num_packages} package{}{targets_clause} in {:.2}s",
if num_total > 1 { "s" } else { "" },
if num_packages > 1 { "s" } else { "" },
elapsed.as_secs_f64(),
);
stdout.set_color(&DIMMED).ok();
print!(" ({num_pruned} pruned)");
stdout.reset().ok();
} else {
print!(
"{num_total} feature combination{} for {num_packages} package{}{targets_clause} in {:.2}s",
if num_total > 1 { "s" } else { "" },
if num_packages > 1 { "s" } else { "" },
elapsed.as_secs_f64(),
);
}
println!();
println!();
let max_errors = summary.iter().map(|s| s.num_errors).max().unwrap_or(0);
let max_warnings = summary.iter().map(|s| s.num_warnings).max().unwrap_or(0);
let max_suppressed = summary.iter().map(|s| s.num_suppressed).max().unwrap_or(0);
let show_suppressed = max_suppressed > 0;
let errors_width = max_errors.to_string().len();
let warnings_width = max_warnings.to_string().len();
let suppressed_width = max_suppressed.to_string().len();
let mut first_bad_exit_code: Option<i32> = None;
for s in summary {
if !show_pruned && s.is_pruned() {
continue;
}
let fmt = SummaryFormat {
show_suppressed,
errors_width,
warnings_width,
suppressed_width,
};
print_summary_entry(s, stdout, &fmt);
if !s.pedantic_success {
let exit_code = match s.exit_code {
Some(code) if code != 0 => code,
_ => 1,
};
first_bad_exit_code = first_bad_exit_code.or(Some(exit_code));
}
}
println!();
first_bad_exit_code
}
struct SummaryFormat {
show_suppressed: bool,
errors_width: usize,
warnings_width: usize,
suppressed_width: usize,
}
fn print_summary_entry(s: &Summary, stdout: &mut termcolor::StandardStream, fmt: &SummaryFormat) {
if s.is_pruned() {
stdout.set_color(&DIMMED).ok();
print!(" SKIP ");
stdout.reset().ok();
} else if !s.pedantic_success {
stdout.set_color(&RED).ok();
print!(" FAIL ");
} else if s.num_warnings > 0 {
stdout.set_color(&YELLOW).ok();
print!(" WARN ");
} else {
stdout.set_color(&GREEN).ok();
print!(" PASS ");
}
stdout.reset().ok();
let feat = s.features.iter().join(", ");
let target = s.target.field_prefix();
let ew = fmt.errors_width;
let ww = fmt.warnings_width;
let sw = fmt.suppressed_width;
let ne = s.num_errors;
let nw = s.num_warnings;
let ns = s.num_suppressed;
if fmt.show_suppressed {
print!(
"{} ( {target}{ne:>ew$} errors, {nw:>ww$} warnings, {ns:>sw$} suppressed, features = [{feat}] )",
s.package_name,
);
} else {
print!(
"{} ( {target}{ne:>ew$} errors, {nw:>ww$} warnings, features = [{feat}] )",
s.package_name,
);
}
if let Some(equiv) = &s.equivalent_to {
let equiv = equiv.iter().join(", ");
stdout.set_color(&DIMMED).ok();
println!(" \u{2190} equivalent to [{equiv}]");
stdout.reset().ok();
} else {
println!();
}
}
#[derive(Clone, Copy)]
struct Progress {
index: usize,
total: usize,
width: usize,
}
struct Invocation<'a> {
package: &'a cargo_metadata::Package,
features: &'a [String],
inject_targets: &'a [String],
summary_target: &'a SummaryTarget,
}
struct AggregateInvocationPlan<'a> {
package: &'a cargo_metadata::Package,
combo: Vec<String>,
targets: Vec<EffectiveTarget>,
}
fn print_package_cmd(
inv: &Invocation<'_>,
cargo_args: &[&str],
all_args: &[&str],
options: &Options,
progress: Progress,
stdout: &mut StandardStream,
) {
let compact = options.summary_only || options.diagnostics_only;
if !compact {
println!();
}
let subcommand = cargo_subcommand(cargo_args);
stdout.set_color(&CYAN).ok();
match subcommand {
CargoSubcommand::Test => {
print!(" Testing ");
}
CargoSubcommand::Doc => {
print!(" Documenting ");
}
CargoSubcommand::Lint => {
print!(" Linting ");
}
CargoSubcommand::Check => {
print!(" Checking ");
}
CargoSubcommand::Run => {
print!(" Running ");
}
CargoSubcommand::Build => {
print!(" Building ");
}
CargoSubcommand::Other => {
print!(" ");
}
}
stdout.set_color(&DIMMED).ok();
print!(
"[{idx:>width$}/{total}]",
idx = progress.index,
total = progress.total,
width = progress.width,
);
if subcommand == CargoSubcommand::Other {
stdout.set_color(&CYAN).ok();
} else {
stdout.reset().ok();
}
print!(
" {} ( {}features = [{}] )",
inv.package.name,
inv.summary_target.field_prefix(),
inv.features.iter().join(", ")
);
if options.verbose {
print!(" [cargo {}]", all_args.join(" "));
}
stdout.reset().ok();
println!();
if !compact {
println!();
}
}
#[derive(Debug, Default)]
pub struct MatrixOptions {
pub pretty: bool,
pub packages_only: bool,
pub no_prune_implied: bool,
}
fn load_configs_for_packages(packages: &[&cargo_metadata::Package]) -> eyre::Result<Vec<Config>> {
packages
.iter()
.map(|package| package.config())
.collect::<eyre::Result<Vec<_>>>()
}
fn single_target_plans<'a>(
packages: &[&'a cargo_metadata::Package],
configs: &'a [Config],
target: &TargetTriple,
) -> TargetPlans<'a> {
let effective_target = EffectiveTarget {
triple: target.clone(),
source: TargetSource::Cli,
};
TargetPlans {
plans: vec![TargetPlan {
target: target.clone(),
packages: packages
.iter()
.zip(configs)
.map(|(package, config)| PlannedPackage {
package,
config,
target: effective_target.clone(),
})
.collect(),
}],
contains_configured_assignments: false,
}
}
pub fn print_feature_matrix_for_target(
packages: &[&cargo_metadata::Package],
target: &TargetTriple,
evaluator: &mut impl crate::cfg_eval::CfgEvaluator,
options: &MatrixOptions,
) -> eyre::Result<ExitCode> {
let configs = load_configs_for_packages(packages)?;
let target_plans = single_target_plans(packages, &configs, target);
let build_options = Options {
no_prune_implied: options.no_prune_implied,
..Options::default()
};
let plan_set = build_execution_plans(
&target_plans,
&build_options,
options.packages_only,
evaluator,
)?;
print_matrix_for_execution_plans(&plan_set, options)
}
pub struct ExecutionPlan<'a> {
pub target: TargetTriple,
pub package_plans: Vec<PackageExecutionPlan<'a>>,
}
pub struct PackageExecutionPlan<'a> {
pub package: &'a cargo_metadata::Package,
pub target: EffectiveTarget,
pub combinations: Vec<Vec<String>>,
pub pruned: Vec<PrunedCombination>,
pub matrix: serde_json::Map<String, serde_json::Value>,
}
pub struct ExecutionPlanSet<'a> {
pub plans: Vec<ExecutionPlan<'a>>,
pub show_pruned: bool,
pub show_target: bool,
}
pub fn build_execution_plans<'a>(
target_plans: &TargetPlans<'a>,
options: &Options,
packages_only: bool,
evaluator: &mut impl CfgEvaluator,
) -> eyre::Result<ExecutionPlanSet<'a>> {
let mut plans = Vec::with_capacity(target_plans.plans.len());
let mut config_show_pruned = false;
for target_plan in &target_plans.plans {
let mut package_plans = Vec::with_capacity(target_plan.packages.len());
for planned in &target_plan.packages {
let config = crate::config::resolve::resolve_config(
planned.config,
&target_plan.target,
evaluator,
)?;
config_show_pruned = config_show_pruned || config.show_pruned;
let (combinations, pruned) = if packages_only {
(Vec::new(), Vec::new())
} else {
let all_combos = planned.package.feature_combinations(&config)?;
let prune_result = crate::implication::maybe_prune(
all_combos,
&planned.package.features,
&config,
options.no_prune_implied,
);
let combinations: Vec<Vec<String>> = prune_result
.keep
.into_iter()
.map(|combo| combo.into_iter().cloned().collect())
.collect();
(combinations, prune_result.pruned)
};
package_plans.push(PackageExecutionPlan {
package: planned.package,
target: planned.target.clone(),
combinations,
pruned,
matrix: config.matrix,
});
}
plans.push(ExecutionPlan {
target: target_plan.target.clone(),
package_plans,
});
}
let show_pruned = options.show_pruned || config_show_pruned;
let show_target = target_plans.contains_configured_assignments || plans.len() > 1;
Ok(ExecutionPlanSet {
plans,
show_pruned,
show_target,
})
}
#[must_use]
pub fn build_matrix_rows(
plan_set: &ExecutionPlanSet,
packages_only: bool,
) -> Vec<serde_json::Value> {
let mut rows = Vec::new();
for plan in &plan_set.plans {
for pp in &plan.package_plans {
let name = pp.package.name.to_string();
let features_list: Vec<String> = if packages_only {
vec!["default".to_string()]
} else {
pp.combinations
.iter()
.map(|combo| combo.iter().join(","))
.collect()
};
for ft in features_list {
let mut row = serde_json::Map::new();
row.insert("features".to_string(), serde_json::json!(ft));
row.insert("metadata".to_string(), sorted_json_object(&pp.matrix));
row.insert("name".to_string(), serde_json::json!(name.as_str()));
row.insert(
"target".to_string(),
serde_json::json!(pp.target.triple.as_str()),
);
rows.push(serde_json::Value::Object(row));
}
}
}
rows
}
fn sorted_json_object(object: &serde_json::Map<String, serde_json::Value>) -> serde_json::Value {
let mut entries: Vec<_> = object.iter().collect();
entries.sort_by_key(|(key, _)| *key);
let mut out = serde_json::Map::new();
for (key, value) in entries {
out.insert(key.clone(), sorted_json_value(value));
}
serde_json::Value::Object(out)
}
fn sorted_json_value(value: &serde_json::Value) -> serde_json::Value {
match value {
serde_json::Value::Array(values) => {
serde_json::Value::Array(values.iter().map(sorted_json_value).collect())
}
serde_json::Value::Object(object) => sorted_json_object(object),
_ => value.clone(),
}
}
pub fn print_matrix_for_execution_plans(
plan_set: &ExecutionPlanSet,
options: &MatrixOptions,
) -> eyre::Result<ExitCode> {
let rows = build_matrix_rows(plan_set, options.packages_only);
let matrix = if options.pretty {
serde_json::to_string_pretty(&rows)
} else {
serde_json::to_string(&rows)
}?;
println!("{matrix}");
Ok(None)
}
struct RunContext<'a> {
cargo_args: &'a [&'a str],
extra_args: &'a [&'a str],
missing_arguments: bool,
use_diagnostics_only: bool,
options: &'a Options,
}
struct CombinationResult {
summary: Summary,
colored_output: Vec<u8>,
}
struct FeatureSelectionNormalization<'a> {
subcommand: CargoSubcommand,
cargo_args: Vec<&'a str>,
removed_args: Vec<&'a str>,
has_feature_selection_args: bool,
}
fn normalize_feature_selection_args(cargo_args: Vec<&str>) -> FeatureSelectionNormalization<'_> {
fn feature_selection_span_length_at(args: &[&str], index: usize) -> Option<usize> {
let arg = *args.get(index)?;
match arg {
"--all-features" | "--no-default-features" => Some(1),
"--features" | "-F" => {
let has_value = args
.get(index + 1)
.is_some_and(|next_arg| !next_arg.starts_with('-'));
Some(if has_value { 2 } else { 1 })
}
_ if arg.starts_with("--features=") || (arg.starts_with("-F") && arg.len() > 2) => {
Some(1)
}
_ => None,
}
}
let subcommand = cargo_subcommand(&cargo_args);
if subcommand == CargoSubcommand::Other {
let has_feature_selection_args = cargo_args.iter().enumerate().any(|(index, _arg)| {
feature_selection_span_length_at(cargo_args.as_slice(), index).is_some()
});
return FeatureSelectionNormalization {
subcommand,
cargo_args,
removed_args: Vec::new(),
has_feature_selection_args,
};
}
let mut forwarded_args = Vec::with_capacity(cargo_args.len());
let mut removed_args = Vec::new();
let mut index = 0;
while let Some(arg) = cargo_args.get(index).copied() {
if let Some(span_len) = feature_selection_span_length_at(cargo_args.as_slice(), index) {
if let Some(span_args) = cargo_args.get(index..index + span_len) {
removed_args.extend(span_args.iter().copied());
debug_assert!(span_len > 0);
index += span_len;
} else {
forwarded_args.push(arg);
index += 1;
}
} else {
forwarded_args.push(arg);
index += 1;
}
}
let has_feature_selection_args = !removed_args.is_empty();
FeatureSelectionNormalization {
subcommand,
cargo_args: forwarded_args,
removed_args,
has_feature_selection_args,
}
}
fn run_single_combination(
inv: &Invocation<'_>,
ctx: &RunContext<'_>,
progress: Progress,
seen_diagnostics: &mut HashSet<String>,
stdout: &mut StandardStream,
) -> eyre::Result<CombinationResult> {
let package = inv.package;
let features = inv.features;
let Some(working_dir) = package.manifest_path.parent() else {
eyre::bail!(
"could not find parent dir of package {}",
package.manifest_path.to_string()
)
};
let cargo = std::env::var_os("CARGO").unwrap_or_else(|| "cargo".into());
let mut cmd = process::Command::new(&cargo);
force_color(&mut cmd);
if ctx.options.errors_only {
cmd.env(
"RUSTFLAGS",
format!(
"-Awarnings {}", std::env::var("RUSTFLAGS").unwrap_or_default()
),
);
}
let mut args = ctx.cargo_args.to_vec();
if ctx.use_diagnostics_only {
args.push(crate::diagnostics_only::MESSAGE_FORMAT);
}
for triple in inv.inject_targets {
args.push("--target");
args.push(triple.as_str());
}
let features_flag = format!("--features={}", features.iter().join(","));
if !ctx.missing_arguments {
args.push("--no-default-features");
args.push(&features_flag);
}
args.extend_from_slice(ctx.extra_args);
print_package_cmd(inv, ctx.cargo_args, &args, ctx.options, progress, stdout);
cmd.args(&args).current_dir(working_dir);
if ctx.use_diagnostics_only {
cmd.stdout(process::Stdio::piped());
}
cmd.stderr(process::Stdio::piped());
let mut child = cmd.spawn()?;
let mut result = if ctx.use_diagnostics_only {
crate::diagnostics_only::process_output(
&mut child,
ctx.options.summary_only,
ctx.options.dedupe,
seen_diagnostics,
stdout,
)?
} else {
capture_stderr(&mut child, ctx.options.summary_only, stdout)?
};
let exit_status = child.wait()?;
if result.num_suppressed > 0 && !ctx.options.summary_only {
stdout.set_color(&CYAN).ok();
print!(" Note ");
stdout.reset().ok();
println!(
"{} duplicate diagnostic{} suppressed",
result.num_suppressed,
if result.num_suppressed > 1 { "s" } else { "" },
);
}
let fail = !exit_status.success();
if ctx.use_diagnostics_only && fail && result.num_errors == 0 && !result.output.is_empty() {
stdout.write_all(&result.output)?;
stdout.flush().ok();
result.output.clear();
}
let pedantic_fail = ctx.options.pedantic && (result.num_errors > 0 || result.num_warnings > 0);
let summary = Summary {
features: features.to_vec(),
target: inv.summary_target.clone(),
num_errors: result.num_errors,
num_warnings: result.num_warnings,
num_suppressed: result.num_suppressed,
package_name: package.name.to_string(),
exit_code: exit_status.code(),
pedantic_success: !(fail || pedantic_fail),
equivalent_to: None,
};
Ok(CombinationResult {
summary,
colored_output: result.output,
})
}
pub fn run_cargo_command_for_target(
packages: &[&cargo_metadata::Package],
cargo_args: Vec<&str>,
options: &Options,
target: &TargetTriple,
evaluator: &mut impl CfgEvaluator,
) -> eyre::Result<ExitCode> {
let configs = load_configs_for_packages(packages)?;
let target_plans = single_target_plans(packages, &configs, target);
let plan_set = build_execution_plans(&target_plans, options, false, evaluator)?;
run_execution_plans(
&plan_set,
cargo_args,
options,
TargetExecutionMode::SerialPerTarget,
)
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TargetExecutionMode {
SerialPerTarget,
Aggregate,
}
pub fn run_execution_plans(
plan_set: &ExecutionPlanSet,
mut cargo_args: Vec<&str>,
options: &Options,
mode: TargetExecutionMode,
) -> eyre::Result<ExitCode> {
let start = Instant::now();
let extra_args_idx = cargo_args
.iter()
.position(|arg| *arg == "--")
.unwrap_or(cargo_args.len());
let extra_args = cargo_args.split_off(extra_args_idx);
let FeatureSelectionNormalization {
subcommand,
cargo_args,
removed_args,
has_feature_selection_args,
} = normalize_feature_selection_args(cargo_args);
if !removed_args.is_empty() {
let flag_label = if removed_args.len() == 1 {
"flag"
} else {
"flags"
};
print_warning!(
"ignoring cargo feature-selection {flag_label} incompatible with feature matrix: {}",
removed_args.iter().join(" ")
);
} else if subcommand == CargoSubcommand::Other && has_feature_selection_args {
print_warning!(
"leaving cargo feature-selection flags unchanged for unknown cargo alias/subcommand"
);
}
let missing_arguments = cargo_args.is_empty() && extra_args.is_empty();
let user_has_message_format = cargo_args.iter().any(|a| a.starts_with("--message-format"));
let use_diagnostics_only = options.diagnostics_only && !user_has_message_format;
if options.diagnostics_only && user_has_message_format {
print_warning!("--diagnostics-only is ignored when --message-format is already specified");
}
let ctx = RunContext {
cargo_args: &cargo_args,
extra_args: &extra_args,
missing_arguments,
use_diagnostics_only,
options,
};
let mut stdout = StandardStream::stdout(ColorChoice::Auto);
let mut seen_diagnostics: HashSet<String> = HashSet::new();
match mode {
TargetExecutionMode::SerialPerTarget => {
execute_serial(plan_set, &ctx, &mut seen_diagnostics, &mut stdout, start)
}
TargetExecutionMode::Aggregate => {
execute_aggregate(plan_set, &ctx, &mut seen_diagnostics, &mut stdout, start)
}
}
}
fn execute_serial(
plan_set: &ExecutionPlanSet,
ctx: &RunContext<'_>,
seen_diagnostics: &mut HashSet<String>,
stdout: &mut StandardStream,
start: Instant,
) -> eyre::Result<ExitCode> {
let mut summary: Vec<Summary> = Vec::new();
let total: usize = plan_set
.plans
.iter()
.flat_map(|plan| plan.package_plans.iter())
.map(|pp| pp.combinations.len())
.sum();
let width = total.to_string().len();
let mut index = 0;
for plan in &plan_set.plans {
for pp in &plan.package_plans {
let summary_target = if plan_set.show_target {
SummaryTarget::Single(plan.target.clone())
} else {
SummaryTarget::Hidden
};
let inject: Vec<String> = if pp.target.source.should_inject_target_arg() {
vec![pp.target.triple.0.clone()]
} else {
Vec::new()
};
let pkg_start = summary.len();
for combo in &pp.combinations {
index += 1;
let result = run_single_combination(
&Invocation {
package: pp.package,
features: combo,
inject_targets: &inject,
summary_target: &summary_target,
},
ctx,
Progress {
index,
total,
width,
},
seen_diagnostics,
stdout,
)?;
if let Some(code) = record_result_and_maybe_stop(
&mut summary,
result,
plan_set.show_pruned,
ctx,
stdout,
start,
)? {
return Ok(Some(code));
}
}
append_pruned_summaries(
&mut summary,
pkg_start,
pp.package.name.as_ref(),
&summary_target,
pp.pruned.clone(),
);
}
}
Ok(print_summary(
&summary,
plan_set.show_pruned,
stdout,
start.elapsed(),
))
}
fn execute_aggregate(
plan_set: &ExecutionPlanSet,
ctx: &RunContext<'_>,
seen_diagnostics: &mut HashSet<String>,
stdout: &mut StandardStream,
start: Instant,
) -> eyre::Result<ExitCode> {
let invocations = aggregate_invocation_plans(plan_set);
let total = invocations.len();
let width = total.to_string().len();
let mut summary: Vec<Summary> = Vec::new();
for (zero_index, inv_plan) in invocations.iter().enumerate() {
let index = zero_index + 1;
let triples: Vec<TargetTriple> =
inv_plan.targets.iter().map(|t| t.triple.clone()).collect();
let summary_target = match triples.as_slice() {
[single] => SummaryTarget::Single(single.clone()),
_ => SummaryTarget::Group(triples.clone()),
};
let inject: Vec<String> = inv_plan
.targets
.iter()
.filter(|t| t.source.should_inject_target_arg())
.map(|t| t.triple.0.clone())
.collect();
let result = run_single_combination(
&Invocation {
package: inv_plan.package,
features: &inv_plan.combo,
inject_targets: &inject,
summary_target: &summary_target,
},
ctx,
Progress {
index,
total,
width,
},
seen_diagnostics,
stdout,
)?;
if let Some(code) = record_result_and_maybe_stop(
&mut summary,
result,
plan_set.show_pruned,
ctx,
stdout,
start,
)? {
return Ok(Some(code));
}
}
Ok(print_summary(
&summary,
plan_set.show_pruned,
stdout,
start.elapsed(),
))
}
fn record_result_and_maybe_stop(
summary: &mut Vec<Summary>,
result: CombinationResult,
show_pruned: bool,
ctx: &RunContext<'_>,
stdout: &mut StandardStream,
start: Instant,
) -> eyre::Result<ExitCode> {
let CombinationResult {
summary: result_summary,
colored_output,
} = result;
let should_stop = ctx.options.fail_fast && !result_summary.pedantic_success;
let exit_code = result_summary.exit_code;
summary.push(result_summary);
if !should_stop {
return Ok(None);
}
if ctx.options.summary_only {
io::copy(&mut io::Cursor::new(colored_output), stdout)?;
stdout.flush().ok();
}
Ok(Some(
print_summary(summary, show_pruned, stdout, start.elapsed())
.or(exit_code)
.unwrap_or(1),
))
}
fn aggregate_invocation_plans<'a>(
plan_set: &'a ExecutionPlanSet<'a>,
) -> Vec<AggregateInvocationPlan<'a>> {
let mut package_order: Vec<&cargo_metadata::Package> = Vec::new();
let mut seen_packages: HashSet<String> = HashSet::new();
let mut grouped: HashMap<String, BTreeMap<Vec<String>, Vec<EffectiveTarget>>> = HashMap::new();
for plan in &plan_set.plans {
for pp in &plan.package_plans {
let id = pp.package.id.repr.clone();
if seen_packages.insert(id.clone()) {
package_order.push(pp.package);
}
let entry = grouped.entry(id).or_default();
for combo in &pp.combinations {
entry
.entry(combo.clone())
.or_default()
.push(pp.target.clone());
}
}
}
let mut invocations = Vec::new();
for package in package_order {
let Some(combos) = grouped.remove(&package.id.repr) else {
continue;
};
for (combo, targets) in combos {
invocations.push(AggregateInvocationPlan {
package,
combo,
targets,
});
}
}
invocations
}
fn append_pruned_summaries(
summary: &mut Vec<Summary>,
pkg_start: usize,
package_name: &str,
summary_target: &SummaryTarget,
pruned: Vec<PrunedCombination>,
) {
let executed: HashMap<Vec<String>, Summary> = summary
.get(pkg_start..)
.unwrap_or_default()
.iter()
.filter(|s| !s.is_pruned())
.map(|s| (s.features.clone(), s.clone()))
.collect();
for p in pruned {
let Some(equiv) = executed.get(&p.equivalent_to) else {
continue;
};
summary.push(Summary {
package_name: package_name.to_string(),
target: summary_target.clone(),
features: p.features,
equivalent_to: Some(p.equivalent_to),
num_errors: equiv.num_errors,
num_warnings: equiv.num_warnings,
num_suppressed: equiv.num_suppressed,
exit_code: None,
pedantic_success: true,
});
}
if let Some(slice) = summary.get_mut(pkg_start..) {
slice.sort_by(|a, b| a.features.cmp(&b.features));
}
}
#[cfg(test)]
mod test {
use super::{
ExecutionPlan, ExecutionPlanSet, PackageExecutionPlan, Summary, SummaryTarget,
aggregate_invocation_plans, build_execution_plans, error_counts,
normalize_feature_selection_args, print_summary, warning_counts,
};
use crate::cfg_eval::CfgEvaluator;
use crate::cli::{CargoSubcommand, Options};
use crate::package::Package as _;
use crate::target::{EffectiveTarget, TargetSource, TargetTriple};
use crate::target_plan::{PlannedPackage, TargetPlan, TargetPlans};
use color_eyre::eyre;
use similar_asserts::assert_eq as sim_assert_eq;
#[derive(Default)]
struct StubEval;
impl CfgEvaluator for StubEval {
fn matches(&mut self, _cfg_expr: &str, _target: &TargetTriple) -> eyre::Result<bool> {
Ok(false)
}
}
fn string_vec(values: &[&str]) -> Vec<String> {
values.iter().copied().map(String::from).collect()
}
fn package(name: &str) -> eyre::Result<cargo_metadata::Package> {
use cargo_metadata::{PackageBuilder, PackageId, PackageName};
use semver::Version;
use std::str::FromStr as _;
Ok(PackageBuilder::new(
PackageName::from_str(name)?,
Version::parse("0.1.0")?,
PackageId {
repr: name.to_string(),
},
"",
)
.build()?)
}
fn effective_target(triple: &str) -> EffectiveTarget {
EffectiveTarget {
triple: TargetTriple(triple.to_string()),
source: TargetSource::WorkspaceConfig,
}
}
fn summary_with_failure(exit_code: Option<i32>, pedantic_success: bool) -> Summary {
Summary {
package_name: "pkg".to_string(),
target: SummaryTarget::Hidden,
features: Vec::new(),
exit_code,
pedantic_success,
num_warnings: usize::from(!pedantic_success),
num_errors: 0,
num_suppressed: 0,
equivalent_to: None,
}
}
#[test]
fn summary_target_field_prefix() {
sim_assert_eq!(SummaryTarget::Hidden.field_prefix(), "");
sim_assert_eq!(
SummaryTarget::Single(TargetTriple("t-a".to_string())).field_prefix(),
"target = t-a, "
);
sim_assert_eq!(
SummaryTarget::Group(vec![
TargetTriple("t-a".to_string()),
TargetTriple("t-b".to_string()),
])
.field_prefix(),
"targets = [t-a, t-b], "
);
}
#[test]
fn print_summary_returns_one_for_pedantic_warning_exit_zero() {
let summary = vec![summary_with_failure(Some(0), false)];
let mut stdout = termcolor::StandardStream::stdout(termcolor::ColorChoice::Never);
let exit = print_summary(&summary, false, &mut stdout, std::time::Duration::ZERO);
sim_assert_eq!(exit, Some(1));
}
#[test]
fn print_summary_returns_one_for_failure_without_exit_code() {
let summary = vec![summary_with_failure(None, false)];
let mut stdout = termcolor::StandardStream::stdout(termcolor::ColorChoice::Never);
let exit = print_summary(&summary, false, &mut stdout, std::time::Duration::ZERO);
sim_assert_eq!(exit, Some(1));
}
#[test]
fn print_summary_preserves_nonzero_failure_exit_code() {
let summary = vec![summary_with_failure(Some(101), false)];
let mut stdout = termcolor::StandardStream::stdout(termcolor::ColorChoice::Never);
let exit = print_summary(&summary, false, &mut stdout, std::time::Duration::ZERO);
sim_assert_eq!(exit, Some(101));
}
#[test]
fn aggregate_invocation_plans_group_by_package_combo_and_target_order() -> eyre::Result<()> {
let package_a = package("a")?;
let package_b = package("b")?;
let plan_set = ExecutionPlanSet {
plans: vec![
ExecutionPlan {
target: TargetTriple("t1".to_string()),
package_plans: vec![
PackageExecutionPlan {
package: &package_a,
target: effective_target("t1"),
combinations: vec![string_vec(&["b"]), string_vec(&[])],
pruned: Vec::new(),
matrix: serde_json::Map::new(),
},
PackageExecutionPlan {
package: &package_b,
target: effective_target("t1"),
combinations: vec![string_vec(&["z"])],
pruned: Vec::new(),
matrix: serde_json::Map::new(),
},
],
},
ExecutionPlan {
target: TargetTriple("t2".to_string()),
package_plans: vec![
PackageExecutionPlan {
package: &package_a,
target: effective_target("t2"),
combinations: vec![string_vec(&[]), string_vec(&["a"])],
pruned: Vec::new(),
matrix: serde_json::Map::new(),
},
PackageExecutionPlan {
package: &package_b,
target: effective_target("t2"),
combinations: vec![string_vec(&["z"])],
pruned: Vec::new(),
matrix: serde_json::Map::new(),
},
],
},
],
show_pruned: false,
show_target: true,
};
let simplified: Vec<_> = aggregate_invocation_plans(&plan_set)
.into_iter()
.map(|inv| {
(
inv.package.name.to_string(),
inv.combo,
inv.targets
.into_iter()
.map(|target| target.triple.0)
.collect::<Vec<_>>(),
)
})
.collect();
sim_assert_eq!(
simplified,
vec![
(
"a".to_string(),
string_vec(&[]),
vec!["t1".to_string(), "t2".to_string()]
),
("a".to_string(), string_vec(&["a"]), vec!["t2".to_string()]),
("a".to_string(), string_vec(&["b"]), vec!["t1".to_string()]),
(
"b".to_string(),
string_vec(&["z"]),
vec!["t1".to_string(), "t2".to_string()]
),
],
);
Ok(())
}
#[test]
fn error_regex_single_mod_multiple_errors() {
let stderr = include_str!("../test-data/single_mod_multiple_errors_stderr.txt");
let errors: Vec<_> = error_counts(stderr).collect();
sim_assert_eq!(&errors, &vec![2]);
}
#[test]
fn error_regex_with_target_kind() {
let stderr =
"error: could not compile `docparser-paddleocr-vl` (lib) due to 24 previous errors";
let errors: Vec<_> = error_counts(stderr).collect();
sim_assert_eq!(&errors, &vec![24]);
}
#[test]
fn error_regex_with_target_kind_bin() {
let stderr =
"error: could not compile `my-crate` (bin \"my-crate\") due to 3 previous errors";
let errors: Vec<_> = error_counts(stderr).collect();
sim_assert_eq!(&errors, &vec![3]);
}
#[test]
fn warning_regex_two_mod_multiple_warnings() {
let stderr = include_str!("../test-data/two_mods_warnings_stderr.txt");
let warnings: Vec<_> = warning_counts(stderr).collect();
sim_assert_eq!(&warnings, &vec![6, 7]);
}
#[test]
fn build_execution_plans_keeps_pruned_entries_for_summary() -> eyre::Result<()> {
let mut package = crate::package::test::package_with_metadata(
&["A", "B", "C"],
"cargo-fc",
&serde_json::json!({ "show_pruned": true }),
)?;
let Some(implied_features) = package.features.get_mut("B") else {
eyre::bail!("test package should contain feature B");
};
implied_features.push("A".to_string());
let config = package.config()?;
let target_plans = TargetPlans {
plans: vec![TargetPlan {
target: TargetTriple("test-target".to_string()),
packages: vec![PlannedPackage {
package: &package,
config: &config,
target: EffectiveTarget {
triple: TargetTriple("test-target".to_string()),
source: TargetSource::Cli,
},
}],
}],
contains_configured_assignments: false,
};
let mut evaluator = StubEval;
let plan_set =
build_execution_plans(&target_plans, &Options::default(), false, &mut evaluator)?;
assert!(plan_set.show_pruned);
let [plan] = plan_set.plans.as_slice() else {
eyre::bail!("expected one execution plan, got {}", plan_set.plans.len());
};
let [pp] = plan.package_plans.as_slice() else {
eyre::bail!(
"expected one package execution plan, got {}",
plan.package_plans.len()
);
};
sim_assert_eq!(
&pp.combinations,
&vec![
string_vec(&[]),
string_vec(&["A"]),
string_vec(&["A", "C"]),
string_vec(&["B"]),
string_vec(&["B", "C"]),
string_vec(&["C"]),
],
);
let pruned: Vec<_> = pp
.pruned
.iter()
.map(|p| (p.features.clone(), p.equivalent_to.clone()))
.collect();
sim_assert_eq!(
pruned,
vec![
(string_vec(&["A", "B"]), string_vec(&["B"])),
(string_vec(&["A", "B", "C"]), string_vec(&["B", "C"])),
],
);
Ok(())
}
#[test]
fn strips_feature_selection_flags_for_known_cargo_commands() {
let normalization = normalize_feature_selection_args(vec![
"--config",
"net.retry=2",
"clippy",
"-vv",
"--all-features",
"--features",
"foo,bar",
"--no-default-features",
"--color=always",
]);
sim_assert_eq!(normalization.subcommand, CargoSubcommand::Lint);
sim_assert_eq!(
normalization.cargo_args,
vec!["--config", "net.retry=2", "clippy", "-vv", "--color=always"]
);
sim_assert_eq!(
normalization.removed_args,
vec![
"--all-features",
"--features",
"foo,bar",
"--no-default-features",
]
);
assert!(normalization.has_feature_selection_args);
}
#[test]
fn preserves_known_cargo_command_args_when_no_feature_selection_is_present() {
let normalization = normalize_feature_selection_args(vec![
"--config",
"net.retry=2",
"clippy",
"--color=always",
]);
sim_assert_eq!(normalization.subcommand, CargoSubcommand::Lint);
sim_assert_eq!(
normalization.cargo_args,
vec!["--config", "net.retry=2", "clippy", "--color=always"]
);
sim_assert_eq!(normalization.removed_args, Vec::<&str>::new());
assert!(!normalization.has_feature_selection_args);
}
#[test]
fn preserves_feature_selection_flags_for_unknown_aliases() {
let normalization = normalize_feature_selection_args(vec!["lint", "--all-features"]);
sim_assert_eq!(normalization.subcommand, CargoSubcommand::Other);
sim_assert_eq!(normalization.cargo_args, vec!["lint", "--all-features"]);
sim_assert_eq!(normalization.removed_args, Vec::<&str>::new());
assert!(normalization.has_feature_selection_args);
}
}