diff options
Diffstat (limited to 'tests/readme.md')
-rw-r--r-- | tests/readme.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/tests/readme.md b/tests/readme.md new file mode 100644 index 000000000..f638ddc10 --- /dev/null +++ b/tests/readme.md @@ -0,0 +1,39 @@ +This directory contains the test cases. + +Each test must have a filename of the form: ``t*.nim`` + +**Note:** [Testament](https://nim-lang.github.io/Nim/testament.html) is only aware of tests under a directory (eg `tests/foo/`) and will ignore +top-level tests like `tests/tbar.nim`. + +# Specs + +Each test can contain a spec in a ``discard """ ... """`` block. + +**Check out the [``parseSpec`` procedure](https://github.com/nim-lang/Nim/blob/devel/testament/specs.nim#L315) in the ``specs`` module for a full and reliable reference** + +## action + +Specifies what action this test should take. + +**Default: run** + +Options: + +* ``compile`` - compiles the module and fails the test if compilations fails. +* ``run`` - compiles and runs the module, fails the test if compilation or + execution of test code fails. +* ``reject`` - compiles the module and fails the test if compilation succeeds. + +There are certain spec keys that imply ``run``, including ``output`` and +``outputsub``. + +# Categories + +Each folder under this directory represents a test category, which can be +tested by running `koch tests pcat <category>` (or `cat` to avoid parallel +testing, which is slower). + +The folder ``dll`` contains simple DLL tests. + +The folder ``realtimeGC`` contains a test for validating that the realtime GC +can run properly without linking against the nimrtl.dll/so. |