Skip to content

fix(json)!: Bring schema up to modern cargo expectations #99

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.

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 11 commits into from
Jul 21, 2025
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
1 change: 1 addition & 0 deletions crates/libtest-json/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ schemars = { version = "1.0.0-alpha.17", features = ["preserve_order", "semver1"

[dev-dependencies]
snapbox = "0.6.21"
serde_json = "1.0.96"

[lints]
workspace = true
68 changes: 30 additions & 38 deletions crates/libtest-json/event.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"properties": {
"event": {
"type": "string",
"const": "discover-start"
"const": "discover_start"
}
},
"required": [
Expand All @@ -24,42 +24,47 @@
"$ref": "#/$defs/RunMode"
},
"run": {
"description": "Whether selected to be run by the user",
"type": "boolean"
},
"event": {
"type": "string",
"const": "discover-case"
"const": "discover_case"
}
},
"required": [
"event",
"name",
"mode",
"run"
"name"
]
},
{
"type": "object",
"properties": {
"elapsed_s": {
"$ref": "#/$defs/Elapsed"
"anyOf": [
{
"$ref": "#/$defs/Elapsed"
},
{
"type": "null"
}
]
},
"event": {
"type": "string",
"const": "discover-complete"
"const": "discover_complete"
}
},
"required": [
"event",
"elapsed_s"
"event"
]
},
{
"type": "object",
"properties": {
"event": {
"type": "string",
"const": "suite-start"
"const": "suite_start"
}
},
"required": [
Expand All @@ -74,7 +79,7 @@
},
"event": {
"type": "string",
"const": "case-start"
"const": "case_start"
}
},
"required": [
Expand All @@ -92,6 +97,7 @@
"$ref": "#/$defs/RunMode"
},
"status": {
"description": "`None` means success",
"anyOf": [
{
"$ref": "#/$defs/RunStatus"
Expand Down Expand Up @@ -119,29 +125,34 @@
},
"event": {
"type": "string",
"const": "case-complete"
"const": "case_complete"
}
},
"required": [
"event",
"name",
"mode"
"name"
]
},
{
"type": "object",
"properties": {
"elapsed_s": {
"$ref": "#/$defs/Elapsed"
"anyOf": [
{
"$ref": "#/$defs/Elapsed"
},
{
"type": "null"
}
]
},
"event": {
"type": "string",
"const": "suite-complete"
"const": "suite_complete"
}
},
"required": [
"event",
"elapsed_s"
"event"
]
}
],
Expand All @@ -154,26 +165,7 @@
]
},
"Elapsed": {
"$ref": "#/$defs/Duration"
},
"Duration": {
"type": "object",
"properties": {
"secs": {
"type": "integer",
"format": "uint64",
"minimum": 0
},
"nanos": {
"type": "integer",
"format": "uint32",
"minimum": 0
}
},
"required": [
"secs",
"nanos"
]
"type": "string"
},
"RunStatus": {
"type": "string",
Expand Down
85 changes: 73 additions & 12 deletions crates/libtest-json/src/event.rs
Original file line number Diff line number Diff line change
@@ -1,34 +1,65 @@
#[derive(Clone, Debug)]
#[cfg_attr(feature = "unstable-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
#[cfg_attr(feature = "serde", serde(tag = "event"))]
pub enum Event {
DiscoverStart,
DiscoverCase {
name: String,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "RunMode::is_default")
)]
mode: RunMode,
/// Whether selected to be run by the user
#[cfg_attr(
feature = "serde",
serde(default = "true_default", skip_serializing_if = "is_true")
)]
run: bool,
},
DiscoverComplete {
#[allow(dead_code)]
elapsed_s: Elapsed,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
SuiteStart,
CaseStart {
name: String,
},
CaseComplete {
name: String,
#[allow(dead_code)]
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "RunMode::is_default")
)]
mode: RunMode,
/// `None` means success
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
status: Option<RunStatus>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
message: Option<String>,
#[allow(dead_code)]
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
SuiteComplete {
elapsed_s: Elapsed,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
elapsed_s: Option<Elapsed>,
},
}

Expand All @@ -39,10 +70,18 @@ impl Event {
}
}

fn true_default() -> bool {
true
}

fn is_true(yes: &bool) -> bool {
*yes
}

#[derive(Copy, Clone, Default, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "unstable-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
pub enum RunMode {
#[default]
Test,
Expand All @@ -56,21 +95,26 @@ impl RunMode {
Self::Bench => "bench",
}
}

fn is_default(&self) -> bool {
*self == Default::default()
}
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "unstable-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
pub enum RunStatus {
Ignored,
Failed,
}

#[derive(Copy, Clone, Default, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "unstable-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(into = "String"))]
#[cfg_attr(feature = "serde", serde(try_from = "String"))]
pub struct Elapsed(pub std::time::Duration);

impl std::fmt::Display for Elapsed {
Expand All @@ -79,6 +123,23 @@ impl std::fmt::Display for Elapsed {
}
}

impl std::str::FromStr for Elapsed {
type Err = std::num::ParseFloatError;

fn from_str(src: &str) -> Result<Self, Self::Err> {
let secs = src.parse()?;
Ok(Elapsed(std::time::Duration::from_secs_f64(secs)))
}
}

impl TryFrom<String> for Elapsed {
type Error = std::num::ParseFloatError;

fn try_from(inner: String) -> Result<Self, Self::Error> {
inner.parse()
}
}

impl From<Elapsed> for String {
fn from(elapsed: Elapsed) -> Self {
elapsed.0.as_secs_f64().to_string()
Expand Down
Loading
Loading