cfg: implement cfg dump module

cfg dump prints tt environment configuration with all paths resolved.
With --raw flag set, it prints config file contents as is.

Closes #135

Author: psergee

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Support of rocks repository specified in tt config.
+- ``cfg dump`` module. It prints tt environment configuration.
 
 ## [0.3.0] - 2022-12-05
 

README.rst

@@ -420,3 +420,4 @@ Common description. For a detailed description, use ``tt help command`` .
 * ``uninstall`` - uninstall tarantool/tt.
 * ``init`` - create tt environment configuration file.
 * ``daemon (experimental)`` - manage tt daemon.
+* ``cfg dump`` - print tt environment configuration.

cli/cfg/dump.go

@@ -0,0 +1,59 @@
+package cfg
+
+import (
+	"fmt"
+	"io"
+	"io/ioutil"
+	"os"
+
+	"github.com/tarantool/tt/cli/cmdcontext"
+	"github.com/tarantool/tt/cli/config"
+	"gopkg.in/yaml.v2"
+)
+
+// DumpCtx contains information for tt config dump.
+type DumpCtx struct {
+	// rawDump is a dump mode flag. If set, raw contents of tt configuration file is printed.
+	RawDump bool
+}
+
+// dumpRaw prints raw content of tt config file.
+func dumpRaw(writer io.Writer, cmdCtx *cmdcontext.CmdCtx) error {
+	if cmdCtx.Cli.ConfigPath != "" {
+		_, err := os.Stat(cmdCtx.Cli.ConfigPath)
+		if err != nil {
+			return err
+		}
+		fileContent, err := ioutil.ReadFile(cmdCtx.Cli.ConfigPath)
+		if err != nil {
+			return err
+		}
+		writer.Write([]byte(cmdCtx.Cli.ConfigPath + ":\n"))
+		writer.Write(fileContent)
+	} else {
+		return fmt.Errorf("tt configuration file is not found")
+	}
+
+	return nil
+}
+
+// dumpConfiguration prints tt env configuration with all resolved paths.
+func dumpConfiguration(writer io.Writer, cmdCtx *cmdcontext.CmdCtx,
+	cliOpts *config.CliOpts) error {
+	if cmdCtx.Cli.ConfigPath != "" {
+		if _, err := os.Stat(cmdCtx.Cli.ConfigPath); err == nil {
+			writer.Write([]byte(cmdCtx.Cli.ConfigPath + ":\n"))
+		}
+	}
+	err := yaml.NewEncoder(writer).Encode(config.Config{CliConfig: cliOpts})
+	return err
+}
+
+// RunDump prints tt configuration.
+func RunDump(writer io.Writer, cmdCtx *cmdcontext.CmdCtx, dumpCtx *DumpCtx,
+	cliOpts *config.CliOpts) error {
+	if dumpCtx.RawDump {
+		return dumpRaw(writer, cmdCtx)
+	}
+	return dumpConfiguration(writer, cmdCtx, cliOpts)
+}

cli/cfg/dump_test.go

@@ -0,0 +1,109 @@
+package cfg
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"github.com/tarantool/tt/cli/cmdcontext"
+	"github.com/tarantool/tt/cli/config"
+	"github.com/tarantool/tt/cli/configure"
+)
+
+func TestRunDump(t *testing.T) {
+	type args struct {
+		cmdCtx  *cmdcontext.CmdCtx
+		dumpCtx *DumpCtx
+		cliOpts *config.CliOpts
+	}
+
+	cliOpts, configPath, err := configure.GetCliOpts("./testdata/tt_cfg.yaml")
+	require.NoError(t, err)
+	require.Equal(t, "testdata/tt_cfg.yaml", configPath)
+
+	cwd, err := os.Getwd()
+	require.NoError(t, err)
+	configDir := filepath.Join(cwd, "testdata")
+
+	tests := []struct {
+		name       string
+		args       args
+		wantWriter string
+		wantErr    bool
+	}{
+		{
+			name: "Raw dump of configuration file",
+			args: args{
+				&cmdcontext.CmdCtx{
+					Cli: cmdcontext.CliCtx{
+						ConfigPath: "./testdata/tt_cfg.yaml",
+					},
+				},
+				&DumpCtx{RawDump: true},
+				configure.GetDefaultCliOpts(),
+			},
+			wantWriter: `./testdata/tt_cfg.yaml:
+tt:
+  app:
+    inc_dir: ./test_inc
+    log_maxsize: 1024
+  modules:
+    directory: /root/modules
+`,
+			wantErr: false,
+		},
+		{
+			name: "Default config dump",
+			args: args{
+				&cmdcontext.CmdCtx{
+					Cli: cmdcontext.CliCtx{
+						ConfigPath: "./testdata/tt_cfg.yaml",
+					},
+				},
+				&DumpCtx{RawDump: false},
+				cliOpts,
+			},
+			wantWriter: fmt.Sprintf(`./testdata/tt_cfg.yaml:
+tt:
+  modules:
+    directory: /root/modules
+  app:
+    run_dir: %[1]s/var/run
+    log_dir: %[1]s/var/log
+    log_maxsize: 1024
+    log_maxage: 8
+    log_maxbackups: 10
+    restart_on_failure: false
+    data_dir: %[1]s/var/lib
+    bin_dir: %[1]s/bin
+    inc_dir: %[1]s/test_inc
+    instances_enabled: .
+  ee:
+    credential_path: ""
+  templates: []
+  repo:
+    rocks: ""
+    distfiles: %[1]s/distfiles
+`, configDir),
+			wantErr: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			writer := &bytes.Buffer{}
+			err := RunDump(writer, tt.args.cmdCtx, tt.args.dumpCtx, tt.args.cliOpts)
+			if tt.wantErr {
+				require.Error(t, err)
+				return
+			} else {
+				require.NoError(t, err)
+			}
+			gotWriter := writer.String()
+			require.EqualValues(t, tt.wantWriter, gotWriter)
+		})
+	}
+}

cli/cfg/testdata/tt_cfg.yaml

@@ -0,0 +1,6 @@
+tt:
+  app:
+    inc_dir: ./test_inc
+    log_maxsize: 1024
+  modules:
+    directory: /root/modules

cli/cmd/cfg.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// NewCfgCmd creates a new cfg command.
+func NewCfgCmd() *cobra.Command {
+	var cfgCmd = &cobra.Command{
+		Use:                   "cfg <command> [command flags]",
+		DisableFlagParsing:    true,
+		DisableFlagsInUseLine: true,
+		Short:                 "Environment configuration management utility",
+		Run: func(cmd *cobra.Command, args []string) {
+			cmd.Help()
+		},
+		Example: `# Print tt environment configuration:
+
+	$ tt cfg dump`,
+	}
+	cfgCmd.AddCommand(
+		NewDumpCmd(),
+	)
+
+	return cfgCmd
+}

cli/cmd/cfg_dump.go

@@ -0,0 +1,42 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/tarantool/tt/cli/cfg"
+	"github.com/tarantool/tt/cli/cmdcontext"
+	"github.com/tarantool/tt/cli/modules"
+)
+
+var (
+	rawDump bool
+)
+
+// NewDumpCmd creates a new dump command.
+func NewDumpCmd() *cobra.Command {
+	var dumpCmd = &cobra.Command{
+		Use:   "dump",
+		Short: "Print environment configuration",
+		Run: func(cmd *cobra.Command, args []string) {
+			cmdCtx.CommandName = cmd.Name()
+			err := modules.RunCmd(&cmdCtx, cmd.CommandPath(), &modulesInfo,
+				internalDumpModule, args)
+			handleCmdErr(cmd, err)
+		},
+	}
+
+	dumpCmd.Flags().BoolVarP(&rawDump, "raw", "r", false,
+		"Display the raw contents of tt environment config.")
+
+	return dumpCmd
+}
+
+// internalDumpModule is a default dump module.
+func internalDumpModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
+	dumpCtx := cfg.DumpCtx{
+		RawDump: rawDump,
+	}
+
+	return cfg.RunDump(os.Stdout, cmdCtx, &dumpCtx, cliOpts)
+}

cli/cmd/root.go

@@ -120,6 +120,7 @@ func NewCmdRoot() *cobra.Command {
 		NewPackCmd(),
 		NewInitCmd(),
 		NewDaemonCmd(),
+		NewCfgCmd(),
 	)
 	if err := injectCmds(rootCmd); err != nil {
 		panic(err.Error())

test/integration/cfg/test_dump.py

@@ -0,0 +1,114 @@
+import os
+import shutil
+import subprocess
+
+
+def test_cfg_dump_default(tt_cmd, tmpdir):
+    shutil.copy(os.path.join(os.path.dirname(__file__), "tt_cfg.yaml"),
+                os.path.join(tmpdir, "tarantool.yaml"))
+
+    buid_cmd = [tt_cmd, "cfg", "dump"]
+    tt_process = subprocess.Popen(
+        buid_cmd,
+        cwd=tmpdir,
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+        stdin=subprocess.PIPE,
+        text=True
+    )
+    tt_process.stdin.close()
+    tt_process.wait()
+    assert tt_process.returncode == 0
+
+    output = tt_process.stdout.read()
+    assert "bin_dir: /usr/bin" in output
+    assert "run_dir: /var/run" in output
+    assert f"data_dir: {os.path.join(tmpdir, 'var', 'lib')}" in output
+    assert f"log_dir: {os.path.join(tmpdir, 'var', 'log')}" in output
+    assert f"inc_dir: {os.path.join(tmpdir, 'include')}" in output
+    assert f"directory: {os.path.join(tmpdir, 'new_modules')}" in output
+    assert f"distfiles: {os.path.join(tmpdir, 'distfiles')}" in output
+    assert "log_maxsize: 100" in output
+    assert "log_maxbackups: 12" in output
+    assert "instances_enabled: ." in output
+    assert "templates: []" in output
+    assert 'credential_path: ""' in output
+
+
+def test_cfg_dump_raw(tt_cmd, tmpdir):
+    shutil.copy(os.path.join(os.path.dirname(__file__), "tt_cfg.yaml"),
+                os.path.join(tmpdir, "tarantool.yaml"))
+
+    buid_cmd = [tt_cmd, "cfg", "dump", "--raw"]
+    tt_process = subprocess.Popen(
+        buid_cmd,
+        cwd=tmpdir,
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+        stdin=subprocess.PIPE,
+        text=True
+    )
+    tt_process.stdin.close()
+    tt_process.wait()
+    assert tt_process.returncode == 0
+
+    output = tt_process.stdout.read()
+    assert output == f"""{os.path.join(tmpdir, "tarantool.yaml")}:
+tt:
+  modules:
+    directory: new_modules
+  app:
+    run_dir: /var/run
+    log_dir: ./var/log
+    log_maxbackups: 12
+    data_dir: var/lib
+    bin_dir: /usr/bin
+"""
+
+
+def test_cfg_dump_no_config(tt_cmd, tmpdir):
+    buid_cmd = [tt_cmd, "cfg", "dump", "--raw"]
+    tt_process = subprocess.Popen(
+        buid_cmd,
+        cwd=tmpdir,
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+        stdin=subprocess.PIPE,
+        text=True
+    )
+    tt_process.stdin.close()
+    tt_process.wait()
+    assert tt_process.returncode == 1
+
+    output = tt_process.stdout.read()
+    assert "tt configuration file is not found" in output
+
+
+def test_cfg_dump_default_no_config(tt_cmd, tmpdir):
+    buid_cmd = [tt_cmd, "cfg", "dump"]
+    tt_process = subprocess.Popen(
+        buid_cmd,
+        cwd=tmpdir,
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+        stdin=subprocess.PIPE,
+        text=True
+    )
+    tt_process.stdin.close()
+    tt_process.wait()
+    assert tt_process.returncode == 0
+
+    output = tt_process.stdout.read()
+    print(output)
+    assert f"bin_dir: {os.path.join(tmpdir, 'bin')}" in output
+    assert f"run_dir: {os.path.join(tmpdir, 'var', 'run')}" in output
+    assert f"data_dir: {os.path.join(tmpdir, 'var', 'lib')}" in output
+    assert f"log_dir: {os.path.join(tmpdir, 'var', 'log')}" in output
+    assert f"inc_dir: {os.path.join(tmpdir, 'include')}" in output
+    assert f"directory: {os.path.join(tmpdir, 'modules')}" in output
+    assert f"distfiles: {os.path.join(tmpdir, 'distfiles')}" in output
+    assert "log_maxsize: 100" in output
+    assert "log_maxbackups: 10" in output
+    assert "instances_enabled: ." in output
+    assert f"templates:\n  - path: {os.path.join(tmpdir, 'templates')}" in output
+    assert 'credential_path: ""' in output

test/integration/cfg/tt_cfg.yaml

@@ -0,0 +1,9 @@
+tt:
+  modules:
+    directory: new_modules
+  app:
+    run_dir: /var/run
+    log_dir: ./var/log
+    log_maxbackups: 12
+    data_dir: var/lib
+    bin_dir: /usr/bin