README.dev.md

How to run tests

Requirements

1. Install Go 1.18.

   go version

2. Install Python 3.x and pip.

   python3 --version
   pip3 --version

3. Install unzip, rpm and cpio packages.

   unzip -v
   rpm --version
   cpio --version

4. Install git.

   git --version

5. Install docker.

   docker --version

6. Install Tarantool (1.10 or 2.x version).

   tarantool --version

7. Install mage.

   mage --version

   If something went wrong, this may help.

   export PATH=$(go env GOPATH)/bin:$PATH

8. Install pytest.

   python3 -m pytest --version

9. Clone this repo.

   git clone [email protected]:tarantool/cartridge-cli.git
   cd ./cartridge-cli

10. To run tests, git user must be configured. For example,

    git config --global user.email "[email protected]"
    git config --global user.name "Tar Antool"

11. Install pytest dependencies.

    pip3 install -r test/requirements.txt

12. Install luacheck.

    tarantoolctl rocks install luacheck

13. Install lichen.

    go install github.com/uw-labs/lichen@latest

All remaining dependencies (like code generation) will be invoked with mage if needed.

Test run

To run all tests, call

mage test

You can run specific test sections.

# Static code analysis (including tests code).
mage lint
# Go unit tests.
mage unit
# pytest integration tests.
mage integration
# Run test example with pytest.
mage testExamples
# pytest end-to-end tests for packages.
mage e2e