diff options
Diffstat (limited to 'docs/TESTS.md')
-rw-r--r-- | docs/TESTS.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/TESTS.md b/docs/TESTS.md new file mode 100644 index 000000000..8005ec9da --- /dev/null +++ b/docs/TESTS.md | |||
@@ -0,0 +1,30 @@ | |||
1 | # libsyntax2.0 testing infrastructure | ||
2 | |||
3 | Libsyntax2.0 tests are in the `tests/data` directory. Each test is a | ||
4 | pair of files, an `.rs` file with Rust code and a `.txt` file with a | ||
5 | human-readable representation of syntax tree. | ||
6 | |||
7 | The test suite is intended to be independent from a particular parser: | ||
8 | that's why it is just a list of files. | ||
9 | |||
10 | The test suite is intended to be progressive: that is, if you want to | ||
11 | write a Rust parser, you can TDD it by working through the test in | ||
12 | order. That's why each test file begins with the number. Generally, | ||
13 | tests should be added in order of the appearance of corresponding | ||
14 | functionality in libsytnax2.0. If a bug in parser is uncovered, a | ||
15 | **new** test should be created instead of modifying an existing one: | ||
16 | it is preferable to have a gazillion of small isolated test files, | ||
17 | rather than a single file which covers all edge cases. It's okay for | ||
18 | files to have the same name except for the leading number. In general, | ||
19 | test suite should be append-only: old tests should not be modified, | ||
20 | new tests should be created instead. | ||
21 | |||
22 | |||
23 | Note that only `ok` tests are normative: `err` tests test error | ||
24 | recovery and it is totally ok for a parser to not implement any error | ||
25 | recovery at all. However, for libsyntax2.0 we do care about error | ||
26 | recovery, and we do care about precise and useful error messages. | ||
27 | |||
28 | |||
29 | Contribution opportunity: design and implement testing infrastructure | ||
30 | for validators. | ||