Top.Mail.Ru
Class cartridge.test-helpers.cluster | Tarantool
Tarantool
Check out the new release 2.8
Tarantool Cartridge Table of contents Class cartridge.test-helpers.cluster

Class cartridge.test-helpers.cluster

Class to run and manage multiple tarantool instances.

Build cluster object.

Parameters:

  • object:
    • datadir: (string) Data directory for all cluster servers.
    • server_command: (string) Command to run server.
    • cookie: (string) Cluster cookie.
    • base_http_port: (int) Value to calculate server’s http_port. (optional)
    • base_advertise_port: (int) Value to calculate server’s advertise_port. (optional)
    • use_vshard: (bool) bootstrap vshard after server is started. (optional)
    • replicasets: (tab) Replicasets configuration. List of replicaset_config
    • failover: (string) Failover mode: disabled, eventual, or stateful. (optional)
    • stateboard_entrypoint: (string) Command to run stateboard. (optional)
    • zone_distances: (tab) Vshard distances between zones. (optional)

Returns:

object

Find server by alias.

Parameters:

Returns:

cartridge.test-helpers.server

Execute edit_topology GraphQL request to setup replicasets, apply roles join servers to replicasets.

Bootstraps cluster if it wasn’t bootstrapped before. Otherwise starts servers.

Stop all servers.

Register running server in the cluster.

Parameters:

  • server: (Server) Server to be registered.

Blocks fiber until cartridge.is_healthy() returns true on main_server.

Parameters:

  • server:

Upload application config, shortcut for cluster.main_server:upload_config(config) .

Parameters:

  • config:

See also:

  • cartridge.test-helpers.server.Server:upload_config

Download application config, shortcut for cluster.main_server:download_config() .

See also:

  • cartridge.test-helpers.server.Server:download_config

Keeps calling fn until it returns without error. Throws last error if config.timeout is elapsed.

Parameters:

  • config: (tab) Options for luatest.helpers.retrying .
  • fn: (func) Function to call
  • …: Args to run fn with. (optional)

Replicaset config.

Fields:

  • alias: (string) Prefix to generate server alias automatically. (optional)
  • uuid: (string) Replicaset uuid. (optional)
  • roles: ({string}) List of roles for servers in the replicaset.
  • vshard_group: (optional string) Name of vshard group.
  • all_rw: (optional boolan) Make all replicas writable.
  • servers: (table or number) List of objects to build Server s with or.. code-block:: lua number of servers in replicaset.