Skip to content

Commit 5f0eab0

Browse files
DifferentialOrangeligurio
authored andcommitted
readme: describe how to run tests
Describe how to run connector tests (with submodules) and test requirements. Closes #106
1 parent 9b0ab07 commit 5f0eab0

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ faster than other packages according to public benchmarks.
2727
* [Custom (un)packing and typed selects and function calls](#custom-unpacking-and-typed-selects-and-function-calls)
2828
* [Options](#options)
2929
* [Working with queue](#working-with-queue)
30+
* [Tests](#tests)
3031
* [Alternative connectors](#alternative-connectors)
3132

3233
## Installation
@@ -673,6 +674,34 @@ Additional options (configurable via `ConnectWithOpts`):
673674
* `ClusterDiscoveryTime` - time interval to ask server for updated address list (works on with `NodesGetFunctionName` set)
674675
* `NodesGetFunctionName` - server lua function name to call for getting address list
675676

677+
## Tests
678+
679+
You need to [install Tarantool](https://www.tarantool.io/en/download/) to run tests.
680+
See [Installation](#installation) section for requirements.
681+
682+
To install test dependencies (like [tarantool/queue](https://github.com/tarantool/queue) module), run
683+
```bash
684+
make deps
685+
```
686+
687+
To run tests for the main package and each subpackage, call
688+
```bash
689+
make test
690+
```
691+
Tests set up all required `tarantool` processes before run and clean up after.
692+
693+
If you want to run a specific package tests, go to a package folder
694+
```bash
695+
cd multi
696+
```
697+
and call
698+
```bash
699+
go clean -testcache && go test -v
700+
```
701+
Use the same for main `tarantool` package and `queue` and `uuid` subpackages.
702+
`uuid` tests require
703+
[Tarantool 2.4.1 or newer](https://github.com/tarantool/tarantool/commit/d68fc29246714eee505bc9bbcd84a02de17972c5).
704+
676705
## Alternative connectors
677706

678707
There are two more connectors from the open-source community available:

0 commit comments

Comments
 (0)