aboutsummaryrefslogtreecommitdiffstats
path: root/internal/configloader
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-03-02 11:07:30 -0500
committerGitHub <noreply@github.com>2024-03-02 11:07:30 -0500
commit571bc9bf2efa841b29bf036f4d307664bfbe155d (patch)
tree41fb3a459db99d1f0ec2ed2e00d4ca580a5d0c46 /internal/configloader
parentUpdate readme (diff)
parentRemove Latest() from migration fs repo in favor of using List on service (diff)
downloadcli-571bc9bf2efa841b29bf036f4d307664bfbe155d.zip
Merge pull request #1 from eugenetriguba/0.3.0
Diffstat (limited to 'internal/configloader')
-rw-r--r--internal/configloader/configloader.go39
-rw-r--r--internal/configloader/configloader_test.go43
-rw-r--r--internal/configloader/configloader_unix_test.go13
-rw-r--r--internal/configloader/configloader_windows_test.go15
4 files changed, 83 insertions, 27 deletions
diff --git a/internal/configloader/configloader.go b/internal/configloader/configloader.go
index c50ec24..c2c05e7 100644
--- a/internal/configloader/configloader.go
+++ b/internal/configloader/configloader.go
@@ -10,6 +10,7 @@ package configloader
import (
"errors"
+ "fmt"
"os"
"path/filepath"
"runtime"
@@ -18,8 +19,21 @@ import (
"github.com/kelseyhightower/envconfig"
)
-var errConfigFileNotFound = errors.New(
- "bolt configuration file not found in current directory or any parent directories",
+type VersionStyle string
+
+const (
+ VersionStyleSequential VersionStyle = "sequential"
+ VersionStyleTimestamp VersionStyle = "timestamp"
+)
+
+var (
+ ErrConfigFileNotFound = errors.New(
+ "bolt configuration file not found in current directory or any parent directories",
+ )
+ ErrInvalidVersionStyle = fmt.Errorf(
+ "invalid version style for bolt migrations. supported styles: %v",
+ []VersionStyle{VersionStyleSequential, VersionStyleTimestamp},
+ )
)
// Config represents the application configuration settings.
@@ -35,7 +49,8 @@ type Config struct {
}
type MigrationsConfig struct {
- DirectoryPath string `toml:"directory_path" envconfig:"BOLT_MIGRATIONS_DIR_PATH"`
+ DirectoryPath string `toml:"directory_path" envconfig:"BOLT_MIGRATIONS_DIR_PATH"`
+ VersionStyle VersionStyle `toml:"version_style" envconfig:"BOLT_MIGRATIONS_VERSION_STYLE"`
}
type ConnectionConfig struct {
@@ -49,12 +64,17 @@ type ConnectionConfig struct {
func NewConfig() (*Config, error) {
filePath, err := findConfigFilePath()
- if err != nil && !errors.Is(err, errConfigFileNotFound) {
+ if err != nil && !errors.Is(err, ErrConfigFileNotFound) {
return nil, err
}
- cfg := Config{Migrations: MigrationsConfig{DirectoryPath: "migrations"}}
- if !errors.Is(err, errConfigFileNotFound) {
+ cfg := Config{
+ Migrations: MigrationsConfig{
+ DirectoryPath: "migrations",
+ VersionStyle: VersionStyleTimestamp,
+ },
+ }
+ if !errors.Is(err, ErrConfigFileNotFound) {
_, err = toml.DecodeFile(filePath, &cfg)
if err != nil {
return nil, err
@@ -66,6 +86,11 @@ func NewConfig() (*Config, error) {
return nil, err
}
+ if cfg.Migrations.VersionStyle != VersionStyleSequential &&
+ cfg.Migrations.VersionStyle != VersionStyleTimestamp {
+ return nil, ErrInvalidVersionStyle
+ }
+
return &cfg, nil
}
@@ -91,7 +116,7 @@ func findConfigFilePath() (filePath string, err error) {
}
if dir == rootDir {
- return "", errConfigFileNotFound
+ return "", ErrConfigFileNotFound
}
dir = filepath.Dir(dir)
diff --git a/internal/configloader/configloader_test.go b/internal/configloader/configloader_test.go
index a41c2be..0ad6930 100644
--- a/internal/configloader/configloader_test.go
+++ b/internal/configloader/configloader_test.go
@@ -7,21 +7,39 @@ import (
"github.com/eugenetriguba/bolt/internal/bolttest"
"github.com/eugenetriguba/bolt/internal/configloader"
- "gotest.tools/v3/assert"
+ "github.com/eugenetriguba/checkmate/assert"
+ "github.com/eugenetriguba/checkmate/check"
)
-func TestNewConfigMigrationsDirPathDefault(t *testing.T) {
+func TestNewConfigDefaults(t *testing.T) {
bolttest.ChangeCwd(t, os.TempDir())
cfg, err := configloader.NewConfig()
- assert.NilError(t, err)
+ assert.Nil(t, err)
- assert.Equal(t, cfg.Migrations.DirectoryPath, "migrations")
+ check.Equal(t, cfg.Migrations.DirectoryPath, "migrations")
+ check.Equal(t, cfg.Migrations.VersionStyle, configloader.VersionStyleTimestamp)
+}
+
+func TestNewConfigWithInvalidVersionStyle(t *testing.T) {
+ fileCfg := configloader.Config{
+ Migrations: configloader.MigrationsConfig{
+ DirectoryPath: "myfancymigrations",
+ VersionStyle: "invalid",
+ },
+ }
+ bolttest.CreateConfigFile(t, &fileCfg, "bolt.toml")
+
+ _, err := configloader.NewConfig()
+ assert.ErrorIs(t, err, configloader.ErrInvalidVersionStyle)
}
func TestNewConfigFindsFileAndPopulatesConfigStruct(t *testing.T) {
expectedCfg := configloader.Config{
- Migrations: configloader.MigrationsConfig{DirectoryPath: "myfancymigrations"},
+ Migrations: configloader.MigrationsConfig{
+ DirectoryPath: "myfancymigrations",
+ VersionStyle: configloader.VersionStyleSequential,
+ },
Connection: configloader.ConnectionConfig{
Host: "testhost",
Port: 1234,
@@ -34,13 +52,16 @@ func TestNewConfigFindsFileAndPopulatesConfigStruct(t *testing.T) {
bolttest.CreateConfigFile(t, &expectedCfg, "bolt.toml")
cfg, err := configloader.NewConfig()
- assert.NilError(t, err)
+ assert.Nil(t, err)
assert.DeepEqual(t, *cfg, expectedCfg)
}
func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
fileCfg := configloader.Config{
- Migrations: configloader.MigrationsConfig{DirectoryPath: "cfgmigrations"},
+ Migrations: configloader.MigrationsConfig{
+ DirectoryPath: "cfgmigrations",
+ VersionStyle: configloader.VersionStyleSequential,
+ },
Connection: configloader.ConnectionConfig{
Host: "testhost",
Port: 1234,
@@ -53,7 +74,10 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
bolttest.CreateConfigFile(t, &fileCfg, "bolt.toml")
envCfg := configloader.Config{
- Migrations: configloader.MigrationsConfig{DirectoryPath: "envmigrations"},
+ Migrations: configloader.MigrationsConfig{
+ DirectoryPath: "envmigrations",
+ VersionStyle: configloader.VersionStyleTimestamp,
+ },
Connection: configloader.ConnectionConfig{
Host: "envtesthost",
Port: 4321,
@@ -63,6 +87,7 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
Driver: "postgres",
},
}
+ t.Setenv("BOLT_MIGRATIONS_VERSION_STYLE", string(envCfg.Migrations.VersionStyle))
t.Setenv("BOLT_MIGRATIONS_DIR_PATH", envCfg.Migrations.DirectoryPath)
t.Setenv("BOLT_DB_CONN_HOST", envCfg.Connection.Host)
t.Setenv("BOLT_DB_CONN_PORT", fmt.Sprintf("%d", envCfg.Connection.Port))
@@ -72,6 +97,6 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
t.Setenv("BOLT_DB_CONN_DRIVER", envCfg.Connection.Driver)
cfg, err := configloader.NewConfig()
- assert.NilError(t, err)
+ assert.Nil(t, err)
assert.DeepEqual(t, *cfg, envCfg)
}
diff --git a/internal/configloader/configloader_unix_test.go b/internal/configloader/configloader_unix_test.go
index dcd8ebd..8043bdb 100644
--- a/internal/configloader/configloader_unix_test.go
+++ b/internal/configloader/configloader_unix_test.go
@@ -1,4 +1,4 @@
-// go:build unix
+//go:build unix
package configloader_test
@@ -8,21 +8,24 @@ import (
"github.com/eugenetriguba/bolt/internal/bolttest"
"github.com/eugenetriguba/bolt/internal/configloader"
- "gotest.tools/v3/assert"
+ "github.com/eugenetriguba/checkmate/assert"
)
func TestNewConfigUnixSearchesToRootFilePath(t *testing.T) {
expectedCfg := configloader.Config{
- Migrations: configloader.MigrationsConfig{DirectoryPath: "differentmigrationsdir"},
+ Migrations: configloader.MigrationsConfig{
+ DirectoryPath: "differentmigrationsdir",
+ VersionStyle: configloader.VersionStyleSequential,
+ },
}
bolttest.CreateConfigFile(t, &expectedCfg, "/bolt.toml")
homedir, err := os.UserHomeDir()
- assert.NilError(t, err)
+ assert.Nil(t, err)
bolttest.ChangeCwd(t, homedir)
cfg, err := configloader.NewConfig()
- assert.NilError(t, err)
+ assert.Nil(t, err)
assert.DeepEqual(t, *cfg, expectedCfg)
}
diff --git a/internal/configloader/configloader_windows_test.go b/internal/configloader/configloader_windows_test.go
index 42f2978..1ba6c51 100644
--- a/internal/configloader/configloader_windows_test.go
+++ b/internal/configloader/configloader_windows_test.go
@@ -1,4 +1,4 @@
-// go:build windows
+//go:build windows
package configloader_test
@@ -9,23 +9,26 @@ import (
"github.com/eugenetriguba/bolt/internal/bolttest"
"github.com/eugenetriguba/bolt/internal/configloader"
- "gotest.tools/v3/assert"
+ "github.com/eugenetriguba/checkmate/assert"
)
func TestNewConfigWindowsSearchesToRootFilePath(t *testing.T) {
expectedCfg := configloader.Config{
- Migrations: configloader.MigrationsConfig{DirectoryPath: "differentmigrationsdir"},
+ Migrations: configloader.MigrationsConfig{
+ DirectoryPath: "differentmigrationsdir",
+ VersionStyle: configloader.VersionStyleSequential,
+ },
}
configPath := filepath.Join(os.Getenv("SystemDrive"), "bolt.toml")
bolttest.CreateConfigFile(t, &expectedCfg, configPath)
- assert.NilError(t, err)
+ assert.Nil(t, err)
homedir, err := os.UserHomeDir()
- assert.NilError(t, err)
+ assert.Nil(t, err)
bolttest.ChangeCwd(t, homedir)
cfg, err := configloader.NewConfig()
- assert.NilError(t, err)
+ assert.Nil(t, err)
assert.DeepEqual(t, *cfg, expectedCfg)
}