Skip to content

Commit 4a09545

Browse files
committed
docs(design): Cover more ground on json format
1 parent 8cb9090 commit 4a09545

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

DESIGN.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,20 @@ Care abouts
2020

2121
See also [eRFC 3558](https://github.com/rust-lang/rfcs/pull/3558)
2222

23+
Current proposal:
24+
- [serde definition](https://github.com/assert-rs/libtest2/blob/main/crates/libtest-json/src/event.rs)
25+
- [JSONSchema](https://github.com/assert-rs/libtest2/blob/main/crates/libtest-json/event.schema.json)
26+
- [example output](https://github.com/assert-rs/libtest2/blob/main/crates/libtest2-mimic/tests/testsuite/mixed_bag.rs)
27+
28+
Decisions
29+
- Always report discovery
30+
- Allows callers to provide a progress indicator
31+
- Replaces the need for harnesses to provide statistics
32+
2333
### Prior Art
2434

35+
#### libtest's existing format
36+
2537
[libtest's existing format](https://github.com/rust-lang/rust/blob/master/library/test/src/formatters/json.rs) (as ndjson):
2638
```json
2739
[
@@ -107,6 +119,24 @@ See also [eRFC 3558](https://github.com/rust-lang/rfcs/pull/3558)
107119
- Does not convey units
108120
- No extension point for special reporters
109121

122+
#### TAP
123+
124+
[TAP](https://testanything.org/tap-version-14-specification.html)
125+
126+
#### pytest-json-report
127+
128+
[pytest-json-report](https://github.com/numirias/pytest-json-report)
129+
130+
#### pytest-reportlog
131+
132+
[pytest-reportlog](https://github.com/pytest-dev/pytest-reportlog)
133+
134+
Endorsed in [pytest's docs](https://docs.pytest.org/en/latest/deprecations.html#result-log-result-log)
135+
136+
#### subunit
137+
138+
[subunit](https://github.com/testing-cabal/subunit) ([rust impl](https://github.com/mtreinish/subunit-rust))
139+
110140
## lexarg
111141

112142
Goal: provide an API-stable CLI parser for inclusion in APIs for plugin-specific CLI args

0 commit comments

Comments
 (0)