begin config + cli refactoring

Author: crimist

cli_entry.go

@@ -6,30 +6,30 @@
 package main
 
 import (
+	"flag"
 	"fmt"
 	"os"
 
 	"github.com/crimist/trakx/config"
 	"github.com/crimist/trakx/controller"
-	"go.uber.org/zap"
 )
 
 func printHelp() {
 	help := "Commands:\n"
-	help += fmt.Sprintf("   %-12s returns the status of trakx\n", "status")
-	help += fmt.Sprintf("   %-12s starts trakx daemon\n", "start")
-	help += fmt.Sprintf("   %-12s stops trakx daemon\n", "stop")
-	help += fmt.Sprintf("   %-12s restarts trakx daemon\n", "restart")
-	help += fmt.Sprintf("   %-12s executes trakx, doesn't return\n", "execute")
-	help += fmt.Sprintf("   %-12s wipes trakx pid file, use if you encounter errors with start/stop/restart commands\n", "reset")
+	help += fmt.Sprintf("  %-12s returns the status of trakx\n", "status")
+	help += fmt.Sprintf("  %-12s starts trakx daemon\n", "start")
+	help += fmt.Sprintf("  %-12s stops trakx daemon\n", "stop")
+	help += fmt.Sprintf("  %-12s restarts trakx daemon\n", "restart")
+	help += fmt.Sprintf("  %-12s executes trakx, doesn't return\n", "execute")
+	help += fmt.Sprintf("  %-12s wipes trakx pid file\n", "reset")
 
-	help += "Usage:\n"
-	help += fmt.Sprintf("   %s <command>\n", os.Args[0])
+	help += "\nFlags:\n"
+	fmt.Fprint(os.Stderr, help)
+	flag.PrintDefaults()
 
-	help += "Example:\n"
-	help += fmt.Sprintf("   %s status\n", os.Args[0])
-
-	fmt.Print(help)
+	help = "\nExample:\n"
+	help += fmt.Sprintf("  %s -config trakx.yaml status\n", os.Args[0])
+	fmt.Fprint(os.Stderr, help)
 }
 
 func logFatal(err error) {
@@ -38,19 +38,21 @@ func logFatal(err error) {
 }
 
 func main() {
-	if len(os.Args) < 2 {
+	flag.Parse()
+
+	if flag.NArg() == 0 {
 		printHelp()
 		return
 	}
 
 	conf, err := config.Load()
 	if err != nil {
-		zap.L().Fatal("failed to load configuration", zap.Error(err))
+		logFatal(err)
 	}
 
 	controller := controller.NewController(conf)
 
-	switch os.Args[1] {
+	switch flag.Arg(0) {
 	case "status":
 		pidFileExists, processAlive, heartbeat := controller.Status()
 

cmd/run.go

@@ -33,14 +33,6 @@ func Run(conf *config.Configuration) {
 
 	zap.L().Debug("Starting Trakx")
 
-	warnings := conf.Validate()
-	if warnings&config.WarningUDPValidation != 0 {
-		zap.L().Warn("Configuration warning [UDP.ConnDB.Validate]: UDP connection validation is disabled. Do not expose this service to untrusted networks; it could be abused in UDP based amplification attacks.")
-	}
-	if warnings&config.WarningPeerExpiry != 0 {
-		zap.L().Warn("Configuration warning [conf.Announce]: Peer expiry time < announce interval. Peers will expire from the database between announces")
-	}
-
 	if conf.Stats.General {
 		if conf.Stats.Interval <= 0 {
 			zap.L().Fatal("Invalid configuration: Stats.Interval must be greater than 0 if Stats.General is enabled")

config/config.go

@@ -1,16 +1,18 @@
 package config
 
 import (
+	"os"
 	"path/filepath"
 	"time"
 
+	"github.com/pkg/errors"
 	"go.uber.org/zap"
 )
 
 type Configuration struct {
-	LogLevel  LogLevel
-	CachePath string
-	Stats     struct {
+	LogLevel LogLevel
+	Cache    string
+	Stats    struct {
 		General  bool
 		IP       bool
 		Interval time.Duration
@@ -61,56 +63,38 @@ type Configuration struct {
 	}
 }
 
-type Warnings int
-
-const (
-	WarningNone Warnings = 1 << iota
-	WarningUDPValidation
-	WarningPeerExpiry
-)
-
-// Validate ensures that configuration values are sane and returns warnings for potential misconfigurations or security issues
-func (conf *Configuration) Validate() Warnings {
-	warnings := WarningNone
+// validate checks that configuration values are sane and returns warnings for potential misconfigurations or security issues
+func (conf *Configuration) validate() error {
+	// check cache directory exists and is a directory
+	stat, err := os.Stat(conf.Cache)
+	if os.IsNotExist(err) {
+		zap.L().Debug("cache directory does not exist, creating it", zap.String("cache", conf.Cache))
+		if err = os.MkdirAll(conf.Cache, defaultFolderPermission); err != nil {
+			return errors.Wrapf(err, "failed to create cache directory '%s'", conf.Cache)
+		}
+	} else if err != nil {
+		return errors.Wrapf(err, "failed to stat cache '%s'", conf.Cache)
+	} else if !stat.IsDir() {
+		return errors.Errorf("cache '%s' is not a directory", conf.Cache)
+	}
 
+	// potential misconfigurations warnings
 	if !conf.UDP.ConnDB.Validate {
-		warnings |= WarningUDPValidation
+		zap.L().Warn("Configuration warning: UDP connection validation is disabled. Do not expose this service to untrusted networks; it could be abused in UDP based amplification attacks.")
 	}
 	if conf.DB.Expiry < conf.Announce.Base+conf.Announce.Fuzz {
-		warnings |= WarningPeerExpiry
+		zap.L().Warn("Configuration warning: Peer expiry time < announce base + fuzz. Peers will expire from the database between announces.")
 	}
 
-	return warnings
+	return nil
 }
 
 // LogPath returns the log path as defined by the configuration and current time
 func (conf *Configuration) LogPath() string {
-	return filepath.Join(conf.CachePath, "trakx_"+time.Now().Format("06-01-02-15-04-05")+".log")
+	return filepath.Join(conf.Cache, "trakx_"+time.Now().Format("06-01-02-15-04-05")+".log")
 }
 
 // PIDPath retuirns the pid file path
 func (conf *Configuration) PIDPath() string {
-	return filepath.Join(conf.CachePath, "trakx.pid")
-}
-
-// setLogLevel sets the desired loglevel in the in memory configuration and logger
-func (conf *Configuration) setLogLevel(level LogLevel) {
-	conf.LogLevel = level
-
-	switch level {
-	case "debug":
-		loggerAtom.SetLevel(zap.DebugLevel)
-		zap.L().Debug("Debug loglevel set, debug panics enabled")
-	case "info":
-		loggerAtom.SetLevel(zap.InfoLevel)
-	case "warn":
-		loggerAtom.SetLevel(zap.WarnLevel)
-	case "error":
-		loggerAtom.SetLevel(zap.ErrorLevel)
-	case "fatal":
-		loggerAtom.SetLevel(zap.FatalLevel)
-	default:
-		zap.L().Warn("Invalid log level was specified, defaulting to warn")
-		loggerAtom.SetLevel(zap.WarnLevel)
-	}
+	return filepath.Join(conf.Cache, "trakx.pid")
 }

config/embed.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"embed"
+	"fmt"
 	"os"
 	"path/filepath"
 	"syscall"
@@ -13,25 +14,30 @@ import (
 //go:embed embedded/*
 var embeddedFS embed.FS
 
-func writeEmbeddedConfig(path string) error {
+func installDefaultConfig(path string) error {
 	syscall.Umask(0)
 
-	if _, err := os.Stat(path); os.IsNotExist(err) {
-		configData, err := embeddedFS.ReadFile("embedded/trakx.yaml")
-		if err != nil {
-			return errors.Wrap(err, "failed to read embedded FS")
-		}
+	_, err := os.Stat(path)
 
-		if err = os.MkdirAll(filepath.Dir(path), folderPerm); err != nil {
-			zap.L().Warn("failed to create config directory", zap.Error(err))
-		}
-
-		if err = os.WriteFile(path, configData, filePerm); err != nil {
-			return errors.Wrap(err, "failed to write configuration file to "+path)
-		}
-	} else if err != nil {
+	if os.IsExist(err) {
+		zap.L().Debug("configuration file already exists, skipping installation", zap.String("path", path))
+		return nil
+	} else if err != nil && !os.IsNotExist(err) {
 		return errors.Wrap(err, "failed to stat config file "+path)
 	}
 
+	configurationContents, err := embeddedFS.ReadFile("embedded/trakx.yaml")
+	if err != nil {
+		return errors.Wrap(err, "failed to read config from embedded FS")
+	}
+
+	if err = os.MkdirAll(filepath.Dir(path), defaultFolderPermission); err != nil {
+		zap.L().Warn("failed to create configuration directory", zap.Error(err), zap.String("directory", filepath.Dir(path)))
+	}
+
+	if err = os.WriteFile(path, configurationContents, defaultFilePermission); err != nil {
+		return errors.Wrap(err, fmt.Sprintf("failed to write configuration file '%s'", path))
+	}
+
 	return nil
 }

config/embedded/trakx.yaml

@@ -1,15 +1,14 @@
 # Trakx YAML config
 #   Values can be overridden with env vars
-#     Example: `TRAKX_LOGLEVEL=debug trakx run`
-
-# TODO: find better names for these, ie conndb.trim should be conncache.expiry
+#     Example: `TRAKX_LOGLEVEL=debug trakx execute`
 
 # "debug", "info", "warn", "error", or "fatal"
 # "debug" will enable debug only panics
 loglevel: "info"
 
-# cachepath is the directory in which trakx will write it's pid, logs, and database
-cachepath: ~/.cache/trakx/
+# cache is the directory in which trakx will write it's pid, logs, and database persistence files
+# leave blank for default of XDG_CACHE_HOME/trakx
+cache:
 
 # Trakx can track statistic about itself such as the number of announces, seeds, unique ips, etc.
 # they are published via the expvar standard at '/stats'
@@ -24,10 +23,11 @@ stats:
   interval: 1s
 
 debug:
-  # port to serve pprof over, 0 to disable
-  pprof: 0
+  # port to serve pprof over, leave blank to disable
+  pprof:
 
 # --- REFACTOR BELOW ---
+# TODO: find better names for these, ie conndb.trim should be conncache.expiry
 
 # announce interval = base + [0, fuzz]
 announce:
@@ -107,13 +107,8 @@ db:
     #     pg    - write db to postgres
     type: "none"
 
-    # backup path:
-    # use "ENV:VARIABLE" for environment variables
-    #   ex: "ENV:TEST" = os.Getenv("TEST")
-    # types
-    #   file  - filepath
-    #   pg    - postgres db addr
-    path: "ENV:DATABASE_URL"
+    # backup path
+    path: ""
 
   # interval for removing expired peers
   trim: 10m