diff options
Diffstat (limited to 'tests/readme.md')
| -rw-r--r-- | tests/readme.md | 37 |
1 files changed, 7 insertions, 30 deletions
diff --git a/tests/readme.md b/tests/readme.md index b9b8abd39..f638ddc10 100644 --- a/tests/readme.md +++ b/tests/readme.md @@ -2,21 +2,20 @@ This directory contains the test cases. Each test must have a filename of the form: ``t*.nim`` -**Note:** Tests are only compiled by default. In order to get the tester to -execute the compiled binary, you need to specify a spec with an ``action`` key -(see below for details). +**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#L132) in the ``specs`` module for a full and reliable reference** +**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: compile** +**Default: run** Options: @@ -28,35 +27,13 @@ Options: There are certain spec keys that imply ``run``, including ``output`` and ``outputsub``. -## cmd - -Specifies the Nim command to use for compiling the test. - -There are a number of variables that are replaced in this spec option: - -* ``$target`` - the compilation target, e.g. ``c``. -* ``$options`` - the options for the compiler. -* ``$file`` - the filename of the test. -* ``$filedir`` - the directory of the test file. - -Example: - -```nim -discard """ - cmd: "nim $target --nimblePath:./nimbleDir/simplePkgs $options $file" -""" -``` - # Categories Each folder under this directory represents a test category, which can be -tested by running `koch tests cat <category>`. - -The folder ``rodfiles`` contains special tests that test incremental -compilation via symbol files. +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. It includes a C -client and platform specific build files for manual compilation. +can run properly without linking against the nimrtl.dll/so. |