move args to config package

logger package rewrite as dlog

6 files changed, 146 insertions, 46 deletions

diff --git a/internal/config/args.go b/internal/config/args.go
new file mode 100644
index 0000000..89e4bc9
--- /dev/null
+++ b/internal/config/args.go
@@ -0,0 +1,105 @@
+package config
+
+import (
+	"flag"
+	"fmt"
+	"strings"
+
+	"github.com/mimecast/dtail/internal/omode"
+
+	gossh "golang.org/x/crypto/ssh"
+)
+
+// Args is a helper struct to summarize common client arguments.
+type Args struct {
+	Arguments          []string
+	ConfigFile         string
+	ConnectionsPerCPU  int
+	Discovery          string
+	LogLevel           string
+	Mode               omode.Mode
+	NoColor            bool
+	PrivateKeyPathFile string
+	Quiet              bool
+	RegexInvert        bool
+	RegexStr           string
+	Serverless         bool
+	ServersStr         string
+	Spartan            bool
+	SSHAuthMethods     []gossh.AuthMethod
+	SSHHostKeyCallback gossh.HostKeyCallback
+	SSHPort            int
+	Timeout            int
+	TrustAllHosts      bool
+	UserName           string
+	What               string
+}
+
+func (a *Args) String() string {
+	var sb strings.Builder
+
+	sb.WriteString("Args(")
+	sb.WriteString(fmt.Sprintf("%s:%s,", "LogLevel", a.LogLevel))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Arguments", a.Arguments))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "ConfigFile", a.ConfigFile))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "ConnectionsPerCPU", a.ConnectionsPerCPU))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Discovery", a.Discovery))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Mode", a.Mode))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "NoColor", a.NoColor))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "PrivateKeyPathFile", a.PrivateKeyPathFile))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Quiet", a.Quiet))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "RegexInvert", a.RegexInvert))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "RegexStr", a.RegexStr))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Serverless", a.Serverless))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "ServersStr", a.ServersStr))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Spartan", a.Spartan))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "SSHAuthMethods", a.SSHAuthMethods))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "SSHHostKeyCallback", a.SSHHostKeyCallback))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "SSHPort", a.SSHPort))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "Timeout", a.Timeout))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "TrustAllHosts", a.TrustAllHosts))
+	sb.WriteString(fmt.Sprintf("%s:%v,", "UserName", a.UserName))
+	sb.WriteString(fmt.Sprintf("%s:%v", "What", a.What))
+	sb.WriteString(")")
+
+	return sb.String()
+}
+
+// Based on the argument list, transform/manipulate some of the arguments.
+func (a *Args) transform(args []string) {
+	if a.LogLevel != "" {
+		Common.LogLevel = a.LogLevel
+	}
+
+	if a.SSHPort != 2222 {
+		Common.SSHPort = a.SSHPort
+	}
+	if a.NoColor {
+		Client.TermColorsEnable = false
+	}
+
+	if a.Spartan {
+		a.Quiet = true
+		a.NoColor = true
+	}
+
+	if a.Discovery == "" && a.ServersStr == "" {
+		a.Serverless = true
+	}
+
+	// Interpret additional args as file list.
+	if a.What == "" {
+		var files []string
+		for _, file := range flag.Args() {
+			files = append(files, file)
+		}
+		a.What = strings.Join(files, ",")
+	}
+}
+
+// SerializeOptions returns a string ready to be sent over the wire to the server.
+func (a *Args) SerializeOptions() string {
+	return fmt.Sprintf("quiet=%v:spartan=%v", a.Quiet, a.Spartan)
+}
+
+// TODO: Put the DeseializeOptions function here (move it away from the internal/server package)
diff --git a/internal/config/common.go b/internal/config/common.go
index c3e203e..7d45261 100644
--- a/internal/config/common.go
+++ b/internal/config/common.go
@@ -6,10 +6,8 @@ type CommonConfig struct {
 	SSHPort int
 	// Enable experimental features (mainly for dev purposes)
 	ExperimentalFeaturesEnable bool `json:",omitempty"`
-	// Enable debug logging. Don't enable in production.
-	DebugEnable bool `json:",omitempty"`
-	// Enable trace logging. Don't enable in production.
-	TraceEnable bool `json:",omitempty"`
+	// LogLevel defines how much is logged. TODO: Adjust JSONschema
+	LogLevel string `json:",omitempty"`
 	// The log strategy to use, one of
 	//   stdout: only log to stdout (useful when used with systemd)
 	//   daily: create a log file for every day
@@ -26,8 +24,6 @@ type CommonConfig struct {
 func newDefaultCommonConfig() *CommonConfig {
 	return &CommonConfig{
 		SSHPort:                    2222,
-		DebugEnable:                false,
-		TraceEnable:                false,
 		ExperimentalFeaturesEnable: false,
 		LogDir:                     "log",
 		CacheDir:                   "cache",
diff --git a/internal/config/config.go b/internal/config/config.go
index 276ddcf..2d77041 100644
--- a/internal/config/config.go
+++ b/internal/config/config.go
@@ -15,6 +15,9 @@ const ScheduleUser string = "DTAIL-SCHEDULE"
 // ContinuousUser is used for non-interactive continuous mapreduce queries.
 const ContinuousUser string = "DTAIL-CONTINUOUS"
 
+// TestUser is used for unit tests and potentially also for integration tests.
+const TestUser string = "DTAIL-TEST"
+
 // InterruptTimeoutS is used to terminate DTail when Ctrl+C was pressed twice within a given interval.
 const InterruptTimeoutS int = 3
 
diff --git a/internal/config/read.go b/internal/config/read.go
deleted file mode 100644
index ea358f8..0000000
--- a/internal/config/read.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package config
-
-import (
-	"os"
-)
-
-// Read the DTail configuration.
-func Read(configFile string, sshPort int, noColor bool) {
-	initializer := configInitializer{
-		Common: newDefaultCommonConfig(),
-		Server: newDefaultServerConfig(),
-		Client: newDefaultClientConfig(),
-	}
-
-	if configFile == "" {
-		configFile = "./cfg/dtail.json"
-	}
-
-	if _, err := os.Stat(configFile); !os.IsNotExist(err) {
-		initializer.parseConfig(configFile)
-	}
-
-	// Assign pointers to global variables, so that we can access the
-	// configuration from any place of the program.
-	Common = initializer.Common
-	Server = initializer.Server
-	Client = initializer.Client
-
-	if Server.MapreduceLogFormat == "" {
-		Server.MapreduceLogFormat = "default"
-	}
-
-	// If non-standard port specified, overwrite config
-	if sshPort != 2222 {
-		Common.SSHPort = sshPort
-	}
-	if noColor {
-		Client.TermColorsEnable = false
-	}
-}
diff --git a/internal/config/server.go b/internal/config/server.go
index dc0d587..8bbb394 100644
--- a/internal/config/server.go
+++ b/internal/config/server.go
@@ -76,6 +76,7 @@ func newDefaultServerConfig() *ServerConfig {
 		MaxConcurrentTails: 50,
 		HostKeyFile:        "./cache/ssh_host_key",
 		HostKeyBits:        4096,
+		MapreduceLogFormat: "default",
 		Permissions: Permissions{
 			Default: defaultPermissions,
 		},
diff --git a/internal/config/setup.go b/internal/config/setup.go
new file mode 100644
index 0000000..3c4bcc4
--- /dev/null
+++ b/internal/config/setup.go
@@ -0,0 +1,35 @@
+package config
+
+import (
+	"os"
+)
+
+const NoConfigFile string = "Don't read a config file - use defaults only"
+
+// Setup the DTail configuration.
+func Setup(args *Args, additionalArgs []string) {
+	initializer := configInitializer{
+		Common: newDefaultCommonConfig(),
+		Server: newDefaultServerConfig(),
+		Client: newDefaultClientConfig(),
+	}
+
+	if args.ConfigFile == "" {
+		// TODO: Search more paths for config file (e.g. in /etc and in ~/.config/...
+		args.ConfigFile = "./cfg/dtail.json"
+	}
+
+	if args.ConfigFile != NoConfigFile {
+		if _, err := os.Stat(args.ConfigFile); !os.IsNotExist(err) {
+			initializer.parseConfig(args.ConfigFile)
+		}
+	}
+
+	// Assign pointers to global variables, so that we can access the
+	// configuration from any place of the program.
+	Common = initializer.Common
+	Server = initializer.Server
+	Client = initializer.Client
+
+	args.transform(additionalArgs)
+}