Skip to content

Commit 46d6813

Browse files
committed
Update and refine the readme
1 parent 2604c46 commit 46d6813

File tree

1 file changed

+33
-18
lines changed

1 file changed

+33
-18
lines changed

README.md

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,45 @@
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`,
7+
Test suite is a bunch of tests located in a subfolder (recursively) with a `suite.ini`
8+
file. The `suite.ini` is a basic ini-file with one section `[default]`,
99
and a number of fields:
1010

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
11+
* `core` — major testing dependency or method
12+
Should have one of the following values:
13+
14+
* `tarantool` — test suite used for functional testing
15+
* `app` — TAP-tests, another functional test suite
16+
* `unittest` — unit testing test suite
17+
* `luatest` — test suite using luatest library
18+
19+
* `description` — test suite description
20+
* `script` — shebang file to start tarantool with
21+
22+
A number of fields are used to disable (skip) certain tests:
23+
24+
25+
* `disabled` — tests that should be skipped
26+
* `release_disabled` — tests that should be skipped when Tarantool is
27+
built with `Release`
28+
* `valgrind_disabled` — tests that should be skipped when Valgrind is enabled
29+
30+
Other parameters:
31+
32+
* `lua_libs` — paths for lua files, that should be copied into the folder,
33+
where server is started. List is delimited by spaces. For example:
34+
35+
```ini
36+
lua_libs = lua/require_mod.lua lua/serializer_test.lua lua/process_timeout.lua
37+
```
38+
*
39+
* , e.g. `lua_libs=lua/1.lua
2140
lua/2.lua`)
22-
* `long_run` - mark tests as long, enabled only with `--long` option (delimited
41+
* `long_run` mark tests as long, enabled only with `--long` option (delimited
2342
with the space, e.g. `long_run=t1.test.lua t2.test.lua`)
24-
* `config` - test configuration file name
43+
* `config` — name of a test configuration file
2544

26-
Field `core` must be one of:
2745

28-
* `tarantool` - Test-Suite for Functional Testing
29-
* `app` - Another functional Test-Suite
30-
* `unittest` - Unit-Testing Test Suite
3146

3247
### Test
3348

0 commit comments

Comments
 (0)