aboutsummaryrefslogtreecommitdiffstats
path: root/internal/configloader/configloader.go
blob: 281ed1fcb9a75a80bade2e213ccc970ef9b968e9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Package configloader implements a Config type for loading in the
// configuration to be used by the app.
//
// It supports reading in configuration from the "bolt.toml" file
// if it can be found in the current directory or any parent directory
// and it supports reading in environment variables. Furthermore, if
// both a configuration file is found and environment variables are set,
// the environment variables will take precedence.
package configloader

import (
	"errors"
	"os"
	"path/filepath"
	"runtime"

	"github.com/BurntSushi/toml"
	"github.com/kelseyhightower/envconfig"
)

var errConfigFileNotFound = errors.New(
	"bolt configuration file not found in current directory or any parent directories",
)

// Config represents the application configuration settings.
//
// This can come from the TOML file or environment variables,
// with environment variables taking precedence.
type Config struct {
	Migrations MigrationsConfig `toml:"bolt.migrations"`

	// Information related to how to connect to the database
	// that is desired to run migrations against.
	Connection ConnectionConfig `toml:"bolt.db.connection"`
}

type MigrationsConfig struct {
	DirectoryPath string `toml:"directory_path" envconfig:"BOLT_MIGRATIONS_DIR_PATH"`
}

type ConnectionConfig struct {
	Host     string `toml:"host"     envconfig:"BOLT_DB_CONN_HOST"`
	Port     int    `toml:"port"     envconfig:"BOLT_DB_CONN_PORT"`
	User     string `toml:"user"     envconfig:"BOLT_DB_CONN_USER"`
	Password string `toml:"password" envconfig:"BOLT_DB_CONN_PASSWORD"`
	DBName   string `toml:"dbname"   envconfig:"BOLT_DB_CONN_DBNAME"`
	Driver   string `toml:"driver"   envconfig:"BOLT_DB_CONN_DRIVER"`
}

func NewConfig() (*Config, error) {
	filePath, err := findConfigFilePath()
	if err != nil && !errors.Is(err, errConfigFileNotFound) {
		return nil, err
	}

	cfg := Config{Migrations: MigrationsConfig{DirectoryPath: "migrations"}}
	if !errors.Is(err, errConfigFileNotFound) {
		_, err = toml.DecodeFile(filePath, &cfg)
		if err != nil {
			return nil, err
		}
	}

	err = envconfig.Process("", &cfg)
	if err != nil {
		return nil, err
	}

	return &cfg, nil
}

func findConfigFilePath() (filePath string, err error) {
	const configFileName = "bolt.toml"
	var rootDir = fsRootDir()

	dir, err := os.Getwd()
	if err != nil {
		return "", err
	}

	for {
		entries, err := os.ReadDir(dir)
		if err != nil {
			return "", err
		}

		for _, e := range entries {
			if e.Name() == configFileName {
				return filepath.Join(dir, e.Name()), nil
			}
		}

		if dir == rootDir {
			return "", errConfigFileNotFound
		}

		dir = filepath.Dir(dir)
	}
}

// fsRootDir retrieves the root directory
// of the filesystem on Windows or any unix-like
// operating system.
func fsRootDir() string {
	if runtime.GOOS == "windows" {
		return os.Getenv("SystemDrive")
	}
	return "/"
}