diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-16 15:06:30 -0400 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-16 15:06:30 -0400 |
| commit | 65ded7c0133ae011a30546fb4fd1e00fc3179874 (patch) | |
| tree | 305c9655c581ba5c959d56cf801a96bf80683dd7 /internal/repositories | |
| parent | Update README (diff) | |
| download | cli-65ded7c0133ae011a30546fb4fd1e00fc3179874.zip | |
Update migration file format
Diffstat (limited to 'internal/repositories')
| -rw-r--r-- | internal/repositories/migration_db_repo.go | 2 | ||||
| -rw-r--r-- | internal/repositories/migration_fs_repo.go | 73 | ||||
| -rw-r--r-- | internal/repositories/migration_fs_repo_test.go | 41 |
3 files changed, 51 insertions, 65 deletions
diff --git a/internal/repositories/migration_db_repo.go b/internal/repositories/migration_db_repo.go index e97349a..26cc2b3 100644 --- a/internal/repositories/migration_db_repo.go +++ b/internal/repositories/migration_db_repo.go @@ -39,7 +39,7 @@ func NewMigrationDBRepo(db storage.DB) (MigrationDBRepo, error) { if !migrationTableExists { _, err := db.Exec(` CREATE TABLE bolt_migrations( - version CHARACTER(14) PRIMARY KEY NOT NULL + version VARCHAR(255) PRIMARY KEY NOT NULL ); `) if err != nil { diff --git a/internal/repositories/migration_fs_repo.go b/internal/repositories/migration_fs_repo.go index e535013..0ded9d0 100644 --- a/internal/repositories/migration_fs_repo.go +++ b/internal/repositories/migration_fs_repo.go @@ -10,6 +10,7 @@ import ( "github.com/eugenetriguba/bolt/internal/configloader" "github.com/eugenetriguba/bolt/internal/models" + "github.com/eugenetriguba/bolt/internal/sqlparse" ) type ErrIsNotDir struct { @@ -26,8 +27,8 @@ func (e *ErrIsNotDir) Error() string { type MigrationFsRepo interface { Create(migration *models.Migration) error List() (map[string]*models.Migration, error) - ReadUpgradeScript(migration *models.Migration) (string, error) - ReadDowngradeScript(migration *models.Migration) (string, error) + ReadUpgradeScript(migration *models.Migration) (sqlparse.MigrationScript, error) + ReadDowngradeScript(migration *models.Migration) (sqlparse.MigrationScript, error) } type migrationFsRepo struct { @@ -61,23 +62,15 @@ func NewMigrationFsRepo( } func (mr migrationFsRepo) Create(migration *models.Migration) error { - newMigrationDir := filepath.Join(mr.migrationsDirPath, mr.migrationDirname(migration)) - - err := os.Mkdir(newMigrationDir, 0755) + newMigrationPath := filepath.Join(mr.migrationsDirPath, migration.Name()+".sql") + file, err := os.Create(newMigrationPath) if err != nil { - return err + return fmt.Errorf("unable to create file at %s: %w", newMigrationPath, err) } - - _, err = os.Create(filepath.Join(newMigrationDir, "upgrade.sql")) + _, err = file.WriteString("-- migrate:up\n\n-- migrate:down\n") if err != nil { - return err + return fmt.Errorf("unable to write template to new migration script: %w", err) } - - _, err = os.Create(filepath.Join(newMigrationDir, "downgrade.sql")) - if err != nil { - return err - } - return nil } @@ -108,31 +101,42 @@ func dirEntryToMigration(entry fs.DirEntry) (*models.Migration, error) { entry.Name(), ) } + version := parts[0] + message := strings.TrimSuffix(parts[1], filepath.Ext(parts[1])) // Remove .sql return &models.Migration{ - Version: parts[0], - Message: parts[1], + Version: version, + Message: message, Applied: false, }, nil } -func (mr migrationFsRepo) ReadUpgradeScript(migration *models.Migration) (string, error) { - upgradeScriptPath := filepath.Join( +func (mr migrationFsRepo) ReadUpgradeScript(migration *models.Migration) (sqlparse.MigrationScript, error) { + scriptPath := filepath.Join( mr.migrationsDirPath, - mr.migrationDirname(migration), - "upgrade.sql", + migration.Name()+".sql", ) - return mr.readScriptContents(upgradeScriptPath) + upgradeScript, _, err := mr.getMigrationScripts(scriptPath) + return upgradeScript, err } func (mr migrationFsRepo) ReadDowngradeScript( migration *models.Migration, -) (string, error) { - downgradeScriptPath := filepath.Join( +) (sqlparse.MigrationScript, error) { + scriptPath := filepath.Join( mr.migrationsDirPath, - mr.migrationDirname(migration), - "downgrade.sql", + migration.Name()+".sql", ) - return mr.readScriptContents(downgradeScriptPath) + _, downgradeScript, err := mr.getMigrationScripts(scriptPath) + return downgradeScript, err +} + +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) + } + sqlParser := sqlparse.NewSqlParser() + return sqlParser.Parse(strings.NewReader(scriptContents)) } func (mr migrationFsRepo) readScriptContents(scriptPath string) (string, error) { @@ -143,18 +147,3 @@ func (mr migrationFsRepo) readScriptContents(scriptPath string) (string, error) return string(contents), nil } - -// migrationDirname creates the directory name that -// should be used for this migration. -func (mr migrationFsRepo) migrationDirname(migration *models.Migration) string { - return fmt.Sprintf("%s_%s", migration.Version, mr.normalizeMessage(migration)) -} - -// normalizeMessage normalizes the Message of a migration -// to be filesystem friendly. -func (mr migrationFsRepo) normalizeMessage(migration *models.Migration) string { - message := strings.ToLower(migration.Message) - message = strings.TrimSpace(message) - message = strings.ReplaceAll(message, " ", "_") - return message -} diff --git a/internal/repositories/migration_fs_repo_test.go b/internal/repositories/migration_fs_repo_test.go index 32de193..96d48a0 100644 --- a/internal/repositories/migration_fs_repo_test.go +++ b/internal/repositories/migration_fs_repo_test.go @@ -59,26 +59,23 @@ func TestCreate_SuccessfullyCreated(t *testing.T) { err = repo.Create(migration) assert.Nil(t, err) - migrationDirName := fmt.Sprintf("%s_add_users_table", migration.Version) - assertFileExists(t, filepath.Join(tempDir, migrationDirName)) - assertFileExists(t, filepath.Join(tempDir, migrationDirName, "upgrade.sql")) - assertFileExists(t, filepath.Join(tempDir, migrationDirName, "downgrade.sql")) + assertFileExists(t, filepath.Join(tempDir, fmt.Sprintf("%s.sql", migration.Name()))) } -func TestCreate_FailsToCreateDir(t *testing.T) { +func TestCreate_FailsToCreateMigration(t *testing.T) { tempDir := t.TempDir() - migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir} - repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + repo, err := repositories.NewMigrationFsRepo( + &configloader.MigrationsConfig{DirectoryPath: tempDir}, + ) assert.Nil(t, err) migration := models.NewTimestampMigration(time.Now(), "add users table") - migrationDirName := fmt.Sprintf("%s_add_users_table", migration.Version) - _, err = os.Create(filepath.Join(tempDir, migrationDirName)) + _, err = os.OpenFile(filepath.Join(tempDir, fmt.Sprintf("%s.sql", migration.Name())), os.O_CREATE, 0000) assert.Nil(t, err) err = repo.Create(migration) assert.NotNil(t, err) - assert.ErrorContains(t, err, "file exists") + assert.ErrorContains(t, err, "unable to create file") } func TestReadUpgradeScript_SuccessfullyRead(t *testing.T) { @@ -91,17 +88,17 @@ func TestReadUpgradeScript_SuccessfullyRead(t *testing.T) { err = repo.Create(migration) assert.Nil(t, err) - migrationDirName := fmt.Sprintf("%s_add_users_table", migration.Version) - expectedUpgradeScriptContents := []byte("CREATE TABLE users(id int PRIMARY KEY);") + migrationName := fmt.Sprintf("%s.sql", migration.Name()) + expectedUpgradeScriptContents := "CREATE TABLE users(id int PRIMARY KEY);\n" os.WriteFile( - filepath.Join(tempDir, migrationDirName, "upgrade.sql"), - expectedUpgradeScriptContents, + filepath.Join(tempDir, migrationName), + []byte("-- migrate:up\n"+expectedUpgradeScriptContents), 0755, ) - upgradeScriptContents, err := repo.ReadUpgradeScript(migration) + upgradeScript, err := repo.ReadUpgradeScript(migration) assert.Nil(t, err) - assert.Equal(t, upgradeScriptContents, string(expectedUpgradeScriptContents)) + assert.Equal(t, upgradeScript.Contents, string(expectedUpgradeScriptContents)) } func TestReadUpgradeScript_FileDoesNotExist(t *testing.T) { @@ -126,17 +123,17 @@ func TestReadDowngradeScript_SuccessfullyRead(t *testing.T) { err = repo.Create(migration) assert.Nil(t, err) - migrationDirName := fmt.Sprintf("%s_add_users_table", migration.Version) - expectedDowngradeScriptContents := []byte("DROP TABLE users;") + migrationName := fmt.Sprintf("%s.sql", migration.Name()) + expectedDowngradeScriptContents := "DROP TABLE users;\n" os.WriteFile( - filepath.Join(tempDir, migrationDirName, "downgrade.sql"), - expectedDowngradeScriptContents, + filepath.Join(tempDir, migrationName), + []byte("-- migrate:down\n"+expectedDowngradeScriptContents), 0755, ) - downgradeScriptContents, err := repo.ReadDowngradeScript(migration) + downgradeScript, err := repo.ReadDowngradeScript(migration) assert.Nil(t, err) - assert.Equal(t, downgradeScriptContents, string(expectedDowngradeScriptContents)) + assert.Equal(t, downgradeScript.Contents, string(expectedDowngradeScriptContents)) } func TestReadDowngradeScript_FileDoesNotExist(t *testing.T) { |