-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathmigration_test.go
More file actions
374 lines (366 loc) · 7.68 KB
/
migration_test.go
File metadata and controls
374 lines (366 loc) · 7.68 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
package gosmig
import (
"context"
"database/sql"
"testing"
"github.com/stretchr/testify/require"
)
func TestMigrationValidate(t *testing.T) {
// Helper functions for test cases
validUpFunc := func(ctx context.Context, tx *sql.Tx) error { return nil }
validDownFunc := func(ctx context.Context, tx *sql.Tx) error { return nil }
validUpNoTXFunc := func(ctx context.Context, db *sql.DB) error { return nil }
validDownNoTXFunc := func(ctx context.Context, db *sql.DB) error { return nil }
testCases := []struct {
name string
migration MigrationSQL
wantErr string
}{
{
name: "valid migration with UpDown",
migration: MigrationSQL{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
},
{
name: "valid migration with UpDownNoTX",
migration: MigrationSQL{
Version: 1,
UpDownNoTX: &UpDownNoTXSQL{
Up: validUpNoTXFunc,
Down: validDownNoTXFunc,
},
},
},
{
name: "invalid version zero",
migration: MigrationSQL{
Version: 0,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
wantErr: "migration version must be > 0",
},
{
name: "invalid version negative",
migration: MigrationSQL{
Version: -1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
wantErr: "migration version must be > 0",
},
{
name: "missing both UpDown and UpDownNoTX",
migration: MigrationSQL{
Version: 1,
},
wantErr: "must have UpDown xor UpDownNoTX fields defined",
},
{
name: "both UpDown and UpDownNoTX defined",
migration: MigrationSQL{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
UpDownNoTX: &UpDownNoTXSQL{
Up: validUpNoTXFunc,
Down: validDownNoTXFunc,
},
},
wantErr: "must have only one of UpDown or UpDownNoTX fields defined",
},
{
name: "UpDown missing Up function",
migration: MigrationSQL{
Version: 1,
UpDown: &UpDownSQL{
Up: nil,
Down: validDownFunc,
},
},
wantErr: "UpDown must have both Up and Down functions defined",
},
{
name: "UpDown missing Down function",
migration: MigrationSQL{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: nil,
},
},
wantErr: "UpDown must have both Up and Down functions defined",
},
{
name: "UpDown missing both Up and Down functions",
migration: MigrationSQL{
Version: 1,
UpDown: &UpDownSQL{
Up: nil,
Down: nil,
},
},
wantErr: "UpDown must have both Up and Down functions defined",
},
{
name: "UpDownNoTX missing Up function",
migration: MigrationSQL{
Version: 1,
UpDownNoTX: &UpDownNoTXSQL{
Up: nil,
Down: validDownNoTXFunc,
},
},
wantErr: "UpDownNoTX must have both Up and Down functions defined",
},
{
name: "UpDownNoTX missing Down function",
migration: MigrationSQL{
Version: 1,
UpDownNoTX: &UpDownNoTXSQL{
Up: validUpNoTXFunc,
Down: nil,
},
},
wantErr: "UpDownNoTX must have both Up and Down functions defined",
},
{
name: "UpDownNoTX missing both Up and Down functions",
migration: MigrationSQL{
Version: 1,
UpDownNoTX: &UpDownNoTXSQL{
Up: nil,
Down: nil,
},
},
wantErr: "UpDownNoTX must have both Up and Down functions defined",
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
err := tc.migration.validate()
if tc.wantErr != "" {
require.ErrorContains(t, err, tc.wantErr)
return
}
require.NoError(t, err)
})
}
}
func TestValidateMigrations(t *testing.T) {
// Helper functions for test cases
validUpFunc := func(ctx context.Context, tx *sql.Tx) error { return nil }
validDownFunc := func(ctx context.Context, tx *sql.Tx) error { return nil }
validUpNoTXFunc := func(ctx context.Context, db *sql.DB) error { return nil }
validDownNoTXFunc := func(ctx context.Context, db *sql.DB) error { return nil }
testCases := []struct {
name string
migrations []MigrationSQL
wantErrs []string
}{
{
name: "valid multiple migrations",
migrations: []MigrationSQL{
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 2,
UpDownNoTX: &UpDownNoTXSQL{
Up: validUpNoTXFunc,
Down: validDownNoTXFunc,
},
},
{
Version: 3,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
},
},
{
name: "duplicate migration version",
migrations: []MigrationSQL{
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 2,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
},
wantErrs: []string{
"invalid migration(s): migration version 1 is defined 2 times",
},
},
{
name: "multiple duplicate versions",
migrations: []MigrationSQL{
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 2,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 2,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
},
wantErrs: []string{
"invalid migration(s): ",
"migration version 1 is defined 2 times",
"migration version 2 is defined 2 times",
},
},
{
name: "triplicate migration version",
migrations: []MigrationSQL{
{
Version: 5,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 5,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 5,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
},
wantErrs: []string{
"invalid migration(s): migration version 5 is defined 3 times",
},
},
{
name: "multiple invalid migrations propagates individual errors",
migrations: []MigrationSQL{
{
Version: 0,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 1,
UpDown: &UpDownSQL{
Up: nil,
Down: validDownFunc,
},
},
{
Version: 2,
},
},
wantErrs: []string{
"invalid migration(s): ",
"migration version must be > 0",
"migration 1 UpDown must have both Up and Down functions defined",
"migration 2 must have UpDown xor UpDownNoTX fields defined",
},
},
{
name: "duplicate version combined with invalid migration",
migrations: []MigrationSQL{
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 1,
UpDown: &UpDownSQL{
Up: validUpFunc,
Down: validDownFunc,
},
},
{
Version: 2,
UpDown: &UpDownSQL{
Up: nil,
Down: validDownFunc,
},
},
},
wantErrs: []string{
"invalid migration(s):",
"migration version 1 is defined 2 times",
"migration 2 UpDown must have both Up and Down functions defined",
},
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
err := validateMigrations(tc.migrations)
if len(tc.wantErrs) > 0 {
for _, wantErr := range tc.wantErrs {
require.ErrorContains(t, err, wantErr)
}
return
}
require.NoError(t, err)
})
}
}