Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 47 additions & 22 deletions src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,17 @@ use similar::{ChangeTag, TextDiff};

use crate::config::TestConfig;
use crate::traits::{Reporter, Runner};
use crate::{RED, RESET};
use crate::{Cli, GREEN, GREY, RED, RESET};

pub struct QemuRunner;

impl Runner for QemuRunner {
fn run(&mut self, config: &TestConfig, reporter: &dyn Reporter) -> anyhow::Result<()> {
fn run(
&mut self,
config: &TestConfig,
opts: &Cli,
reporter: &dyn Reporter,
) -> anyhow::Result<()> {
reporter.on_test_start(config);

let mut p = spawn(&config.command, Some(config.timeout_ms))?;
Expand All @@ -36,26 +41,40 @@ impl Runner for QemuRunner {
anyhow::bail!(e.to_string());
}

let mut verbose_logs = String::new();

for expect in &test.expect {
if let Err(e) = p.exp_string(expect) {
let fail_msg = match &e {
rexpect::error::Error::Timeout {
expected: exp, got, ..
} => format_diff(exp, got),
rexpect::error::Error::EOF {
expected: exp, got, ..
} => {
format!(
"EOF (OS Crashed)!\n {RED}│{RESET} Expected: '{}'\n {RED}│{RESET} Got: '{}'",
exp,
clean_output(got)
)
match p.exp_string(expect) {
Ok(got) => {
if opts.verbose {
let clean = clean_output(&got);
let reconstructed = format!("{clean}{GREEN}{expect}{GREY}");
verbose_logs.push_str(&format!(
" │ Expected: '{}'\n │ Got: '{}'\n",
expect, reconstructed
));
}
_ => e.to_string(),
};

reporter.on_step_failure(&test.command, &fail_msg);
anyhow::bail!(e.to_string());
}
Err(e) => {
let fail_msg = match &e {
rexpect::error::Error::Timeout {
expected: exp, got, ..
} => format_diff(exp, got),
rexpect::error::Error::EOF {
expected: exp, got, ..
} => {
format!(
"EOF (OS Crashed)!\n {RED}│{RESET} Expected: '{}'\n {RED}│{RESET} Got: '{}'",
exp,
clean_output(got)
)
}
_ => e.to_string(),
};

reporter.on_step_failure(&test.command, &fail_msg);
anyhow::bail!(e.to_string());
}
}
}

Expand All @@ -67,7 +86,13 @@ impl Runner for QemuRunner {
anyhow::bail!(e.to_string());
}

reporter.on_step_success(&test.command);
let details = if opts.verbose && !verbose_logs.is_empty() {
Some(verbose_logs.trim_end().to_string())
} else {
None
};

reporter.on_step_success(&test.command, details);
}

let _ = p.process_mut().kill(rexpect::process::Signal::SIGTERM);
Expand All @@ -78,7 +103,7 @@ impl Runner for QemuRunner {
}

fn clean_output(raw: &str) -> String {
let mut msg = raw.replace("\r\n", " ↵ ").replace('\n', " ↵ ");
let mut msg = raw.replace("\r\n", " ↵ ").replace(['\n', '\r'], " ↵ ");

if let Ok(re) = Regex::new(r"\x1b\[[0-9;]*[mK]|\\u\{1b\}\[[0-9;]*[mK]") {
msg = re.replace_all(&msg, "").to_string();
Expand Down
15 changes: 15 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,19 @@ pub mod traits;

const GREEN: &str = "\x1b[32m";
const RED: &str = "\x1b[31m";
const GREY: &str = "\x1b[90m";
const RESET: &str = "\x1b[0m";

use clap::Parser;

#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
pub struct Cli {
pub path: String,

#[arg(long, default_value_t = false)]
pub nui: bool,

#[arg(long, default_value_t = false)]
pub verbose: bool,
}
14 changes: 3 additions & 11 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use std::{
};

use walkman::{
Cli,
config::TestConfig,
engine::QemuRunner,
reporter::{console::ConsoleReporter, tui::TuiReporter},
Expand All @@ -12,15 +13,6 @@ use walkman::{

use clap::Parser;

#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
struct Cli {
path: String,

#[arg(long, default_value_t = false)]
nui: bool,
}

fn main() {
let cli = Cli::parse();

Expand Down Expand Up @@ -71,10 +63,10 @@ fn main() {

let result = if cli.nui {
let reporter = ConsoleReporter;
runner.run(&config, &reporter)
runner.run(&config, &cli, &reporter)
} else {
let reporter = TuiReporter::new(&config);
runner.run(&config, &reporter)
runner.run(&config, &cli, &reporter)
};

let success = result.is_ok();
Expand Down
7 changes: 5 additions & 2 deletions src/reporter/console.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use crate::config::TestConfig;
use crate::traits::Reporter;
use crate::{GREEN, RED, RESET};
use crate::{GREEN, GREY, RED, RESET};

pub struct ConsoleReporter;

Expand All @@ -22,8 +22,11 @@ impl Reporter for ConsoleReporter {
print!(" [TEST] Executing: '{}' ... ", step_name);
}

fn on_step_success(&self, _step_name: &str) {
fn on_step_success(&self, _step_name: &str, details: Option<String>) {
println!("{}SUCCESS{}", GREEN, RESET);
if let Some(msg) = details {
println!("{GREY}{msg}{RESET}");
}
}

fn on_step_failure(&self, _step_name: &str, reason: &str) {
Expand Down
25 changes: 19 additions & 6 deletions src/reporter/tui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use crate::{RED, RESET, config::TestConfig, traits::Reporter};
enum Status {
Pending,
Running,
Success,
Success(Option<String>),
Failed(String),
}

Expand Down Expand Up @@ -131,14 +131,24 @@ impl TuiReporter {
ResetColor
);
}
Status::Success => {
Status::Success(details) => {
let _ = execute!(
out,
SetForegroundColor(Color::Green),
Print(" ● "),
ResetColor,
Print(format!("{}{}\n", prefix, name))
);

if let Some(msg) = details {
let _ = execute!(
out,
SetForegroundColor(Color::DarkGrey),
Print(format!("{}\n", msg)),
ResetColor
);
lines += msg.lines().count() as u16;
}
}
Status::Running => {
let _ = execute!(
Expand Down Expand Up @@ -213,15 +223,15 @@ impl Reporter for TuiReporter {
}

fn on_boot_check(&self, msg: &str) {
self.update_boot_status(msg, Status::Success);
self.update_boot_status(msg, Status::Success(None));
}

fn on_step_start(&self, step_name: &str) {
self.update_shell_status(step_name, Status::Running);
}

fn on_step_success(&self, step_name: &str) {
self.update_shell_status(step_name, Status::Success);
fn on_step_success(&self, step_name: &str, details: Option<String>) {
self.update_shell_status(step_name, Status::Success(details));
}

fn on_step_failure(&self, step_name: &str, reason: &str) {
Expand Down Expand Up @@ -293,7 +303,10 @@ mod tests {
assert_eq!(reporter.state.borrow().boot_steps[0].1, Status::Running);

reporter.on_boot_check("booting");
assert_eq!(reporter.state.borrow().boot_steps[0].1, Status::Success);
assert_eq!(
reporter.state.borrow().boot_steps[0].1,
Status::Success(None)
);

reporter.on_step_failure("ls", "timeout");
assert_eq!(
Expand Down
11 changes: 8 additions & 3 deletions src/traits.rs
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
use crate::config::TestConfig;
use crate::{Cli, config::TestConfig};

pub trait Reporter {
fn on_test_start(&self, config: &TestConfig);
fn on_boot_start(&self, msg: &str);
fn on_boot_check(&self, msg: &str);
fn on_step_start(&self, step_name: &str);
fn on_step_success(&self, step_name: &str);
fn on_step_success(&self, step_name: &str, details: Option<String>);
fn on_step_failure(&self, step_name: &str, reason: &str);
fn on_test_end(&self, success: bool);
}

pub trait Runner {
fn run(&mut self, config: &TestConfig, reporter: &dyn Reporter) -> anyhow::Result<()>;
fn run(
&mut self,
config: &TestConfig,
opts: &Cli,
reporter: &dyn Reporter,
) -> anyhow::Result<()>;
}
Loading