Skip to content

fix(schema)!: Track process-start elapsed #107

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
merged 1 commit into from
Aug 15, 2025
Merged

fix(schema)!: Track process-start elapsed #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 44 additions & 3 deletions crates/libtest-json/event.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@
{
"type": "object",
"properties": {
"elapsed_s": {
"anyOf": [
{
"$ref": "#/$defs/Elapsed"
},
{
"type": "null"
}
]
},
"event": {
"type": "string",
"const": "discover_start"
Expand All @@ -27,6 +37,16 @@
"description": "Whether selected to be run by the user",
"type": "boolean"
},
"elapsed_s": {
"anyOf": [
{
"$ref": "#/$defs/Elapsed"
},
{
"type": "null"
}
]
},
"event": {
"type": "string",
"const": "discover_case"
Expand Down Expand Up @@ -62,6 +82,16 @@
{
"type": "object",
"properties": {
"elapsed_s": {
"anyOf": [
{
"$ref": "#/$defs/Elapsed"
},
{
"type": "null"
}
]
},
"event": {
"type": "string",
"const": "suite_start"
Expand All @@ -77,6 +107,16 @@
"name": {
"type": "string"
},
"elapsed_s": {
"anyOf": [
{
"$ref": "#/$defs/Elapsed"
},
{
"type": "null"
}
]
},
"event": {
"type": "string",
"const": "case_start"
Expand Down Expand Up @@ -157,16 +197,17 @@
}
],
"$defs": {
"Elapsed": {
"description": "Time elapsed since process start",
"type": "string"
},
"RunMode": {
"type": "string",
"enum": [
"test",
"bench"
]
},
"Elapsed": {
"type": "string"
},
"RunStatus": {
"type": "string",
"enum": [
Expand Down
70 changes: 64 additions & 6 deletions crates/libtest-json/src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
#[cfg_attr(feature = "serde", serde(tag = "event"))]
pub enum Event {
DiscoverStart,
DiscoverStart {
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
DiscoverCase {
name: String,
#[cfg_attr(
Expand All @@ -18,6 +24,11 @@ pub enum Event {
serde(default = "true_default", skip_serializing_if = "is_true")
)]
run: bool,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
DiscoverComplete {
#[cfg_attr(
Expand All @@ -26,9 +37,20 @@ pub enum Event {
)]
elapsed_s: Option<Elapsed>,
},
SuiteStart,
SuiteStart {
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
CaseStart {
name: String,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
CaseComplete {
name: String,
Expand Down Expand Up @@ -71,12 +93,24 @@ impl Event {
let mut buffer = String::new();
buffer.open_object().unwrap();
match self {
Self::DiscoverStart => {
Self::DiscoverStart { elapsed_s } => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("discover_start").unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
buffer.key("elapsed_s").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::DiscoverCase { name, mode, run } => {
Self::DiscoverCase {
name,
mode,
run,
elapsed_s,
} => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("discover_case").unwrap();
Expand All @@ -99,24 +133,39 @@ impl Event {
buffer.keyval_sep().unwrap();
buffer.value(run).unwrap();
}

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
buffer.key("elapsed_s").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::DiscoverComplete { elapsed_s } => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("discover_complete").unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
buffer.key("elapsed_s").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::SuiteStart => {
Self::SuiteStart { elapsed_s } => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("suite_start").unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
buffer.key("elapsed_s").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::CaseStart { name } => {
Self::CaseStart { name, elapsed_s } => {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("case_start").unwrap();
Expand All @@ -125,6 +174,13 @@ impl Event {
buffer.key("name").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(name).unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
buffer.key("elapsed_s").unwrap();
buffer.keyval_sep().unwrap();
buffer.value(String::from(*elapsed_s)).unwrap();
}
}
Self::CaseComplete {
name,
Expand Down Expand Up @@ -174,6 +230,7 @@ impl Event {
buffer.key("event").unwrap();
buffer.keyval_sep().unwrap();
buffer.value("suite_complete").unwrap();

if let Some(elapsed_s) = elapsed_s {
buffer.val_sep().unwrap();
buffer.key("elapsed_s").unwrap();
Expand Down Expand Up @@ -237,6 +294,7 @@ impl RunStatus {
}
}

/// Time elapsed since process start
#[derive(Copy, Clone, Default, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "unstable-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
Expand Down
30 changes: 27 additions & 3 deletions crates/libtest-json/tests/roundtrip.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,15 @@ fn t(input: libtest_json::Event, snapshot: impl IntoData) {
#[test]
fn discover_start() {
t(
libtest_json::Event::DiscoverStart,
libtest_json::Event::DiscoverStart { elapsed_s: None },
str![[r#"{"event":"discover_start"}"#]],
);
t(
libtest_json::Event::DiscoverStart {
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[r#"{"event":"discover_start","elapsed_s":"0"}"#]],
);
}

#[test]
Expand All @@ -29,6 +35,7 @@ fn discover_case() {
name: "Hello\tworld!".to_owned(),
mode: libtest_json::RunMode::Test,
run: true,
elapsed_s: None,
},
str![[r#"{"event":"discover_case","name":"Hello\tworld!"}"#]],
);
Expand All @@ -38,8 +45,11 @@ fn discover_case() {
name: "Hello\tworld!".to_owned(),
mode: libtest_json::RunMode::Bench,
run: false,
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[r#"{"event":"discover_case","name":"Hello\tworld!","mode":"bench","run":false}"#]],
str![[
r#"{"event":"discover_case","name":"Hello\tworld!","mode":"bench","run":false,"elapsed_s":"0"}"#
]],
);
}

Expand All @@ -61,19 +71,33 @@ fn discover_complete() {
#[test]
fn suite_start() {
t(
libtest_json::Event::SuiteStart,
libtest_json::Event::SuiteStart { elapsed_s: None },
str![[r#"{"event":"suite_start"}"#]],
);
t(
libtest_json::Event::SuiteStart {
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[r#"{"event":"suite_start","elapsed_s":"0"}"#]],
);
}

#[test]
fn case_start() {
t(
libtest_json::Event::CaseStart {
name: "Hello\tworld!".to_owned(),
elapsed_s: None,
},
str![[r#"{"event":"case_start","name":"Hello\tworld!"}"#]],
);
t(
libtest_json::Event::CaseStart {
name: "Hello\tworld!".to_owned(),
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
},
str![[r#"{"event":"case_start","name":"Hello\tworld!","elapsed_s":"0"}"#]],
);
}

#[test]
Expand Down
Loading
Loading