aboutsummaryrefslogtreecommitdiffstats
path: root/internal
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-01-13 21:47:26 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2024-01-13 21:47:26 -0500
commit34702d3802c8eb08cf4440c0cbb939b1db45168d (patch)
treea9d601c583d431092f74d3af7a98f6b84379ab20 /internal
parentTweak doc text (diff)
downloadcli-34702d3802c8eb08cf4440c0cbb939b1db45168d.zip
Update configuration format and env names
Diffstat (limited to 'internal')
-rw-r--r--internal/commands/down.go2
-rw-r--r--internal/commands/new.go2
-rw-r--r--internal/commands/status.go2
-rw-r--r--internal/commands/up.go2
-rw-r--r--internal/configloader/configloader.go25
-rw-r--r--internal/configloader/configloader_test.go24
-rw-r--r--internal/configloader/configloader_unix_test.go2
-rw-r--r--internal/configloader/configloader_windows_test.go2
-rw-r--r--internal/repositories/migration_fs_repo.go11
-rw-r--r--internal/repositories/migration_fs_repo_test.go16
10 files changed, 48 insertions, 40 deletions
diff --git a/internal/commands/down.go b/internal/commands/down.go
index d9965b5..262e229 100644
--- a/internal/commands/down.go
+++ b/internal/commands/down.go
@@ -69,7 +69,7 @@ func (cmd *DownCmd) Execute(
return subcommands.ExitFailure
}
- migrationFsRepo, err := repositories.NewMigrationFsRepo(cfg.MigrationsDir)
+ migrationFsRepo, err := repositories.NewMigrationFsRepo(&cfg.Migrations)
if err != nil {
consoleOutputter.Error(err.Error())
return subcommands.ExitFailure
diff --git a/internal/commands/new.go b/internal/commands/new.go
index 864de4e..a4eeff4 100644
--- a/internal/commands/new.go
+++ b/internal/commands/new.go
@@ -54,7 +54,7 @@ func (cmd *NewCmd) Execute(
return subcommands.ExitFailure
}
- migrationFsRepo, err := repositories.NewMigrationFsRepo(cfg.MigrationsDir)
+ migrationFsRepo, err := repositories.NewMigrationFsRepo(&cfg.Migrations)
if err != nil {
consoleOutputter.Error(err.Error())
return subcommands.ExitFailure
diff --git a/internal/commands/status.go b/internal/commands/status.go
index 2adafef..417e95b 100644
--- a/internal/commands/status.go
+++ b/internal/commands/status.go
@@ -59,7 +59,7 @@ func (m *StatusCmd) Execute(
return subcommands.ExitFailure
}
- migrationFsRepo, err := repositories.NewMigrationFsRepo(cfg.MigrationsDir)
+ migrationFsRepo, err := repositories.NewMigrationFsRepo(&cfg.Migrations)
if err != nil {
consoleOutputter.Error(err.Error())
return subcommands.ExitFailure
diff --git a/internal/commands/up.go b/internal/commands/up.go
index 57f9109..ba74299 100644
--- a/internal/commands/up.go
+++ b/internal/commands/up.go
@@ -69,7 +69,7 @@ func (cmd *UpCmd) Execute(
return subcommands.ExitFailure
}
- migrationFsRepo, err := repositories.NewMigrationFsRepo(cfg.MigrationsDir)
+ migrationFsRepo, err := repositories.NewMigrationFsRepo(&cfg.Migrations)
if err != nil {
consoleOutputter.Error(err.Error())
return subcommands.ExitFailure
diff --git a/internal/configloader/configloader.go b/internal/configloader/configloader.go
index d85548a..281ed1f 100644
--- a/internal/configloader/configloader.go
+++ b/internal/configloader/configloader.go
@@ -27,23 +27,24 @@ var errConfigFileNotFound = errors.New(
// This can come from the TOML file or environment variables,
// with environment variables taking precedence.
type Config struct {
- // Relative file path from the bolt configuration file.
- // This is optional and will default to "migrations" if
- // not specified.
- MigrationsDir string `toml:"migrations_dir" envconfig:"BOLT_MIGRATIONS_DIR"`
+ Migrations MigrationsConfig `toml:"bolt.migrations"`
// Information related to how to connect to the database
// that is desired to run migrations against.
- Connection ConnectionConfig `toml:"connection"`
+ 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_CONNECTION_HOST"`
- Port int `toml:"port" envconfig:"BOLT_CONNECTION_PORT"`
- User string `toml:"user" envconfig:"BOLT_CONNECTION_USER"`
- Password string `toml:"password" envconfig:"BOLT_CONNECTION_PASSWORD"`
- DBName string `toml:"dbname" envconfig:"BOLT_CONNECTION_DBNAME"`
- Driver string `toml:"driver" envconfig:"BOLT_CONNECTION_DRIVER"`
+ 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) {
@@ -52,7 +53,7 @@ func NewConfig() (*Config, error) {
return nil, err
}
- cfg := Config{MigrationsDir: "migrations"}
+ cfg := Config{Migrations: MigrationsConfig{DirectoryPath: "migrations"}}
if !errors.Is(err, errConfigFileNotFound) {
_, err = toml.DecodeFile(filePath, &cfg)
if err != nil {
diff --git a/internal/configloader/configloader_test.go b/internal/configloader/configloader_test.go
index 88c7f94..a41c2be 100644
--- a/internal/configloader/configloader_test.go
+++ b/internal/configloader/configloader_test.go
@@ -10,18 +10,18 @@ import (
"gotest.tools/v3/assert"
)
-func TestNewConfigMigrationsDirDefault(t *testing.T) {
+func TestNewConfigMigrationsDirPathDefault(t *testing.T) {
bolttest.ChangeCwd(t, os.TempDir())
cfg, err := configloader.NewConfig()
assert.NilError(t, err)
- assert.Equal(t, cfg.MigrationsDir, "migrations")
+ assert.Equal(t, cfg.Migrations.DirectoryPath, "migrations")
}
func TestNewConfigFindsFileAndPopulatesConfigStruct(t *testing.T) {
expectedCfg := configloader.Config{
- MigrationsDir: "myfancymigrations",
+ Migrations: configloader.MigrationsConfig{DirectoryPath: "myfancymigrations"},
Connection: configloader.ConnectionConfig{
Host: "testhost",
Port: 1234,
@@ -40,7 +40,7 @@ func TestNewConfigFindsFileAndPopulatesConfigStruct(t *testing.T) {
func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
fileCfg := configloader.Config{
- MigrationsDir: "cfgmigrations",
+ Migrations: configloader.MigrationsConfig{DirectoryPath: "cfgmigrations"},
Connection: configloader.ConnectionConfig{
Host: "testhost",
Port: 1234,
@@ -53,7 +53,7 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
bolttest.CreateConfigFile(t, &fileCfg, "bolt.toml")
envCfg := configloader.Config{
- MigrationsDir: "envmigrations",
+ Migrations: configloader.MigrationsConfig{DirectoryPath: "envmigrations"},
Connection: configloader.ConnectionConfig{
Host: "envtesthost",
Port: 4321,
@@ -63,13 +63,13 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) {
Driver: "postgres",
},
}
- t.Setenv("BOLT_MIGRATIONS_DIR", envCfg.MigrationsDir)
- t.Setenv("BOLT_CONNECTION_HOST", envCfg.Connection.Host)
- t.Setenv("BOLT_CONNECTION_PORT", fmt.Sprintf("%d", envCfg.Connection.Port))
- t.Setenv("BOLT_CONNECTION_USER", envCfg.Connection.User)
- t.Setenv("BOLT_CONNECTION_PASSWORD", envCfg.Connection.Password)
- t.Setenv("BOLT_CONNECTION_DBNAME", envCfg.Connection.DBName)
- t.Setenv("BOLT_CONNECTION_DRIVER", envCfg.Connection.Driver)
+ 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))
+ t.Setenv("BOLT_DB_CONN_USER", envCfg.Connection.User)
+ t.Setenv("BOLT_DB_CONN_PASSWORD", envCfg.Connection.Password)
+ t.Setenv("BOLT_DB_CONN_DBNAME", envCfg.Connection.DBName)
+ t.Setenv("BOLT_DB_CONN_DRIVER", envCfg.Connection.Driver)
cfg, err := configloader.NewConfig()
assert.NilError(t, err)
diff --git a/internal/configloader/configloader_unix_test.go b/internal/configloader/configloader_unix_test.go
index 412ef47..dcd8ebd 100644
--- a/internal/configloader/configloader_unix_test.go
+++ b/internal/configloader/configloader_unix_test.go
@@ -13,7 +13,7 @@ import (
func TestNewConfigUnixSearchesToRootFilePath(t *testing.T) {
expectedCfg := configloader.Config{
- MigrationsDir: "differentmigrationsdir",
+ Migrations: configloader.MigrationsConfig{DirectoryPath: "differentmigrationsdir"},
}
bolttest.CreateConfigFile(t, &expectedCfg, "/bolt.toml")
diff --git a/internal/configloader/configloader_windows_test.go b/internal/configloader/configloader_windows_test.go
index 5c8cee9..42f2978 100644
--- a/internal/configloader/configloader_windows_test.go
+++ b/internal/configloader/configloader_windows_test.go
@@ -14,7 +14,7 @@ import (
func TestNewConfigWindowsSearchesToRootFilePath(t *testing.T) {
expectedCfg := configloader.Config{
- MigrationsDir: "differentmigrationsdir",
+ Migrations: configloader.MigrationsConfig{DirectoryPath: "differentmigrationsdir"},
}
configPath := filepath.Join(os.Getenv("SystemDrive"), "bolt.toml")
bolttest.CreateConfigFile(t, &expectedCfg, configPath)
diff --git a/internal/repositories/migration_fs_repo.go b/internal/repositories/migration_fs_repo.go
index 1bec146..5478b5c 100644
--- a/internal/repositories/migration_fs_repo.go
+++ b/internal/repositories/migration_fs_repo.go
@@ -7,6 +7,7 @@ import (
"path/filepath"
"strings"
+ "github.com/eugenetriguba/bolt/internal/configloader"
"github.com/eugenetriguba/bolt/internal/models"
)
@@ -25,20 +26,20 @@ type MigrationFsRepo struct {
migrationsDirPath string
}
-func NewMigrationFsRepo(migrationsDirPath string) (*MigrationFsRepo, error) {
- fileInfo, err := os.Stat(migrationsDirPath)
+func NewMigrationFsRepo(migrationsConfig *configloader.MigrationsConfig) (*MigrationFsRepo, error) {
+ fileInfo, err := os.Stat(migrationsConfig.DirectoryPath)
if errors.Is(err, os.ErrNotExist) {
- err = os.MkdirAll(migrationsDirPath, 0755)
+ err = os.MkdirAll(migrationsConfig.DirectoryPath, 0755)
if err != nil {
return nil, err
}
} else if err != nil {
return nil, err
} else if err == nil && !fileInfo.IsDir() {
- return nil, &ErrIsNotDir{path: migrationsDirPath}
+ return nil, &ErrIsNotDir{path: migrationsConfig.DirectoryPath}
}
- return &MigrationFsRepo{migrationsDirPath: migrationsDirPath}, nil
+ return &MigrationFsRepo{migrationsDirPath: migrationsConfig.DirectoryPath}, nil
}
func (mr *MigrationFsRepo) Create(migration *models.Migration) error {
diff --git a/internal/repositories/migration_fs_repo_test.go b/internal/repositories/migration_fs_repo_test.go
index bb12097..8fdcd8f 100644
--- a/internal/repositories/migration_fs_repo_test.go
+++ b/internal/repositories/migration_fs_repo_test.go
@@ -7,6 +7,7 @@ import (
"testing"
"time"
+ "github.com/eugenetriguba/bolt/internal/configloader"
"github.com/eugenetriguba/bolt/internal/models"
"github.com/eugenetriguba/bolt/internal/repositories"
"gotest.tools/v3/assert"
@@ -20,8 +21,9 @@ func assertFileExists(t *testing.T, path string) {
func TestNewMigrationFsRepoCreatesDirIfNotExists(t *testing.T) {
tempDir := t.TempDir()
migrationsDir := filepath.Join(tempDir, "migrations")
+ migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir}
- _, err := repositories.NewMigrationFsRepo(migrationsDir)
+ _, err := repositories.NewMigrationFsRepo(&migrationsConfig)
assert.NilError(t, err)
assertFileExists(t, migrationsDir)
@@ -30,16 +32,18 @@ func TestNewMigrationFsRepoCreatesDirIfNotExists(t *testing.T) {
func TestNewMigrationFsRepoMigrationDirIsFile(t *testing.T) {
tempDir := t.TempDir()
migrationsDir := filepath.Join(tempDir, "migrations")
+ migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir}
_, err := os.Create(migrationsDir)
assert.NilError(t, err)
- _, err = repositories.NewMigrationFsRepo(migrationsDir)
+ _, err = repositories.NewMigrationFsRepo(&migrationsConfig)
assert.ErrorContains(t, err, "is not a directory")
}
func TestMigrationFsRepoCreate(t *testing.T) {
tempDir := t.TempDir()
- repo, err := repositories.NewMigrationFsRepo(tempDir)
+ migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir}
+ repo, err := repositories.NewMigrationFsRepo(&migrationsConfig)
assert.NilError(t, err)
migration := models.NewMigration(time.Now(), "add users table")
@@ -54,7 +58,8 @@ func TestMigrationFsRepoCreate(t *testing.T) {
func TestMigrationFsRepoReadUpgradeAndDowngradeScript(t *testing.T) {
tempDir := t.TempDir()
- repo, err := repositories.NewMigrationFsRepo(tempDir)
+ migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir}
+ repo, err := repositories.NewMigrationFsRepo(&migrationsConfig)
assert.NilError(t, err)
migration := models.NewMigration(time.Now(), "add users table")
@@ -85,7 +90,8 @@ func TestMigrationFsRepoReadUpgradeAndDowngradeScript(t *testing.T) {
func TestMigrationFsRepo_List(t *testing.T) {
tempDir := t.TempDir()
- repo, err := repositories.NewMigrationFsRepo(tempDir)
+ migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir}
+ repo, err := repositories.NewMigrationFsRepo(&migrationsConfig)
assert.NilError(t, err)
migration1 := models.NewMigration(