1Redis Test Suite
2================
3
4The normal execution mode of the test suite involves starting and manipulating
5local `redis-server` instances, inspecting process state, log files, etc.
6
7The test suite also supports execution against an external server, which is
8enabled using the `--host` and `--port` parameters. When executing against an
9external server, tests tagged `external:skip` are skipped.
10
11There are additional runtime options that can further adjust the test suite to
12match different external server configurations:
13
14| Option               | Impact                                                   |
15| -------------------- | -------------------------------------------------------- |
16| `--singledb`         | Only use database 0, don't assume others are supported. |
17| `--ignore-encoding`  | Skip all checks for specific encoding.  |
18| `--ignore-digest`    | Skip key value digest validations. |
19| `--cluster-mode`     | Run in strict Redis Cluster compatibility mode. |
20| `--large-memory`     | Enables tests that consume more than 100mb |
21
22Tags
23----
24
25Tags are applied to tests to classify them according to the subsystem they test,
26but also to indicate compatibility with different run modes and required
27capabilities.
28
29Tags can be applied in different context levels:
30* `start_server` context
31* `tags` context that bundles several tests together
32* A single test context.
33
34The following compatibility and capability tags are currently used:
35
36| Tag                       | Indicates |
37| ---------------------     | --------- |
38| `external:skip`           | Not compatible with external servers. |
39| `cluster:skip`            | Not compatible with `--cluster-mode`. |
40| `large-memory`            | Test that requires more than 100mb |
41| `tls:skip`                | Not campatible with `--tls`. |
42| `needs:repl`              | Uses replication and needs to be able to `SYNC` from server. |
43| `needs:debug`             | Uses the `DEBUG` command or other debugging focused commands (like `OBJECT`). |
44| `needs:pfdebug`           | Uses the `PFDEBUG` command. |
45| `needs:config-maxmemory`  | Uses `CONFIG SET` to manipulate memory limit, eviction policies, etc. |
46| `needs:config-resetstat`  | Uses `CONFIG RESETSTAT` to reset statistics. |
47| `needs:reset`             | Uses `RESET` to reset client connections. |
48| `needs:save`              | Uses `SAVE` to create an RDB file. |
49
50When using an external server (`--host` and `--port`), filtering using the
51`external:skip` tags is done automatically.
52
53When using `--cluster-mode`, filtering using the `cluster:skip` tag is done
54automatically.
55
56When not using `--large-memory`, filtering using the `largemem:skip` tag is done
57automatically.
58
59In addition, it is possible to specify additional configuration. For example, to
60run tests on a server that does not permit `SYNC` use:
61
62    ./runtest --host <host> --port <port> --tags -needs:repl
63
64