idris-lang/Idris2
1
1
Fork 0
mirror of https://github.com/idris-lang/Idris2.git synced 2024-09-11 13:36:08 +03:00
Code Issues Projects Releases Wiki Activity

[ re #2649 ] Describe test naming pattern

Browse Source
This commit is contained in:
Thomas E. Hansen 2022-11-10 10:59:46 +01:00 committed by CodingCellist
parent e0d6d0881e
commit 643c4be55f
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
tests/README.md
View File

@ -13,3 +13,17 @@ Examples:
- `make test only=idris2/basic001` will run a specific test.
Templates for common test instances can be found in the `templates` folder.
There is no defined naming convention for adding tests, but the pattern has
been:
- a sub-directory in the relevant test section (`idris2`, `refc`, etc.)
- with a descriptive name followed by a 3-digit number (e.g. `envflags001` is
the first test checking the environment flags functions)
- containing:
* an Idris file importing the relevant modules and containing the test
function(s)
* a `run` file which is a shell script that runs the test (see the existing
tests for examples for this)
* an `expected` file containing the expected output