diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-23 09:12:52 -0400 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-23 09:12:52 -0400 |
| commit | 99c4818223ac87eee30bb1ecbf96dbdd32a31a1f (patch) | |
| tree | 0b40ba322d1d42a8d17aa182aac78e3822ee6895 | |
| parent | Add workflow to bump homebrew formula version (diff) | |
| download | cli-99c4818223ac87eee30bb1ecbf96dbdd32a31a1f.zip | |
Add handling of duplicate local migration versions
| -rw-r--r-- | CHANGELOG.md | 6 | ||||
| -rw-r--r-- | internal/models/migration_test.go | 10 | ||||
| -rw-r--r-- | internal/repositories/migration_fs_repo.go | 25 | ||||
| -rw-r--r-- | internal/repositories/migration_fs_repo_test.go | 28 | ||||
| -rw-r--r-- | internal/services/migration.go | 6 | ||||
| -rw-r--r-- | internal/sqlparse/sqlparse.go | 5 | ||||
| -rw-r--r-- | internal/sqlparse/sqlparse_test.go | 4 | ||||
| -rw-r--r-- | internal/storage/db.go | 7 |
8 files changed, 81 insertions, 10 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index fd80b41..49b7bd7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ 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 + +### Fixed + +- If a local migration with the same version already exists, bolt will now error out when listing out the migrations and indicate that there is a conflicting migration. Previously, it would ignore the first migration and use the second one with the same version. + ## [0.8.0] - 2024-03-16 ### Changed diff --git a/internal/models/migration_test.go b/internal/models/migration_test.go index 809887f..15f3123 100644 --- a/internal/models/migration_test.go +++ b/internal/models/migration_test.go @@ -45,7 +45,10 @@ func TestName(t *testing.T) { expectedName: "001_test_message", }, { - migration: models.NewTimestampMigration(time.Date(1234, 1, 2, 3, 4, 5, 6, time.UTC), "test_message"), + migration: models.NewTimestampMigration( + time.Date(1234, 1, 2, 3, 4, 5, 6, time.UTC), + "test_message", + ), expectedName: "12340102030405_test_message", }, // Leading/Trailing spaces trimmed, lowercased, and spaces converted to underscores. @@ -54,7 +57,10 @@ func TestName(t *testing.T) { expectedName: "001_test_message", }, { - migration: models.NewTimestampMigration(time.Date(1234, 1, 2, 3, 4, 5, 6, time.UTC), " teST mesSAGE "), + migration: models.NewTimestampMigration( + time.Date(1234, 1, 2, 3, 4, 5, 6, time.UTC), + " teST mesSAGE ", + ), expectedName: "12340102030405_test_message", }, } diff --git a/internal/repositories/migration_fs_repo.go b/internal/repositories/migration_fs_repo.go index 0ded9d0..a4030a5 100644 --- a/internal/repositories/migration_fs_repo.go +++ b/internal/repositories/migration_fs_repo.go @@ -13,6 +13,8 @@ import ( "github.com/eugenetriguba/bolt/internal/sqlparse" ) +var ErrMigrationVersionConflict = errors.New("migration version conflict") + type ErrIsNotDir struct { path string } @@ -86,6 +88,15 @@ func (mr migrationFsRepo) List() (map[string]*models.Migration, error) { if err != nil { return nil, err } + _, exists := migrations[migration.Version] + if exists { + return nil, fmt.Errorf( + "%w: a local migration file with version %s already exists", + ErrMigrationVersionConflict, + migration.Version, + ) + } + migrations[migration.Version] = migration } @@ -110,7 +121,9 @@ func dirEntryToMigration(entry fs.DirEntry) (*models.Migration, error) { }, nil } -func (mr migrationFsRepo) ReadUpgradeScript(migration *models.Migration) (sqlparse.MigrationScript, error) { +func (mr migrationFsRepo) ReadUpgradeScript( + migration *models.Migration, +) (sqlparse.MigrationScript, error) { scriptPath := filepath.Join( mr.migrationsDirPath, migration.Name()+".sql", @@ -130,10 +143,16 @@ func (mr migrationFsRepo) ReadDowngradeScript( return downgradeScript, err } -func (mr migrationFsRepo) getMigrationScripts(scriptPath string) (sqlparse.MigrationScript, sqlparse.MigrationScript, error) { +func (mr migrationFsRepo) getMigrationScripts( + scriptPath string, +) (sqlparse.MigrationScript, sqlparse.MigrationScript, error) { scriptContents, err := mr.readScriptContents(scriptPath) if err != nil { - return sqlparse.MigrationScript{}, sqlparse.MigrationScript{}, fmt.Errorf("unable to read %s script: %w", scriptPath, err) + return sqlparse.MigrationScript{}, sqlparse.MigrationScript{}, fmt.Errorf( + "unable to read %s script: %w", + scriptPath, + err, + ) } sqlParser := sqlparse.NewSqlParser() return sqlParser.Parse(strings.NewReader(scriptContents)) diff --git a/internal/repositories/migration_fs_repo_test.go b/internal/repositories/migration_fs_repo_test.go index 96d48a0..938cc2b 100644 --- a/internal/repositories/migration_fs_repo_test.go +++ b/internal/repositories/migration_fs_repo_test.go @@ -69,7 +69,11 @@ func TestCreate_FailsToCreateMigration(t *testing.T) { ) assert.Nil(t, err) migration := models.NewTimestampMigration(time.Now(), "add users table") - _, err = os.OpenFile(filepath.Join(tempDir, fmt.Sprintf("%s.sql", migration.Name())), os.O_CREATE, 0000) + _, err = os.OpenFile( + filepath.Join(tempDir, fmt.Sprintf("%s.sql", migration.Name())), + os.O_CREATE, + 0000, + ) assert.Nil(t, err) err = repo.Create(migration) @@ -205,3 +209,25 @@ func TestList_InvalidMigrationName(t *testing.T) { "expected a migration directory of the format <version>_<message>", ) } + +func TestList_DuplicateMigrationVersion(t *testing.T) { + migrationsDir := filepath.Join(t.TempDir(), "migrations") + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + migration1 := models.NewSequentialMigration(1, "migration_1") + migration2 := models.NewSequentialMigration(1, "migration_2") + err = repo.Create(migration1) + assert.Nil(t, err) + repo.Create(migration2) + assert.Nil(t, err) + + _, err = repo.List() + + assert.ErrorIs(t, err, repositories.ErrMigrationVersionConflict) + assert.ErrorContains( + t, + err, + "a local migration file with version 001 already exists", + ) +} diff --git a/internal/services/migration.go b/internal/services/migration.go index 3b0f297..700998f 100644 --- a/internal/services/migration.go +++ b/internal/services/migration.go @@ -274,7 +274,11 @@ func (ms MigrationService) getCurrentSequentialMigrationVersion() (uint64, error return 0, fmt.Errorf("unable to list out local filesystem migrations: %w", err) } - migrations, err := ms.combineMigrations(localMigrations, map[string]*models.Migration{}, SortOrderDesc) + migrations, err := ms.combineMigrations( + localMigrations, + map[string]*models.Migration{}, + SortOrderDesc, + ) if err != nil { return 0, err } diff --git a/internal/sqlparse/sqlparse.go b/internal/sqlparse/sqlparse.go index fa9fa96..90ebc2f 100644 --- a/internal/sqlparse/sqlparse.go +++ b/internal/sqlparse/sqlparse.go @@ -67,7 +67,10 @@ func (sp *sqlParser) Parse(reader io.Reader) (MigrationScript, MigrationScript, } if err := scanner.Err(); err != nil { - return MigrationScript{}, MigrationScript{}, fmt.Errorf("parsing sql file encountered an error: %w", err) + return MigrationScript{}, MigrationScript{}, fmt.Errorf( + "parsing sql file encountered an error: %w", + err, + ) } return upgradeScript, downgradeScript, nil diff --git a/internal/sqlparse/sqlparse_test.go b/internal/sqlparse/sqlparse_test.go index b5d2e93..174b6fc 100644 --- a/internal/sqlparse/sqlparse_test.go +++ b/internal/sqlparse/sqlparse_test.go @@ -182,7 +182,9 @@ func TestSqlParser_Parse(t *testing.T) { for _, tc := range testCases { sqlParser := sqlparse.NewSqlParser() - upgradeScript, downgradeScript, err := sqlParser.Parse(strings.NewReader(tc.migration)) + upgradeScript, downgradeScript, err := sqlParser.Parse( + strings.NewReader(tc.migration), + ) assert.Nil(t, err) check.DeepEqual(t, upgradeScript, tc.expectedUpgradeScript) check.DeepEqual(t, downgradeScript, tc.expectedDowngradeScript) diff --git a/internal/storage/db.go b/internal/storage/db.go index dc32304..1d4cada 100644 --- a/internal/storage/db.go +++ b/internal/storage/db.go @@ -36,7 +36,12 @@ var ( ErrUnableToConnect = errors.New("unable to open connection to database") ErrUnsupportedDriver = fmt.Errorf( "unsupported driver, supported drivers are %s", - []string{postgresqlDriverName, mysqlDriverName, mssqlDriverName, sqliteDriverName}, + []string{ + postgresqlDriverName, + mysqlDriverName, + mssqlDriverName, + sqliteDriverName, + }, ) ) |