-
Notifications
You must be signed in to change notification settings - Fork 9
/
cache_test.go
383 lines (312 loc) · 10.3 KB
/
cache_test.go
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
375
376
377
378
379
380
381
382
383
// Copyright 2024 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package sqlair
import (
"context"
"database/sql"
"runtime"
"testing"
"time"
_ "github.com/mattn/go-sqlite3"
. "gopkg.in/check.v1"
)
// Hook up gocheck into the "go test" runner.
func TestPackage(t *testing.T) { TestingT(t) }
type CacheSuite struct{}
var _ = Suite(&CacheSuite{})
func (s *CacheSuite) TearDownTest(c *C) {
// Check every test finishes cleanly.
s.triggerFinalizers()
s.checkCacheEmpty(c)
s.checkDriverStmtsAllClosed(c)
}
func (s *CacheSuite) TearDownSuite(_ *C) {
stmtRegistryMutex.Lock()
defer stmtRegistryMutex.Unlock()
// Reset prepared statements trackers.
closedStmts = map[string]map[uintptr]bool{}
openedStmts = map[string]map[uintptr]string{}
// Reset prepared statements trackers.
dbQueriesRun = map[string]int{}
stmtQueriesRun = map[string]int{}
}
func (s *CacheSuite) TestPreparedStatementReuse(c *C) {
db := s.openDB(c)
var stmtID uint64
// For a Statement or DB to be removed from the cache it needs to go out of
// scope and be garbage collected. A function is used to "forget" the
// statement.
func() {
stmt, err := Prepare(`SELECT 'test'`)
c.Assert(err, IsNil)
stmtID = stmt.cacheID
// Start a query with stmt on db. This will prepare the stmt on the db.
err = db.Query(nil, stmt).Run()
c.Assert(err, IsNil)
// Check a statement is in the cache and a prepared statement has been
// opened on the DB.
s.checkStmtInCache(c, db.cacheID, stmt.cacheID)
s.checkNumDBStmts(c, db.cacheID, 1)
s.checkDriverStmtsOpened(c, 1)
// Run the query again.
err = db.Query(nil, stmt).Run()
c.Assert(err, IsNil)
// Check that running a second time does not prepare a second statement.
s.checkNumDBStmts(c, db.cacheID, 1)
s.checkDriverStmtsOpened(c, 1)
}()
s.triggerFinalizers()
// Check the prepared statement has been removed from the cache and closed.
s.checkStmtNotInCache(c, stmtID)
s.checkDriverStmtsAllClosed(c)
}
func (s *CacheSuite) TestClosingDB(c *C) {
stmt, err := Prepare(`SELECT 'test'`)
c.Assert(err, IsNil)
var dbID uint64
// For a Statement or DB to be removed from the cache it needs to go out of
// scope and be garbage collected. A function is used to "forget" the
// statement.
func() {
db := s.openDB(c)
dbID = db.cacheID
// Start a query with stmt on db. This will prepare the stmt on the db.
err = db.Query(nil, stmt).Run()
c.Assert(err, IsNil)
// Check a statement is in the cache and a prepared statement has been
// opened on the DB.
s.checkStmtInCache(c, db.cacheID, stmt.cacheID)
s.checkNumDBStmts(c, db.cacheID, 1)
s.checkDriverStmtsOpened(c, 1)
}()
s.triggerFinalizers()
s.checkDBNotInCache(c, dbID)
s.checkDriverStmtsAllClosed(c)
// Check that the statement runs fine on a new DB.
db := s.openDB(c)
err = db.Query(nil, stmt).Run()
c.Assert(err, IsNil)
// Check the statement has been added to the cache for the new DB.
s.checkStmtInCache(c, db.cacheID, stmt.cacheID)
s.checkNumDBStmts(c, db.cacheID, 1)
s.checkDriverStmtsOpened(c, 2)
}
func (s *CacheSuite) TestStatementPreparedAndClosed(c *C) {
db := s.openDB(c)
// For a Statement or DB to be removed from the cache it needs to go out of
// scope and be garbage collected. A function is used to "forget" the
// statement.
func() {
stmt, err := Prepare(`SELECT 'test'`)
c.Assert(err, IsNil)
// Start a query with stmt on db. This will prepare the stmt on the db.
err = db.Query(nil, stmt).Run()
c.Assert(err, IsNil)
// Check a prepared statement has been opened on the DB.
s.checkDriverStmtsOpened(c, 1)
}()
s.triggerFinalizers()
s.checkDriverStmtsAllClosed(c)
}
func (s *CacheSuite) TestPreparedStatementsClosedWithDB(c *C) {
stmt, err := Prepare(`SELECT 'test'`)
c.Assert(err, IsNil)
// For a Statement or DB to be removed from the cache it needs to go out of
// scope and be garbage collected. A function is used to "forget" the
// statement.
func() {
db := s.openDB(c)
// Start a query with stmt on db. This will prepare the stmt on the db.
err = db.Query(context.Background(), stmt).Run()
c.Assert(err, IsNil)
s.checkStmtInCache(c, db.cacheID, stmt.cacheID)
}()
s.triggerFinalizers()
s.checkStmtNotInCache(c, stmt.cacheID)
}
func (s *CacheSuite) TestPreparedStatementsInTX(c *C) {
db := s.openDB(c)
stmt, err := Prepare(`SELECT 'test'`)
c.Assert(err, IsNil)
// Start a new transaction.
tx, err := db.Begin(context.Background(), nil)
c.Assert(err, IsNil)
// A query executed on a transaction will reuse a prepared statement if it
// exists, but it will not create one if it does not. The query below should
// run directly on the DB, not use a prepared statement.
err = tx.Query(context.Background(), stmt).Run()
c.Assert(err, IsNil)
// Check no new statement has been added to the driver cache.
s.checkNumDBStmts(c, db.cacheID, 0)
s.checkQueriesRunOnDB(c, 1)
s.checkQueriesRunOnStmt(c, 0)
// Prepare the query on the database by running it.
err = db.Query(context.Background(), stmt).Run()
c.Assert(err, IsNil)
s.checkStmtInCache(c, db.cacheID, stmt.cacheID)
s.checkNumDBStmts(c, db.cacheID, 1)
s.checkQueriesRunOnDB(c, 1)
s.checkQueriesRunOnStmt(c, 1)
// Run the statement on the transaction. This should reuse the prepared
// statement.
err = tx.Query(context.Background(), stmt).Run()
c.Assert(err, IsNil)
// Check no new statement has been added to the driver cache.
s.checkQueriesRunOnDB(c, 1)
s.checkQueriesRunOnStmt(c, 2)
err = tx.Commit()
c.Assert(err, IsNil)
}
// TestLateQuery checks that a Query that outlives a Statement does not throw a
// statement is closed error.
func (s *CacheSuite) TestLateQuery(c *C) {
var q *Query
// Drop all the values except the query itself.
func() {
db := s.openDB(c)
selectStmt, err := Prepare(`SELECT 'hello'`)
c.Assert(err, IsNil)
q = db.Query(nil, selectStmt)
}()
s.triggerFinalizers()
// Assert that sql.Stmt was not closed early.
c.Assert(q.Run(), IsNil)
}
// TestLateQueryTX checks that a Query on a transaction that outlives a
// Statement does not throw a statement is closed error.
func (s *CacheSuite) TestLateQueryTX(c *C) {
var q *Query
// Drop all the values except the query itself.
func() {
db := s.openDB(c)
selectStmt, err := Prepare(`SELECT 'hello'`)
c.Assert(err, IsNil)
tx, err := db.Begin(nil, nil)
c.Assert(err, IsNil)
q = tx.Query(nil, selectStmt)
}()
s.triggerFinalizers()
// Assert that sql.Stmt was not closed early.
c.Assert(q.Run(), IsNil)
}
// TestQueryWithBulkAndSlice checks that a sqlair.Statements that generate
// different SQL strings when given different arguments work with the cache.
func (s *CacheSuite) TestQueryWithBulkAndSlice(c *C) {
db := s.openDB(c)
createStmt, err := Prepare(`
CREATE TABLE t (
col integer
);`)
c.Assert(err, IsNil)
err = db.Query(context.Background(), createStmt).Run()
createStmt = nil
c.Assert(err, IsNil)
type dbCol struct {
Col int `db:"col"`
}
insertStmt, err := Prepare(`INSERT INTO t (*) VALUES ($dbCol.*)`, dbCol{})
c.Assert(err, IsNil)
// Bulk insert some columns
insertCols := []dbCol{{Col: 1}, {Col: 2}}
err = db.Query(context.Background(), insertStmt, insertCols).Run()
c.Assert(err, IsNil)
// Bulk insert a different number of columns using the same statement.
insertCols = []dbCol{{Col: 3}, {Col: 4}, {Col: 5}}
err = db.Query(context.Background(), insertStmt, insertCols).Run()
c.Assert(err, IsNil)
type dbCols []int
selectStmt, err := Prepare(`SELECT col AS &dbCol.* FROM t WHERE col IN ($dbCols[:])`, dbCols{}, dbCol{})
c.Assert(err, IsNil)
cols := dbCols{1, 3, 5}
colsFromDB := []dbCol{}
err = db.Query(context.Background(), selectStmt, cols).GetAll(&colsFromDB)
c.Assert(err, IsNil)
c.Assert(colsFromDB, DeepEquals, []dbCol{{Col: 1}, {Col: 3}, {Col: 5}})
cols = dbCols{2, 4}
colsFromDB = []dbCol{}
err = db.Query(context.Background(), selectStmt, cols).GetAll(&colsFromDB)
c.Assert(err, IsNil)
c.Assert(colsFromDB, DeepEquals, []dbCol{{Col: 2}, {Col: 4}})
}
func (s *CacheSuite) openDB(c *C) *DB {
db, err := sql.Open("sqlite3_stmtChecked", "file:test.db?cache=shared&mode=memory&testName="+c.TestName())
c.Assert(err, IsNil)
return NewDB(db)
}
func (s *CacheSuite) triggerFinalizers() {
// Try to run finalizers by calling GC several times.
for i := 0; i <= 10; i++ {
runtime.GC()
time.Sleep(0)
}
}
func (s *CacheSuite) checkStmtInCache(c *C, dbID, stmtID uint64) {
stmtCache.mutex.RLock()
defer stmtCache.mutex.RUnlock()
_, ok := stmtCache.stmtDBCache[stmtID][dbID]
c.Check(ok, Equals, true)
_, ok = stmtCache.dbStmtCache[dbID][stmtID]
c.Check(ok, Equals, true)
}
func (s *CacheSuite) checkStmtNotInCache(c *C, stmtID uint64) {
stmtCache.mutex.RLock()
defer stmtCache.mutex.RUnlock()
dbc, ok := stmtCache.stmtDBCache[stmtID]
if ok {
c.Check(dbc, HasLen, 0)
}
for _, dbc := range stmtCache.dbStmtCache {
_, ok := dbc[stmtID]
c.Check(ok, Equals, false)
}
}
func (s *CacheSuite) checkDBNotInCache(c *C, dbID uint64) {
stmtCache.mutex.RLock()
defer stmtCache.mutex.RUnlock()
_, ok := stmtCache.dbStmtCache[dbID]
c.Check(ok, Equals, false)
for _, sc := range stmtCache.stmtDBCache {
_, ok := sc[dbID]
c.Check(ok, Equals, false)
}
}
func (s *CacheSuite) checkNumDBStmts(c *C, dbID uint64, n int) {
stmtCache.mutex.RLock()
defer stmtCache.mutex.RUnlock()
sc, ok := stmtCache.dbStmtCache[dbID]
c.Check(ok, Equals, true)
c.Check(sc, HasLen, n)
numDBStmts := 0
for _, dbc := range stmtCache.stmtDBCache {
if _, ok := dbc[dbID]; ok {
numDBStmts += 1
}
}
c.Check(numDBStmts, Equals, n)
}
func (s *CacheSuite) checkCacheEmpty(c *C) {
stmtCache.mutex.RLock()
defer stmtCache.mutex.RUnlock()
c.Check(stmtCache.stmtDBCache, HasLen, 0)
c.Check(stmtCache.dbStmtCache, HasLen, 0)
}
func (s *CacheSuite) checkDriverStmtsAllClosed(c *C) {
stmtRegistryMutex.RLock()
defer stmtRegistryMutex.RUnlock()
c.Check(len(openedStmts[c.TestName()]), Equals, len(closedStmts[c.TestName()]))
}
func (s *CacheSuite) checkDriverStmtsOpened(c *C, n int) {
stmtRegistryMutex.RLock()
defer stmtRegistryMutex.RUnlock()
c.Check(openedStmts[c.TestName()], HasLen, n)
}
func (s *CacheSuite) checkQueriesRunOnDB(c *C, n int) {
queriesRunMutex.RLock()
defer queriesRunMutex.RUnlock()
c.Check(dbQueriesRun[c.TestName()], Equals, n)
}
func (s *CacheSuite) checkQueriesRunOnStmt(c *C, n int) {
queriesRunMutex.RLock()
defer queriesRunMutex.RUnlock()
c.Check(stmtQueriesRun[c.TestName()], Equals, n)
}