Skip to content

fix(schema)!: Clarify naming #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
epage merged 3 commits into from
Aug 15, 2025
Merged

fix(schema)!: Clarify naming #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c356e5b
fix(schema)!: Rename Suite to Run
epage Aug 15, 2025
dafbfd5
fix(schema)!: Remove mode from CaseComplete
epage Aug 15, 2025
6fa5eda
fix(schema): Rename DiscoverCase::run to selected
epage Aug 15, 2025
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
9 changes: 3 additions & 6 deletions crates/libtest-json/event.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"mode": {
"$ref": "#/$defs/RunMode"
},
"run": {
"selected": {
"description": "Whether selected to be run by the user",
"type": "boolean"
},
Expand Down Expand Up @@ -94,7 +94,7 @@
},
"event": {
"type": "string",
"const": "suite_start"
"const": "run_start"
}
},
"required": [
Expand Down Expand Up @@ -133,9 +133,6 @@
"name": {
"type": "string"
},
"mode": {
"$ref": "#/$defs/RunMode"
},
"status": {
"description": "`None` means success",
"anyOf": [
Expand Down Expand Up @@ -188,7 +185,7 @@
},
"event": {
"type": "string",
"const": "suite_complete"
"const": "run_complete"
}
},
"required": [
Expand Down
35 changes: 11 additions & 24 deletions crates/libtest-json/src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub enum Event {
feature = "serde",
serde(default = "true_default", skip_serializing_if = "is_true")
)]
run: bool,
selected: bool,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
Expand All @@ -37,7 +37,7 @@ pub enum Event {
)]
elapsed_s: Option<Elapsed>,
},
SuiteStart {
RunStart {
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
Expand All @@ -54,11 +54,6 @@ pub enum Event {
},
CaseComplete {
name: String,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "RunMode::is_default")
)]
mode: RunMode,
/// `None` means success
#[cfg_attr(
feature = "serde",
Expand All @@ -76,7 +71,7 @@ pub enum Event {
)]
elapsed_s: Option<Elapsed>,
},
SuiteComplete {
RunComplete {
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
Expand Down Expand Up @@ -108,7 +103,7 @@ impl Event {
Self::DiscoverCase {
name,
mode,
run,
selected,
elapsed_s,
} => {
buffer.key("event").unwrap();
Expand All @@ -127,11 +122,11 @@ impl Event {
buffer.value(mode.as_str()).unwrap();
}

if !run {
if !selected {
buffer.val_sep().unwrap();
buffer.key("run").unwrap();
buffer.key("selected").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(run).unwrap();
buffer.value(selected).unwrap();
}

if let Some(elapsed_s) = elapsed_s {
Expand All @@ -153,10 +148,10 @@ impl Event {
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::SuiteStart { elapsed_s } => {
Self::RunStart { elapsed_s } => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("suite_start").unwrap();
buffer.value("run_start").unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
Expand Down Expand Up @@ -184,7 +179,6 @@ impl Event {
}
Self::CaseComplete {
name,
mode,
status,
message,
elapsed_s,
Expand All @@ -198,13 +192,6 @@ impl Event {
buffer.keyval_sep().unwrap();
buffer.value(name).unwrap();

if !mode.is_default() {
buffer.val_sep().unwrap();
buffer.key("mode").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(mode.as_str()).unwrap();
}

if let Some(status) = status {
buffer.val_sep().unwrap();
buffer.key("status").unwrap();
Expand All @@ -226,10 +213,10 @@ impl Event {
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::SuiteComplete { elapsed_s } => {
Self::RunComplete { elapsed_s } => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("suite_complete").unwrap();
buffer.value("run_complete").unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
Expand Down
26 changes: 12 additions & 14 deletions crates/libtest-json/tests/roundtrip.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ fn discover_case() {
libtest_json::Event::DiscoverCase {
name: "Hello\tworld!".to_owned(),
mode: libtest_json::RunMode::Test,
run: true,
selected: true,
elapsed_s: None,
},
str![[r#"{"event":"discover_case","name":"Hello\tworld!"}"#]],
Expand All @@ -44,11 +44,11 @@ fn discover_case() {
libtest_json::Event::DiscoverCase {
name: "Hello\tworld!".to_owned(),
mode: libtest_json::RunMode::Bench,
run: false,
selected: false,
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[
r#"{"event":"discover_case","name":"Hello\tworld!","mode":"bench","run":false,"elapsed_s":"0"}"#
r#"{"event":"discover_case","name":"Hello\tworld!","mode":"bench","selected":false,"elapsed_s":"0"}"#
]],
);
}
Expand All @@ -71,14 +71,14 @@ fn discover_complete() {
#[test]
fn suite_start() {
t(
libtest_json::Event::SuiteStart { elapsed_s: None },
str![[r#"{"event":"suite_start"}"#]],
libtest_json::Event::RunStart { elapsed_s: None },
str![[r#"{"event":"run_start"}"#]],
);
t(
libtest_json::Event::SuiteStart {
libtest_json::Event::RunStart {
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[r#"{"event":"suite_start","elapsed_s":"0"}"#]],
str![[r#"{"event":"run_start","elapsed_s":"0"}"#]],
);
}

Expand All @@ -105,7 +105,6 @@ fn case_complete() {
t(
libtest_json::Event::CaseComplete {
name: "Hello\tworld!".to_owned(),
mode: libtest_json::RunMode::Test,
status: None,
message: None,
elapsed_s: None,
Expand All @@ -116,28 +115,27 @@ fn case_complete() {
t(
libtest_json::Event::CaseComplete {
name: "Hello\tworld!".to_owned(),
mode: libtest_json::RunMode::Bench,
status: Some(libtest_json::RunStatus::Ignored),
message: Some("This\tfailed".to_owned()),
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[
r#"{"event":"case_complete","name":"Hello\tworld!","mode":"bench","status":"ignored","message":"This\tfailed","elapsed_s":"0"}"#
r#"{"event":"case_complete","name":"Hello\tworld!","status":"ignored","message":"This\tfailed","elapsed_s":"0"}"#
]],
);
}

#[test]
fn suite_complete() {
t(
libtest_json::Event::SuiteComplete { elapsed_s: None },
str![[r#"{"event":"suite_complete"}"#]],
libtest_json::Event::RunComplete { elapsed_s: None },
str![[r#"{"event":"run_complete"}"#]],
);

t(
libtest_json::Event::SuiteComplete {
libtest_json::Event::RunComplete {
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[r#"{"event":"suite_complete","elapsed_s":"0"}"#]],
str![[r#"{"event":"run_complete","elapsed_s":"0"}"#]],
);
}
7 changes: 3 additions & 4 deletions crates/libtest2-harness/src/harness.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ fn discover(
notifier.notify(notify::Event::DiscoverCase {
name: case.name().to_owned(),
mode: RunMode::Test,
run: retain_case,
selected: retain_case,
elapsed_s: Some(notify::Elapsed(start.elapsed())),
})?;
}
Expand All @@ -250,7 +250,7 @@ fn run(
cases: Vec<Box<dyn Case>>,
notifier: &mut dyn notify::Notifier,
) -> std::io::Result<bool> {
notifier.notify(notify::Event::SuiteStart {
notifier.notify(notify::Event::RunStart {
elapsed_s: Some(notify::Elapsed(start.elapsed())),
})?;

Expand Down Expand Up @@ -398,7 +398,7 @@ fn run(
}
}

notifier.notify(notify::Event::SuiteComplete {
notifier.notify(notify::Event::RunComplete {
elapsed_s: Some(notify::Elapsed(start.elapsed())),
})?;

Expand Down Expand Up @@ -440,7 +440,6 @@ fn run_case(
let message = err.and_then(|e| e.cause().map(|c| c.to_string()));
notifier.notify(notify::Event::CaseComplete {
name: case.name().to_owned(),
mode: RunMode::Test,
status,
message,
elapsed_s: Some(notify::Elapsed(start.elapsed())),
Expand Down
8 changes: 4 additions & 4 deletions crates/libtest2-harness/src/notify/pretty.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ impl<W: std::io::Write> super::Notifier for PrettyRunNotifier<W> {
self.summary.notify(event.clone())?;
match event {
Event::DiscoverStart { .. } => {}
Event::DiscoverCase { name, run, .. } => {
if run {
Event::DiscoverCase { name, selected, .. } => {
if selected {
self.name_width = name.len().max(self.name_width);
}
}
Event::DiscoverComplete { .. } => {}
Event::SuiteStart { .. } => {
Event::RunStart { .. } => {
self.summary.write_start(&mut self.writer)?;
}
Event::CaseStart { name, .. } => {
Expand All @@ -59,7 +59,7 @@ impl<W: std::io::Write> super::Notifier for PrettyRunNotifier<W> {
}
writeln!(self.writer, "{style}{s}{style:#}")?;
}
Event::SuiteComplete { .. } => {
Event::RunComplete { .. } => {
self.summary.write_complete(&mut self.writer)?;
}
}
Expand Down
8 changes: 4 additions & 4 deletions crates/libtest2-harness/src/notify/summary.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,15 @@ impl super::Notifier for Summary {
fn notify(&mut self, event: Event) -> std::io::Result<()> {
match event {
Event::DiscoverStart { .. } => {}
Event::DiscoverCase { run, .. } => {
if run {
Event::DiscoverCase { selected, .. } => {
if selected {
self.num_run += 1;
} else {
self.num_filtered_out += 1;
}
}
Event::DiscoverComplete { .. } => {}
Event::SuiteStart { .. } => {}
Event::RunStart { .. } => {}
Event::CaseStart { .. } => {}
Event::CaseComplete {
name,
Expand All @@ -115,7 +115,7 @@ impl super::Notifier for Summary {
self.num_passed += 1;
}
},
Event::SuiteComplete { elapsed_s, .. } => {
Event::RunComplete { elapsed_s, .. } => {
self.elapsed_s = elapsed_s;
}
}
Expand Down
15 changes: 9 additions & 6 deletions crates/libtest2-harness/src/notify/terse.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ impl<W: std::io::Write> super::Notifier for TerseListNotifier<W> {
match event {
Event::DiscoverStart { .. } => {}
Event::DiscoverCase {
name, mode, run, ..
name,
mode,
selected,
..
} => {
if run {
if selected {
let mode = mode.as_str();
writeln!(self.writer, "{name}: {mode}")?;
self.tests += 1;
Expand All @@ -34,10 +37,10 @@ impl<W: std::io::Write> super::Notifier for TerseListNotifier<W> {
writeln!(self.writer, "{} tests", self.tests)?;
writeln!(self.writer)?;
}
Event::SuiteStart { .. } => {}
Event::RunStart { .. } => {}
Event::CaseStart { .. } => {}
Event::CaseComplete { .. } => {}
Event::SuiteComplete { .. } => {}
Event::RunComplete { .. } => {}
}
Ok(())
}
Expand Down Expand Up @@ -65,7 +68,7 @@ impl<W: std::io::Write> super::Notifier for TerseRunNotifier<W> {
Event::DiscoverStart { .. } => {}
Event::DiscoverCase { .. } => {}
Event::DiscoverComplete { .. } => {}
Event::SuiteStart { .. } => {
Event::RunStart { .. } => {
self.summary.write_start(&mut self.writer)?;
}
Event::CaseStart { .. } => {}
Expand All @@ -78,7 +81,7 @@ impl<W: std::io::Write> super::Notifier for TerseRunNotifier<W> {
write!(self.writer, "{style}{c}{style:#}")?;
self.writer.flush()?;
}
Event::SuiteComplete { .. } => {
Event::RunComplete { .. } => {
self.summary.write_complete(&mut self.writer)?;
}
}
Expand Down
Loading
Loading