rocks: consider environment for some paths

Rocks local repository path and tarantool installation prefix
path can be specified using environment variables.
TT_CLI_REPO_ROCKS variable is used if it is set and there is no
repo.rocks in tt config or repo.rocks directory does not include
repository manifest.
TT_CLI_TARANTOOL_PREFIX variable is used for build, rocks commands
if it is set and tarantool executable is found in PATH.

Closes #471

Author: psergee

CHANGELOG.md

@@ -21,6 +21,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - smart auto-completion for `tt start`, `tt stop`, `tt restart`, `tt connect`, `tt build`, `tt clean`, `tt logrotate`, `tt status`.   
 It shows suitable apps, in case of the pattern doesn't contain delimiter `:`, and suitable instances otherwise.
+- support tt environment directories overriding using environment variables:
+  * TT_CLI_REPO_ROCKS environment variable value is used as rocks repository path if it is set and
+there is no tt.repo.rocks in tt configuration file or tt.repo.rocks directory does not include
+repository manifest file.
+  * TT_CLI_TARANTOOL_PREFIX environment variable value is used for as tarantool installation prefix
+directory for rocks commands if it is set and tarantool executable is found in PATH.
 
 ## [1.1.0] - 2023-05-02
 

cli/cmdcontext/cmdcontext.go

@@ -30,10 +30,6 @@ type CliCtx struct {
 	TarantoolExecutable string
 	// Tarantool version.
 	TarantoolVersion string
-	// Tarantool install prefix path.
-	TarantoolInstallPrefix string
-	// Path to header files supplied with tarantool.
-	TarantoolIncludeDir string
 	// The flag determines if the tarantool binary is from the internal tt repository.
 	IsTarantoolBinFromRepo bool
 	// Verbose logging flag. Enables debug log output.

cli/rocks/rocks.go

@@ -4,9 +4,12 @@ import (
 	"embed"
 	"fmt"
 	"os"
+	"os/exec"
 	"path/filepath"
+	"regexp"
 	"strings"
 
+	"github.com/apex/log"
 	"github.com/tarantool/tt/cli/cmdcontext"
 	"github.com/tarantool/tt/cli/config"
 	"github.com/tarantool/tt/cli/util"
@@ -17,6 +20,12 @@ import (
 //go:embed third_party/luarocks/src/*
 var luarocks embed.FS
 
+const (
+	rocksRepoManifestName     = "manifest"
+	repoRocksPathEnvVarName   = "TT_CLI_REPO_ROCKS"
+	tarantoolPrefixEnvVarName = "TT_CLI_TARANTOOL_PREFIX"
+)
+
 // addLuarocksRepoOpts adds --server option to luarocks command line if rocks repository
 // info is specified in tt config. Return updated args slice.
 func addLuarocksRepoOpts(cliOpts *config.CliOpts, args []string) ([]string, error) {
@@ -35,6 +44,57 @@ func addLuarocksRepoOpts(cliOpts *config.CliOpts, args []string) ([]string, erro
 	return args, nil
 }
 
+// getRocksRepoPath returns actual rocks repo path: either from passed path argument or
+// from current environment.
+func getRocksRepoPath(rocksRepoPath string) string {
+	rockRepoPathFromEnv := os.Getenv(repoRocksPathEnvVarName)
+	if rocksRepoPath == "" || (rocksRepoPath != "" &&
+		!util.IsRegularFile(filepath.Join(rocksRepoPath, rocksRepoManifestName))) {
+		if rockRepoPathFromEnv != "" {
+			rocksRepoPath = rockRepoPathFromEnv
+		}
+	}
+	return rocksRepoPath
+}
+
+// GetTarantoolPrefix returns tarantool installation prefix.
+func GetTarantoolPrefix(cli *cmdcontext.CliCtx, cliOpts *config.CliOpts) (string, error) {
+	if cli.IsTarantoolBinFromRepo {
+		prefixDir, err := util.JoinAbspath(cliOpts.App.IncludeDir)
+		if err != nil {
+			return "", err
+		}
+
+		log.Debugf("Tarantool prefix path: %q", prefixDir)
+		return prefixDir, nil
+	}
+
+	if prefixPathFromEnv := os.Getenv(tarantoolPrefixEnvVarName); prefixPathFromEnv != "" {
+		log.Debugf("Tarantool prefix path: %q", prefixPathFromEnv)
+		return prefixPathFromEnv, nil
+	}
+
+	output, err := exec.Command(cli.TarantoolExecutable, "--version").Output()
+	if err != nil {
+		return "", fmt.Errorf("failed to get tarantool version: %s", err)
+	}
+
+	lines := strings.Split(strings.TrimSpace(string(output)), "\n")
+	if len(lines) < 3 {
+		return "", fmt.Errorf("failed to get prefix path: expected more data")
+	}
+
+	re := regexp.MustCompile(`^.*\s-DCMAKE_INSTALL_PREFIX=(?P<prefix>\/.*)\s.*$`)
+	matches := util.FindNamedMatches(re, lines[2])
+	if len(matches) == 0 {
+		return "", fmt.Errorf("failed to get prefix path: regexp does not match")
+	}
+
+	prefixDir := matches["prefix"]
+	log.Debugf("Tarantool prefix path: %q", prefixDir)
+	return prefixDir, nil
+}
+
 // Execute LuaRocks command. All args will be processed by LuaRocks.
 func Exec(cmdCtx *cmdcontext.CmdCtx, cliOpts *config.CliOpts, args []string) error {
 	var cmd string
@@ -44,6 +104,8 @@ func Exec(cmdCtx *cmdcontext.CmdCtx, cliOpts *config.CliOpts, args []string) err
 		cmd = "help"
 	}
 
+	cliOpts.Repo.Rocks = getRocksRepoPath(cliOpts.Repo.Rocks)
+
 	var err error
 	if args, err = addLuarocksRepoOpts(cliOpts, args); err != nil {
 		return err
@@ -61,16 +123,19 @@ func Exec(cmdCtx *cmdcontext.CmdCtx, cliOpts *config.CliOpts, args []string) err
 	if err != nil {
 		return err
 	}
-
-	err = util.SetupTarantoolPrefix(&cmdCtx.Cli, cliOpts)
+	tarantoolPrefixDir, err := GetTarantoolPrefix(&cmdCtx.Cli, cliOpts)
+	if err != nil {
+		return err
+	}
+	tarantoolIncludeDir, err := util.JoinAbspath(tarantoolPrefixDir, "include", "tarantool")
 	if err != nil {
 		return err
 	}
 
 	os.Setenv("TT_CLI_TARANTOOL_VERSION", version)
-	os.Setenv("TT_CLI_TARANTOOL_PREFIX", cmdCtx.Cli.TarantoolInstallPrefix)
-	os.Setenv("TT_CLI_TARANTOOL_INCLUDE", cmdCtx.Cli.TarantoolIncludeDir)
-	os.Setenv("TARANTOOL_DIR", filepath.Dir(cmdCtx.Cli.TarantoolIncludeDir))
+	os.Setenv("TT_CLI_TARANTOOL_PREFIX", tarantoolPrefixDir)
+	os.Setenv("TT_CLI_TARANTOOL_INCLUDE", tarantoolIncludeDir)
+	os.Setenv("TARANTOOL_DIR", filepath.Dir(tarantoolIncludeDir))
 	os.Setenv("TT_CLI_TARANTOOL_PATH", filepath.Dir(cmdCtx.Cli.TarantoolExecutable))
 
 	rocks_cmd := fmt.Sprintf("t=require('extra.wrapper').exec('%s', %s)",

cli/rocks/rocks_test.go

@@ -1,9 +1,14 @@
 package rocks
 
 import (
+	"fmt"
+	"io/ioutil"
+	"os"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"github.com/tarantool/tt/cli/cmdcontext"
 	"github.com/tarantool/tt/cli/config"
 )
 
@@ -82,3 +87,136 @@ func TestAddLuarocksRepoOpts(t *testing.T) {
 		})
 	}
 }
+
+func TestGetRocksRepoPath(t *testing.T) {
+	assert.EqualValues(t, "./testdata/repo", getRocksRepoPath("./testdata/repo"))
+	assert.EqualValues(t, "./testdata/emptyrepo", getRocksRepoPath("./testdata/emptyrepo"))
+
+	os.Setenv(repoRocksPathEnvVarName, "./other_repo")
+	// If env var is set, return it if manifets is missing in passed repo.
+	assert.EqualValues(t, "./other_repo", getRocksRepoPath("./testdata/emptyrepo"))
+	// Return passed repo path, since manifest exists. Env var is ignored.
+	assert.EqualValues(t, "./testdata/repo", getRocksRepoPath("./testdata/repo"))
+	os.Unsetenv(repoRocksPathEnvVarName)
+}
+
+func TestSetupTarantoolPrefix(t *testing.T) {
+	type prefixInput struct {
+		cli          cmdcontext.CliCtx
+		cliOpts      *config.CliOpts
+		data         *[]byte
+		tntPrefixEnv string
+	}
+
+	type prefixOutput struct {
+		prefix string
+		err    error
+	}
+
+	assert := assert.New(t)
+	testDir, err := ioutil.TempDir("/tmp", "tt-unit")
+	require.NoError(t, err)
+
+	defer os.RemoveAll(testDir)
+
+	err = os.Mkdir(testDir+"/bin", os.ModePerm)
+	require.NoError(t, err)
+
+	tntBinPath := testDir + "/bin/tarantool"
+
+	cwd, err := os.Getwd()
+	require.NoError(t, err)
+
+	testCases := make(map[prefixInput]prefixOutput)
+
+	tntOkData := []byte("#!/bin/sh\n" +
+		"echo 'Tarantool 2.10.2-0-gb924f0b\n" +
+		"Target: Linux-x86_64-RelWithDebInfo\n" +
+		"Build options: cmake . -DCMAKE_INSTALL_PREFIX=/usr -DENABLE_BACKTRACE=yes'")
+
+	testCases[prefixInput{cli: cmdcontext.CliCtx{
+		IsTarantoolBinFromRepo: false,
+		TarantoolExecutable:    tntBinPath,
+	}, data: &tntOkData}] =
+		prefixOutput{
+			prefix: "/usr",
+			err:    nil,
+		}
+
+	testCases[prefixInput{cli: cmdcontext.CliCtx{
+		IsTarantoolBinFromRepo: false,
+		TarantoolExecutable:    tntBinPath,
+	},
+		data:         &tntOkData,
+		tntPrefixEnv: "/tnt/prefix"}] =
+		prefixOutput{
+			prefix: "/tnt/prefix",
+			err:    nil,
+		}
+
+	tntBadData0 := []byte("#!/bin/sh\n" +
+		"echo 'Tarantool 2.10.2-0-gb924f0b\n" +
+		"Target: Linux-x86_64-RelWithDebInfo\n" +
+		"Build options: cmake . -D_FAIL_HERE_=/usr -DENABLE_BACKTRACE=yes'")
+
+	testCases[prefixInput{cli: cmdcontext.CliCtx{
+		IsTarantoolBinFromRepo: false,
+		TarantoolExecutable:    tntBinPath,
+	}, data: &tntBadData0}] =
+		prefixOutput{
+			err: fmt.Errorf("failed to get prefix path: regexp does not match"),
+		}
+
+	tntBadData1 := []byte("#!/bin/sh\n" +
+		"echo 'Tarantool 2.10.2-0-gb924f0b\n" +
+		"Target: Linux-x86_64-RelWithDebInfo\n'")
+
+	testCases[prefixInput{cli: cmdcontext.CliCtx{
+		IsTarantoolBinFromRepo: false,
+		TarantoolExecutable:    tntBinPath,
+	}, data: &tntBadData1}] =
+		prefixOutput{
+			err: fmt.Errorf("failed to get prefix path: expected more data"),
+		}
+
+	appOpts := config.AppOpts{IncludeDir: "hdr"}
+	cliOpts := config.CliOpts{App: &appOpts}
+
+	testCases[prefixInput{cli: cmdcontext.CliCtx{
+		IsTarantoolBinFromRepo: true,
+		TarantoolExecutable:    tntBinPath,
+	},
+		cliOpts:      &cliOpts,
+		data:         &tntOkData,
+		tntPrefixEnv: "/tnt/prefix"}] =
+		prefixOutput{
+			prefix: cwd + "/hdr",
+			err:    nil,
+		}
+
+	for input, output := range testCases {
+		tntFile, err := os.Create(tntBinPath)
+		require.NoError(t, err)
+
+		_, err = tntFile.Write(*input.data)
+		require.NoError(t, err)
+		tntFile.Close()
+
+		err = os.Chmod(tntFile.Name(), 0755)
+		require.NoError(t, err)
+
+		if input.tntPrefixEnv != "" {
+			os.Setenv(tarantoolPrefixEnvVarName, input.tntPrefixEnv)
+		}
+		tarantoolPrefix, err := GetTarantoolPrefix(&input.cli, input.cliOpts)
+		os.Unsetenv(tarantoolPrefixEnvVarName)
+		if err == nil {
+			assert.Nil(err)
+			assert.Equal(output.prefix, tarantoolPrefix)
+		} else {
+			assert.Equal(output.err, err)
+		}
+
+		os.Remove(tntBinPath)
+	}
+}

cli/rocks/testdata/repo/manifest

@@ -24,7 +24,6 @@ import (
 	"github.com/apex/log"
 	"github.com/spf13/cobra"
 	"github.com/tarantool/tt/cli/cmdcontext"
-	"github.com/tarantool/tt/cli/config"
 	"gopkg.in/yaml.v2"
 )
 
@@ -301,51 +300,6 @@ func GetTarantoolVersion(cli *cmdcontext.CliCtx) (string, error) {
 	return cli.TarantoolVersion, nil
 }
 
-// SetupTarantoolPrefix defines the installation prefix and the path to the tarantool header files.
-func SetupTarantoolPrefix(cli *cmdcontext.CliCtx, cliOpts *config.CliOpts) error {
-	if cli.TarantoolIncludeDir != "" && cli.TarantoolInstallPrefix != "" {
-		return nil
-	}
-
-	if cli.IsTarantoolBinFromRepo {
-		includeDir, err := JoinAbspath(cliOpts.App.IncludeDir, "include/tarantool")
-		if err != nil {
-			return err
-		}
-
-		prefix, err := JoinAbspath(cliOpts.App.IncludeDir)
-		if err != nil {
-			return err
-		}
-
-		cli.TarantoolIncludeDir = includeDir
-		cli.TarantoolInstallPrefix = prefix
-
-		return nil
-	}
-
-	output, err := exec.Command(cli.TarantoolExecutable, "--version").Output()
-	if err != nil {
-		return fmt.Errorf("failed to get tarantool version: %s", err)
-	}
-
-	lines := strings.Split(strings.TrimSpace(string(output)), "\n")
-	if len(lines) < 3 {
-		return fmt.Errorf("failed to get prefix path: expected more data")
-	}
-
-	re := regexp.MustCompile(`^.*\s-DCMAKE_INSTALL_PREFIX=(?P<prefix>\/.*)\s.*$`)
-	matches := FindNamedMatches(re, lines[2])
-	if len(matches) == 0 {
-		return fmt.Errorf("failed to get prefix path: regexp does not match")
-	}
-
-	cli.TarantoolInstallPrefix = matches["prefix"]
-	cli.TarantoolIncludeDir = cli.TarantoolInstallPrefix + "/include/tarantool"
-
-	return nil
-}
-
 // ReadEmbedFile reads content of embed file in string mode.
 func ReadEmbedFile(fs embed.FS, path string) (string, error) {
 	content, err := ReadEmbedFileBinary(fs, path)