1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-07-04 07:15:18 +02:00

flashrom_tester: Only print color when stdout isatty

Add the atty crate as a dependency. Print log and report in color only
when isatty is true.

BUG=b:246250254
BRANCH=None
TEST=ssh dut flashrom_tester # no color
TEST=ssh -t dut flashrom_tester # color

Change-Id: Ia3cc527fb98e53eda6773622340cf10764df2cba
Signed-off-by: Evan Benn <evanbenn@chromium.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/69270
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
This commit is contained in:
Evan Benn
2022-11-07 16:48:14 +11:00
committed by Edward O'Callaghan
parent 065366dd27
commit 4df64d93a0
4 changed files with 57 additions and 25 deletions

View File

@ -41,6 +41,7 @@ use std::sync::Mutex;
struct Logger<W: Write + Send> {
level: log::LevelFilter,
target: LogTarget<W>,
color: types::Color,
}
enum LogTarget<W>
@ -57,16 +58,14 @@ impl<W: Write + Send> log::Log for Logger<W> {
}
fn log(&self, record: &log::Record) {
fn log_internal<W: Write>(mut w: W, record: &log::Record) -> std::io::Result<()> {
fn log_internal<W: Write>(
mut w: W,
record: &log::Record,
color: &types::Color,
) -> std::io::Result<()> {
let now = chrono::Utc::now().to_rfc3339_opts(chrono::SecondsFormat::Micros, true);
write!(w, "{}{} ", types::MAGENTA, now)?;
write!(
w,
"{}[ {} ]{} ",
types::YELLOW,
record.level(),
types::RESET
)?;
write!(w, "{}{} ", color.magenta, now)?;
write!(w, "{}[ {} ]{} ", color.yellow, record.level(), color.reset)?;
writeln!(w, "{}", record.args())
}
@ -75,11 +74,11 @@ impl<W: Write + Send> log::Log for Logger<W> {
LogTarget::Terminal => {
let stdout = std::io::stdout();
let mut lock = stdout.lock();
log_internal(&mut lock, record)
log_internal(&mut lock, record, &self.color)
}
LogTarget::Write(ref mutex) => {
let mut lock = mutex.lock().unwrap();
log_internal(&mut *lock, record)
log_internal(&mut *lock, record, &self.color)
}
};
}
@ -97,6 +96,11 @@ pub fn init(to_file: Option<PathBuf>, debug: bool) {
let mut logger = Logger {
level: log::LevelFilter::Info,
target: LogTarget::Terminal,
color: if atty::is(atty::Stream::Stdout) {
types::COLOR
} else {
types::NOCOLOR
},
};
if debug {
@ -106,6 +110,7 @@ pub fn init(to_file: Option<PathBuf>, debug: bool) {
logger.target = LogTarget::Write(Mutex::new(
std::fs::File::create(path).expect("Unable to open log file for writing"),
));
logger.color = types::NOCOLOR;
}
log::set_max_level(logger.level);
@ -115,6 +120,7 @@ pub fn init(to_file: Option<PathBuf>, debug: bool) {
#[cfg(test)]
mod tests {
use super::{LogTarget, Logger};
use flashrom_tester::types;
use log::{Level, LevelFilter, Log, Record};
use std::sync::Mutex;
@ -125,6 +131,7 @@ mod tests {
let logger = Logger {
level: LevelFilter::Info,
target: LogTarget::Write(lock),
color: types::COLOR,
};
for record in records {