diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2023-12-30 23:04:22 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2023-12-30 23:04:22 -0500 |
| commit | 6a414432a2cc90523eced1dccb3f5060b5252a08 (patch) | |
| tree | 4c9c06a1cd73ccdad31dbb8f2f7c6b7465631e9b | |
| parent | Tweak migrations dir error handling (diff) | |
| download | cli-6a414432a2cc90523eced1dccb3f5060b5252a08.zip | |
Add working create, list, and migrate commands
| -rw-r--r-- | internal/commands/create.go | 55 | ||||
| -rw-r--r-- | internal/commands/list.go | 58 | ||||
| -rw-r--r-- | internal/commands/migrate.go | 33 | ||||
| -rw-r--r-- | internal/models/migration.go | 48 | ||||
| -rw-r--r-- | internal/repositories/migration.go | 98 | ||||
| -rw-r--r-- | pkg/cli/cli.go | 2 |
6 files changed, 269 insertions, 25 deletions
diff --git a/internal/commands/create.go b/internal/commands/create.go index ab37eca..b9d63df 100644 --- a/internal/commands/create.go +++ b/internal/commands/create.go @@ -6,36 +6,61 @@ import ( "fmt" "os" + "github.com/eugenetriguba/bolt/internal/config" "github.com/eugenetriguba/bolt/internal/db" + "github.com/eugenetriguba/bolt/internal/models" + "github.com/eugenetriguba/bolt/internal/repositories" "github.com/google/subcommands" ) -type CreateCmd struct{} +type CreateCmd struct { + message string +} -func (*CreateCmd) Name() string { return "create" } -func (*CreateCmd) Synopsis() string { return "Create a new database migration." } +func (*CreateCmd) Name() string { return "create" } +func (*CreateCmd) Synopsis() string { + return "Create a new database migration." +} func (*CreateCmd) Usage() string { - return `create: + return `create [-message]: Create a new database migration. ` } -func (m *CreateCmd) SetFlags(f *flag.FlagSet) {} +func (c *CreateCmd) SetFlags(f *flag.FlagSet) { + f.StringVar( + &c.message, + "message", + "autogenerated", + "Message to use for the migration", + ) +} + +func (m *CreateCmd) Execute( + _ context.Context, + f *flag.FlagSet, + _ ...interface{}, +) subcommands.ExitStatus { + conn, err := db.Connect() + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + + c, err := config.NewConfig() + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } -func (m *CreateCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus { - db, err := db.Connect() + migrationRepo, err := repositories.NewMigrationRepo(conn, c) if err != nil { fmt.Fprintln(os.Stderr, err) return subcommands.ExitFailure } - defer db.Close() - - sqlStatement := ` - CREATE TABLE IF NOT EXISTS applied_migration( - version CHARACTER(32) PRIMARY KEY NOT NULL - ); - ` - _, err = db.Exec(sqlStatement) + + migration := models.NewMigration(m.message) + err = migrationRepo.Create(migration) if err != nil { fmt.Fprintln(os.Stderr, err) return subcommands.ExitFailure diff --git a/internal/commands/list.go b/internal/commands/list.go new file mode 100644 index 0000000..ba7958d --- /dev/null +++ b/internal/commands/list.go @@ -0,0 +1,58 @@ +package commands + +import ( + "context" + "flag" + "fmt" + "os" + + "github.com/eugenetriguba/bolt/internal/config" + "github.com/eugenetriguba/bolt/internal/db" + "github.com/eugenetriguba/bolt/internal/repositories" + "github.com/google/subcommands" +) + +type ListCmd struct{} + +func (*ListCmd) Name() string { return "list" } +func (*ListCmd) Synopsis() string { return "List the database migrations and their statuses." } +func (*ListCmd) Usage() string { + return `list: + List the database migrations and their statuses. + ` +} + +func (m *ListCmd) SetFlags(f *flag.FlagSet) {} + +func (m *ListCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus { + db, err := db.Connect() + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + defer db.Close() + + c, err := config.NewConfig() + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + + migrationRepo, err := repositories.NewMigrationRepo(db, c) + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + + migrations, err := migrationRepo.List() + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + + for _, migration := range migrations { + fmt.Println(migration) + } + + return subcommands.ExitSuccess +} diff --git a/internal/commands/migrate.go b/internal/commands/migrate.go index fdbddfe..edcfc81 100644 --- a/internal/commands/migrate.go +++ b/internal/commands/migrate.go @@ -6,7 +6,9 @@ import ( "fmt" "os" + "github.com/eugenetriguba/bolt/internal/config" "github.com/eugenetriguba/bolt/internal/db" + "github.com/eugenetriguba/bolt/internal/repositories" "github.com/google/subcommands" ) @@ -30,16 +32,35 @@ func (m *MigrateCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{ } defer db.Close() - sqlStatement := ` - CREATE TABLE IF NOT EXISTS applied_migration( - version CHARACTER(32) PRIMARY KEY NOT NULL - ); - ` - _, err = db.Exec(sqlStatement) + c, err := config.NewConfig() if err != nil { fmt.Fprintln(os.Stderr, err) return subcommands.ExitFailure } + migrationRepo, err := repositories.NewMigrationRepo(db, c) + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + + migrations, err := migrationRepo.List() + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + + for _, migration := range migrations { + if !migration.Applied { + fmt.Printf("Applying migration for %s..\n", migration.Dirname()) + err = migrationRepo.Apply(migration) + if err != nil { + fmt.Fprintln(os.Stderr, err) + return subcommands.ExitFailure + } + fmt.Printf("%s [x]\n", migration.Dirname()) + } + } + return subcommands.ExitSuccess } diff --git a/internal/models/migration.go b/internal/models/migration.go index a7e27aa..a19b95f 100644 --- a/internal/models/migration.go +++ b/internal/models/migration.go @@ -1,3 +1,49 @@ package models -type Migration struct{} +import ( + "fmt" + "strings" + "time" +) + +type Migration struct { + Version string + Message string + Applied bool +} + +func NewMigration(message string) *Migration { + now := time.Now() + version := fmt.Sprintf( + "%d%02d%02d%02d%02d%02d", + now.Year(), now.Month(), now.Day(), + now.Hour(), now.Minute(), now.Second(), + ) + return &Migration{Version: version, Message: message, Applied: false} +} + +func (m *Migration) Dirname() string { + return fmt.Sprintf("%s_%s", m.Version, m.normalizedMessage()) +} + +func (m *Migration) normalizedMessage() string { + return strings.ReplaceAll( + strings.TrimSpace(strings.ToLower(m.Message)), + " ", + "_", + ) +} + +func (m *Migration) String() string { + checked := " " + if m.Applied { + checked = "x" + } + + return fmt.Sprintf( + "%s - %s - [%s]", + m.Version, + m.normalizedMessage(), + checked, + ) +} diff --git a/internal/repositories/migration.go b/internal/repositories/migration.go index efd29e3..562b2e5 100644 --- a/internal/repositories/migration.go +++ b/internal/repositories/migration.go @@ -5,8 +5,12 @@ import ( "errors" "fmt" "os" + "path/filepath" + "sort" + "strings" "github.com/eugenetriguba/bolt/internal/config" + "github.com/eugenetriguba/bolt/internal/models" ) type IsNotDirError struct { @@ -57,18 +61,106 @@ func NewMigrationRepo(db *sql.DB, c *config.Config) (*MigrationRepo, error) { return &MigrationRepo{db: db, config: c}, nil } -func (mr *MigrationRepo) Create(message string) error { +func (mr *MigrationRepo) Create(m *models.Migration) error { + path := filepath.Join(mr.config.MigrationsDir, m.Dirname()) + err := os.Mkdir(path, 0755) + if err != nil { + return err + } + + _, err = os.Create(filepath.Join(path, "upgrade.sql")) + if err != nil { + return err + } + + return nil +} + +func (mr *MigrationRepo) List() ([]*models.Migration, error) { + rows, err := mr.db.Query(`SELECT version FROM bolt_migrations;`) + if err != nil { + return nil, err + } + defer rows.Close() + + migrations := make(map[string]*models.Migration) + for rows.Next() { + var version string + err := rows.Scan(&version) + if err != nil { + return nil, err + } + version = strings.TrimSpace(version) + migrations[version] = &models.Migration{ + Version: version, + Message: "", + Applied: true, + } + } + + entries, err := os.ReadDir(mr.config.MigrationsDir) + if err != nil { + return nil, err + } + for _, entry := range entries { + parts := strings.SplitN(entry.Name(), "_", 2) + if len(parts) != 2 { + return nil, errors.New( + fmt.Sprintf( + "%s is an invalid migration name. Expected a "+ + "migration directory of the format <version>_<message>.", + entry.Name(), + ), + ) + } + version := parts[0] + message := parts[1] + val, ok := migrations[version] + if ok { + val.Message = message + } else { + migrations[version] = &models.Migration{ + Version: version, + Message: message, + Applied: false, + } + } + } + + values := make([]*models.Migration, 0, len(migrations)) + for _, value := range migrations { + values = append(values, value) + } + + sort.Slice(values, func(i, j int) bool { + return values[i].Dirname() < values[j].Dirname() + }) + + return values, nil +} + +func (mr *MigrationRepo) Apply(migration *models.Migration) error { tx, err := mr.db.Begin() if err != nil { return err } defer tx.Rollback() - sqlStatement := `INSERT INTO applied_migration(version) VALUES ($1);` - _, err = mr.db.Exec(sqlStatement) + upgradeScriptPath := filepath.Join( + mr.config.MigrationsDir, migration.Dirname(), "upgrade.sql", + ) + contents, err := os.ReadFile(upgradeScriptPath) if err != nil { return err } + tx.Exec(string(contents)) + tx.Exec( + `INSERT INTO bolt_migrations(version) VALUES ($1);`, + migration.Version, + ) + migration.Applied = true + tx.Commit() + return nil } diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go index bbbd8d1..0ce67be 100644 --- a/pkg/cli/cli.go +++ b/pkg/cli/cli.go @@ -12,7 +12,9 @@ func Run() int { subcommands.Register(subcommands.HelpCommand(), "") subcommands.Register(subcommands.FlagsCommand(), "") subcommands.Register(subcommands.CommandsCommand(), "") + subcommands.Register(&commands.CreateCmd{}, "") subcommands.Register(&commands.MigrateCmd{}, "") + subcommands.Register(&commands.ListCmd{}, "") flag.Parse() ctx := context.Background() |