Skip to content

Commit 008ce99

Browse files
committed
Add a README to libtest with a roadmap
1 parent 4c38f19 commit 008ce99

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/libtest/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
WIP - stable libtest
2+
===
3+
4+
The migration of libtest to stable Rust is currently in progress.
5+
6+
You can find libtest at: https://github.com/rust-lang/libtest . If you need to
7+
make a change:
8+
9+
* perform the change there,
10+
* do a new crates.io release, and
11+
* send a PR to rust-lang/rust bumping the libtest version.
12+
13+
## Roadmap
14+
15+
Right now all the contests of libtest live in the external repo.
16+
17+
The next steps are:
18+
19+
* make `#[test]` and `#[ignore]` procedural macros in the prelude by default,
20+
routed to the same procedural macro, so that it doesn't matter which one runs
21+
first.
22+
* move the unstable APIs back into rust-lang/rust to help maintainability
23+
(replacing `pub use libtest::*` with explicit imports)
24+
* migrate libtest to the real `term` crate
25+
* provide `libtest` a real `custom_test_framework` runner (in parallel with the
26+
runner in rust-lang/rust)
27+
* set up `libtest` as a normal `custom_test_framework` inside rust-lang/rust
28+
* refactor the internal structure of `libtest` to make it re-usable by
29+
third-party custom test frameworks (think test formatting, benchmark
30+
formatting, argument parsing, json format serialization, etc.)

0 commit comments

Comments
 (0)