1 # Regression test for the Nit project
3 ## Content of the directory
5 This directory contains small Nit programs and useful scripts to test the non regression of the nit tools.
9 * `tests.sh` is the main test script used to run some specific tests.
10 * `testall.sh` runs some tests on all engines.
11 (No more excuse to forget to check your new tests with an obscure engine).
12 * `testfull.sh` runs all tests on a single engine.
13 (go and grab a coffee)
14 * `search_test.sh` lists tests given a testname, a basename, or a `.res` file.
15 Useful when `foo failed` but you do not know where the program `foo` is.
16 * `search_tests_git.sh` lists tests that seem modified between 2 git revisions.
17 Useful before committing something.
18 * `listfull.sh` lists tests that are run by `testfull.sh`.
19 It is used by other scripts but can be used by human to see what is tested.
21 Currently, all files in `tests/`, `lib/` and `examples/` are executed, some of `contrib/` and the main programs of `src/`.
22 To update the list of tested files, just edit this script.
24 ### Small Nit programs
26 They are divided in categories:
28 * `base` are minimal and fundamental tests.
29 They are small and test the fundamental language specifications.
30 * `bench` are memory and time tests
31 * `error` are invalid programs
32 They test the error message and the good behavior of the tool.
33 Nowadays, alternatives (see below) are more used to test erroneous programs.
34 * `example` are examples
35 Nowadays, examples are developed in the `examples/` root directory.
36 * `test` are others tests that usually depend on standard or other libraries.
37 Nowadays, nitunit are a better place for them.
38 * `shootout` are benchmarks from http://shootout.alioth.debian.org/
42 The .gitignore contains specific artefacts produced by some tests.
43 However, it is better to produce these artifacts in the `out` directory instead,
44 because `out` is cleaned before running tests (so that old artefacts do not
45 interfere with new executions of tests)
47 The `sav/` directory contains reference result files for tests (see below)
49 The `alt/` and `out/` directory are transient directories used during the tests.
51 The `zzz_tests/` directory contains tests to test the test system.
52 Execute `./tests.ss zzz_tests/*.nit` if you want.
57 ./tests.sh filepath.nit...
58 ./tests.sh base_attr*.nit
61 Will execute the program filepath for all its alternative (see below) and all its arguments (see below) for the default engine (see below).
63 The output is something like
65 => test_args: . [ok] out/test_args.res sav/test_args.res
68 where in order, there is
70 * The test description (`test_args` in the example).
71 It is the basename of the file + information about alternatives and arguments.
72 * The build status: `.`, `!`, or `nocc`, or `_`.
73 They respectively mean "compilation OK", "compilation error", "compilation skipped", "compilation OK but execution skipped".
74 * The test status (see below) where `out/*.res` is the produced result file, and `sav/*.res` is the reference result file.
81 `[ok] out/zzz_test_ok.res sav/zzz_test_ok.res`
83 The produced result file correspond to the reference result file (according to `diff`).
88 `[0k] out/zzz_test_0k.res is empty`
90 The produced result file is empty and no reference result file is present.
93 If you introduced a new library, it is likely that you get this.
94 It basically means that the module compile and does noting, and its fine.
98 `[======= fail out/zzz_test_fail.res sav/zzz_test_fail.res =======]`
100 The produced result file do not correspond to the reference result file.
103 Did something break? or does the reference result file need to be updated?
107 `[=== no sav ===] out/zzz_test_nosav.res is not empty`
109 The produced result file is not empty but no reference result file is present.
112 Did something break? or does the reference result file need to be created?
113 If you introduced a new program, it is likely that you get this.
114 It basically means the program compiles and produces something.
115 Please create a new reference result file for it.
119 `[======= soso out/zzz_test_soso.res sav//zzz_test_soso.res =======]`
121 The produced result file do not correspond to the reference result file.
122 But the difference in only in errors or warnings.
125 Usually, some lines in error messages changed.
126 So just update the reference result file.
130 `[fixme] out/zzz_test_fixme.res sav//fixme/zzz_test_fixme.res`
132 The produced result file correspond to a *fixme* reference result file.
133 It is an expected error. So not a regression.
135 Reference result files in `sav/**/fixme/` are considered expected errors.
136 The distinction with standard reference result files is only for final statistics.
138 ### Ok, but fixme remains
140 `[*ok*] out/zzz_test_fixme_remains.res sav//zzz_test_fixme_remains.res - but sav//fixme/zzz_test_fixme_remains.res remains!`
142 There is a fixme reference result file and a standard reference result file. But the produced result file correspond to the standard one.
143 Usually it means that a bug was fixed. But is considered a regression until the *fixme* reference result file is removed.
148 `[======= changed out/zzz_test_fixme_changed.res sav//fixme/zzz_test_fixme_changed.res ======]`
150 The produced result file do not correspond to the *fixme* reference result file.
151 It is a failure, and analogous to the standard `fail`.
153 ### Todo, not yet implemented
155 `[todo] out/zzz_test_todo.res -> not yet implemented`
157 The produced result file contains the magic string "NOT YET IMPLEMENTED".
158 Those are considered the same as expected errors (like a fixme)
161 Some engines, libraries or program just print this to simplify the management of tests.
170 The `$engine.skip` files (where `$engine` is an engine name, see below) describe tests that are skipped completely on a given engine.
171 Usually it used with then engine `niti` because tests are too long.
173 The `cc.skip` file describes tests that are analysed but no executable is generated.
174 Usually it is because expected CC errors or missing C libraries.
176 The `exec.skip` file describes tests that compiled but not executed.
177 Usually it is because the programs are interactive or run some kind of server.
179 These `*.skip` files contain a list of patterns that will be used against test names.
180 A single substring can thus be used to skip a full family of tests.
182 ## Update reference result files
184 To update the reference result files, just create/remove/update files in the `sav/` directory.
186 HINT: for easy management, just copy-paste parts of the test status to build your command.
187 Example `cp <copy-paste out/zzz_test_fail.res sav/zzz_test_fail.res>` to update a file.
190 If a reference result file contains only `UNDEFINED`, then the produced result file is always considered successful.
191 It is used to store system-dependant *fixme* reference result files.
192 Once the problem is solved, the status will become `Ok but fixme remains`
195 Note: `UNDEFINED` still gives a success even if the tests is uncompilable.
196 So do not use it for standard reference result files.
197 Use the various skipping or controls to try to produce reproducible results.
202 Engines are selected with the option `--engine`.
205 ./tests.sh --engine nitg-e base_class_name.nit
210 * `nitg-s`, for `nitg --separate` (this is the default)
211 * `nitg-e`, for `nitg --erasure`
212 * `nitg-sg`, for `nitg --separate --semi-global`
213 * `nitg-g`, for `nitg --global`
214 * `niti`, for `nit`, the interpreter
215 * `nitvm`, for `nitvm` (not automatically executed by `testall.sh`)
216 * `emscripten`, for `nitg --semi-global -m emscripten` (not automatically executed by `testall.sh`)
220 * How tests are run: compiled or interpreted? which binary? what options?
221 * Where to find the reference result files.
222 The sav/ directory contains subdirectories per engine that are used to store specific reference result files.
223 Specific reference result files override the generic ones.
228 See `README_alternatives.md`
231 ## Controlling the execution of program tests
236 Argument files `*.args` are used to run program tests with specific command line arguments.
238 * `foo.args` are used for the test file basenamed `foo`.
239 * `foo_*alt*.args` are used for specific alternatives if they exists.
241 Each line of an argument file produces an additional distinct test, with its own testname and reference result files.
244 The first test, with a short arrow `=>`, is the test executed without any arguments.
245 Other tests are arguments tests and have a longer arrow `==>`.
246 If the first test does not produce an executapel, arguments tests are not run.
251 $ tail zzz_test_args.args zzz_tests/zzz_test_args.nit
252 $ ./tests.sh zzz_tests/zzz_test_args.nit
253 $ tail out/zzz_test_args*.res
259 By default, stdin is read from `/dev/null.`
260 Specific tests may need prepared inputs.
262 The `*.inputs` files are used to provide inputs during the execution of program tests.
264 * `foo.inputs` are used for the test file basenamed `foo`
265 * `foo_*alt*_args*.args` are used for specific alternatives and/or arguments if they exists.
270 $ tail zzz_test_in.inputs zzz_tests/zzz_test_in.nit
271 $ ./tests.sh zzz_tests/zzz_test_in.nit
272 $ cat out/zzz_test_in.res
276 ### Output and generated files
278 The stdout and stderr are redirected to the produced result file.
280 Sometimes, files are also produced by the programs.
281 In order to check those files, a special path by testname is watched.
282 Its name is `out/foo.write` where `foo` is the complete testname (with alts and args).
284 The shell variable `$WRITE` can be used in `*.args` file in order to give the correct path to the program.
286 If it exists, the content of the `$WRITE` file is appended at the end of the produced result file.
287 If `$WRITE` is created as a directory, then the names of files in this directory is appended.
292 $ tail zzz_test_write.args zzz_tests/zzz_test_write.nit
293 $ ./tests.sh zzz_tests/zzz_test_write.nit
294 $ cat out/zzz_test_write.out
300 Some simple post-processing can be executed after each tests associated to a line in a `.args` file.
302 In `*.args` files, semicolons can be used to introduce and separate additional shell commands.
305 $ tail zzz_test_post_proc.args zzz_tests/zzz_test_post_proc.nit
306 $ ./tests.sh zzz_tests/zzz_test_post_proc.nit
307 $ cat out/zzz_test_post_proc.res
311 ### Environment variable
313 The environment variable `NIT_TESTING` is set to `true` during the execution of program tests.
314 Some libraries of programs can use it to produce specific reproducible results ; or just to exit their executions.
317 $ cat zzz_tests/zzz_test_envvar.nit
318 $ ./tests.sh zzz_tests/zzz_test_envvar.nit
319 $ cat out/zzz_test_post_proc.res