diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-02 10:18:41 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-02 10:18:41 -0500 |
| commit | 018083b9259c2265ad3ea2432f315641e5b996ce (patch) | |
| tree | 455ecf9fb4ccf12f9634e6e54fb8a9e73e162220 | |
| parent | Improve coverage for separate Tx methods (diff) | |
| download | cli-018083b9259c2265ad3ea2432f315641e5b996ce.zip | |
Clean up fs repo and fs repo tests
| -rw-r--r-- | internal/bolttest/mock_migration_fs_repo.go | 23 | ||||
| -rw-r--r-- | internal/repositories/migration_fs_repo.go | 46 | ||||
| -rw-r--r-- | internal/repositories/migration_fs_repo_test.go | 141 | ||||
| -rw-r--r-- | internal/services/migration.go | 5 |
4 files changed, 152 insertions, 63 deletions
diff --git a/internal/bolttest/mock_migration_fs_repo.go b/internal/bolttest/mock_migration_fs_repo.go index 0932b37..ae933e3 100644 --- a/internal/bolttest/mock_migration_fs_repo.go +++ b/internal/bolttest/mock_migration_fs_repo.go @@ -5,10 +5,6 @@ import "github.com/eugenetriguba/bolt/internal/models" type MockMigrationFsRepo struct { CreateReturnValue CreateReturnValue CreateCallCount int - ExistsReturnValue ExistsReturnValue - ExistsCallCount int - GetReturnValue GetReturnValue - GetCallCount int ListReturnValue ListReturnValue ListCallCount int LatestReturnValue LatestReturnValue @@ -23,18 +19,11 @@ type CreateReturnValue struct { Err error } -type ExistsReturnValue struct { - Exists bool - Err error -} - -type GetReturnValue struct { +type LatestReturnValue struct { Migration *models.Migration Err error } -type LatestReturnValue = GetReturnValue - type ReadUpgradeScriptReturnValue struct { ScriptContents string Err error @@ -47,16 +36,6 @@ func (repo *MockMigrationFsRepo) Create(migration *models.Migration) error { return repo.CreateReturnValue.Err } -func (repo *MockMigrationFsRepo) Exists(version string) (bool, error) { - repo.ExistsCallCount += 1 - return repo.ExistsReturnValue.Exists, repo.ExistsReturnValue.Err -} - -func (repo *MockMigrationFsRepo) Get(version string) (*models.Migration, error) { - repo.GetCallCount += 1 - return repo.GetReturnValue.Migration, repo.GetReturnValue.Err -} - func (repo *MockMigrationFsRepo) List() (map[string]*models.Migration, error) { repo.ListCallCount += 1 return repo.ListReturnValue.Migrations, repo.ListReturnValue.Err diff --git a/internal/repositories/migration_fs_repo.go b/internal/repositories/migration_fs_repo.go index 9d21c59..9d6c3aa 100644 --- a/internal/repositories/migration_fs_repo.go +++ b/internal/repositories/migration_fs_repo.go @@ -25,8 +25,6 @@ func (e *ErrIsNotDir) Error() string { type MigrationFsRepo interface { Create(migration *models.Migration) error - Exists(version string) (bool, error) - Get(version string) (*models.Migration, error) List() (map[string]*models.Migration, error) Latest() (*models.Migration, error) ReadUpgradeScript(migration *models.Migration) (string, error) @@ -41,14 +39,22 @@ func NewMigrationFsRepo( migrationsConfig *configloader.MigrationsConfig, ) (MigrationFsRepo, error) { fileInfo, err := os.Stat(migrationsConfig.DirectoryPath) - if errors.Is(err, os.ErrNotExist) { + if errors.Is(err, fs.ErrNotExist) { err = os.MkdirAll(migrationsConfig.DirectoryPath, 0755) if err != nil { - return nil, err + return nil, fmt.Errorf( + "unable to create migration directory at %s: %w", + migrationsConfig.DirectoryPath, + err, + ) } } else if err != nil { - return nil, err - } else if err == nil && !fileInfo.IsDir() { + return nil, fmt.Errorf( + "unable to check if migration directory at %s exists: %w", + migrationsConfig.DirectoryPath, + err, + ) + } else if !fileInfo.IsDir() { return nil, &ErrIsNotDir{path: migrationsConfig.DirectoryPath} } @@ -76,31 +82,11 @@ func (mr migrationFsRepo) Create(migration *models.Migration) error { return nil } -func (mr migrationFsRepo) Exists(version string) (bool, error) { - migrations, err := mr.List() - if err != nil { - return false, err - } - - _, ok := migrations[version] - return ok, nil -} - -func (mr migrationFsRepo) Get(version string) (*models.Migration, error) { - migrations, err := mr.List() - if err != nil { - return nil, err - } - - migration, ok := migrations[version] - if !ok { - return nil, fmt.Errorf("migration %s does not exist", version) - } - - return migration, nil -} - func (mr migrationFsRepo) Latest() (*models.Migration, error) { + // TODO: ReadDir returns migrations sorted by filename. + // To be correct, it seems like we will need to sort these + // migrations by the version style that is configured and then + // grab the latest. entries, err := os.ReadDir(mr.migrationsDirPath) if err != nil { return nil, err diff --git a/internal/repositories/migration_fs_repo_test.go b/internal/repositories/migration_fs_repo_test.go index 72ba792..d10bddc 100644 --- a/internal/repositories/migration_fs_repo_test.go +++ b/internal/repositories/migration_fs_repo_test.go @@ -18,18 +18,18 @@ func assertFileExists(t *testing.T, path string) { assert.Nil(t, err) } -func TestNewMigrationFsRepoCreatesDirIfNotExists(t *testing.T) { +func TestNewMigrationFsRepo_CreatesDirIfNotExists(t *testing.T) { tempDir := t.TempDir() migrationsDir := filepath.Join(tempDir, "migrations") migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} _, err := repositories.NewMigrationFsRepo(&migrationsConfig) - assert.Nil(t, err) + assert.Nil(t, err) assertFileExists(t, migrationsDir) } -func TestNewMigrationFsRepoMigrationDirIsFile(t *testing.T) { +func TestNewMigrationFsRepo_MigrationDirIsFile(t *testing.T) { tempDir := t.TempDir() migrationsDir := filepath.Join(tempDir, "migrations") migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} @@ -37,10 +37,19 @@ func TestNewMigrationFsRepoMigrationDirIsFile(t *testing.T) { assert.Nil(t, err) _, err = repositories.NewMigrationFsRepo(&migrationsConfig) + assert.ErrorContains(t, err, "is not a directory") } -func TestMigrationFsRepoCreate(t *testing.T) { +func TestNewMigrationFsRepo_UnknownStatErr(t *testing.T) { + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: "\000x"} + + _, err := repositories.NewMigrationFsRepo(&migrationsConfig) + + assert.ErrorContains(t, err, "unable to check if migration directory") +} + +func TestCreate_SuccessfullyCreated(t *testing.T) { tempDir := t.TempDir() migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir} repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) @@ -56,13 +65,29 @@ func TestMigrationFsRepoCreate(t *testing.T) { assertFileExists(t, filepath.Join(tempDir, migrationDirName, "downgrade.sql")) } -func TestMigrationFsRepoReadUpgradeAndDowngradeScript(t *testing.T) { +func TestCreate_FailsToCreateDir(t *testing.T) { tempDir := t.TempDir() migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir} repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) 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)) + assert.Nil(t, err) + + err = repo.Create(migration) + + assert.NotNil(t, err) + assert.ErrorContains(t, err, "file exists") +} + +func TestReadUpgradeScript_SuccessfullyRead(t *testing.T) { + tempDir := t.TempDir() + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + + migration := models.NewSequentialMigration(1, "add users table") err = repo.Create(migration) assert.Nil(t, err) @@ -73,6 +98,35 @@ func TestMigrationFsRepoReadUpgradeAndDowngradeScript(t *testing.T) { expectedUpgradeScriptContents, 0755, ) + + upgradeScriptContents, err := repo.ReadUpgradeScript(migration) + assert.Nil(t, err) + assert.Equal(t, upgradeScriptContents, string(expectedUpgradeScriptContents)) +} + +func TestReadUpgradeScript_FileDoesNotExist(t *testing.T) { + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: t.TempDir()} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + migration := models.NewSequentialMigration(1, "add users table") + + _, err = repo.ReadUpgradeScript(migration) + + assert.NotNil(t, err) + assert.ErrorContains(t, err, "no such file or directory") +} + +func TestReadDowngradeScript_SuccessfullyRead(t *testing.T) { + tempDir := t.TempDir() + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + + migration := models.NewSequentialMigration(1, "add users table") + err = repo.Create(migration) + assert.Nil(t, err) + + migrationDirName := fmt.Sprintf("%s_add_users_table", migration.Version) expectedDowngradeScriptContents := []byte("DROP TABLE users;") os.WriteFile( filepath.Join(tempDir, migrationDirName, "downgrade.sql"), @@ -80,15 +134,24 @@ func TestMigrationFsRepoReadUpgradeAndDowngradeScript(t *testing.T) { 0755, ) - upgradeScriptContents, err := repo.ReadUpgradeScript(migration) - assert.Nil(t, err) - assert.Equal(t, upgradeScriptContents, string(expectedUpgradeScriptContents)) downgradeScriptContents, err := repo.ReadDowngradeScript(migration) assert.Nil(t, err) assert.Equal(t, downgradeScriptContents, string(expectedDowngradeScriptContents)) } -func TestMigrationFsRepo_List(t *testing.T) { +func TestReadDowngradeScript_FileDoesNotExist(t *testing.T) { + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: t.TempDir()} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + migration := models.NewSequentialMigration(1, "add users table") + + _, err = repo.ReadDowngradeScript(migration) + + assert.NotNil(t, err) + assert.ErrorContains(t, err, "no such file or directory") +} + +func TestList_Success(t *testing.T) { tempDir := t.TempDir() migrationsConfig := configloader.MigrationsConfig{DirectoryPath: tempDir} repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) @@ -113,3 +176,61 @@ func TestMigrationFsRepo_List(t *testing.T) { assert.DeepEqual(t, migrations[migration1.Version], migration1) assert.DeepEqual(t, migrations[migration2.Version], migration2) } + +func TestList_DirDoesNotExist(t *testing.T) { + migrationsDir := filepath.Join(t.TempDir(), "migrations") + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + err = os.RemoveAll(migrationsDir) + assert.Nil(t, err) + + _, err = repo.List() + + assert.NotNil(t, err) + assert.ErrorContains(t, err, "no such file or directory") +} + +func TestList_InvalidMigrationName(t *testing.T) { + migrationsDir := filepath.Join(t.TempDir(), "migrations") + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + err = os.Mkdir(filepath.Join(migrationsDir, "invalid"), 0755) + assert.Nil(t, err) + + _, err = repo.List() + + assert.NotNil(t, err) + assert.ErrorContains( + t, + err, + "expected a migration directory of the format <version>_<message>", + ) +} + +func TestLatest_DirDoesNotExist(t *testing.T) { + migrationsDir := filepath.Join(t.TempDir(), "migrations") + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + err = os.RemoveAll(migrationsDir) + assert.Nil(t, err) + + _, err = repo.Latest() + + assert.NotNil(t, err) + assert.ErrorContains(t, err, "no such file or directory") +} + +func TestLatest_NoMigrations(t *testing.T) { + migrationsDir := filepath.Join(t.TempDir(), "migrations") + migrationsConfig := configloader.MigrationsConfig{DirectoryPath: migrationsDir} + repo, err := repositories.NewMigrationFsRepo(&migrationsConfig) + assert.Nil(t, err) + + latestMigration, err := repo.Latest() + + assert.Nil(t, err) + assert.Nil(t, latestMigration) +} diff --git a/internal/services/migration.go b/internal/services/migration.go index 446f267..a91ae2a 100644 --- a/internal/services/migration.go +++ b/internal/services/migration.go @@ -335,7 +335,10 @@ func (ms MigrationService) ListMigrations(order sortOrder) ([]*models.Migration, return migrations, err } -func (ms MigrationService) sortMigrations(migrations []*models.Migration, order sortOrder) error { +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 |