aboutsummaryrefslogtreecommitdiffstats
path: root/internal/services/migration.go
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-02-29 19:53:20 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2024-02-29 19:53:20 -0500
commitbf1d3b3e1fc42132678b244e479839416a03a6ce (patch)
treefbe4f5e7e41b77bc990ebdece673c7f16102f61f /internal/services/migration.go
parentTweak error and doc for storage module (diff)
downloadcli-bf1d3b3e1fc42132678b244e479839416a03a6ce.zip
Add service tests
Diffstat (limited to 'internal/services/migration.go')
-rw-r--r--internal/services/migration.go233
1 files changed, 186 insertions, 47 deletions
diff --git a/internal/services/migration.go b/internal/services/migration.go
index b6b00bb..48859d6 100644
--- a/internal/services/migration.go
+++ b/internal/services/migration.go
@@ -1,29 +1,62 @@
package services
import (
+ "database/sql"
"fmt"
"sort"
"strconv"
+ "strings"
"time"
"github.com/eugenetriguba/bolt/internal/configloader"
"github.com/eugenetriguba/bolt/internal/models"
"github.com/eugenetriguba/bolt/internal/output"
"github.com/eugenetriguba/bolt/internal/repositories"
+ "github.com/eugenetriguba/bolt/internal/sqlparse"
)
type MigrationService struct {
- dbRepo *repositories.MigrationDBRepo
- fsRepo *repositories.MigrationFsRepo
+ dbRepo repositories.MigrationDBRepo
+ fsRepo repositories.MigrationFsRepo
+ cfg configloader.Config
outputter output.Outputter
}
func NewMigrationService(
- dbRepo *repositories.MigrationDBRepo,
- fsRepo *repositories.MigrationFsRepo,
+ dbRepo repositories.MigrationDBRepo,
+ fsRepo repositories.MigrationFsRepo,
+ cfg configloader.Config,
outputter output.Outputter,
-) *MigrationService {
- return &MigrationService{dbRepo: dbRepo, fsRepo: fsRepo, outputter: outputter}
+) MigrationService {
+ return MigrationService{
+ dbRepo: dbRepo,
+ fsRepo: fsRepo,
+ cfg: cfg,
+ outputter: outputter,
+ }
+}
+
+func NewMigrationServiceFromConfig(
+ db *sql.DB,
+ outputter output.Outputter,
+ cfg configloader.Config,
+) (MigrationService, error) {
+ migrationDBRepo, err := repositories.NewMigrationDBRepo(db)
+ if err != nil {
+ return MigrationService{}, err
+ }
+
+ migrationFsRepo, err := repositories.NewMigrationFsRepo(&cfg.Migrations)
+ if err != nil {
+ return MigrationService{}, err
+ }
+
+ return NewMigrationService(
+ migrationDBRepo,
+ migrationFsRepo,
+ cfg,
+ outputter,
+ ), nil
}
type sortOrder int
@@ -33,7 +66,7 @@ const (
SortOrderAsc
)
-func (ms *MigrationService) ApplyAllMigrations() error {
+func (ms MigrationService) ApplyAllMigrations() error {
migrations, err := ms.ListMigrations(SortOrderAsc)
if err != nil {
return err
@@ -55,7 +88,7 @@ func (ms *MigrationService) ApplyAllMigrations() error {
return nil
}
-func (ms *MigrationService) ApplyUpToVersion(version string) error {
+func (ms MigrationService) ApplyUpToVersion(version string) error {
migrations, err := ms.ListMigrations(SortOrderAsc)
if err != nil {
return err
@@ -98,7 +131,7 @@ func (ms *MigrationService) ApplyUpToVersion(version string) error {
return nil
}
-func (ms *MigrationService) ApplyMigration(migration *models.Migration) error {
+func (ms MigrationService) ApplyMigration(migration *models.Migration) error {
ms.outputter.Output(
fmt.Sprintf(
"Applying migration %s_%s..",
@@ -112,10 +145,22 @@ func (ms *MigrationService) ApplyMigration(migration *models.Migration) error {
return err
}
- err = ms.dbRepo.Apply(scriptContents, migration)
+ sqlParser := sqlparse.NewSqlParser()
+ execOptions, err := sqlParser.Parse(strings.NewReader(scriptContents))
if err != nil {
- return err
+ return fmt.Errorf("unable to parse sql file for upgrade script: %w", err)
}
+
+ if execOptions.UseTransaction {
+ err = ms.dbRepo.ApplyWithTx(scriptContents, migration)
+ } else {
+ err = ms.dbRepo.Apply(scriptContents, migration)
+ }
+
+ if err != nil {
+ return fmt.Errorf("unable to apply migration %s: %w", migration.Name(), err)
+ }
+
ms.outputter.Output(
fmt.Sprintf(
"Successfully applied migration %s_%s!",
@@ -127,7 +172,7 @@ func (ms *MigrationService) ApplyMigration(migration *models.Migration) error {
return nil
}
-func (ms *MigrationService) RevertAllMigrations() error {
+func (ms MigrationService) RevertAllMigrations() error {
migrations, err := ms.ListMigrations(SortOrderDesc)
if err != nil {
return err
@@ -149,7 +194,7 @@ func (ms *MigrationService) RevertAllMigrations() error {
return nil
}
-func (ms *MigrationService) RevertDownToVersion(version string) error {
+func (ms MigrationService) RevertDownToVersion(version string) error {
migrations, err := ms.ListMigrations(SortOrderDesc)
if err != nil {
return err
@@ -192,7 +237,7 @@ func (ms *MigrationService) RevertDownToVersion(version string) error {
return nil
}
-func (ms *MigrationService) RevertMigration(migration *models.Migration) error {
+func (ms MigrationService) RevertMigration(migration *models.Migration) error {
ms.outputter.Output(
fmt.Sprintf(
"Reverting migration %s_%s..",
@@ -205,10 +250,22 @@ func (ms *MigrationService) RevertMigration(migration *models.Migration) error {
return err
}
- err = ms.dbRepo.Revert(scriptContents, migration)
+ sqlParser := sqlparse.NewSqlParser()
+ execOptions, err := sqlParser.Parse(strings.NewReader(scriptContents))
+ if err != nil {
+ return fmt.Errorf("unable to parse sql file for downgrade script: %w", err)
+ }
+
+ if execOptions.UseTransaction {
+ err = ms.dbRepo.ApplyWithTx(scriptContents, migration)
+ } else {
+ err = ms.dbRepo.Revert(scriptContents, migration)
+ }
+
if err != nil {
return err
}
+
ms.outputter.Output(
fmt.Sprintf(
"Successfully reverted migration %s_%s!",
@@ -220,70 +277,152 @@ func (ms *MigrationService) RevertMigration(migration *models.Migration) error {
return nil
}
-func (ms *MigrationService) CreateMigration(
- versionStyle configloader.VersionStyle,
- message string,
-) error {
+func (ms MigrationService) CreateMigration(message string) (*models.Migration, error) {
var migration *models.Migration
- if versionStyle == configloader.VersionStyleTimestamp {
+ if ms.cfg.Migrations.VersionStyle == configloader.VersionStyleTimestamp {
migration = models.NewTimestampMigration(time.Now(), message)
} else {
- var currentVerison uint64 = 0
- latestMigration, err := ms.fsRepo.Latest()
+ currentVersion, err := ms.getCurrentSequentialMigrationVersion()
if err != nil {
- return err
+ return nil, err
}
- if latestMigration != nil {
- currentVerison, err = strconv.ParseUint(latestMigration.Version, 10, 64)
- if err != nil {
- return err
- }
- }
- migration = models.NewSequentialMigration(currentVerison+1, message)
+ migration = models.NewSequentialMigration(currentVersion+1, message)
}
err := ms.fsRepo.Create(migration)
if err != nil {
- return err
+ return nil, err
}
ms.outputter.Output(
fmt.Sprintf("Created migration %s - %s.", migration.Version, migration.Message),
)
- return nil
+ return migration, nil
+}
+
+func (ms MigrationService) getCurrentSequentialMigrationVersion() (uint64, error) {
+ var currentVersion uint64 = 0
+
+ latestMigration, err := ms.fsRepo.Latest()
+ if err != nil {
+ return 0, err
+ }
+
+ if latestMigration != nil {
+ currentVersion, err = strconv.ParseUint(latestMigration.Version, 10, 64)
+ if err != nil {
+ return 0, err
+ }
+ }
+
+ return currentVersion, nil
}
-func (ms *MigrationService) ListMigrations(order sortOrder) ([]*models.Migration, error) {
+func (ms MigrationService) ListMigrations(order sortOrder) ([]*models.Migration, error) {
// Assumption: All migration versions that have been applied
// to the database exist locally in the list of filesystem migrations.
// This would hold true unless someone decided to apply a migration and,
- // for whatever reason, delete it later from their filesystem.
- migrations, err := ms.fsRepo.List()
+ // for whatever reason, delete it later from their filesystem. If there is
+ // an applied migration that doesn't exist locally, it would not be shown
+ // here.
+ localMigrations, err := ms.fsRepo.List()
if err != nil {
- return nil, err
+ return nil, fmt.Errorf("unable to list out local filesystem migrations: %w", err)
}
appliedMigrations, err := ms.dbRepo.List()
if err != nil {
- return nil, err
+ return nil, fmt.Errorf(
+ "unable to list out applied migrations from remote db: %w",
+ err,
+ )
}
- var flatMigrations []*models.Migration
- for _, migration := range migrations {
- _, ok := appliedMigrations[migration.Version]
+ migrations := make([]*models.Migration, 0)
+ for _, localMigration := range localMigrations {
+ _, ok := appliedMigrations[localMigration.Version]
if ok {
- migration.Applied = true
+ localMigration.Applied = true
}
- flatMigrations = append(flatMigrations, migration)
+ migrations = append(migrations, localMigration)
}
- sort.Slice(flatMigrations, func(i, j int) bool {
- if order == SortOrderAsc {
- return flatMigrations[i].Version < flatMigrations[j].Version
+ err = ms.sortMigrations(migrations, order)
+ if err != nil {
+ return nil, err
+ }
+
+ return migrations, err
+}
+
+func (ms MigrationService) sortMigrations(migrations []*models.Migration, order sortOrder) error {
+ sortErrs := make([]error, 0)
+ sort.Slice(migrations, func(i, j int) bool {
+ var comparison bool
+ var err error
+
+ if ms.cfg.Migrations.VersionStyle == configloader.VersionStyleSequential {
+ comparison, err = ms.compareSequentialMigrations(
+ migrations[i],
+ migrations[j],
+ order,
+ )
} else {
- return flatMigrations[i].Version > flatMigrations[j].Version
+ comparison, err = ms.compareTimestampMigrations(migrations[i], migrations[j], order)
}
+
+ if err != nil {
+ sortErrs = append(sortErrs, err)
+ }
+
+ return comparison
})
+ if len(sortErrs) != 0 {
+ return fmt.Errorf("unable to sort migrations: %v", sortErrs)
+ }
+ return nil
+}
+
+func (ms MigrationService) compareSequentialMigrations(
+ m1 *models.Migration,
+ m2 *models.Migration,
+ order sortOrder,
+) (bool, error) {
+ m1Version, err := strconv.ParseInt(m1.Version, 10, 64)
+ if err != nil {
+ return false, err
+ }
+
+ m2Version, err := strconv.ParseInt(m2.Version, 10, 64)
+ if err != nil {
+ return false, err
+ }
- return flatMigrations, nil
+ if order == SortOrderAsc {
+ return m1Version < m2Version, nil
+ } else {
+ return m1Version > m2Version, nil
+ }
+}
+
+func (ms MigrationService) compareTimestampMigrations(
+ m1 *models.Migration,
+ m2 *models.Migration,
+ order sortOrder,
+) (bool, error) {
+ m1Version, err := time.Parse("20060102150405", m1.Version)
+ if err != nil {
+ return false, err
+ }
+
+ m2Version, err := time.Parse("20060102150405", m2.Version)
+ if err != nil {
+ return false, err
+ }
+
+ if order == SortOrderAsc {
+ return m1Version.Before(m2Version), nil
+ } else {
+ return m1Version.After(m2Version), nil
+ }
}