aboutsummaryrefslogtreecommitdiffstats
path: root/internal/repositories/migration_db_repo_test.go
blob: 8098e034a7d6c6502c116f53c65ff3eab6b204fe (plain) (blame)
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
package repositories_test

import (
	"database/sql"
	"errors"
	"testing"
	"time"

	"git.sr.ht/~eugenetriguba/bolt/internal/bolttest"
	"git.sr.ht/~eugenetriguba/bolt/internal/models"
	"git.sr.ht/~eugenetriguba/bolt/internal/repositories"
	"git.sr.ht/~eugenetriguba/checkmate/assert"
)

func TestNewMigrationDBRepo_CreatesTable(t *testing.T) {
	testdb := bolttest.NewTestDB(t)
	exists, err := testdb.TableExists("bolt_migrations")
	assert.Nil(t, err)
	assert.False(t, exists)

	_, err = repositories.NewMigrationDBRepo("bolt_migrations", testdb)
	assert.Nil(t, err)

	exists, err = testdb.TableExists("bolt_migrations")
	assert.Nil(t, err)
	assert.True(t, exists)
}

func TestNewMigrationDBRepo_CreateTableExecError(t *testing.T) {
	mockDB := &bolttest.MockDB{
		TableExistsFunc: func(tableName string) (bool, error) {
			return false, nil
		},
		ExecFunc: func(query string, args ...interface{}) (sql.Result, error) {
			return nil, errors.New("exec error")
		},
	}
	_, err := repositories.NewMigrationDBRepo("bolt_migrations", mockDB)
	assert.NotNil(t, err)
	assert.ErrorContains(t, err, "unable to create 'bolt_migrations' database table: exec error")
}

func TestNewMigrationDBRepo_TableExistsError(t *testing.T) {
	mockDB := &bolttest.MockDB{
		TableExistsFunc: func(tableName string) (bool, error) {
			return false, errors.New("table exists failed")
		},
	}
	_, err := repositories.NewMigrationDBRepo("bolt_migrations", mockDB)
	assert.NotNil(t, err)
	assert.ErrorContains(t, err, "unable to confirm 'bolt_migrations' database table exists: table exists failed")
}

func TestNewMigrationDBRepo_TableAlreadyExists(t *testing.T) {
	testdb := bolttest.NewTestDB(t)
	_, err := testdb.Exec(`CREATE TABLE bolt_migrations(id INT NOT NULL PRIMARY KEY)`)
	assert.Nil(t, err)
	_, err = testdb.Exec(`INSERT INTO bolt_migrations(id) VALUES (1);`)
	assert.Nil(t, err)

	_, err = repositories.NewMigrationDBRepo("bolt_migrations", testdb)
	assert.Nil(t, err)

	var count int
	err = testdb.QueryRow("SELECT count(*) FROM bolt_migrations;").Scan(&count)
	assert.Nil(t, err)
	assert.Equal(t, count, 1)
	var scanResult int
	err = testdb.QueryRow("SELECT id FROM bolt_migrations;").Scan(&scanResult)
	assert.Nil(t, err)
	assert.Equal(t, scanResult, 1)
}

func TestList_EmptyTable(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)

	migrations, err := repo.List()
	assert.Nil(t, err)
	assert.Equal(t, len(migrations), 0)
}

func TestList_QueryError(t *testing.T) {
	mockDB := &bolttest.MockDB{
		TableExistsFunc: func(tableName string) (bool, error) {
			return true, nil
		},
		QueryFunc: func(query string, args ...interface{}) (*sql.Rows, error) {
			return nil, errors.New("query error")
		},
	}
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", mockDB)
	assert.Nil(t, err)

	_, err = repo.List()
	assert.NotNil(t, err)
	assert.ErrorContains(t, err, "unable to execute query to select versions from 'bolt_migrations' database table: query error")
}

func TestList_SingleResult(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)

	version := "20230101000000"
	_, err = db.Exec("INSERT INTO bolt_migrations(version) VALUES(?)", version)
	assert.Nil(t, err)

	migrations, err := repo.List()
	assert.Nil(t, err)
	assert.Equal(t, len(migrations), 1)
	assert.DeepEqual(
		t,
		migrations[version],
		&models.Migration{Version: version, Message: "", Applied: true},
	)
}

func TestList_ShortVersion(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)

	version := "20230101"
	_, err = db.Exec("INSERT INTO bolt_migrations(version) VALUES(?)", version)
	assert.Nil(t, err)

	migrations, err := repo.List()
	assert.Nil(t, err)
	assert.Equal(t, len(migrations), 1)
	assert.DeepEqual(
		t,
		migrations[version],
		&models.Migration{Version: version, Message: "", Applied: true},
	)
}

func TestIsApplied_WithNotApplied(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)

	version := "20230101010101"
	applied, err := repo.IsApplied(version)
	assert.Nil(t, err)
	assert.Equal(t, applied, false)
}

func TestIsApplied_WithApplied(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)

	version := "20230101010101"
	_, err = db.Exec("INSERT INTO bolt_migrations(version) VALUES(?)", version)
	assert.Nil(t, err)

	applied, err := repo.IsApplied(version)
	assert.Nil(t, err)
	assert.Equal(t, applied, true)
}

func TestIsApplied_SQLInjectionAttempt(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)

	version := "20230101010101'; DROP TABLE bolt_migrations; --"
	applied, err := repo.IsApplied(version)
	assert.Nil(t, err)
	assert.Equal(t, applied, false)

	exists, err := db.TableExists("bolt_migrations")
	assert.Nil(t, err)
	assert.True(t, exists)
}

func TestApply(t *testing.T) {
	testdb := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", testdb)
	assert.Nil(t, err)

	migration := models.NewTimestampMigration(time.Now(), "test")
	err = repo.Apply(`CREATE TABLE tmp(id INT NOT NULL PRIMARY KEY)`, migration)
	assert.Nil(t, err)
	assert.Equal(t, migration.Applied, true)

	exists, err := testdb.TableExists("tmp")
	assert.Nil(t, err)
	assert.True(t, exists)
	applied, err := repo.IsApplied(migration.Version)
	assert.Nil(t, err)
	assert.Equal(t, applied, true)
}

func TestApply_MalformedSql(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)
	migration := models.NewTimestampMigration(time.Now(), "test")

	err = repo.Apply("this is not SQL", migration)

	assert.NotNil(t, err)
	assert.Equal(t, migration.Applied, false)
}

func TestApplyWithTx_ExecErr(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)
	migration := models.NewTimestampMigration(time.Now(), "test")

	err = repo.ApplyWithTx("SELECT 1 FROM abc123donotexist;", migration)

	assert.ErrorContains(t, err, `unable to execute upgrade script`)
}

func TestApplyWithTx_SuccessfullyApplied(t *testing.T) {
	testdb := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", testdb)
	assert.Nil(t, err)

	migration := models.NewTimestampMigration(time.Now(), "test")
	err = repo.ApplyWithTx(`CREATE TABLE tmp(id INT NOT NULL PRIMARY KEY)`, migration)
	assert.Nil(t, err)
	assert.Equal(t, migration.Applied, true)

	exists, err := testdb.TableExists("tmp")
	assert.Nil(t, err)
	assert.True(t, exists)
	applied, err := repo.IsApplied(migration.Version)
	assert.Nil(t, err)
	assert.Equal(t, applied, true)
}

func TestRevert(t *testing.T) {
	testdb := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", testdb)
	assert.Nil(t, err)

	_, err = testdb.Exec(`CREATE TABLE tmp(id INT NOT NULL PRIMARY KEY)`)
	assert.Nil(t, err)

	migration := models.NewTimestampMigration(time.Now(), "test")
	_, err = testdb.Exec(
		"INSERT INTO bolt_migrations(version) VALUES(?)",
		migration.Version,
	)
	assert.Nil(t, err)
	migration.Applied = true

	err = repo.Revert(`DROP TABLE tmp;`, migration)
	assert.Nil(t, err)
	assert.Equal(t, migration.Applied, false)

	exists, err := testdb.TableExists("tmp")
	assert.Nil(t, err)
	assert.False(t, exists)
	var count int
	err = testdb.QueryRow("SELECT count(*) FROM bolt_migrations;").Scan(&count)
	assert.Nil(t, err)
	assert.Equal(t, count, 0)
}

func TestRevert_MalformedSql(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)
	migration := models.NewTimestampMigration(time.Now(), "test")
	migration.Applied = true

	err = repo.Revert("this is not SQL", migration)
	assert.ErrorContains(t, err, "unable to execute downgrade script")
	assert.Equal(t, migration.Applied, true)
}

func TestRevertWithTx_ExecErr(t *testing.T) {
	db := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", db)
	assert.Nil(t, err)
	migration := models.NewTimestampMigration(time.Now(), "test")

	err = repo.RevertWithTx("DROP TABLE abc123donotexist;", migration)

	assert.ErrorContains(t, err, `unable to execute downgrade script`)
}

func TestRevertWithTx_SuccessfullyReverted(t *testing.T) {
	testdb := bolttest.NewTestDB(t)
	repo, err := repositories.NewMigrationDBRepo("bolt_migrations", testdb)
	assert.Nil(t, err)

	_, err = testdb.Exec(`CREATE TABLE tmp(id INT NOT NULL PRIMARY KEY)`)
	assert.Nil(t, err)

	migration := models.NewTimestampMigration(time.Now(), "test")
	_, err = testdb.Exec(
		"INSERT INTO bolt_migrations(version) VALUES(?)",
		migration.Version,
	)
	assert.Nil(t, err)
	migration.Applied = true

	err = repo.RevertWithTx(`DROP TABLE tmp;`, migration)
	assert.Nil(t, err)
	assert.Equal(t, migration.Applied, false)

	exists, err := testdb.TableExists("tmp")
	assert.Nil(t, err)
	assert.False(t, exists)
	var count int
	err = testdb.QueryRow("SELECT count(*) FROM bolt_migrations;").Scan(&count)
	assert.Nil(t, err)
	assert.Equal(t, count, 0)
}

func TestNewMigrationDBRepo_InvalidTableName(t *testing.T) {
	db := bolttest.NewTestDB(t)
	invalidTableNames := []string{
		"bolt_migrations; DROP TABLE users; --", // SQL injection attempt
		"bolt_migrations`",                      // Backtick is not allowed
		"bolt_migrations'",                      // Single quote is not allowed
		"bolt_migrations\"",                     // Double quote is not allowed
		"bolt_migrations;",                      // Semicolon could terminate the SQL statement
		"bolt_migrations\\",                     // Backslash is not allowed
		"myschema..migrations_table",            // Double dot, which is invalid for schema.table format
		"myschema.migrations_table.",            // Trailing dot is not allowed
		"myschema.migrations_table;",            // Semicolon in schema-qualified name is not allowed
		".migrations_table",                     // Leading dot is not allowed
		"myschema.migrations_table$",            // Dollar sign is not allowed
	}

	for _, tableName := range invalidTableNames {
		_, err := repositories.NewMigrationDBRepo(tableName, db)
		assert.NotNil(t, err)
		assert.ErrorContains(t, err, "invalid migration table name")
	}
}