Skip to content

Commit 75e528d

Browse files
committed
Update and refine the readme
1 parent 2604c46 commit 75e528d

File tree

1 file changed

+44
-24
lines changed

1 file changed

+44
-24
lines changed

README.md

+44-24
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,50 @@
44

55
### Test Suite
66

7-
Bunch of tests, that lay down in the subfolder (recursively) with `suite.ini`
8-
file. `suite.ini` is basic ini-file, that consists of one section `default`,
9-
and a number of fields:
10-
11-
* `core`
12-
* `description` - Test Suite description
13-
* `script` - shebang file to start tarantool with
14-
* disables:
15-
* `disabled` - tests that must be skipped
16-
* `release_disabled` - tests that must be skipped when Tarantool has been
17-
builded with `Release`
18-
* `valgrind_disabled` - tests that must be skipped when Valgrind is enabled
19-
* `lua_libs` - paths for lua files, that should be copied into the folder,
20-
where server is started (delimited with the space, e.g. `lua_libs=lua/1.lua
21-
lua/2.lua`)
22-
* `long_run` - mark tests as long, enabled only with `--long` option (delimited
23-
with the space, e.g. `long_run=t1.test.lua t2.test.lua`)
24-
* `config` - test configuration file name
25-
26-
Field `core` must be one of:
27-
28-
* `tarantool` - Test-Suite for Functional Testing
29-
* `app` - Another functional Test-Suite
30-
* `unittest` - Unit-Testing Test Suite
7+
Test suite is a bunch of tests located in a subdirectory (recursively) with a `suite.ini`
8+
file. The `suite.ini` is a basic ini-file with one section `[default]`.
9+
All lists are values delimited by spaces.
10+
11+
A `suite.ini` file can have the following fields:
12+
13+
* `core` — major testing dependency or method
14+
Should have one of the following values:
15+
16+
* `tarantool` — test suite used for functional testing
17+
* `app` — TAP-tests, another functional test suite
18+
* `unittest` — unit testing test suite
19+
* `luatest` — test suite using luatest library
20+
21+
* `description` — test suite description
22+
* `script` (optional) — shebang file to start tarantool with
23+
24+
A number of fields are used to disable (skip) certain tests:
25+
26+
27+
* `disabled` — tests that should be skipped
28+
* `release_disabled` — tests that should be skipped when Tarantool is
29+
built with `Release`
30+
* `valgrind_disabled` — tests that should be skipped when Valgrind is enabled
31+
32+
Other parameters:
33+
34+
* `lua_libs` — paths for lua files, that should be copied into the folder,
35+
where server is started. For example:
36+
37+
```ini
38+
lua_libs = lua/require_mod.lua lua/serializer_test.lua lua/process_timeout.lua
39+
```
40+
41+
* `long_run` — mark tests as long, such tests will run only with `--long` option.
42+
43+
```ini
44+
long_run = long_run=t1.test.lua t2.test.lua
45+
```
46+
47+
* `config` — name of a test configuration file
48+
49+
* `is_parallel = [True|False]`
50+
3151

3252
### Test
3353

0 commit comments

Comments
 (0)