summary refs log tree commit diff stats
path: root/tests/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/readme.md')
-rw-r--r--tests/readme.md39
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.
profani-tty/blame/tests/config/stub_accounts.c?id=69fe6c4d21d885f1397172605e8babe639a945c5'>^
5be9ac32 ^



05bf9bb9 ^

5be9ac32 ^



71dbd7fd ^

5be9ac32 ^




c20e38a4 ^


5be9ac32 ^



c20e38a4 ^













5be9ac32 ^

5be9ac32 ^
c20e38a4 ^












6af10696 ^





c20e38a4 ^

















5be9ac32 ^
54e225aa ^
b484411e ^
475dfebd ^
904a5a81 ^
53fc89f7 ^
6640a089 ^
c20e38a4 ^






5be9ac32 ^




54e225aa ^




5be9ac32 ^

c20e38a4 ^































5be9ac32 ^

5be9ac32 ^







6af10696 ^
5be9ac32 ^


475dfebd ^
904a5a81 ^
53fc89f7 ^
5be9ac32 ^
482eea4f ^



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203