From fa92d8abe7810c8a32a37be49f162b795c226f4d Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 00:09:50 +0200 Subject: Add some QoL to run_command --- xtask/src/command.rs | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 6e91a52..8a2e99b 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -1,7 +1,10 @@ use crate::{debug, ExtraArguments, Package, RunResult, TestRunError}; use core::fmt; -use os_pipe::pipe; -use std::{fs::File, io::Read, process::Command}; +use std::{ + fs::File, + io::Read, + process::{Command, Stdio}, +}; #[allow(dead_code)] #[derive(Debug, Clone, Copy, PartialEq)] @@ -412,26 +415,26 @@ impl fmt::Display for BuildMode { } pub fn run_command(command: &CargoCommand) -> anyhow::Result { - let (mut reader, writer) = pipe()?; - let (mut error_reader, error_writer) = pipe()?; - debug!("👟 {} {}", command.executable(), command.args().join(" ")); + let command_display = command.executable(); + let args = command.args(); - let mut handle = Command::new(command.executable()) - .args(command.args()) - .stdout(writer) - .stderr(error_writer) - .spawn()?; + let full_command = format!("\"{command_display}\" {}", args.join(" ")); + + debug!("👟 {full_command}"); - // retrieve output and clean up - let mut stdout = String::new(); - reader.read_to_string(&mut stdout)?; - let exit_status = handle.wait()?; + let result = Command::new(command.executable()) + .args(command.args()) + .stdout(Stdio::piped()) + .stderr(Stdio::piped()) + .output()?; - let mut stderr = String::new(); - error_reader.read_to_string(&mut stderr)?; + let exit_status = result.status; + let stderr = String::from_utf8(result.stderr).unwrap_or("Not displayable".into()); + let stdout = String::from_utf8(result.stdout).unwrap_or("Not displayable".into()); Ok(RunResult { exit_status, + full_command, stdout, stderr, }) -- cgit v1.2.3 From 18522122f1238d7200a9c4bcc696e707385bcbb1 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 00:26:16 +0200 Subject: xtask: forward globals through the chain and add stderr-inheritance flag --- xtask/src/command.rs | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 8a2e99b..9fa5378 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -13,6 +13,21 @@ pub enum BuildMode { Debug, } +#[derive(Debug, Clone, Copy, PartialEq)] +pub enum OutputMode { + PipedAndCollected, + Inherited, +} + +impl From for Stdio { + fn from(value: OutputMode) -> Self { + match value { + OutputMode::PipedAndCollected => Stdio::piped(), + OutputMode::Inherited => Stdio::inherit(), + } + } +} + #[derive(Debug)] pub enum CargoCommand<'a> { // For future embedded-ci @@ -414,7 +429,7 @@ impl fmt::Display for BuildMode { } } -pub fn run_command(command: &CargoCommand) -> anyhow::Result { +pub fn run_command(command: &CargoCommand, stderr_mode: OutputMode) -> anyhow::Result { let command_display = command.executable(); let args = command.args(); @@ -425,7 +440,7 @@ pub fn run_command(command: &CargoCommand) -> anyhow::Result { let result = Command::new(command.executable()) .args(command.args()) .stdout(Stdio::piped()) - .stderr(Stdio::piped()) + .stderr(stderr_mode) .output()?; let exit_status = result.status; -- cgit v1.2.3 From 4adae80f2d575b631b0bc1aef4b7272e62acedb6 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 00:50:46 +0200 Subject: xtask: don't add default arguments if building for a no_std target --- xtask/src/command.rs | 60 +++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 45 insertions(+), 15 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 9fa5378..32ca9c8 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -1,4 +1,4 @@ -use crate::{debug, ExtraArguments, Package, RunResult, TestRunError}; +use crate::{debug, ExtraArguments, Package, RunResult, Target, TestRunError}; use core::fmt; use std::{ fs::File, @@ -35,49 +35,49 @@ pub enum CargoCommand<'a> { Run { cargoarg: &'a Option<&'a str>, example: &'a str, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, }, Qemu { cargoarg: &'a Option<&'a str>, example: &'a str, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, }, ExampleBuild { cargoarg: &'a Option<&'a str>, example: &'a str, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, }, ExampleCheck { cargoarg: &'a Option<&'a str>, example: &'a str, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, }, Build { cargoarg: &'a Option<&'a str>, package: Option, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, }, Check { cargoarg: &'a Option<&'a str>, package: Option, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, }, Clippy { cargoarg: &'a Option<&'a str>, package: Option, - target: &'a str, + target: Target<'a>, features: Option, }, Format { @@ -101,7 +101,7 @@ pub enum CargoCommand<'a> { ExampleSize { cargoarg: &'a Option<&'a str>, example: &'a str, - target: &'a str, + target: Target<'a>, features: Option, mode: BuildMode, arguments: Option, @@ -153,7 +153,13 @@ impl<'a> CargoCommand<'a> { if let Some(cargoarg) = cargoarg { args.extend_from_slice(&[cargoarg]); } - args.extend_from_slice(&[self.command(), "--example", example, "--target", target]); + args.extend_from_slice(&[ + self.command(), + "--example", + example, + "--target", + target.triple(), + ]); if let Some(feature) = features { args.extend_from_slice(&["--features", feature]); @@ -174,7 +180,13 @@ impl<'a> CargoCommand<'a> { if let Some(cargoarg) = cargoarg { args.extend_from_slice(&[cargoarg]); } - args.extend_from_slice(&[self.command(), "--example", example, "--target", target]); + args.extend_from_slice(&[ + self.command(), + "--example", + example, + "--target", + target.triple(), + ]); if let Some(feature) = features { args.extend_from_slice(&["--features", feature]); @@ -196,7 +208,7 @@ impl<'a> CargoCommand<'a> { args.extend_from_slice(&[cargoarg]); } - args.extend_from_slice(&[self.command(), "--target", target]); + args.extend_from_slice(&[self.command(), "--target", target.triple()]); if let Some(package) = package { args.extend_from_slice(&["--package", package.name()]); @@ -344,7 +356,13 @@ impl<'a> CargoCommand<'a> { if let Some(cargoarg) = cargoarg { args.extend_from_slice(&[cargoarg]); } - args.extend_from_slice(&[self.command(), "--example", example, "--target", target]); + args.extend_from_slice(&[ + self.command(), + "--example", + example, + "--target", + target.triple(), + ]); if let Some(feature) = features { args.extend_from_slice(&["--features", feature]); @@ -365,7 +383,13 @@ impl<'a> CargoCommand<'a> { if let Some(cargoarg) = cargoarg { args.extend_from_slice(&[cargoarg]); } - args.extend_from_slice(&[self.command(), "--example", example, "--target", target]); + args.extend_from_slice(&[ + self.command(), + "--example", + example, + "--target", + target.triple(), + ]); if let Some(feature) = features { args.extend_from_slice(&["--features", feature]); @@ -387,7 +411,13 @@ impl<'a> CargoCommand<'a> { if let Some(cargoarg) = cargoarg { args.extend_from_slice(&[cargoarg]); } - args.extend_from_slice(&[self.command(), "--example", example, "--target", target]); + args.extend_from_slice(&[ + self.command(), + "--example", + example, + "--target", + target.triple(), + ]); if let Some(feature_name) = features { args.extend_from_slice(&["--features", feature_name]); -- cgit v1.2.3 From 525703358bf52b74a01d9b0c04680d33621d60cd Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 12:21:11 +0200 Subject: Rework command execution structure and make rayon optional (since it's not necessarily faster due to workspace wide lockfile contention) --- xtask/src/command.rs | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 32ca9c8..359a7f9 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -108,6 +108,14 @@ pub enum CargoCommand<'a> { }, } +impl core::fmt::Display for CargoCommand<'_> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let executable = self.executable(); + let args = self.args().join(" "); + write!(f, "\"{executable} {args}\"") + } +} + impl<'a> CargoCommand<'a> { fn command(&self) -> &str { match self { @@ -460,12 +468,7 @@ impl fmt::Display for BuildMode { } pub fn run_command(command: &CargoCommand, stderr_mode: OutputMode) -> anyhow::Result { - let command_display = command.executable(); - let args = command.args(); - - let full_command = format!("\"{command_display}\" {}", args.join(" ")); - - debug!("👟 {full_command}"); + debug!("👟 {command}"); let result = Command::new(command.executable()) .args(command.args()) @@ -479,7 +482,6 @@ pub fn run_command(command: &CargoCommand, stderr_mode: OutputMode) -> anyhow::R Ok(RunResult { exit_status, - full_command, stdout, stderr, }) -- cgit v1.2.3 From df69b35c250eff5858d6e994a9866be35b987a6e Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 13:18:18 +0200 Subject: More housekeeping and making it work that bit better --- xtask/src/command.rs | 190 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 187 insertions(+), 3 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 359a7f9..99b7518 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -110,9 +110,193 @@ pub enum CargoCommand<'a> { impl core::fmt::Display for CargoCommand<'_> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - let executable = self.executable(); - let args = self.args().join(" "); - write!(f, "\"{executable} {args}\"") + let p = |p: &Option| { + if let Some(package) = p { + format!("package {package}") + } else { + format!("default package") + } + }; + + let feat = |f: &Option| { + if let Some(features) = f { + format!("\"{features}\"") + } else { + format!("no features") + } + }; + + let carg = |f: &&Option<&str>| { + if let Some(cargoarg) = f { + format!("{cargoarg}") + } else { + format!("no cargo args") + } + }; + + let details = |target: &Target, + mode: &BuildMode, + features: &Option, + cargoarg: &&Option<&str>| { + let feat = feat(features); + let carg = carg(cargoarg); + if cargoarg.is_some() { + format!("({target}, {mode}, {feat}, {carg})") + } else { + format!("({target}, {mode}, {feat})") + } + }; + + match self { + CargoCommand::Run { + cargoarg, + example, + target, + features, + mode, + } => write!( + f, + "Run example {example} {}", + details(target, mode, features, cargoarg) + ), + CargoCommand::Qemu { + cargoarg, + example, + target, + features, + mode, + } => write!( + f, + "Run example {example} in QEMU {}", + details(target, mode, features, cargoarg) + ), + CargoCommand::ExampleBuild { + cargoarg, + example, + target, + features, + mode, + } => write!( + f, + "Build example {example} {}", + details(target, mode, features, cargoarg) + ), + CargoCommand::ExampleCheck { + cargoarg, + example, + target, + features, + mode, + } => write!( + f, + "Check example {example} {}", + details(target, mode, features, cargoarg) + ), + CargoCommand::Build { + cargoarg, + package, + target, + features, + mode, + } => { + let package = p(package); + write!( + f, + "Build {package} {}", + details(target, mode, features, cargoarg) + ) + } + CargoCommand::Check { + cargoarg, + package, + target, + features, + mode, + } => { + let package = p(package); + write!( + f, + "Check {package} {}", + details(target, mode, features, cargoarg) + ) + } + CargoCommand::Clippy { + cargoarg, + package, + target, + features, + } => { + let package = p(package); + let features = feat(features); + let carg = carg(cargoarg); + write!(f, "Clippy {package} ({target}, {features}, {carg})") + } + CargoCommand::Format { + cargoarg, + package, + check_only, + } => { + let package = p(package); + let carg = carg(cargoarg); + + let carg = if cargoarg.is_some() { + format!("(cargo args: {carg})") + } else { + format!("") + }; + + if *check_only { + write!(f, "Check format for {package} {carg}") + } else { + write!(f, "Format {package} {carg}") + } + } + CargoCommand::Doc { + cargoarg, + features, + arguments, + } => { + let feat = feat(features); + let carg = carg(cargoarg); + let arguments = arguments + .clone() + .map(|a| format!("{a}")) + .unwrap_or_else(|| "No extra arguments".into()); + if cargoarg.is_some() { + write!(f, "Document ({feat}, {carg}, {arguments}") + } else { + write!(f, "Document ({feat}, {arguments}") + } + } + CargoCommand::Test { + package, + features, + test, + } => { + let p = p(package); + let test = test + .clone() + .map(|t| format!("test {t}")) + .unwrap_or("all tests".into()); + let feat = feat(features); + write!(f, "Run {test} in {p} ({feat})") + } + CargoCommand::Book { arguments: _ } => write!(f, "Build the book"), + CargoCommand::ExampleSize { + cargoarg, + example, + target, + features, + mode, + arguments: _, + } => { + write!( + f, + "Compute size of example {example} {}", + details(target, mode, features, cargoarg) + ) + } + } } } -- cgit v1.2.3 From 461023e3b836db394dce0e034a1d329b1f5c8f48 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 13:45:58 +0200 Subject: More emojis and correct place for things --- xtask/src/command.rs | 71 +++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 68 insertions(+), 3 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 99b7518..71dda2b 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -1,4 +1,8 @@ -use crate::{debug, ExtraArguments, Package, RunResult, Target, TestRunError}; +use log::{error, info, Level}; + +use crate::{ + cargo_commands::FinalRunResult, ExtraArguments, Package, RunResult, Target, TestRunError, +}; use core::fmt; use std::{ fs::File, @@ -279,7 +283,7 @@ impl core::fmt::Display for CargoCommand<'_> { .map(|t| format!("test {t}")) .unwrap_or("all tests".into()); let feat = feat(features); - write!(f, "Run {test} in {p} ({feat})") + write!(f, "Run {test} in {p} (features: {feat})") } CargoCommand::Book { arguments: _ } => write!(f, "Build the book"), CargoCommand::ExampleSize { @@ -652,7 +656,7 @@ impl fmt::Display for BuildMode { } pub fn run_command(command: &CargoCommand, stderr_mode: OutputMode) -> anyhow::Result { - debug!("👟 {command}"); + log::info!("👟 {command}"); let result = Command::new(command.executable()) .args(command.args()) @@ -697,3 +701,64 @@ pub fn run_successful(run: &RunResult, expected_output_file: &str) -> Result<(), Ok(()) } } + +pub fn handle_results(results: Vec) -> anyhow::Result<()> { + let errors = results.iter().filter_map(|r| { + if let FinalRunResult::Failed(c, r) = r { + Some((c, r)) + } else { + None + } + }); + + let successes = results.iter().filter_map(|r| { + if let FinalRunResult::Success(c, r) = r { + Some((c, r)) + } else { + None + } + }); + + let log_stdout_stderr = |level: Level| { + move |(command, result): (&CargoCommand, &RunResult)| { + let stdout = &result.stdout; + let stderr = &result.stderr; + if !stdout.is_empty() && !stderr.is_empty() { + log::log!( + level, + "Output for \"{command}\"\nStdout:\n{stdout}\nStderr:\n{stderr}" + ); + } else if !stdout.is_empty() { + log::log!( + level, + "Output for \"{command}\":\nStdout:\n{}", + stdout.trim_end() + ); + } else if !stderr.is_empty() { + log::log!( + level, + "Output for \"{command}\"\nStderr:\n{}", + stderr.trim_end() + ); + } + } + }; + + successes.clone().for_each(log_stdout_stderr(Level::Debug)); + errors.clone().for_each(log_stdout_stderr(Level::Error)); + + successes.for_each(|(cmd, _)| { + info!("✅ Success: {cmd}"); + }); + + errors.clone().for_each(|(cmd, _)| { + error!("❌ Failed: {cmd}"); + }); + + let ecount = errors.count(); + if ecount != 0 { + Err(anyhow::anyhow!("{ecount} commands failed.")) + } else { + Ok(()) + } +} -- cgit v1.2.3 From 622a58db5a06b1c4b29d9036ffaa593edff771b2 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 13:55:56 +0200 Subject: Also log command with enough verbosity --- xtask/src/command.rs | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 71dda2b..d05a95b 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -1,7 +1,8 @@ use log::{error, info, Level}; use crate::{ - cargo_commands::FinalRunResult, ExtraArguments, Package, RunResult, Target, TestRunError, + argument_parsing::Globals, cargo_commands::FinalRunResult, ExtraArguments, Package, RunResult, + Target, TestRunError, }; use core::fmt; use std::{ @@ -305,6 +306,12 @@ impl core::fmt::Display for CargoCommand<'_> { } impl<'a> CargoCommand<'a> { + pub fn as_cmd_string(&self) -> String { + let executable = self.executable(); + let args = self.args().join(" "); + format!("{executable} {args}") + } + fn command(&self) -> &str { match self { CargoCommand::Run { .. } | CargoCommand::Qemu { .. } => "run", @@ -702,7 +709,7 @@ pub fn run_successful(run: &RunResult, expected_output_file: &str) -> Result<(), } } -pub fn handle_results(results: Vec) -> anyhow::Result<()> { +pub fn handle_results(globals: &Globals, results: Vec) -> anyhow::Result<()> { let errors = results.iter().filter_map(|r| { if let FinalRunResult::Failed(c, r) = r { Some((c, r)) @@ -748,11 +755,15 @@ pub fn handle_results(results: Vec) -> anyhow::Result<()> { errors.clone().for_each(log_stdout_stderr(Level::Error)); successes.for_each(|(cmd, _)| { - info!("✅ Success: {cmd}"); + if globals.verbose > 0 { + info!("✅ Success: {cmd}\n {}", cmd.as_cmd_string()); + } else { + info!("✅ Success: {cmd}"); + } }); errors.clone().for_each(|(cmd, _)| { - error!("❌ Failed: {cmd}"); + error!("❌ Failed: {cmd}\n {}", cmd.as_cmd_string()); }); let ecount = errors.count(); -- cgit v1.2.3 From b11b4f8cddfb9714e542155a957e070713e297f9 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 15:16:43 +0200 Subject: Missed a paren --- xtask/src/command.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index d05a95b..38550fe 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -266,11 +266,11 @@ impl core::fmt::Display for CargoCommand<'_> { let arguments = arguments .clone() .map(|a| format!("{a}")) - .unwrap_or_else(|| "No extra arguments".into()); + .unwrap_or_else(|| "no extra arguments".into()); if cargoarg.is_some() { - write!(f, "Document ({feat}, {carg}, {arguments}") + write!(f, "Document ({feat}, {carg}, {arguments})") } else { - write!(f, "Document ({feat}, {arguments}") + write!(f, "Document ({feat}, {arguments})") } } CargoCommand::Test { -- cgit v1.2.3 From aeeb623a70b2bf4ae78f1629a5171406ba51ec4d Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 15 Apr 2023 15:32:33 +0200 Subject: Don't print no cargo args here either --- xtask/src/command.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'xtask/src/command.rs') diff --git a/xtask/src/command.rs b/xtask/src/command.rs index 38550fe..b62724a 100644 --- a/xtask/src/command.rs +++ b/xtask/src/command.rs @@ -234,7 +234,11 @@ impl core::fmt::Display for CargoCommand<'_> { let package = p(package); let features = feat(features); let carg = carg(cargoarg); - write!(f, "Clippy {package} ({target}, {features}, {carg})") + if cargoarg.is_some() { + write!(f, "Clippy {package} ({target}, {features}, {carg})") + } else { + write!(f, "Clippy {package} ({target}, {features})") + } } CargoCommand::Format { cargoarg, -- cgit v1.2.3