add tests for config

internal/configuration/configuration_test.go

@@ -0,0 +1,203 @@
+package configuration
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/jinzhu/configor"
+	"github.com/stretchr/testify/assert"
+	"gopkg.in/yaml.v2"
+)
+
+type Pair struct {
+	Is     interface{}
+	Should interface{}
+}
+
+func TestMain(m *testing.M) {
+	m.Run()
+	cleanUp()
+}
+
+func TestConfiguration_GetMinimal(t *testing.T) {
+	err := writeMinimalConfig()
+	if err != nil {
+		fmt.Println("Could not write minimal config: ", err)
+		os.Exit(1)
+	}
+
+	validateConfig(t)
+}
+
+func TestConfiguration_GetValid(t *testing.T) {
+	assert := assert.New(t)
+
+	err := writeValidConfig()
+	if err != nil {
+		fmt.Println("Could not write valid config: ", err)
+		os.Exit(1)
+	}
+
+	validateConfig(t)
+
+	config := Get()
+
+	expectedValues := make(map[string]Pair)
+	expectedValues["config.Admin.MatrixID"] = Pair{config.Admin.MatrixID, "000000"}
+	expectedValues["config.Matrix.Username"] = Pair{config.Matrix.Username, "default-username"}
+	expectedValues["config.Matrix.Password"] = Pair{config.Matrix.Password, "default-password"}
+
+	for name, pair := range expectedValues {
+		assert.Equalf(pair.Is, pair.Should, fmt.Sprintf("%s should be %v but is %v", name, pair.Should, pair.Is))
+	}
+}
+
+func TestConfiguration_GetEmpty(t *testing.T) {
+	err := writeEmptyConfig()
+	if err != nil {
+		fmt.Println("Could not write empty config: ", err)
+		os.Exit(1)
+	}
+
+	assert.Panicsf(t, func() { Get() }, "Get() did not panic altough config is empty")
+}
+
+func TestConfiguration_GetInvalid(t *testing.T) {
+	err := writeInvalidConfig()
+	if err != nil {
+		fmt.Println("Could not write empty config: ", err)
+		os.Exit(1)
+	}
+
+	assert.Panicsf(t, func() { Get() }, "Get() did not panic altough config is empty")
+}
+
+func TestConfiguaration_ConfigFiles(t *testing.T) {
+	files := configFiles()
+
+	assert.Greater(t, len(files), 0)
+	for _, file := range files {
+		assert.Truef(t, strings.HasSuffix(file, ".yml"), "%s is no yaml file", file)
+	}
+}
+
+// Checks if the values in the configuration are plausible
+func validateConfig(t *testing.T) {
+	assert := assert.New(t)
+	assert.NotPanicsf(func() { Get() }, "Get configuration should not panic")
+
+	config := Get()
+	asGreater := make(map[string]Pair)
+	asGreater["config.Crypto.Argon2.Memory"] = Pair{config.Crypto.Argon2.Memory, uint32(0)}
+	asGreater["config.Crypto.Argon2.Iterations"] = Pair{config.Crypto.Argon2.Iterations, uint32(0)}
+	asGreater["config.Crypto.Argon2.SaltLength"] = Pair{config.Crypto.Argon2.SaltLength, uint32(0)}
+	asGreater["config.Crypto.Argon2.KeyLength"] = Pair{config.Crypto.Argon2.KeyLength, uint32(0)}
+	asGreater["config.Crypto.Argon2.Parallelism"] = Pair{config.Crypto.Argon2.Parallelism, uint8(0)}
+	asGreater["config.HTTP.Port"] = Pair{config.HTTP.Port, 0}
+	for name, pair := range asGreater {
+		assert.Greaterf(pair.Is, pair.Should, fmt.Sprintf("%s should be > %v but is %v", name, pair.Should, pair.Is))
+	}
+
+	asFalse := make(map[string]bool)
+	asFalse["config.Formatting.ColoredTitle"] = config.Formatting.ColoredTitle
+	asFalse["config.Debug"] = config.Debug
+	asFalse["config.Security.CheckHIBP"] = config.Security.CheckHIBP
+	for name, value := range asFalse {
+		assert.Falsef(value, fmt.Sprintf("%s should be false but is %t", name, value))
+	}
+}
+
+type MinimalConfiguration struct {
+	Admin struct {
+		MatrixID string
+	}
+	Matrix struct {
+		Username string
+		Password string
+	}
+}
+
+type InvalidConfiguration struct {
+	Debug int
+	HTTP  struct {
+		ListenAddress bool
+	}
+	Admin struct {
+		Name int
+	}
+	Formatting string
+}
+
+// Writes a minimal config to config.yml
+func writeMinimalConfig() error {
+	cleanUp()
+	config := MinimalConfiguration{}
+	config.Admin.MatrixID = "000000"
+	config.Matrix.Username = "default-username"
+	config.Matrix.Password = "default-password"
+
+	configString, err := yaml.Marshal(&config)
+	if err != nil {
+		return err
+	}
+
+	return ioutil.WriteFile("config.yml", configString, 0644)
+}
+
+// Writes a config with default values to config.yml
+func writeValidConfig() error {
+	cleanUp()
+
+	// Load minimal config to get default values
+	writeMinimalConfig()
+	config := &Configuration{}
+	err := configor.New(&configor.Config{
+		Environment:          "production",
+		ENVPrefix:            "PUSHBITS",
+		ErrorOnUnmatchedKeys: true,
+	}).Load(config, "config.yml")
+	if err != nil {
+		return err
+	}
+
+	config.Admin.MatrixID = "000000"
+	config.Matrix.Username = "default-username"
+	config.Matrix.Password = "default-password"
+
+	configString, err := yaml.Marshal(&config)
+	if err != nil {
+		return err
+	}
+
+	return ioutil.WriteFile("config.yml", configString, 0644)
+}
+
+// Writes a config that is empty
+func writeEmptyConfig() error {
+	cleanUp()
+	return ioutil.WriteFile("config.yml", []byte(""), 0644)
+}
+
+// Writes a config with invalid entries
+func writeInvalidConfig() error {
+	cleanUp()
+	config := InvalidConfiguration{}
+	config.Debug = 1337
+	config.HTTP.ListenAddress = true
+	config.Admin.Name = 23
+	config.Formatting = "Nice"
+
+	configString, err := yaml.Marshal(&config)
+	if err != nil {
+		return err
+	}
+
+	return ioutil.WriteFile("config.yml", configString, 0644)
+}
+
+func cleanUp() error {
+	return os.Remove("config.yml")
+}