Add config option to disable log coloration (#103)

* Add config option to disable log coloration

Color logs are great in person, but not so awesome when you're trying
to view them in a log aggregation services e.g. splunk, stackdriver,
ELK, etc.

* dump running config to log on startup

* init config before testing

...and use a temporary directory for config_test, lest the presence
of a local one cause confusing test results.

Author: memory

build/config.yaml

@@ -5,6 +5,7 @@ RedisHost: localhost:6379 # If using the redis backend, a host:port combination
 RedisPassword: replace me # if using the redis backend, a conneciton password.
 DataDir: ./data # Contains: the database and the private key
 EnableDebugMode: true # Activates more detailed logging
+EnableColorLogs: true # Enables/disables ANSI color sequences in log output; default is true
 ShortedIDLength: 10 # Length of the random generated ID which is used for new shortened URLs
 AuthBackend: oauth # Can be 'oauth' or 'proxy'
 Google:  # only relevant when using the oauth authbackend

main.go

@@ -14,11 +14,19 @@ import (
 
 func main() {
 	stop := make(chan os.Signal, 1)
+	if err := initConfig(); err != nil {
+		logrus.Fatal(err)
+	}
 	signal.Notify(stop, os.Interrupt)
 	logrus.SetFormatter(&logrus.TextFormatter{
-		ForceColors: true,
+		ForceColors:   util.GetConfig().EnableColorLogs,
+		DisableColors: !util.GetConfig().EnableColorLogs,
 	})
-	logrus.SetOutput(ansicolor.NewAnsiColorWriter(os.Stdout))
+	if util.GetConfig().EnableColorLogs == true {
+		logrus.SetOutput(ansicolor.NewAnsiColorWriter(os.Stdout))
+	} else {
+		logrus.SetOutput(os.Stdout)
+	}
 	close, err := initShortener()
 	if err != nil {
 		logrus.Fatalf("could not init shortener: %v", err)
@@ -28,10 +36,14 @@ func main() {
 	close()
 }
 
-func initShortener() (func(), error) {
+func initConfig() error {
 	if err := util.ReadInConfig(); err != nil {
-		return nil, errors.Wrap(err, "could not reload config file")
+		return errors.Wrap(err, "could not load config")
 	}
+	return nil
+}
+
+func initShortener() (func(), error) {
 	if util.GetConfig().EnableDebugMode {
 		logrus.SetLevel(logrus.DebugLevel)
 	}

main_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"io/ioutil"
 	"net"
 	"testing"
 	"time"
@@ -9,6 +10,14 @@ import (
 )
 
 func TestInitShortener(t *testing.T) {
+	tmpdir, err := ioutil.TempDir("", "shorten")
+	if err != nil {
+		t.Fatal(err)
+	}
+	util.Config.DataDir = tmpdir
+	if err = initConfig(); err != nil {
+		t.Fatal(err)
+	}
 	close, err := initShortener()
 	if err != nil {
 		t.Fatalf("could not init shortener: %v", err)

util/config.go

@@ -23,6 +23,7 @@ type Configuration struct {
 	AuthBackend     string        `yaml:"AuthBackend" env:"AUTH_BACKEND"`
 	UseSSL          bool          `yaml:"EnableSSL" env:"USE_SSL"`
 	EnableDebugMode bool          `yaml:"EnableDebugMode" env:"ENABLE_DEBUG_MODE"`
+	EnableColorLogs bool          `yaml:"EnableColorLogs" env:"ENABLE_COLOR_LOGS"`
 	ShortedIDLength int           `yaml:"ShortedIDLength" env:"SHORTED_ID_LENGTH"`
 	Google          oAuthConf     `yaml:"Google" env:"GOOGLE"`
 	GitHub          oAuthConf     `yaml:"GitHub" env:"GITHUB"`
@@ -42,12 +43,13 @@ type proxyAuthConf struct {
 }
 
 // config contains the default values
-var config = Configuration{
+var Config = Configuration{
 	ListenAddr:      ":8080",
 	BaseURL:         "http://localhost:3000",
 	DataDir:         "data",
 	Backend:         "boltdb",
 	EnableDebugMode: false,
+	EnableColorLogs: true,
 	UseSSL:          false,
 	ShortedIDLength: 4,
 	AuthBackend:     "oauth",
@@ -57,23 +59,24 @@ var config = Configuration{
 func ReadInConfig() error {
 	file, err := ioutil.ReadFile("config.yaml")
 	if err == nil {
-		if err := yaml.Unmarshal(file, &config); err != nil {
+		if err := yaml.Unmarshal(file, &Config); err != nil {
 			return errors.Wrap(err, "could not unmarshal yaml file")
 		}
 	} else if !os.IsNotExist(err) {
 		return errors.Wrap(err, "could not read config file")
 	} else {
 		logrus.Info("No configuration file found, using defaults with environment variable overrides.")
 	}
-	if err := envstruct.ApplyEnvVars(&config, "GUS"); err != nil {
+	if err := envstruct.ApplyEnvVars(&Config, "GUS"); err != nil {
 		return errors.Wrap(err, "could not apply environment configuration")
 	}
-	config.DataDir, err = filepath.Abs(config.DataDir)
+	logrus.Info("Loaded configuration: %v", Config)
+	Config.DataDir, err = filepath.Abs(Config.DataDir)
 	if err != nil {
 		return errors.Wrap(err, "could not get relative data dir path")
 	}
-	if _, err = os.Stat(config.DataDir); os.IsNotExist(err) {
-		if err = os.MkdirAll(config.DataDir, 0755); err != nil {
+	if _, err = os.Stat(Config.DataDir); os.IsNotExist(err) {
+		if err = os.MkdirAll(Config.DataDir, 0755); err != nil {
 			return errors.Wrap(err, "could not create config directory")
 		}
 	}
@@ -86,10 +89,10 @@ func (o oAuthConf) Enabled() bool {
 
 // GetConfig returns the configuration from the memory
 func GetConfig() Configuration {
-	return config
+	return Config
 }
 
 // SetConfig sets the configuration into the memory
 func SetConfig(c Configuration) {
-	config = c
+	Config = c
 }

util/config_test.go

@@ -8,6 +8,6 @@ func TestReadInConfig(t *testing.T) {
 	if err := ReadInConfig(); err != nil {
 		t.Fatalf("could not read in config file: %v", err)
 	}
-	config := config
+	config := Config
 	config.DataDir = "./test"
 }

util/private.go

@@ -14,7 +14,7 @@ var privateKey []byte
 // CheckForPrivateKey checks if already an private key exists, if not it will
 // be randomly generated and saved as a private.dat file in the data directory
 func CheckForPrivateKey() error {
-	privateDatPath := filepath.Join(config.DataDir, "private.dat")
+	privateDatPath := filepath.Join(Config.DataDir, "private.dat")
 	privateDatContent, err := ioutil.ReadFile(privateDatPath)
 	if err == nil {
 		privateKey = privateDatContent

util/private_test.go

@@ -14,7 +14,7 @@ func TestCheckforPrivateKey(t *testing.T) {
 	if GetPrivateKey() == nil {
 		t.Fatalf("private key is nil")
 	}
-	if err := os.RemoveAll(config.DataDir); err != nil {
+	if err := os.RemoveAll(Config.DataDir); err != nil {
 		t.Fatalf("could not remove data dir: %v", err)
 	}
 }