Tarantool code examples

Prerequisites

First, install the tt CLI utility. Then, go to the doc/code_snippets folder and install the following libraries:

• Install luatest:

  tt rocks install luatest
  

• Install luarapidxml:

  tt rocks install luarapidxml
  

Running and testing examples

To test all the examples, go to the doc/code_snippets folder and execute the luatest command:

.rocks/bin/luatest

To test the examples from the specified directory, pass its relative path to the luatest command:

.rocks/bin/luatest test/transactions

To test a specific example with the stdout output enabled, use the luatest command with the -c option, for example:

.rocks/bin/luatest -c test/http_client/get_test.lua

Note that the HTTP client samples (placed in test/http_client) use the httpbin service. You can run httpbin locally using Docker to stabilize test results:

docker run -p 80:80 kennethreitz/httpbin

In this case, you need to replace https://httpbin.org links with http://127.0.0.1.

Referencing code snippets

To display a specific source file in a topic, use the literalinclude directive as follows:

..  literalinclude:: /code_snippets/test/http_client/post_json_test.lua
    :language: lua
    :lines: 1-6