tests/README.md

   1 # Regression test for the Nit project
   2
   3 ## Content of the directory
   4
   5 This directory contains small Nit programs and useful scripts to test the non regression of the nit tools.
   6
   7 ### Useful scripts
   8
   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.
  20
  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.
  23
  24 ### Small Nit programs
  25
  26 They are divided in categories:
  27
  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/
  39
  40 ### Other stuff
  41
  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)
  46
  47 The `sav/` directory contains reference result files for tests (see below)
  48
  49 The `alt/` and `out/` directory are transient directories used during the tests.
  50
  51 The `zzz_tests/` directory contains tests to test the test system.
  52 Execute `./tests.ss zzz_tests/*.nit` if you want.
  53
  54 ## Running tests
  55
  56 ~~~
  57 ./tests.sh filepath.nit...
  58 ./tests.sh base_attr*.nit
  59 ~~~
  60
  61 Will execute the program filepath for all its alternative (see below) and all its arguments (see below) for the default engine (see below).
  62
  63 The output is something like
  64 ~~~
  65 => test_args: . [ok] out/test_args.res sav/test_args.res
  66 ~~~
  67
  68 where in order, there is
  69
  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.
  75
  76
  77 ## Test statuses
  78
  79 ### Ok
  80
  81 `[ok] out/zzz_test_ok.res sav/zzz_test_ok.res`
  82
  83 The produced result file correspond to the reference result file (according to `diff`).
  84 It is a success.
  85
  86 ### 0k, is empty
  87
  88 `[0k] out/zzz_test_0k.res is empty`
  89
  90 The produced result file is empty and no reference result file is present.
  91 It is a success.
  92
  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.
  95
  96 ### Fail
  97
  98 `[======= fail out/zzz_test_fail.res sav/zzz_test_fail.res =======]`
  99
 100 The produced result file do not correspond to the reference result file.
 101 It is a failure.
 102
 103 Did something break? or does the reference result file need to be updated?
 104
 105 ### No sav
 106
 107 `[=== no sav ===] out/zzz_test_nosav.res is not empty`
 108
 109 The produced result file is not empty but no reference result file is present.
 110 It is a failure.
 111
 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.
 116
 117 ### Soso
 118
 119 `[======= soso out/zzz_test_soso.res sav//zzz_test_soso.res =======]`
 120
 121 The produced result file do not correspond to the reference result file.
 122 But the difference in only in errors or warnings.
 123 It is a failure.
 124
 125 Usually, some lines in error messages changed.
 126 So just update the reference result file.
 127
 128 ### Fixme
 129
 130 `[fixme] out/zzz_test_fixme.res sav//fixme/zzz_test_fixme.res`
 131
 132 The produced result file correspond to a *fixme* reference result file.
 133 It is an expected error. So not a regression.
 134
 135 Reference result files in `sav/**/fixme/` are considered expected errors.
 136 The distinction with standard reference result files is only for final statistics.
 137
 138 ### Ok, but fixme remains
 139
 140 `[*ok*] out/zzz_test_fixme_remains.res sav//zzz_test_fixme_remains.res - but sav//fixme/zzz_test_fixme_remains.res remains!`
 141
 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.
 144 It is a failure.
 145
 146 ### Changed fixme
 147
 148 `[======= changed out/zzz_test_fixme_changed.res sav//fixme/zzz_test_fixme_changed.res ======]`
 149
 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`.
 152
 153 ### Todo, not yet implemented
 154
 155 `[todo] out/zzz_test_todo.res -> not yet implemented`
 156
 157 The produced result file contains the magic string "NOT YET IMPLEMENTED".
 158 Those are considered the same as expected errors (like a fixme)
 159 It is a success.
 160
 161 Some engines, libraries or program just print this to simplify the management of tests.
 162
 163 ### Skipped
 164
 165 `[skip]`
 166
 167 The test is skipped.
 168 It is a success.
 169
 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.
 172
 173 The `cc.skip` file describes tests that are analyzed but no executable is generated.
 174 Usually it is because of expected CC errors or missing C libraries.
 175
 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.
 178
 179 The `$os.skip` file describes tests that are to be skipped completely on the given OS.
 180 Usually it is because of OS specific libraries.
 181
 182 These `*.skip` files contain a list of patterns that will be used against test names.
 183 A single substring can thus be used to skip a full family of tests.
 184
 185 ## Update reference result files
 186
 187 To update the reference result files, just create/remove/update files in the `sav/` directory.
 188
 189 HINT: for easy management, just copy-paste parts of the test status to build your command.
 190 Example `cp <copy-paste out/zzz_test_fail.res sav/zzz_test_fail.res>` to update a file.
 191
 192
 193 If a reference result file contains only `UNDEFINED`, then the produced result file is always considered successful.
 194 It is used to store system-dependant *fixme* reference result files.
 195 Once the problem is solved, the status will become `Ok but fixme remains`
 196
 197
 198 Note: `UNDEFINED` still gives a success even if the tests is uncompilable.
 199 So do not use it for standard reference result files.
 200 Use the various skipping or controls to try to produce reproducible results.
 201
 202
 203 ## Engines
 204
 205 Engines are selected with the option `--engine`.
 206
 207 ~~~
 208 ./tests.sh --engine nitg-e base_class_name.nit
 209 ~~~
 210
 211 Current engines are:
 212
 213 * `nitg-s`, for `nitg --separate` (this is the default)
 214 * `nitg-e`, for `nitg --erasure`
 215 * `nitg-sg`, for `nitg --separate --semi-global`
 216 * `nitg-g`, for `nitg --global`
 217 * `niti`, for `nit`, the interpreter
 218 * `nitvm`, for `nitvm` (not automatically executed by `testall.sh`)
 219 * `emscripten`, for `nitg --semi-global -m emscripten` (not automatically executed by `testall.sh`)
 220
 221 Engines control:
 222
 223 * How tests are run: compiled or interpreted? which binary? what options?
 224 * Where to find the reference result files.
 225   The sav/ directory contains subdirectories per engine that are used to store specific reference result files.
 226   Specific reference result files override the generic ones.
 227
 228
 229 ## Alternatives
 230
 231 See `README_alternatives.md`
 232
 233
 234 ## Controlling the execution of program tests
 235
 236
 237 ### Arguments
 238
 239 Argument files `*.args` are used to run program tests with specific command line arguments.
 240
 241 * `foo.args` are used for the test file basenamed `foo`.
 242 * `foo_*alt*.args` are used for specific alternatives if they exists.
 243
 244 Each line of an argument file produces an additional distinct test, with its own testname and reference result files.
 245
 246
 247 The first test, with a short arrow `=>`, is the test executed without any arguments.
 248 Other tests are arguments tests and have a longer arrow `==>`.
 249 If the first test does not produce an executapel, arguments tests are not run.
 250
 251 Example:
 252
 253 ~~~
 254 $ tail zzz_test_args.args zzz_tests/zzz_test_args.nit
 255 $ ./tests.sh zzz_tests/zzz_test_args.nit
 256 $ tail out/zzz_test_args*.res
 257 ~~~
 258
 259
 260 ### Input
 261
 262 By default, stdin is read from `/dev/null.`
 263 Specific tests may need prepared inputs.
 264
 265 The `*.inputs` files are used to provide inputs during the execution of program tests.
 266
 267 * `foo.inputs` are used for the test file basenamed `foo`
 268 * `foo_*alt*_args*.args` are used for specific alternatives and/or arguments if they exists.
 269
 270 Example:
 271
 272 ~~~
 273 $ tail zzz_test_in.inputs zzz_tests/zzz_test_in.nit
 274 $ ./tests.sh zzz_tests/zzz_test_in.nit
 275 $ cat out/zzz_test_in.res
 276 ~~~
 277
 278
 279 ### Output and generated files
 280
 281 The stdout and stderr are redirected to the produced result file.
 282
 283 Sometimes, files are also produced by the programs.
 284 In order to check those files, a special path by testname is watched.
 285 Its name is `out/foo.write` where `foo` is the complete testname (with alts and args).
 286
 287 The shell variable `$WRITE` can be used in `*.args` file in order to give the correct path to the program.
 288
 289 If it exists, the content of the `$WRITE` file is appended at the end of the produced result file.
 290 If `$WRITE` is created as a directory, then the names of files in this directory is appended.
 291
 292 Example:
 293
 294 ~~~
 295 $ tail zzz_test_write.args zzz_tests/zzz_test_write.nit
 296 $ ./tests.sh zzz_tests/zzz_test_write.nit
 297 $ cat out/zzz_test_write.out
 298 ~~~
 299
 300
 301 ### Post-processing
 302
 303 Some simple post-processing can be executed after each tests associated to a line in a `.args` file.
 304
 305 In `*.args` files, semicolons can be used to introduce and separate additional shell commands.
 306
 307 ~~~
 308 $ tail zzz_test_post_proc.args zzz_tests/zzz_test_post_proc.nit
 309 $ ./tests.sh zzz_tests/zzz_test_post_proc.nit
 310 $ cat out/zzz_test_post_proc.res
 311 ~~~
 312
 313
 314 ### Environment variable
 315
 316 The environment variable `NIT_TESTING` is set to `true` during the execution of program tests.
 317 Some libraries of programs can use it to produce specific reproducible results ; or just to exit their executions.
 318
 319 ~~~
 320 $ cat zzz_tests/zzz_test_envvar.nit
 321 $ ./tests.sh zzz_tests/zzz_test_envvar.nit
 322 $ cat out/zzz_test_post_proc.res
 323 ~~~