Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 13:03:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document inline tests infra

Browse source
This commit is contained in:
Aleksey Kladov 2018-02-03 22:39:01 +03:00
parent 9b3d806b0d
commit 2fd3228525
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/TESTS.md
View file

@ -19,12 +19,26 @@ files to have the same name except for the leading number. In general,
test suite should be append-only: old tests should not be modified, test suite should be append-only: old tests should not be modified,
new tests should be created instead. new tests should be created instead.
Note that only `ok` tests are normative: `err` tests test error Note that only `ok` tests are normative: `err` tests test error
recovery and it is totally ok for a parser to not implement any error recovery and it is totally ok for a parser to not implement any error
recovery at all. However, for libsyntax2.0 we do care about error recovery at all. However, for libsyntax2.0 we do care about error
recovery, and we do care about precise and useful error messages. recovery, and we do care about precise and useful error messages.
There are also so-called "inline tests". They appear as the comments
with a `test` header in the source code, like this:
```rust
// test fn_basic
// fn foo() {}
fn fn_item(p: &mut Parser) {
// ...
}
```
You can run `cargo collect-tests` command to collect all inline tests
into `tests/data/inline` directory. The main advantage of inline tests
is that they help to illustrate what the relevant code is doing.
Contribution opportunity: design and implement testing infrastructure Contribution opportunity: design and implement testing infrastructure
for validators. for validators.