Skip to content

Commit

Permalink
Update and refine the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NickVolynkin committed Feb 14, 2022
1 parent 2604c46 commit 75e528d
Showing 1 changed file with 44 additions and 24 deletions.
68 changes: 44 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,50 @@

### Test Suite

Bunch of tests, that lay down in the subfolder (recursively) with `suite.ini`
file. `suite.ini` is basic ini-file, that consists of one section `default`,
and a number of fields:

* `core`
* `description` - Test Suite description
* `script` - shebang file to start tarantool with
* disables:
* `disabled` - tests that must be skipped
* `release_disabled` - tests that must be skipped when Tarantool has been
builded with `Release`
* `valgrind_disabled` - tests that must be skipped when Valgrind is enabled
* `lua_libs` - paths for lua files, that should be copied into the folder,
where server is started (delimited with the space, e.g. `lua_libs=lua/1.lua
lua/2.lua`)
* `long_run` - mark tests as long, enabled only with `--long` option (delimited
with the space, e.g. `long_run=t1.test.lua t2.test.lua`)
* `config` - test configuration file name

Field `core` must be one of:

* `tarantool` - Test-Suite for Functional Testing
* `app` - Another functional Test-Suite
* `unittest` - Unit-Testing Test Suite
Test suite is a bunch of tests located in a subdirectory (recursively) with a `suite.ini`
file. The `suite.ini` is a basic ini-file with one section `[default]`.
All lists are values delimited by spaces.

A `suite.ini` file can have the following fields:

* `core` — major testing dependency or method
Should have one of the following values:

* `tarantool` — test suite used for functional testing
* `app` — TAP-tests, another functional test suite
* `unittest` — unit testing test suite
* `luatest` — test suite using luatest library

* `description` — test suite description
* `script` (optional) — shebang file to start tarantool with

A number of fields are used to disable (skip) certain tests:


* `disabled` — tests that should be skipped
* `release_disabled` — tests that should be skipped when Tarantool is
built with `Release`
* `valgrind_disabled` — tests that should be skipped when Valgrind is enabled

Other parameters:

* `lua_libs` — paths for lua files, that should be copied into the folder,
where server is started. For example:

```ini
lua_libs = lua/require_mod.lua lua/serializer_test.lua lua/process_timeout.lua
```

* `long_run` — mark tests as long, such tests will run only with `--long` option.

```ini
long_run = long_run=t1.test.lua t2.test.lua
```

* `config` — name of a test configuration file

* `is_parallel = [True|False]` —


### Test

Expand Down

0 comments on commit 75e528d

Please sign in to comment.