daemon: add daemon module

`tt daemon` module is used to manage HTTP server
running on the background. HTTP server can process
`tt` commands such as `start`, `status`, etc.
Daemon can be configurated with `tt_daemon.yaml` config.

The following set of commands is implemented:

* `tt daemon start` - launch of a daemon;
* `tt daemon stop` - terminate of the daemon;
* `tt daemon status` - get daemon status;
* `tt daemon restart` - daemon restart.

Closes #10

Author: AnaNek

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Module ``tt init``, to create tt environment configuration file.
+- Module ``tt daemon`` to launch ``tt`` as a daemon HTTP server.
 
 ## [0.1.0] - 2022-10-12
 

README.rst

@@ -314,3 +314,4 @@ Common description. For a detailed description, use ``tt help command`` .
 * ``install`` - install tarantool/tt.
 * ``remove`` - remove tarantool/tt.
 * ``init`` - create tt environment configuration file.
+* ``daemon`` - manage ``tt`` daemon HTTP server.

cli/cmd/clean.go

@@ -110,7 +110,7 @@ func internalCleanModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
 	}
 
 	for _, run := range cmdCtx.Running {
-		status := running.Status(cmdCtx, &run)
+		status := running.Status(cmdCtx, run.PIDFile)
 		if status == running.InstStateStopped {
 			var statusMsg string
 

cli/cmd/daemon.go

@@ -0,0 +1,162 @@
+package cmd
+
+import (
+	"github.com/apex/log"
+	"github.com/spf13/cobra"
+	"github.com/tarantool/tt/cli/cmdcontext"
+	"github.com/tarantool/tt/cli/configure"
+	"github.com/tarantool/tt/cli/daemon"
+	"github.com/tarantool/tt/cli/modules"
+	"github.com/tarantool/tt/cli/running"
+)
+
+// NewDaemonCmd creates daemon command.
+func NewDaemonCmd() *cobra.Command {
+	var daemonCmd = &cobra.Command{
+		Use:   "daemon",
+		Short: "Perform manipulations with the tarantool daemon",
+	}
+
+	var startCmd = &cobra.Command{
+		Use:   "start",
+		Short: "start tt daemon",
+		Run: func(cmd *cobra.Command, args []string) {
+			if len(args) != 0 {
+				log.Fatalf("Wrong number of arguments")
+			}
+
+			err := modules.RunCmd(&cmdCtx, cmd.Name(), &modulesInfo,
+				internalDaemonStartModule, args)
+			if err != nil {
+				log.Fatalf(err.Error())
+			}
+		},
+	}
+
+	var stopCmd = &cobra.Command{
+		Use:   "stop",
+		Short: "stop tt daemon",
+		Run: func(cmd *cobra.Command, args []string) {
+			if len(args) != 0 {
+				log.Fatalf("Wrong number of arguments")
+			}
+
+			err := modules.RunCmd(&cmdCtx, cmd.Name(), &modulesInfo,
+				internalDaemonStopModule, args)
+			if err != nil {
+				log.Fatalf(err.Error())
+			}
+		},
+	}
+
+	var statusCmd = &cobra.Command{
+		Use:   "status",
+		Short: "status of tt daemon",
+		Run: func(cmd *cobra.Command, args []string) {
+			if len(args) != 0 {
+				log.Fatalf("Wrong number of arguments")
+			}
+
+			err := modules.RunCmd(&cmdCtx, cmd.Name(), &modulesInfo,
+				internalDaemonStatusModule, args)
+			if err != nil {
+				log.Fatalf(err.Error())
+			}
+		},
+	}
+
+	var restartCmd = &cobra.Command{
+		Use:   "restart",
+		Short: "restart tt daemon",
+		Run: func(cmd *cobra.Command, args []string) {
+			if len(args) != 0 {
+				log.Fatalf("Wrong number of arguments")
+			}
+
+			err := modules.RunCmd(&cmdCtx, cmd.Name(), &modulesInfo,
+				internalDaemonRestartModule, args)
+			if err != nil {
+				log.Fatalf(err.Error())
+			}
+		},
+	}
+
+	daemonSubCommands := []*cobra.Command{
+		startCmd,
+		stopCmd,
+		statusCmd,
+		restartCmd,
+	}
+
+	for _, cmd := range daemonSubCommands {
+		daemonCmd.AddCommand(cmd)
+	}
+
+	return daemonCmd
+}
+
+// internalDaemonStartModule is a default restart module.
+func internalDaemonRestartModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
+	if err := internalDaemonStopModule(cmdCtx, args); err != nil {
+		return err
+	}
+
+	if err := internalDaemonStartModule(cmdCtx, args); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// internalDaemonStartModule is a default start module.
+func internalDaemonStartModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
+	opts, err := configure.GetDaemonOpts(cmdCtx.Cli.DaemonCfgPath)
+	if err != nil {
+		return err
+	}
+
+	if err = running.FillDaemonCtx(opts, cmdCtx); err != nil {
+		log.Fatalf(err.Error())
+	}
+
+	if err := daemon.RunHTTPServerOnBackground(cmdCtx); err != nil {
+		log.Fatalf(err.Error())
+	}
+
+	return nil
+}
+
+// internalDaemonStopModule is a default stop module.
+func internalDaemonStopModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
+	opts, err := configure.GetDaemonOpts(cmdCtx.Cli.DaemonCfgPath)
+	if err != nil {
+		return err
+	}
+
+	if err = running.FillDaemonCtx(opts, cmdCtx); err != nil {
+		log.Fatalf(err.Error())
+	}
+
+	if err := running.Stop(cmdCtx, cmdCtx.Daemon.PIDFile,
+		cmdCtx.Daemon.ConsoleSocket, "Daemon"); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// internalDaemonStatusModule is a default status module.
+func internalDaemonStatusModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
+	opts, err := configure.GetDaemonOpts(cmdCtx.Cli.DaemonCfgPath)
+	if err != nil {
+		return err
+	}
+
+	if err = running.FillDaemonCtx(opts, cmdCtx); err != nil {
+		log.Fatalf(err.Error())
+	}
+
+	log.Info(running.Status(cmdCtx, cmdCtx.Daemon.PIDFile))
+
+	return nil
+}

cli/cmd/root.go

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

cli/cmd/status.go

@@ -38,7 +38,7 @@ func internalStatusModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
 	}
 
 	for _, run := range cmdCtx.Running {
-		log.Infof("%s: %s", run.InstName, running.Status(cmdCtx, &run))
+		log.Infof("%s: %s", run.InstName, running.Status(cmdCtx, run.PIDFile))
 	}
 
 	return nil

cli/cmd/stop.go

@@ -38,7 +38,7 @@ func internalStopModule(cmdCtx *cmdcontext.CmdCtx, args []string) error {
 	}
 
 	for _, run := range cmdCtx.Running {
-		if err = running.Stop(cmdCtx, &run); err != nil {
+		if err = running.Stop(cmdCtx, run.PIDFile, run.ConsoleSocket, "Instance"); err != nil {
 			log.Infof(err.Error())
 		}
 	}

cli/cmdcontext/cmdcontext.go

@@ -14,6 +14,7 @@ type CmdCtx struct {
 	Running []RunningCtx
 	// Connect contains information for connecting to the instance.
 	Connect ConnectCtx
+	Daemon  DaemonCtx
 	// CommandName contains name of the command.
 	CommandName string
 	// Create contains information to create an application.
@@ -37,6 +38,8 @@ type CliCtx struct {
 	LocalLaunchDir string
 	// Path to Tarantool CLI (tarantool.yaml) config.
 	ConfigPath string
+	// Path to tt daemon (tt_daemon.yaml) config.
+	DaemonCfgPath string
 	// Path to Tarantool executable (detected if CLI launch is local).
 	TarantoolExecutable string
 	// Tarantool version.
@@ -204,3 +207,31 @@ type InitCtx struct {
 	// so init does not try to get directories information from exitsting config files.
 	SkipConfig bool
 }
+
+// DaemonCtx contains information for running an daemon instance.
+type DaemonCtx struct {
+	// Port is a port number to be used for daemon http server.
+	Port    int
+	// PIDFile is a path of a file contains pid of daemon process.
+	PIDFile string
+	// LogPath is a path to a file contains log of daemon process.
+	LogPath string
+	// LogMaxSize is the maximum size in megabytes of the log file
+	// before it gets rotated. It defaults to 100 megabytes.
+	LogMaxSize int
+	// LogMaxBackups is the maximum number of old log files to retain.
+	// The default is to retain all old log files (though LogMaxAge may
+	// still cause them to get deleted).
+	LogMaxBackups int
+	// LogMaxAge is the maximum number of days to retain old log files
+	// based on the timestamp encoded in their filename. Note that a
+	// day is defined as 24 hours and may not exactly correspond to
+	// calendar days due to daylight savings, leap seconds, etc. The
+	// default is not to remove old log files based on age.
+	LogMaxAge       int
+	// ListenInterface is a network interface the IP address
+	// should be found on to bind http server socket.
+	ListenInterface string
+	// Control UNIX socket for started instance.
+	ConsoleSocket string
+}

cli/config/daemon_cfg.go

@@ -0,0 +1,51 @@
+package config
+
+// DaemonCfg used to store all information from the
+// tt_daemon.yaml configuration file.
+type DaemonCfg struct {
+	DaemonConfig *DaemonOpts `mapstructure:"daemon" yaml:"daemon"`
+}
+
+// DaemonOpts stores information about tt daemon configuration.
+// Filled in when parsing the tt_daemon.yaml configuration file.
+//
+// tt_daemon.yaml file format:
+// daemon:
+//   run_dir: path
+//   log_dir: path
+//   log_maxsize: num (MB)
+//   log_maxage: num (Days)
+//   log_maxbackups: num
+//   log_file: string (file name)
+//   listen_interface: string
+//   port: num
+//   pidfile: string (file name)
+type DaemonOpts struct {
+	// PIDFile is name of file contains pid of daemon process.
+	PIDFile    string `mapstructure:"pidfile"`
+	// Port is a port number to be used for daemon http server.
+	Port       int    `mapstructure:"port"`
+	// LogDir is a directory that stores log files.
+	LogDir     string `mapstructure:"log_dir"`
+	// LogFile is a name of file contains log of daemon process.
+	LogFile    string `mapstructure:"log_file"`
+	// LogMaxSize is a maximum size in MB of the log file before
+	// it gets rotated.
+	LogMaxSize int    `mapstructure:"log_maxsize"`
+	// LogMaxAge is the maximum number of days to retain old log files
+	// based on the timestamp encoded in their filename. Note that a
+	// day is defined as 24 hours and may not exactly correspond to
+	// calendar days due to daylight savings, leap seconds, etc. The
+	// default is not to remove old log files based on age.
+	LogMaxAge int `mapstructure:"log_maxage"`
+	// LogMaxBackups is the maximum number of old log files to retain.
+	// The default is to retain all old log files (though LogMaxAge may
+	// still cause them to get deleted).
+	LogMaxBackups   int    `mapstructure:"log_maxbackups"`
+	// ListenInterface is a network interface the IP address
+	// should be found on to bind http server socket.
+	ListenInterface string `mapstructure:"listen_interface"`
+	// RunDir is a path to directory that stores various instance
+	// runtime artifacts like console socket, PID file, etc.
+	RunDir string `mapstructure:"run_dir" yaml:"run_dir"`
+}