Add CLI overrides and log config option

Fixes #3

Author: binarymason

config.go

@@ -13,6 +13,7 @@ const defaultCertPath = "/etc/bashrpc/"
 type config struct {
 	Cert        string   `yaml:"cert"`
 	Key         string   `yaml:"key"`
+	Log         string   `yaml:"log"`
 	Port        string   `yaml:"port"`
 	Routes      []route  `yaml:"routes"`
 	Secret      string   `yaml:"secret"`
@@ -39,12 +40,13 @@ func loadConfig(p string) (config, error) {
 
 func setConfigDefaults(cfg *config) {
 	defaultPKIPath := "/etc/bashrpc/pki"
-	cfg.Key = defaultPKIPath + "/bashrpc.key"
 	cfg.Cert = defaultPKIPath + "/bashrpc.cert"
+	cfg.Key = defaultPKIPath + "/bashrpc.key"
+	cfg.Log = "bashrpc.log"
 	cfg.Port = "8675"
 }
 
-func validateConfig(cfg config) error {
+func validateConfig(cfg *config) (err error) {
 	var issues []string
 
 	if cfg.Port == "" {
@@ -63,13 +65,17 @@ func validateConfig(cfg config) error {
 		issues = append(issues, "cert is missing")
 	}
 
+	if cfg.Log == "" {
+		issues = append(issues, "log is missing")
+	}
+
 	if len(cfg.Whitelisted) == 0 {
 		issues = append(issues, "no whitelisted clients are specified")
 	}
 
 	if len(issues) > 0 {
-		return errors.New("config validation errors: " + strings.Join(issues, ", "))
+		err = errors.New("config validation errors: " + strings.Join(issues, ", "))
 	}
 
-	return nil
+	return
 }

config_test.go

@@ -24,6 +24,7 @@ func TestSetConfigDefaults(t *testing.T) {
 	Assert(cfg.Port, "8675", t)
 	Assert(cfg.Key, "/etc/bashrpc/pki/bashrpc.key", t)
 	Assert(cfg.Cert, "/etc/bashrpc/pki/bashrpc.cert", t)
+	Assert(cfg.Log, "bashrpc.log", t)
 }
 
 var validConfig = config{
@@ -32,12 +33,13 @@ var validConfig = config{
 	Whitelisted: []string{"127.0.0.1"},
 	Key:         "/path/to/key",
 	Cert:        "/path/to/cert",
+	Log:         "/path/to/log",
 }
 
 func TestValidConfig(t *testing.T) {
 	When("config is valid")
 	Then("there should be NO errors")
-	if err := validateConfig(validConfig); err != nil {
+	if err := validateConfig(&validConfig); err != nil {
 		t.Errorf("expected NO errors but received %v", err)
 	}
 }
@@ -48,7 +50,7 @@ func TestConfigMissingPort(t *testing.T) {
 	cfg.Port = ""
 
 	Then("an error is returned")
-	if err := validateConfig(cfg); err == nil {
+	if err := validateConfig(&cfg); err == nil {
 		t.Error("expected errors but received none")
 	}
 }
@@ -59,7 +61,7 @@ func TestConfigMissingSecret(t *testing.T) {
 	cfg.Secret = ""
 
 	Then("an error is returned")
-	if err := validateConfig(cfg); err == nil {
+	if err := validateConfig(&cfg); err == nil {
 		t.Error("expected errors but received none")
 	}
 }
@@ -70,7 +72,7 @@ func TestConfigMissingWhitelisted(t *testing.T) {
 	cfg.Whitelisted = []string{}
 
 	Then("an error is returned")
-	if err := validateConfig(cfg); err == nil {
+	if err := validateConfig(&cfg); err == nil {
 		t.Error("expected errors but received none")
 	}
 }
@@ -81,7 +83,7 @@ func TestConfigMissingKey(t *testing.T) {
 	cfg.Key = ""
 
 	Then("an error is returned")
-	if err := validateConfig(cfg); err == nil {
+	if err := validateConfig(&cfg); err == nil {
 		t.Error("expected errors but received none")
 	}
 }
@@ -92,7 +94,18 @@ func TestConfigMissingCert(t *testing.T) {
 	cfg.Cert = ""
 
 	Then("an error is returned")
-	if err := validateConfig(cfg); err == nil {
+	if err := validateConfig(&cfg); err == nil {
+		t.Error("expected errors but received none")
+	}
+}
+
+func TestConfigMissingLog(t *testing.T) {
+	When("log file is not specified")
+	cfg := validConfig
+	cfg.Log = ""
+
+	Then("an error is returned")
+	if err := validateConfig(&cfg); err == nil {
 		t.Error("expected errors but received none")
 	}
 }

logging.go

@@ -3,8 +3,13 @@ package main
 import (
 	"log"
 	"net/http"
+	"os"
 )
 
+func initLog(logPath string) (*os.File, error) {
+	return os.OpenFile(logPath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+}
+
 type loggingResponseWriter struct {
 	http.ResponseWriter
 	statusCode int

main.go

@@ -8,44 +8,73 @@ import (
 	"os"
 )
 
-var (
+type options struct {
 	configPath string
 	logPath    string
-)
+	port       string
+}
+
+var opts options
 
 func init() {
 	c := flag.String("c", "", "specify bashRPC config file")
+	p := flag.String("p", "", "specify bashRPC port")
 	l := flag.String("log", "bashrpc.log", "specify log file")
 	flag.Parse()
 
-	configPath = *c
-	logPath = *l
+	opts = options{
+		configPath: *c,
+		logPath:    *l,
+		port:       *p,
+	}
 }
 
 func main() {
-	if configPath == "" {
+	if opts.configPath == "" {
 		fmt.Println("config file argument is required")
 		flag.Usage()
 		os.Exit(1)
 	}
 
-	logFile, err := os.OpenFile(logPath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+	var (
+		logFile *os.File
+		cfg     config
+		err     error
+		rtr     router
+	)
+
+	if cfg, err = loadConfig(opts.configPath); err != nil {
+		panic(err)
+	}
+
+	overrideConfigWithOptions(&cfg, opts)
 
-	if err != nil {
+	if err = validateConfig(&cfg); err != nil {
+		panic(err)
+	}
+
+	if logFile, err = initLog(opts.logPath); err != nil {
 		panic(err)
 	}
 
 	defer logFile.Close()
 	log.SetOutput(io.MultiWriter(os.Stdout, logFile))
+	log.Println("logging to", opts.logPath)
 
-	rtr, err := newRouter(configPath)
-	if err != nil {
-		log.Fatal(fmt.Sprintf("%v", err))
-		os.Exit(1)
+	if rtr, err = newRouter(cfg); err != nil {
+		panic(err)
 	}
 
-	if err := rtr.listen(); err != nil {
-		log.Fatal(fmt.Sprintf("%v", err))
-		os.Exit(1)
+	if err = rtr.listen(); err != nil {
+		panic(err)
+	}
+}
+
+func overrideConfigWithOptions(cfg *config, opts options) {
+	if opts.logPath != "" {
+		cfg.Log = opts.logPath
+	}
+	if opts.port != "" {
+		cfg.Port = opts.port
 	}
 }

main_test.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"testing"
+
+	. "github.com/binarymason/bashRPC/internal/testhelpers"
+)
+
+func TestCLIOverrides(t *testing.T) {
+	cfg := config{
+		Log:  "/path/to/log",
+		Port: "8443",
+	}
+
+	opts := options{
+		logPath: "/path/to/another/log",
+		port:    "3210",
+	}
+
+	overrideConfigWithOptions(&cfg, opts)
+
+	Assert(cfg.Log, "/path/to/another/log", t)
+	Assert(cfg.Port, "3210", t)
+}

router.go

@@ -12,20 +12,9 @@ type router struct {
 	config config
 }
 
-func newRouter(p string) (router, error) {
-	rtr := router{}
-	cfg, err := loadConfig(p)
-
-	if err != nil {
-		return rtr, err
-	}
-
-	if err := validateConfig(cfg); err != nil {
-		return rtr, err
-	}
-
+// TODO: combine config struct with router
+func newRouter(cfg config) (rtr router, err error) {
 	rtr.config = cfg
-
 	return rtr, nil
 }