Compare commits

...

2 commits

Author SHA1 Message Date
Miguel de la Cruz
29ac8f6f33 Update README with the new library API 2022-08-12 16:55:21 +02:00
Miguel de la Cruz
0bfc18f735 Add RunInterceptor test helper and update MigrateToStep ones 2022-08-12 16:34:23 +02:00
2 changed files with 63 additions and 15 deletions

View file

@ -21,6 +21,7 @@ type Migrator interface {
DriverName() string DriverName() string
Setup() error Setup() error
MigrateToStep(step int) error MigrateToStep(step int) error
Interceptors() map[int]Interceptor
TearDown() error TearDown() error
} }
@ -39,7 +40,6 @@ your assertions:
```go ```go
t.Run("migration should link book 1 with its author", func(t *testing.T) { t.Run("migration should link book 1 with its author", func(t *testing.T) {
f := foundation.New(t, migrator). f := foundation.New(t, migrator).
RegisterInterceptors(interceptors).
// runs migrations up to and including 5 // runs migrations up to and including 5
MigrateToStep(5). MigrateToStep(5).
// loads the SQL of the file // loads the SQL of the file
@ -48,14 +48,21 @@ t.Run("migration should link book 1 with its author", func(t *testing.T) {
MigrateToStep(6) MigrateToStep(6)
defer f.TearDown() defer f.TearDown()
book := struct{ book := struct{ID int; AuthorID int}{}
ID int
AuthorID int
}{}
err = f.DB().Get(&book, "SELECT id, authorID FROM books") err := f.DB().Get(&book, "SELECT id, authorID FROM books")
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, 1, book.ID) require.Equal(t, 1, book.ID)
require.Equal(t, 3, book.AuthorID) require.Equal(t, 3, book.AuthorID)
}) })
t.Run("test specifically the interceptor 6", func(t *testing.T) {
f := foundation.New(t, migrator).
MigrateToStepSkippingLastInterceptor(6).
ExecFile("./myfixtures.sql").
RunInterceptor(6)
defer f.TearDown()
// ...
})
``` ```

View file

@ -22,6 +22,7 @@ type Migrator interface {
DriverName() string DriverName() string
Setup() error Setup() error
MigrateToStep(step int) error MigrateToStep(step int) error
Interceptors() map[int]Interceptor
TearDown() error TearDown() error
} }
@ -42,10 +43,13 @@ func New(t *testing.T, migrator Migrator) *Foundation {
// instead of just once with the final step // instead of just once with the final step
stepByStep: false, stepByStep: false,
migrator: migrator, migrator: migrator,
interceptors: migrator.Interceptors(),
db: db, db: db,
} }
} }
// RegisterInterceptors replaced the migrator interceptors with new
// ones, in case we want to check a special case for a given test
func (f *Foundation) RegisterInterceptors(interceptors map[int]Interceptor) *Foundation { func (f *Foundation) RegisterInterceptors(interceptors map[int]Interceptor) *Foundation {
f.interceptors = interceptors f.interceptors = interceptors
return f return f
@ -83,7 +87,7 @@ func (f *Foundation) calculateNextStep(step int) int {
return i return i
} }
func (f *Foundation) MigrateToStep(step int) *Foundation { func (f *Foundation) migrateToStep(step int, skipLastInterceptor bool) *Foundation {
if step == f.currentStep { if step == f.currentStep {
// log nothing to do // log nothing to do
return f return f
@ -95,7 +99,7 @@ func (f *Foundation) MigrateToStep(step int) *Foundation {
// if there are no interceptors, just migrate to the last step // if there are no interceptors, just migrate to the last step
if f.interceptors == nil { if f.interceptors == nil {
if err := f.migrateToStep(step); err != nil { if err := f.doMigrateToStep(step); err != nil {
f.t.Fatalf("migration to step %d failed: %s", step, err) f.t.Fatalf("migration to step %d failed: %s", step, err)
} }
@ -105,14 +109,20 @@ func (f *Foundation) MigrateToStep(step int) *Foundation {
for f.currentStep < step { for f.currentStep < step {
nextStep := f.calculateNextStep(step) nextStep := f.calculateNextStep(step)
if err := f.migrateToStep(nextStep); err != nil { if err := f.doMigrateToStep(nextStep); err != nil {
f.t.Fatalf("migration to step %d failed: %s", nextStep, err) f.t.Fatalf("migration to step %d failed: %s", nextStep, err)
} }
// if we want to skip the last interceptor and we're in the
// last step, just continue
if skipLastInterceptor && nextStep == step {
continue
}
interceptorFn, ok := f.interceptors[nextStep] interceptorFn, ok := f.interceptors[nextStep]
if ok { if ok {
if err := interceptorFn(); err != nil { if err := interceptorFn(); err != nil {
f.t.Fatalf("interceptor function for step %d failed", nextStep) f.t.Fatalf("interceptor function for step %d failed: %s", nextStep, err)
} }
} }
} }
@ -120,11 +130,42 @@ func (f *Foundation) MigrateToStep(step int) *Foundation {
return f return f
} }
// migrateToStep executes the migrator function to migrate to a // MigrateToStep instructs the migrator to move forward until step is
// reached. While migrating, it will run the interceptors after the
// step they're defined for
func (f *Foundation) MigrateToStep(step int) *Foundation {
return f.migrateToStep(step, false)
}
// MigrateToStepSkippingLastInterceptor instructs the migrator to move
// forward until step is reached, skipping the last interceptor. This
// is useful if we want to load fixtures on the last step but before
// running the interceptor code, so we can check how that data is
// modified by the interceptor
func (f *Foundation) MigrateToStepSkippingLastInterceptor(step int) *Foundation {
return f.migrateToStep(step, true)
}
// RunInterceptor executes the code of the interceptor corresponding
// to step
func (f *Foundation) RunInterceptor(step int) *Foundation {
interceptorFn, ok := f.interceptors[step]
if !ok {
f.t.Fatalf("no interceptor found for step %d", step)
}
if err := interceptorFn(); err != nil {
f.t.Fatalf("interceptor function for step %d failed: %s", step, err)
}
return f
}
// doMigrateToStep executes the migrator function to migrate to a
// specific step and updates the foundation currentStep to reflect the // specific step and updates the foundation currentStep to reflect the
// result. This function doesn't take into account interceptors, that // result. This function doesn't take into account interceptors, that
// happens on MigrateToStep // happens on MigrateToStep
func (f *Foundation) migrateToStep(step int) error { func (f *Foundation) doMigrateToStep(step int) error {
if f.stepByStep { if f.stepByStep {
for f.currentStep < step { for f.currentStep < step {
if err := f.migrator.MigrateToStep(f.currentStep + 1); err != nil { if err := f.migrator.MigrateToStep(f.currentStep + 1); err != nil {