ui_test/README.md

   1 A smaller version of compiletest-rs
   2
   3 ## Magic behavior
   4
   5 * Tests are run in order of their filenames (files first, then recursing into folders).
   6   So if you have any slow tests, prepend them with a small integral number to make them get run first, taking advantage of parallelism as much as possible (instead of waiting for the slow tests at the end).
   7
   8 ## Supported magic comment annotations
   9
  10 If your test tests for failure, you need to add a `//~` annotation where the error is happening
  11 to make sure that the test will always keep failing with a specific message at the annotated line.
  12
  13 `//~ ERROR: XXX` make sure the stderr output contains `XXX` for an error in the line where this comment is written
  14
  15 * Also supports `HELP`, `WARN` or `NOTE` for different kind of message
  16     * if one of those levels is specified explicitly, *all* diagnostics of this level or higher need an annotation. If you want to avoid this, just leave out the all caps level note entirely.
  17 * If the all caps note is left out, a message of any level is matched. Leaving it out is not allowed for `ERROR` levels.
  18 * This checks the output *before* normalization, so you can check things that get normalized away, but need to
  19     be careful not to accidentally have a pattern that differs between platforms.
  20 * if `XXX` is of the form `/XXX/` it is treated as a regex instead of a substring and will succeed if the regex matches.
  21
  22 In order to change how a single test is tested, you can add various `//@` comments to the test.
  23 Any other comments will be ignored, and all `//@` comments must be formatted precisely as
  24 their command specifies, or the test will fail without even being run.
  25
  26 * `//@ignore-XXX` avoids running the test on targets whose triple contains `XXX`
  27     * `XXX` can also be one of `64bit`, `32bit` or `16bit`
  28 * `//@only-XXX` avoids running the test on targets whose triple **does not** contain `XXX`
  29     * `XXX` can also be one of `64bit`, `32bit` or `16bit`
  30 * `//@stderr-per-bitwidth` produces one stderr file per bitwidth, as they may differ significantly sometimes
  31 * `//@error-pattern: XXX` make sure the stderr output contains `XXX`
  32 * `//@revisions: XXX YYY` runs the test once for each space separated name in the list
  33     * emits one stderr file per revision
  34     * `//~` comments can be restricted to specific revisions by adding the revision name before the `~` in square brackets: `//[XXX]~`
  35 * `//@compile-flags: XXX` appends `XXX` to the command line arguments passed to the rustc driver
  36     * you can specify this multiple times, and all the flags will accumulate
  37 * `//@rustc-env: XXX=YYY` sets the env var `XXX` to `YYY` for the rustc driver execution.
  38     * for Miri these env vars are used during compilation via rustc and during the emulation of the program
  39     * you can specify this multiple times, accumulating all the env vars
  40 * `//@normalize-stderr-test: "REGEX" -> "REPLACEMENT"` replaces all matches of `REGEX` in the stderr with `REPLACEMENT`. The replacement may specify `$1` and similar backreferences to paste captures.
  41     * you can specify multiple such commands, there is no need to create a single regex that handles multiple replacements that you want to perform.
  42 * `//@require-annotations-for-level: LEVEL` can be used to change the level of diagnostics that require a corresponding annotation.
  43     * this is only useful if there are any annotations like `HELP`, `WARN` or `NOTE`, as these would automatically require annotations for all other diagnostics of the same or higher level.
  44
  45 ## Significant differences to compiletest-rs
  46
  47 * `ignore-*` and `only-*` opereate solely on the triple, instead of supporting things like `macos`
  48 * only `//~` comments can be individualized per revision