tests: add helpers for TcS

Simple helpers to make easy create tests required Taranatool
centralized configuration storage.

Author: dmyger

go.mod

@@ -4,6 +4,7 @@ go 1.20
 
 require (
 	github.com/google/uuid v1.3.0
+	github.com/mitchellh/mapstructure v1.5.0
 	github.com/shopspring/decimal v1.3.1
 	github.com/stretchr/testify v1.9.0
 	github.com/tarantool/go-iproto v1.1.0

go.sum

@@ -3,6 +3,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
+github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=

test_helpers/main.go

@@ -33,6 +33,14 @@ type StartOpts struct {
 	// InitScript is a Lua script for tarantool to run on start.
 	InitScript string
 
+	// ConfigFile is a path to a configuration file for a Tarantool instance.
+	// Required in pair with InstanceName.
+	ConfigFile string
+
+	// InstanceName is a name of an instance to run.
+	// Required in pair with ConfigFile.
+	InstanceName string
+
 	// Listen is box.cfg listen parameter for tarantool.
 	// Use this address to connect to tarantool after configuration.
 	// https://www.tarantool.io/en/doc/latest/reference/configuration/#cfg-basic-listen
@@ -108,7 +116,7 @@ var (
 )
 
 func init() {
-	tarantoolVersionRegexp = regexp.MustCompile(`Tarantool (?:Enterprise )?(\d+)\.(\d+)\.(\d+).*`)
+	tarantoolVersionRegexp = regexp.MustCompile(`Tarantool (Enterprise )?(\d+)\.(\d+)\.(\d+).*`)
 }
 
 // atoiUint64 parses string to uint64.
@@ -145,15 +153,58 @@ func IsTarantoolVersionLess(majorMin uint64, minorMin uint64, patchMin uint64) (
 		return true, fmt.Errorf("failed to parse output %q", out)
 	}
 
-	if major, err = atoiUint64(parsed[1]); err != nil {
+	if major, err = atoiUint64(parsed[2]); err != nil {
 		return true, fmt.Errorf("failed to parse major from output %q: %w", out, err)
 	}
 
-	if minor, err = atoiUint64(parsed[2]); err != nil {
+	if minor, err = atoiUint64(parsed[3]); err != nil {
 		return true, fmt.Errorf("failed to parse minor from output %q: %w", out, err)
 	}
 
-	if patch, err = atoiUint64(parsed[3]); err != nil {
+	if patch, err = atoiUint64(parsed[4]); err != nil {
+		return true, fmt.Errorf("failed to parse patch from output %q: %w", out, err)
+	}
+
+	if major != majorMin {
+		return major < majorMin, nil
+	} else if minor != minorMin {
+		return minor < minorMin, nil
+	} else {
+		return patch < patchMin, nil
+	}
+}
+
+// IsTarantoolEEVersionLess checks if tarantool is Enterprise and version is less
+// than passed <major.minor.patch>. Returns error if failed
+// to extract version.
+func IsTarantoolEEVersionLess(majorMin uint64, minorMin uint64, patchMin uint64) (bool, error) {
+	var major, minor, patch uint64
+
+	out, err := exec.Command(getTarantoolExec(), "--version").Output()
+
+	if err != nil {
+		return true, err
+	}
+
+	parsed := tarantoolVersionRegexp.FindStringSubmatch(string(out))
+
+	if parsed == nil {
+		return true, fmt.Errorf("failed to parse output %q", out)
+	}
+
+	if parsed[1] == "" {
+		return true, nil
+	}
+
+	if major, err = atoiUint64(parsed[2]); err != nil {
+		return true, fmt.Errorf("failed to parse major from output %q: %w", out, err)
+	}
+
+	if minor, err = atoiUint64(parsed[3]); err != nil {
+		return true, fmt.Errorf("failed to parse minor from output %q: %w", out, err)
+	}
+
+	if patch, err = atoiUint64(parsed[4]); err != nil {
 		return true, fmt.Errorf("failed to parse patch from output %q: %w", out, err)
 	}
 
@@ -219,6 +270,11 @@ func StartTarantool(startOpts StartOpts) (TarantoolInstance, error) {
 		fmt.Sprintf("TEST_TNT_MEMTX_USE_MVCC_ENGINE=%t", startOpts.MemtxUseMvccEngine),
 		fmt.Sprintf("TEST_TNT_AUTH_TYPE=%s", startOpts.Auth),
 	)
+	if startOpts.ConfigFile != "" && startOpts.InstanceName != "" {
+		inst.Cmd.Env = append(inst.Cmd.Env, fmt.Sprintf("TT_CONFIG=%s", startOpts.ConfigFile))
+		inst.Cmd.Env = append(inst.Cmd.Env,
+			fmt.Sprintf("TT_INSTANCE_NAME=%s", startOpts.InstanceName))
+	}
 
 	// Copy SSL certificates.
 	if startOpts.SslCertsDir != "" {

test_helpers/tcs/tcs.go

@@ -0,0 +1,98 @@
+package tcs
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/mitchellh/mapstructure"
+	"github.com/tarantool/go-tarantool/v2"
+	"github.com/tarantool/go-tarantool/v2/test_helpers"
+)
+
+type Tcs struct {
+	// conn Connection interface for interacting with Tarantool.
+	doer tarantool.Doer
+}
+
+// GetResponse is a response of a get request.
+type GetResponse struct {
+	Data []struct {
+		Path        string
+		Value       string
+		ModRevision int64 `mapstructure:"mod_revision"`
+	}
+}
+
+// StartTcs starts a Tarantool centralized configuration storage.
+// Returns a Tcs instance and a cleanup function.
+func StartTcs(opts test_helpers.StartOpts) (Tcs, func()) {
+	if less, err := test_helpers.IsTarantoolEEVersionLess(3, 3, 0); less || err != nil {
+		log.Fatal("Tarantool EE 3.3+ required", err)
+	}
+	need_clean := opts.WorkDir == ""
+
+	inst, err := test_helpers.StartTarantool(opts)
+	if err != nil {
+		log.Fatalf("Failed to start Tarantool config instance: %v", err)
+	}
+	conn, err := tarantool.Connect(context.Background(), inst.Dialer, tarantool.Opts{})
+	if err != nil {
+		log.Fatal("Can't connect to Tarantool config instance")
+		return Tcs{}, nil
+	}
+
+	return Tcs{conn}, func() {
+		conn.Close()
+		if need_clean {
+			test_helpers.StopTarantoolWithCleanup(inst)
+		} else {
+			test_helpers.StopTarantool(inst)
+		}
+	}
+
+}
+
+// Put implements "config.storage.put" method.
+func (t *Tcs) Put(ctx context.Context, path string, value string) error {
+	req := tarantool.NewCallRequest("config.storage.put").
+		Args([]any{path, value}).
+		Context(ctx)
+	if _, err := t.doer.Do(req).GetResponse(); err != nil {
+		return fmt.Errorf("failed save data to tarantool: %w", err)
+	}
+	return nil
+}
+
+// delete implements "config.storage.delete" method.
+func (t *Tcs) Delete(ctx context.Context, path string) error {
+	req := tarantool.NewCallRequest("config.storage.delete").
+		Args([]any{path}).
+		Context(ctx)
+	if _, err := t.doer.Do(req).GetResponse(); err != nil {
+		return fmt.Errorf("failed delete data from tarantool: %w", err)
+	}
+	return nil
+}
+
+// get implements "config.storage.get" method.
+func (t *Tcs) Get(ctx context.Context, path string) (GetResponse, error) {
+	req := tarantool.NewCallRequest("config.storage.get").
+		Args([]any{path}).
+		Context(ctx)
+
+	resp := GetResponse{}
+	result, err := t.doer.Do(req).Get()
+	if err != nil {
+		return resp, fmt.Errorf("failed to fetch data from tarantool: %w", err)
+	}
+
+	if len(result) != 1 {
+		return resp, fmt.Errorf("unexpected response from tarantool: %q", result)
+	}
+	if err := mapstructure.Decode(result[0], &resp); err != nil {
+		return resp, fmt.Errorf("failed to map response from tarantool: %q", result[0])
+	}
+
+	return resp, nil
+}