diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-14 20:00:09 -0400 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-14 20:00:09 -0400 |
| commit | 75e6e9a2996ab5186f29f64eda2850b49da0ad93 (patch) | |
| tree | e3f5886d0450ee68b8f25d8a3c62325382cf8d63 | |
| parent | Use p 1 for github workflow (diff) | |
| download | cli-75e6e9a2996ab5186f29f64eda2850b49da0ad93.zip | |
Update env var names
| -rw-r--r-- | .env.mssql | 12 | ||||
| -rw-r--r-- | .env.mysql | 12 | ||||
| -rw-r--r-- | .env.postgresql | 12 | ||||
| -rw-r--r-- | .env.sqlite3 | 4 | ||||
| -rw-r--r-- | CHANGELOG.md | 14 | ||||
| -rw-r--r-- | README.md | 17 | ||||
| -rw-r--r-- | docker-compose.mssql.yml | 6 | ||||
| -rw-r--r-- | docker-compose.mysql.yml | 12 | ||||
| -rw-r--r-- | docker-compose.postgresql.yml | 8 | ||||
| -rw-r--r-- | internal/bolttest/db.go | 12 | ||||
| -rw-r--r-- | internal/configloader/configloader.go | 14 | ||||
| -rw-r--r-- | internal/configloader/configloader_test.go | 36 |
12 files changed, 86 insertions, 73 deletions
@@ -1,6 +1,6 @@ -BOLT_DB_CONN_DBNAME=master -BOLT_DB_CONN_HOST=localhost -BOLT_DB_CONN_PORT=4003 -BOLT_DB_CONN_USER=sa -BOLT_DB_CONN_PASSWORD=testPASS123.? -BOLT_DB_CONN_DRIVER=mssql +BOLT_DB_NAME=master +BOLT_DB_HOST=localhost +BOLT_DB_PORT=4003 +BOLT_DB_USER=sa +BOLT_DB_PASSWORD=testPASS123.? +BOLT_DB_DRIVER=mssql @@ -1,6 +1,6 @@ -BOLT_DB_CONN_DBNAME=test_db -BOLT_DB_CONN_HOST=localhost -BOLT_DB_CONN_PORT=4002 -BOLT_DB_CONN_USER=test_user -BOLT_DB_CONN_PASSWORD=testpassword -BOLT_DB_CONN_DRIVER=mysql +BOLT_DB_NAME=test_db +BOLT_DB_HOST=localhost +BOLT_DB_PORT=4002 +BOLT_DB_USER=test_user +BOLT_DB_PASSWORD=testpassword +BOLT_DB_DRIVER=mysql diff --git a/.env.postgresql b/.env.postgresql index 65082c9..b62d4bc 100644 --- a/.env.postgresql +++ b/.env.postgresql @@ -1,6 +1,6 @@ -BOLT_DB_CONN_DBNAME=test_db -BOLT_DB_CONN_HOST=localhost -BOLT_DB_CONN_PORT=4001 -BOLT_DB_CONN_USER=test_user -BOLT_DB_CONN_PASSWORD=testpassword -BOLT_DB_CONN_DRIVER=postgresql +BOLT_DB_NAME=test_db +BOLT_DB_HOST=localhost +BOLT_DB_PORT=4001 +BOLT_DB_USER=test_user +BOLT_DB_PASSWORD=testpassword +BOLT_DB_DRIVER=postgresql diff --git a/.env.sqlite3 b/.env.sqlite3 index b2300d7..f735af9 100644 --- a/.env.sqlite3 +++ b/.env.sqlite3 @@ -1,2 +1,2 @@ -BOLT_DB_CONN_DBNAME=/tmp/tmp.db -BOLT_DB_CONN_DRIVER=sqlite3 +BOLT_DB_NAME=/tmp/tmp.db +BOLT_DB_DRIVER=sqlite3 diff --git a/CHANGELOG.md b/CHANGELOG.md index 729d717..6720741 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## Unreleased + +### Changed + +- Renamed the following environment variables names: + - `BOLT_DB_CONN_HOST` -> `BOLT_DB_HOST` + - `BOLT_DB_CONN_PORT` -> `BOLT_DB_PORT` + - `BOLT_DB_CONN_USER` -> `BOLT_DB_USER` + - `BOLT_DB_CONN_PASSWORD` -> `BOLT_DB_PASSWORD` + - `BOLT_DB_CONN_DBNAME` -> `BOLT_DB_NAME` + - `BOLT_DB_CONN_DRIVER` -> `BOLT_DB_DRIVER` + +- Renamed the `[connection]` section of `bolt.toml` to `[database]`. + ## [0.6.0] - 2024-03-11 ### Added @@ -149,7 +149,7 @@ $ touch bolt.toml 2. Add the following contents to the file: ```toml -[connection] +[database] host = "localhost" port = 5432 user = "bolt_user" @@ -276,11 +276,10 @@ version_style = "sequential" # Connection parameters for the database Bolt will be # applying migrations to. All connection parameters are # required. -[connection] +[database] # The host to use to connect to your database. host = # The port to use to connect to your database. -# Note: This should be an integer. port = # The user to use to connect to your database. user = @@ -300,12 +299,12 @@ All configuration file settings have corresponding environment variables. - `BOLT_MIGRATIONS_DIR_PATH` - `BOLT_MIGRATIONS_VERSION_STYLE` -- `BOLT_DB_CONN_HOST` -- `BOLT_DB_CONN_PORT` -- `BOLT_DB_CONN_USER` -- `BOLT_DB_CONN_PASSWORD` -- `BOLT_DB_CONN_DBNAME` -- `BOLT_DB_CONN_DRIVER` +- `BOLT_DB_HOST` +- `BOLT_DB_PORT` +- `BOLT_DB_USER` +- `BOLT_DB_PASSWORD` +- `BOLT_DB_NAME` +- `BOLT_DB_DRIVER` ### Commands diff --git a/docker-compose.mssql.yml b/docker-compose.mssql.yml index 1dd941b..e2a2f5c 100644 --- a/docker-compose.mssql.yml +++ b/docker-compose.mssql.yml @@ -8,13 +8,13 @@ services: test: [ "CMD-SHELL", - "/opt/mssql-tools/bin/sqlcmd -S ${BOLT_DB_CONN_HOST:?err} -U ${BOLT_DB_CONN_USER:?err} -P ${BOLT_DB_CONN_PASSWORD:?err} -Q 'SELECT 1'", + "/opt/mssql-tools/bin/sqlcmd -S ${BOLT_DB_HOST:?err} -U ${BOLT_DB_USER:?err} -P ${BOLT_DB_PASSWORD:?err} -Q 'SELECT 1'", ] interval: 10s timeout: 5s retries: 5 ports: - - "${BOLT_DB_CONN_PORT:?err}:1433" + - "${BOLT_DB_PORT:?err}:1433" environment: - ACCEPT_EULA=Y - - MSSQL_SA_PASSWORD=${BOLT_DB_CONN_PASSWORD:?err} + - MSSQL_SA_PASSWORD=${BOLT_DB_PASSWORD:?err} diff --git a/docker-compose.mysql.yml b/docker-compose.mysql.yml index 837fe54..6c8a0b1 100644 --- a/docker-compose.mysql.yml +++ b/docker-compose.mysql.yml @@ -5,17 +5,17 @@ services: image: mysql:8.3 container_name: bolt_mysql_db healthcheck: - test: ["CMD", "mysqladmin", "ping", "-h", "${BOLT_DB_CONN_HOST:?err}"] + test: ["CMD", "mysqladmin", "ping", "-h", "${BOLT_DB_HOST:?err}"] interval: 10s timeout: 5s retries: 5 ports: - - "${BOLT_DB_CONN_PORT:?err}:3306" + - "${BOLT_DB_PORT:?err}:3306" environment: - - MYSQL_DATABASE=${BOLT_DB_CONN_DBNAME:?err} - - MYSQL_USER=${BOLT_DB_CONN_USER:?err} - - MYSQL_PASSWORD=${BOLT_DB_CONN_PASSWORD:?err} - - MYSQL_ROOT_PASSWORD=${BOLT_DB_CONN_PASSWORD:?err} + - MYSQL_DATABASE=${BOLT_DB_NAME:?err} + - MYSQL_USER=${BOLT_DB_USER:?err} + - MYSQL_PASSWORD=${BOLT_DB_PASSWORD:?err} + - MYSQL_ROOT_PASSWORD=${BOLT_DB_PASSWORD:?err} volumes: - mysql_db_volume:/var/lib/mysql diff --git a/docker-compose.postgresql.yml b/docker-compose.postgresql.yml index b2f6107..ae21fdd 100644 --- a/docker-compose.postgresql.yml +++ b/docker-compose.postgresql.yml @@ -10,11 +10,11 @@ services: timeout: 5s retries: 5 ports: - - "${BOLT_DB_CONN_PORT:?err}:5432" + - "${BOLT_DB_PORT:?err}:5432" environment: - - POSTGRES_DB=${BOLT_DB_CONN_DBNAME:?err} - - POSTGRES_USER=${BOLT_DB_CONN_USER:?err} - - POSTGRES_PASSWORD=${BOLT_DB_CONN_PASSWORD:?err} + - POSTGRES_DB=${BOLT_DB_NAME:?err} + - POSTGRES_USER=${BOLT_DB_USER:?err} + - POSTGRES_PASSWORD=${BOLT_DB_PASSWORD:?err} volumes: - postgres_db_volume:/var/lib/postgresql/data diff --git a/internal/bolttest/db.go b/internal/bolttest/db.go index 0e1e740..d03012f 100644 --- a/internal/bolttest/db.go +++ b/internal/bolttest/db.go @@ -28,12 +28,12 @@ func NewTestDB(t *testing.T) storage.DB { func NewTestConnectionConfig() configloader.ConnectionConfig { return configloader.ConnectionConfig{ - Driver: os.Getenv("BOLT_DB_CONN_DRIVER"), - DBName: os.Getenv("BOLT_DB_CONN_DBNAME"), - Host: os.Getenv("BOLT_DB_CONN_HOST"), - Port: os.Getenv("BOLT_DB_CONN_PORT"), - User: os.Getenv("BOLT_DB_CONN_USER"), - Password: os.Getenv("BOLT_DB_CONN_PASSWORD"), + Driver: os.Getenv("BOLT_DB_DRIVER"), + DBName: os.Getenv("BOLT_DB_NAME"), + Host: os.Getenv("BOLT_DB_HOST"), + Port: os.Getenv("BOLT_DB_PORT"), + User: os.Getenv("BOLT_DB_USER"), + Password: os.Getenv("BOLT_DB_PASSWORD"), } } diff --git a/internal/configloader/configloader.go b/internal/configloader/configloader.go index 4fbe27f..eed150f 100644 --- a/internal/configloader/configloader.go +++ b/internal/configloader/configloader.go @@ -45,7 +45,7 @@ type Config struct { // Information related to how to connect to the database // that is desired to run migrations against. - Connection ConnectionConfig `toml:"connection"` + Connection ConnectionConfig `toml:"database"` } type MigrationsConfig struct { @@ -54,12 +54,12 @@ type MigrationsConfig struct { } type ConnectionConfig struct { - Host string `toml:"host" envconfig:"BOLT_DB_CONN_HOST"` - Port string `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"` + Host string `toml:"host" envconfig:"BOLT_DB_HOST"` + Port string `toml:"port" envconfig:"BOLT_DB_PORT"` + User string `toml:"user" envconfig:"BOLT_DB_USER"` + Password string `toml:"password" envconfig:"BOLT_DB_PASSWORD"` + DBName string `toml:"dbname" envconfig:"BOLT_DB_NAME"` + Driver string `toml:"driver" envconfig:"BOLT_DB_DRIVER"` } func NewConfig() (*Config, error) { diff --git a/internal/configloader/configloader_test.go b/internal/configloader/configloader_test.go index 22fdd26..7684436 100644 --- a/internal/configloader/configloader_test.go +++ b/internal/configloader/configloader_test.go @@ -35,12 +35,12 @@ func TestNewConfigWithInvalidVersionStyle(t *testing.T) { } func TestNewConfigFindsFileAndPopulatesConfigStruct(t *testing.T) { - bolttest.UnsetEnv(t, "BOLT_DB_CONN_HOST") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_PORT") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_USER") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_PASSWORD") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_DBNAME") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_DRIVER") + bolttest.UnsetEnv(t, "BOLT_DB_HOST") + bolttest.UnsetEnv(t, "BOLT_DB_PORT") + bolttest.UnsetEnv(t, "BOLT_DB_USER") + bolttest.UnsetEnv(t, "BOLT_DB_PASSWORD") + bolttest.UnsetEnv(t, "BOLT_DB_NAME") + bolttest.UnsetEnv(t, "BOLT_DB_DRIVER") bolttest.UnsetEnv(t, "BOLT_MIGRATIONS_DIR_PATH") bolttest.UnsetEnv(t, "BOLT_MIGRATIONS_VERSION_STYLE") expectedCfg := configloader.Config{ @@ -100,12 +100,12 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) { } 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", 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) + t.Setenv("BOLT_DB_HOST", envCfg.Connection.Host) + t.Setenv("BOLT_DB_PORT", envCfg.Connection.Port) + t.Setenv("BOLT_DB_USER", envCfg.Connection.User) + t.Setenv("BOLT_DB_PASSWORD", envCfg.Connection.Password) + t.Setenv("BOLT_DB_NAME", envCfg.Connection.DBName) + t.Setenv("BOLT_DB_DRIVER", envCfg.Connection.Driver) cfg, err := configloader.NewConfig() assert.Nil(t, err) @@ -113,12 +113,12 @@ func TestNewConfigCanBeOverridenByEnvVars(t *testing.T) { } func TestNewConfigSearchesParentDirectories(t *testing.T) { - bolttest.UnsetEnv(t, "BOLT_DB_CONN_HOST") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_PORT") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_USER") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_PASSWORD") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_DBNAME") - bolttest.UnsetEnv(t, "BOLT_DB_CONN_DRIVER") + bolttest.UnsetEnv(t, "BOLT_DB_HOST") + bolttest.UnsetEnv(t, "BOLT_DB_PORT") + bolttest.UnsetEnv(t, "BOLT_DB_USER") + bolttest.UnsetEnv(t, "BOLT_DB_PASSWORD") + bolttest.UnsetEnv(t, "BOLT_DB_NAME") + bolttest.UnsetEnv(t, "BOLT_DB_DRIVER") bolttest.UnsetEnv(t, "BOLT_MIGRATIONS_DIR_PATH") bolttest.UnsetEnv(t, "BOLT_MIGRATIONS_VERSION_STYLE") expectedCfg := configloader.Config{ |