Skip to content

Commit 9aad038

Browse files
epageepage
authored
fix(schema)!: Clarify naming (#108)
2 parents 477aed1 + 6fa5eda commit 9aad038

9 files changed

Lines changed: 344 additions & 360 deletions

File tree

‎crates/libtest-json/event.schema.json‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"mode": {
3434
"$ref": "#/$defs/RunMode"
3535
},
36-
"run": {
36+
"selected": {
3737
"description": "Whether selected to be run by the user",
3838
"type": "boolean"
3939
},
@@ -94,7 +94,7 @@
9494
},
9595
"event": {
9696
"type": "string",
97-
"const": "suite_start"
97+
"const": "run_start"
9898
}
9999
},
100100
"required": [
@@ -133,9 +133,6 @@
133133
"name": {
134134
"type": "string"
135135
},
136-
"mode": {
137-
"$ref": "#/$defs/RunMode"
138-
},
139136
"status": {
140137
"description": "`None` means success",
141138
"anyOf": [
@@ -188,7 +185,7 @@
188185
},
189186
"event": {
190187
"type": "string",
191-
"const": "suite_complete"
188+
"const": "run_complete"
192189
}
193190
},
194191
"required": [

‎crates/libtest-json/src/event.rs‎

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pub enum Event {
2323
feature = "serde",
2424
serde(default = "true_default", skip_serializing_if = "is_true")
2525
)]
26-
run: bool,
26+
selected: bool,
2727
#[cfg_attr(
2828
feature = "serde",
2929
serde(default, skip_serializing_if = "Option::is_none")
@@ -37,7 +37,7 @@ pub enum Event {
3737
)]
3838
elapsed_s: Option<Elapsed>,
3939
},
40-
SuiteStart {
40+
RunStart {
4141
#[cfg_attr(
4242
feature = "serde",
4343
serde(default, skip_serializing_if = "Option::is_none")
@@ -54,11 +54,6 @@ pub enum Event {
5454
},
5555
CaseComplete {
5656
name: String,
57-
#[cfg_attr(
58-
feature = "serde",
59-
serde(default, skip_serializing_if = "RunMode::is_default")
60-
)]
61-
mode: RunMode,
6257
/// `None` means success
6358
#[cfg_attr(
6459
feature = "serde",
@@ -76,7 +71,7 @@ pub enum Event {
7671
)]
7772
elapsed_s: Option<Elapsed>,
7873
},
79-
SuiteComplete {
74+
RunComplete {
8075
#[cfg_attr(
8176
feature = "serde",
8277
serde(default, skip_serializing_if = "Option::is_none")
@@ -108,7 +103,7 @@ impl Event {
108103
Self::DiscoverCase {
109104
name,
110105
mode,
111-
run,
106+
selected,
112107
elapsed_s,
113108
} => {
114109
buffer.key("event").unwrap();
@@ -127,11 +122,11 @@ impl Event {
127122
buffer.value(mode.as_str()).unwrap();
128123
}
129124

130-
if !run {
125+
if !selected {
131126
buffer.val_sep().unwrap();
132-
buffer.key("run").unwrap();
127+
buffer.key("selected").unwrap();
133128
buffer.keyval_sep().unwrap();
134-
buffer.value(run).unwrap();
129+
buffer.value(selected).unwrap();
135130
}
136131

137132
if let Some(elapsed_s) = elapsed_s {
@@ -153,10 +148,10 @@ impl Event {
153148
buffer.value(String::from(*elapsed_s)).unwrap();
154149
}
155150
}
156-
Self::SuiteStart { elapsed_s } => {
151+
Self::RunStart { elapsed_s } => {
157152
buffer.key("event").unwrap();
158153
buffer.keyval_sep().unwrap();
159-
buffer.value("suite_start").unwrap();
154+
buffer.value("run_start").unwrap();
160155

161156
if let Some(elapsed_s) = elapsed_s {
162157
buffer.val_sep().unwrap();
@@ -184,7 +179,6 @@ impl Event {
184179
}
185180
Self::CaseComplete {
186181
name,
187-
mode,
188182
status,
189183
message,
190184
elapsed_s,
@@ -198,13 +192,6 @@ impl Event {
198192
buffer.keyval_sep().unwrap();
199193
buffer.value(name).unwrap();
200194

201-
if !mode.is_default() {
202-
buffer.val_sep().unwrap();
203-
buffer.key("mode").unwrap();
204-
buffer.keyval_sep().unwrap();
205-
buffer.value(mode.as_str()).unwrap();
206-
}
207-
208195
if let Some(status) = status {
209196
buffer.val_sep().unwrap();
210197
buffer.key("status").unwrap();
@@ -226,10 +213,10 @@ impl Event {
226213
buffer.value(String::from(*elapsed_s)).unwrap();
227214
}
228215
}
229-
Self::SuiteComplete { elapsed_s } => {
216+
Self::RunComplete { elapsed_s } => {
230217
buffer.key("event").unwrap();
231218
buffer.keyval_sep().unwrap();
232-
buffer.value("suite_complete").unwrap();
219+
buffer.value("run_complete").unwrap();
233220

234221
if let Some(elapsed_s) = elapsed_s {
235222
buffer.val_sep().unwrap();

‎crates/libtest-json/tests/roundtrip.rs‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ fn discover_case() {
3434
libtest_json::Event::DiscoverCase {
3535
name: "Hello\tworld!".to_owned(),
3636
mode: libtest_json::RunMode::Test,
37-
run: true,
37+
selected: true,
3838
elapsed_s: None,
3939
},
4040
str![[r#"{"event":"discover_case","name":"Hello\tworld!"}"#]],
@@ -44,11 +44,11 @@ fn discover_case() {
4444
libtest_json::Event::DiscoverCase {
4545
name: "Hello\tworld!".to_owned(),
4646
mode: libtest_json::RunMode::Bench,
47-
run: false,
47+
selected: false,
4848
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
4949
},
5050
str![[
51-
r#"{"event":"discover_case","name":"Hello\tworld!","mode":"bench","run":false,"elapsed_s":"0"}"#
51+
r#"{"event":"discover_case","name":"Hello\tworld!","mode":"bench","selected":false,"elapsed_s":"0"}"#
5252
]],
5353
);
5454
}
@@ -71,14 +71,14 @@ fn discover_complete() {
7171
#[test]
7272
fn suite_start() {
7373
t(
74-
libtest_json::Event::SuiteStart { elapsed_s: None },
75-
str![[r#"{"event":"suite_start"}"#]],
74+
libtest_json::Event::RunStart { elapsed_s: None },
75+
str![[r#"{"event":"run_start"}"#]],
7676
);
7777
t(
78-
libtest_json::Event::SuiteStart {
78+
libtest_json::Event::RunStart {
7979
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
8080
},
81-
str![[r#"{"event":"suite_start","elapsed_s":"0"}"#]],
81+
str![[r#"{"event":"run_start","elapsed_s":"0"}"#]],
8282
);
8383
}
8484

@@ -105,7 +105,6 @@ fn case_complete() {
105105
t(
106106
libtest_json::Event::CaseComplete {
107107
name: "Hello\tworld!".to_owned(),
108-
mode: libtest_json::RunMode::Test,
109108
status: None,
110109
message: None,
111110
elapsed_s: None,
@@ -116,28 +115,27 @@ fn case_complete() {
116115
t(
117116
libtest_json::Event::CaseComplete {
118117
name: "Hello\tworld!".to_owned(),
119-
mode: libtest_json::RunMode::Bench,
120118
status: Some(libtest_json::RunStatus::Ignored),
121119
message: Some("This\tfailed".to_owned()),
122120
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
123121
},
124122
str![[
125-
r#"{"event":"case_complete","name":"Hello\tworld!","mode":"bench","status":"ignored","message":"This\tfailed","elapsed_s":"0"}"#
123+
r#"{"event":"case_complete","name":"Hello\tworld!","status":"ignored","message":"This\tfailed","elapsed_s":"0"}"#
126124
]],
127125
);
128126
}
129127

130128
#[test]
131129
fn suite_complete() {
132130
t(
133-
libtest_json::Event::SuiteComplete { elapsed_s: None },
134-
str![[r#"{"event":"suite_complete"}"#]],
131+
libtest_json::Event::RunComplete { elapsed_s: None },
132+
str![[r#"{"event":"run_complete"}"#]],
135133
);
136134

137135
t(
138-
libtest_json::Event::SuiteComplete {
136+
libtest_json::Event::RunComplete {
139137
elapsed_s: Some(libtest_json::Elapsed(Default::default())),
140138
},
141-
str![[r#"{"event":"suite_complete","elapsed_s":"0"}"#]],
139+
str![[r#"{"event":"run_complete","elapsed_s":"0"}"#]],
142140
);
143141
}

‎crates/libtest2-harness/src/harness.rs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ fn discover(
230230
notifier.notify(notify::Event::DiscoverCase {
231231
name: case.name().to_owned(),
232232
mode: RunMode::Test,
233-
run: retain_case,
233+
selected: retain_case,
234234
elapsed_s: Some(notify::Elapsed(start.elapsed())),
235235
})?;
236236
}
@@ -250,7 +250,7 @@ fn run(
250250
cases: Vec<Box<dyn Case>>,
251251
notifier: &mut dyn notify::Notifier,
252252
) -> std::io::Result<bool> {
253-
notifier.notify(notify::Event::SuiteStart {
253+
notifier.notify(notify::Event::RunStart {
254254
elapsed_s: Some(notify::Elapsed(start.elapsed())),
255255
})?;
256256

@@ -398,7 +398,7 @@ fn run(
398398
}
399399
}
400400

401-
notifier.notify(notify::Event::SuiteComplete {
401+
notifier.notify(notify::Event::RunComplete {
402402
elapsed_s: Some(notify::Elapsed(start.elapsed())),
403403
})?;
404404

@@ -440,7 +440,6 @@ fn run_case(
440440
let message = err.and_then(|e| e.cause().map(|c| c.to_string()));
441441
notifier.notify(notify::Event::CaseComplete {
442442
name: case.name().to_owned(),
443-
mode: RunMode::Test,
444443
status,
445444
message,
446445
elapsed_s: Some(notify::Elapsed(start.elapsed())),

‎crates/libtest2-harness/src/notify/pretty.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ impl<W: std::io::Write> super::Notifier for PrettyRunNotifier<W> {
3232
self.summary.notify(event.clone())?;
3333
match event {
3434
Event::DiscoverStart { .. } => {}
35-
Event::DiscoverCase { name, run, .. } => {
36-
if run {
35+
Event::DiscoverCase { name, selected, .. } => {
36+
if selected {
3737
self.name_width = name.len().max(self.name_width);
3838
}
3939
}
4040
Event::DiscoverComplete { .. } => {}
41-
Event::SuiteStart { .. } => {
41+
Event::RunStart { .. } => {
4242
self.summary.write_start(&mut self.writer)?;
4343
}
4444
Event::CaseStart { name, .. } => {
@@ -59,7 +59,7 @@ impl<W: std::io::Write> super::Notifier for PrettyRunNotifier<W> {
5959
}
6060
writeln!(self.writer, "{style}{s}{style:#}")?;
6161
}
62-
Event::SuiteComplete { .. } => {
62+
Event::RunComplete { .. } => {
6363
self.summary.write_complete(&mut self.writer)?;
6464
}
6565
}

‎crates/libtest2-harness/src/notify/summary.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,15 @@ impl super::Notifier for Summary {
8888
fn notify(&mut self, event: Event) -> std::io::Result<()> {
8989
match event {
9090
Event::DiscoverStart { .. } => {}
91-
Event::DiscoverCase { run, .. } => {
92-
if run {
91+
Event::DiscoverCase { selected, .. } => {
92+
if selected {
9393
self.num_run += 1;
9494
} else {
9595
self.num_filtered_out += 1;
9696
}
9797
}
9898
Event::DiscoverComplete { .. } => {}
99-
Event::SuiteStart { .. } => {}
99+
Event::RunStart { .. } => {}
100100
Event::CaseStart { .. } => {}
101101
Event::CaseComplete {
102102
name,
@@ -115,7 +115,7 @@ impl super::Notifier for Summary {
115115
self.num_passed += 1;
116116
}
117117
},
118-
Event::SuiteComplete { elapsed_s, .. } => {
118+
Event::RunComplete { elapsed_s, .. } => {
119119
self.elapsed_s = elapsed_s;
120120
}
121121
}

‎crates/libtest2-harness/src/notify/terse.rs‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@ impl<W: std::io::Write> super::Notifier for TerseListNotifier<W> {
2121
match event {
2222
Event::DiscoverStart { .. } => {}
2323
Event::DiscoverCase {
24-
name, mode, run, ..
24+
name,
25+
mode,
26+
selected,
27+
..
2528
} => {
26-
if run {
29+
if selected {
2730
let mode = mode.as_str();
2831
writeln!(self.writer, "{name}: {mode}")?;
2932
self.tests += 1;
@@ -34,10 +37,10 @@ impl<W: std::io::Write> super::Notifier for TerseListNotifier<W> {
3437
writeln!(self.writer, "{} tests", self.tests)?;
3538
writeln!(self.writer)?;
3639
}
37-
Event::SuiteStart { .. } => {}
40+
Event::RunStart { .. } => {}
3841
Event::CaseStart { .. } => {}
3942
Event::CaseComplete { .. } => {}
40-
Event::SuiteComplete { .. } => {}
43+
Event::RunComplete { .. } => {}
4144
}
4245
Ok(())
4346
}
@@ -65,7 +68,7 @@ impl<W: std::io::Write> super::Notifier for TerseRunNotifier<W> {
6568
Event::DiscoverStart { .. } => {}
6669
Event::DiscoverCase { .. } => {}
6770
Event::DiscoverComplete { .. } => {}
68-
Event::SuiteStart { .. } => {
71+
Event::RunStart { .. } => {
6972
self.summary.write_start(&mut self.writer)?;
7073
}
7174
Event::CaseStart { .. } => {}
@@ -78,7 +81,7 @@ impl<W: std::io::Write> super::Notifier for TerseRunNotifier<W> {
7881
write!(self.writer, "{style}{c}{style:#}")?;
7982
self.writer.flush()?;
8083
}
81-
Event::SuiteComplete { .. } => {
84+
Event::RunComplete { .. } => {
8285
self.summary.write_complete(&mut self.writer)?;
8386
}
8487
}

0 commit comments

Comments
 (0)