Skip to content

readme: describe how to run tests #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ faster than other packages according to public benchmarks.
* [Custom (un)packing and typed selects and function calls](#custom-unpacking-and-typed-selects-and-function-calls)
* [Options](#options)
* [Working with queue](#working-with-queue)
* [Tests](#tests)
* [Alternative connectors](#alternative-connectors)

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

## Tests

You need to [install Tarantool](https://www.tarantool.io/en/download/) to run tests.
See [Installation](#installation) section for requirements.

To install test dependencies (like [tarantool/queue](https://github.com/tarantool/queue) module), run
```bash
make deps
```

To run tests for the main package and each subpackage, call
```bash
make test
```
Tests set up all required `tarantool` processes before run and clean up after.

If you want to run a specific package tests, go to a package folder
```bash
cd multi
```
and call
```bash
go clean -testcache && go test -v
```
Use the same for main `tarantool` package and `queue` and `uuid` subpackages.
`uuid` tests require
[Tarantool 2.4.1 or newer](https://github.com/tarantool/tarantool/commit/d68fc29246714eee505bc9bbcd84a02de17972c5).

## Alternative connectors

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