Merge pull request #22 from tarantool/20-docker-cluster

Start a cluster of Tarantools in docker example

Author: DifferentialOrange

CHANGELOG.md

@@ -7,10 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Publish dashboard on Grafana official and community built dashboards
+- Generate HTTP and space operations traffic for example cluster with luatest
 
 ### Changed
 - Update metrics version to 0.3.0 in experimental cluster
 - Rework example Tarantool instance on "cartridge.roles.metrics"
+- Rework example Tarantool docker to start multiple instances with luatest
 - Documentation improvements and fixes
 
 ## [0.1.0] - 2020-06-30

docker-compose.yml

@@ -4,14 +4,21 @@ services:
     build:
       context: ./example/project
       dockerfile: Dockerfile
-    environment:
-      - TARANTOOL_ALIAS=instance
-    entrypoint: ["/usr/local/bin/tarantool"]
-    command: ["init.lua"]
+    entrypoint: ["/app/.rocks/bin/luatest"]
+    command: ["./cluster"]
     networks:
       tarantool_dashboard_dev:
     ports:
+      - 13301:13301
+      - 13302:13302
+      - 13303:13303
+      - 13304:13304
+      - 13305:13305
       - 8081:8081
+      - 8082:8082
+      - 8083:8083
+      - 8084:8084
+      - 8085:8085
 
   telegraf:
     image: telegraf:1.13-alpine

example/project/.luacheckrc

@@ -1,3 +1,15 @@
-include_files = {'**/*.lua', '*.luacheckrc', '*.rockspec'}
-exclude_files = {'.rocks/', 'tmp/'}
-max_line_length = 120
+std = {
+    read_globals = {'require', 'debug', 'pcall', 'xpcall', 'tostring',
+        'tonumber', 'type', 'assert', 'ipairs', 'math', 'error', 'string',
+        'table', 'pairs', 'os', 'io', 'select', 'unpack', 'dofile', 'next',
+        'loadstring', 'setfenv',
+        'rawget', 'rawset', '_G',
+        'getmetatable', 'setmetatable',
+        'print', 'tonumber64', 'arg'
+
+    },
+    globals = {'box', 'vshard', 'package',
+        'applier'
+    }
+}
+redefined = false

example/project/Dockerfile

@@ -7,7 +7,7 @@ RUN yum install -y git \
                    make \
                    gcc
 COPY . .
-RUN tarantoolctl rocks make
 RUN mkdir -p tmp
 
-CMD ["tarantool", "init.lua"]
+RUN tarantoolctl rocks make
+RUN tarantoolctl rocks install luatest 0.5.0

example/project/app/roles/custom.lua

@@ -1,8 +1,12 @@
 local cartridge = require('cartridge')
+local config = require('cartridge.argparse')
 
 local function init(opts) -- luacheck: no unused args
-    -- if opts.is_master then
-    -- end
+    local local_cfg = config.get_opts({
+        user = 'string',
+        password = 'string'
+    })
+
     local metrics = cartridge.service_get('metrics')
     local http_middleware = metrics.http_middleware
 
@@ -13,11 +17,44 @@ local function init(opts) -- luacheck: no unused args
         { method = 'GET', path = '/hello' },
         http_middleware.v1(
             function()
-                return { body = 'Hello world!' }
+                return { status = 200, body = 'Hello world!' }
+            end,
+            http_collector
+        )
+    )
+    httpd:route(
+        { method = 'GET', path = '/hell0' },
+        http_middleware.v1(
+            function()
+                return { status = 400, body = 'Hell0 world!' }
             end,
             http_collector
         )
     )
+    httpd:route(
+        { method = 'POST', path = '/goodbye' },
+        http_middleware.v1(
+            function()
+                return { status = 500, body = 'Goodbye cruel world!' }
+            end,
+            http_collector
+        )
+    )
+
+    if opts.is_master then
+        local sp = box.schema.space.create('MY_SPACE', { if_not_exists = true })
+        sp:format({
+            { name = 'key', type = 'number', is_nullable = false },
+            { name = 'value', type = 'string', is_nullable = false },
+        })
+        sp:create_index('pk', { parts = { 'key' }, if_not_exists = true })
+
+        if local_cfg.user and local_cfg.password then
+            -- cluster-wide user privileges
+            box.schema.user.create(local_cfg.user, { password = local_cfg.password, if_not_exists = true })
+            box.schema.user.grant(local_cfg.user, 'read,write,execute', 'universe', nil, { if_not_exists = true })
+        end
+    end
 
     return true
 end
@@ -38,6 +75,7 @@ end
 
 return {
     role_name = 'app.roles.custom',
+    dependencies = { 'cartridge.roles.metrics' },
     init = init,
     stop = stop,
     validate_config = validate_config,

example/project/cluster/helper.lua

@@ -0,0 +1,51 @@
+local fio = require('fio')
+local lt = require('luatest')
+local json = require('json')
+local Server = require('cartridge.test-helpers.server')
+
+local helper = {}
+
+helper.root = fio.dirname(fio.abspath(package.search('init')))
+helper.datadir = fio.pathjoin(helper.root, 'dev')
+helper.server_command = fio.pathjoin(helper.root, 'cluster/init.lua')
+
+lt.before_suite(function()
+    fio.rmtree(helper.datadir)
+    fio.mktree(helper.datadir)
+end)
+
+function Server:build_env()
+    return {
+        TARANTOOL_ALIAS = self.alias,
+        TARANTOOL_WORKDIR = self.workdir,
+        TARANTOOL_HTTP_PORT = self.http_port,
+        TARANTOOL_ADVERTISE_URI = self.advertise_uri,
+        TARANTOOL_CLUSTER_COOKIE = self.cluster_cookie,
+        TARANTOOL_LOG_LEVEL = 6,
+        TZ = 'Europe/Moscow'
+    }
+end
+
+Server.constructor_checks.api_host = '?string'
+Server.constructor_checks.api_port = '?string'
+function Server:api_request(method, path, options)
+    method = method and string.upper(method)
+    if not self.http_client then
+        error('http_port not configured')
+    end
+    options = options or {}
+    local body = options.body or (options.json and json.encode(options.json))
+    local http_options = options.http or {}
+    local url = self.api_host .. ':' .. self.api_port .. path
+    local response = self.http_client:request(method, url, body, http_options)
+    local ok, json_body = pcall(json.decode, response.body)
+    if ok then
+        response.json = json_body
+    end
+    if not options.raw and response.status ~= 200 then
+        error({type = 'HTTPRequest', response = response})
+    end
+    return response
+end
+
+return helper

example/project/cluster/init.lua

@@ -0,0 +1,46 @@
+#!/usr/bin/env tarantool
+
+local fio = require('fio')
+if os.getenv('ENABLE_TEST_COVERAGE') == 'true' then
+    local cfg_luacov = dofile(fio.pathjoin('.luacov'))
+    cfg_luacov.statsfile = fio.pathjoin('luacov.stats.out')
+
+    local coverage = require('luacov.runner')
+    coverage.init(cfg_luacov)
+    rawset(_G, 'coverage', coverage)
+end
+
+local function get_base_dir()
+    return fio.abspath(fio.dirname(arg[0]) .. '/app/')
+end
+
+local function extend_path(path)
+    package.path = package.path .. ';' .. path
+end
+
+local function extend_cpath(path)
+    package.cpath = package.cpath .. ';' .. path
+end
+
+local function set_base_load_paths(base_dir)
+    extend_path(base_dir .. '/?.lua')
+    extend_path(base_dir .. '/?/init.lua')
+    extend_cpath(base_dir .. '/?.dylib')
+    extend_cpath(base_dir .. '/?.so')
+end
+
+local function set_rocks_load_paths(base_dir)
+    extend_path(base_dir..'/.rocks/share/tarantool/?.lua')
+    extend_path(base_dir..'/.rocks/share/tarantool/?/init.lua')
+    extend_cpath(base_dir..'/.rocks/lib/tarantool/?.dylib')
+    extend_cpath(base_dir..'/.rocks/lib/tarantool/?.so')
+end
+
+local function set_load_paths(base_dir)
+    set_base_load_paths(base_dir)
+    set_rocks_load_paths(base_dir)
+end
+
+set_load_paths(get_base_dir())
+
+require('init')