Decouple vttest tests from user's config (#258)

* Make DefaultConfig safer

Instead of having a global mutable DefaultConfig which might be
changed by anything during run/test time turn DefaultConfig into a
function which returns a fresh DefaultConfig. This is safer and more
convenient.

* Decouple vttest tests from user's config

The screen capture tests were failing on my machine because the screen
capture based vttest tests were using my personal config in
~/.config/aminal/config.toml. This had different colours and a fixed
DPI scaling factor which mean the screen captures didn't match.

The sixel tests were also failing because my login shell is a highly
customised zsh.

A static test config is now passed by the vttest tests and the shell
is set to "/bin/sh" on Linux, OSX etc to help avoid problems due to
differences between shells and shell configs.

config.go

@@ -22,6 +22,13 @@ func getActuallyProvidedFlags() map[string]bool {
 	return result
 }
 
+func maybeGetConfig(override *config.Config) *config.Config {
+	if override != nil {
+		return override
+	}
+	return getConfig()
+}
+
 func getConfig() *config.Config {
 	showVersion := false
 	ignoreConfig := false
@@ -53,7 +60,7 @@ func getConfig() *config.Config {
 
 	var conf *config.Config
 	if ignoreConfig {
-		conf = &config.DefaultConfig
+		conf = config.DefaultConfig()
 	} else {
 		conf = loadConfigFile()
 	}
@@ -83,12 +90,12 @@ func loadConfigFile() *config.Config {
 	usr, err := user.Current()
 	if err != nil {
 		fmt.Printf("Failed to get current user information: %s\n", err)
-		return &config.DefaultConfig
+		return config.DefaultConfig()
 	}
 
 	home := usr.HomeDir
 	if home == "" {
-		return &config.DefaultConfig
+		return config.DefaultConfig()
 	}
 
 	places := []string{}
@@ -111,7 +118,7 @@ func loadConfigFile() *config.Config {
 		}
 	}
 
-	if b, err := config.DefaultConfig.Encode(); err != nil {
+	if b, err := config.DefaultConfig().Encode(); err != nil {
 		fmt.Printf("Failed to encode config file: %s\n", err)
 	} else {
 		err = os.MkdirAll(filepath.Dir(places[0]), 0744)
@@ -124,5 +131,5 @@ func loadConfigFile() *config.Config {
 		}
 	}
 
-	return &config.DefaultConfig
+	return config.DefaultConfig()
 }

config/config.go

@@ -24,12 +24,12 @@ type Config struct {
 type KeyMappingConfig map[string]string
 
 func Parse(data []byte) (*Config, error) {
-	c := DefaultConfig
+	c := DefaultConfig()
-	err := toml.Unmarshal(data, &c)
+	err := toml.Unmarshal(data, c)
 	if c.KeyMapping == nil {
 		c.KeyMapping = KeyMappingConfig(map[string]string{})
 	}
-	return &c, err
+	return c, err
 }
 
 func (c *Config) Encode() ([]byte, error) {

config/defaults.go

@@ -2,52 +2,50 @@ package config
 
 import "runtime"
 
-var DefaultConfig = Config{
+func DefaultConfig() *Config {
-	DebugMode: false,
+	return &Config{
-	ColourScheme: ColourScheme{
+		DebugMode: false,
-		Cursor:       strToColourNoErr("#e8dfd6"),
+		ColourScheme: ColourScheme{
-		Foreground:   strToColourNoErr("#e8dfd6"),
+			Cursor:       strToColourNoErr("#e8dfd6"),
-		Background:   strToColourNoErr("#021b21"),
+			Foreground:   strToColourNoErr("#e8dfd6"),
-		Black:        strToColourNoErr("#000000"),
+			Background:   strToColourNoErr("#021b21"),
-		Red:          strToColourNoErr("#800000"),
+			Black:        strToColourNoErr("#000000"),
-		Green:        strToColourNoErr("#008000"),
+			Red:          strToColourNoErr("#800000"),
-		Yellow:       strToColourNoErr("#808000"),
+			Green:        strToColourNoErr("#008000"),
-		Blue:         strToColourNoErr("#000080"),
+			Yellow:       strToColourNoErr("#808000"),
-		Magenta:      strToColourNoErr("#800080"),
+			Blue:         strToColourNoErr("#000080"),
-		Cyan:         strToColourNoErr("#008080"),
+			Magenta:      strToColourNoErr("#800080"),
-		LightGrey:    strToColourNoErr("#f2f2f2"),
+			Cyan:         strToColourNoErr("#008080"),
-		DarkGrey:     strToColourNoErr("#808080"),
+			LightGrey:    strToColourNoErr("#f2f2f2"),
-		LightRed:     strToColourNoErr("#ff0000"),
+			DarkGrey:     strToColourNoErr("#808080"),
-		LightGreen:   strToColourNoErr("#00ff00"),
+			LightRed:     strToColourNoErr("#ff0000"),
-		LightYellow:  strToColourNoErr("#ffff00"),
+			LightGreen:   strToColourNoErr("#00ff00"),
-		LightBlue:    strToColourNoErr("#0000ff"),
+			LightYellow:  strToColourNoErr("#ffff00"),
-		LightMagenta: strToColourNoErr("#ff00ff"),
+			LightBlue:    strToColourNoErr("#0000ff"),
-		LightCyan:    strToColourNoErr("#00ffff"),
+			LightMagenta: strToColourNoErr("#ff00ff"),
-		White:        strToColourNoErr("#ffffff"),
+			LightCyan:    strToColourNoErr("#00ffff"),
-		Selection:    strToColourNoErr("#333366"),
+			White:        strToColourNoErr("#ffffff"),
-	},
+			Selection:    strToColourNoErr("#333366"),
-	KeyMapping:            KeyMappingConfig(map[string]string{}),
+		},
-	SearchURL:             "https://www.google.com/search?q=$QUERY",
+		KeyMapping: KeyMappingConfig(map[string]string{
-	MaxLines:              1000,
+			string(ActionCopy):        addMod("c"),
-	CopyAndPasteWithMouse: true,
+			string(ActionPaste):       addMod("v"),
-}
+			string(ActionSearch):      addMod("g"),
-
+			string(ActionToggleDebug): addMod("d"),
-func init() {
+			string(ActionToggleSlomo): addMod(";"),
-	DefaultConfig.KeyMapping[string(ActionCopy)] = addMod("c")
+			string(ActionReportBug):   addMod("r"),
-	DefaultConfig.KeyMapping[string(ActionPaste)] = addMod("v")
+			string(ActionBufferClear): addMod("k"),
-	DefaultConfig.KeyMapping[string(ActionSearch)] = addMod("g")
+		}),
-	DefaultConfig.KeyMapping[string(ActionToggleDebug)] = addMod("d")
+		SearchURL:             "https://www.google.com/search?q=$QUERY",
-	DefaultConfig.KeyMapping[string(ActionToggleSlomo)] = addMod(";")
+		MaxLines:              1000,
-	DefaultConfig.KeyMapping[string(ActionReportBug)] = addMod("r")
+		CopyAndPasteWithMouse: true,
-	DefaultConfig.KeyMapping[string(ActionBufferClear)] = addMod("k")
+	}
 }
 
 func addMod(keys string) string {
 	standardMod := "ctrl + shift + "
-
 	if runtime.GOOS == "darwin" {
 		standardMod = "super + "
 	}
-
 	return standardMod + keys
 }

main.go

@@ -7,6 +7,7 @@ import (
 	"runtime"
 	"runtime/pprof"
 
+	"github.com/liamg/aminal/config"
 	"github.com/liamg/aminal/gui"
 	"github.com/liamg/aminal/platform"
 	"github.com/liamg/aminal/terminal"
@@ -20,11 +21,12 @@ func init() {
 }
 
 func main() {
-	initialize(nil)
+	initialize(nil, nil)
 }
 
-func initialize(unitTestfunc callback) {
+func initialize(unitTestfunc callback, configOverride *config.Config) {
-	conf := getConfig()
+	conf := maybeGetConfig(configOverride)
+
 	logger, err := getLogger(conf)
 	if err != nil {
 		fmt.Printf("Failed to create logger: %s\n", err)

main_test.go

@@ -6,10 +6,12 @@ import (
 	"flag"
 	"fmt"
 	"os"
+	"runtime"
 	"strings"
 	"testing"
 	"time"
 
+	"github.com/liamg/aminal/config"
 	"github.com/liamg/aminal/gui"
 	"github.com/liamg/aminal/terminal"
 
@@ -123,7 +125,7 @@ func TestCursorMovement(t *testing.T) {
 			g.Close()
 		}
 
-		initialize(testFunc)
+		initialize(testFunc, testConfig())
 	})
 }
 
@@ -159,7 +161,7 @@ func TestScreenFeatures(t *testing.T) {
 			g.Close()
 		}
 
-		initialize(testFunc)
+		initialize(testFunc, testConfig())
 	})
 }
 
@@ -184,7 +186,7 @@ func TestSixel(t *testing.T) {
 			g.Close()
 		}
 
-		initialize(testFunc)
+		initialize(testFunc, testConfig())
 	})
 }
 
@@ -192,3 +194,14 @@ func TestSixel(t *testing.T) {
 func TestExit(t *testing.T) {
 	os.Exit(0)
 }
+
+func testConfig() *config.Config {
+	c := config.DefaultConfig()
+
+	// Use a vanilla shell on POSIX to help ensure consistency.
+	if runtime.GOOS != "windows" {
+		c.Shell = "/bin/sh"
+	}
+
+	return c
+}