-
-
Notifications
You must be signed in to change notification settings - Fork 50
/
pgxmock.go
591 lines (513 loc) · 17.8 KB
/
pgxmock.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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
/*
package pgxmock is a mock library implementing pgx connector. Which has one and only
purpose - to simulate pgx driver behavior in tests, without needing a real
database connection. It helps to maintain correct **TDD** workflow.
It does not require (almost) any modifications to your source code in order to test
and mock database operations. Supports concurrency and multiple database mocking.
The driver allows to mock any pgx driver method behavior.
*/
package pgxmock
import (
"context"
"errors"
"fmt"
"reflect"
pgx "github.com/jackc/pgx/v5"
pgconn "github.com/jackc/pgx/v5/pgconn"
pgxpool "github.com/jackc/pgx/v5/pgxpool"
)
// Expecter interface serves to create expectations
// for any kind of database action in order to mock
// and test real database behavior.
type Expecter interface {
// ExpectationsWereMet checks whether all queued expectations
// were met in order (unless MatchExpectationsInOrder set to false).
// If any of them was not met - an error is returned.
ExpectationsWereMet() error
// ExpectBatch expects pgx.Batch to be called. The *ExpectedBatch
// allows to mock database response
ExpectBatch() *ExpectedBatch
// ExpectClose queues an expectation for this database
// action to be triggered. The *ExpectedClose allows
// to mock database response
ExpectClose() *ExpectedClose
// ExpectPrepare expects Prepare() to be called with expectedSQL query.
ExpectPrepare(expectedStmtName, expectedSQL string) *ExpectedPrepare
// ExpectDeallocate expects Deallocate() to be called with expectedStmtName.
// The *ExpectedDeallocate allows to mock database response
ExpectDeallocate(expectedStmtName string) *ExpectedDeallocate
ExpectDeallocateAll() *ExpectedDeallocate
// ExpectQuery expects Query() or QueryRow() to be called with expectedSQL query.
// the *ExpectedQuery allows to mock database response.
ExpectQuery(expectedSQL string) *ExpectedQuery
// ExpectExec expects Exec() to be called with expectedSQL query.
// the *ExpectedExec allows to mock database response
ExpectExec(expectedSQL string) *ExpectedExec
// ExpectBegin expects pgx.Conn.Begin to be called.
// the *ExpectedBegin allows to mock database response
ExpectBegin() *ExpectedBegin
// ExpectBeginTx expects expects BeginTx() to be called with expectedSQL
// query. The *ExpectedBegin allows to mock database response.
ExpectBeginTx(txOptions pgx.TxOptions) *ExpectedBegin
// ExpectCommit expects pgx.Tx.Commit to be called.
// the *ExpectedCommit allows to mock database response
ExpectCommit() *ExpectedCommit
// ExpectReset expects pgxpool.Reset() to be called.
// The *ExpectedReset allows to mock database response
ExpectReset() *ExpectedReset
// ExpectRollback expects pgx.Tx.Rollback to be called.
// the *ExpectedRollback allows to mock database response
ExpectRollback() *ExpectedRollback
// ExpectPing expected Ping() to be called.
// The *ExpectedPing allows to mock database response
ExpectPing() *ExpectedPing
// ExpectCopyFrom expects pgx.CopyFrom to be called.
// The *ExpectCopyFrom allows to mock database response
ExpectCopyFrom(expectedTableName pgx.Identifier, expectedColumns []string) *ExpectedCopyFrom
// MatchExpectationsInOrder gives an option whether to match all
// expectations in the order they were set or not.
//
// By default it is set to - true. But if you use goroutines
// to parallelize your query executation, that option may
// be handy.
//
// This option may be turned on anytime during tests. As soon
// as it is switched to false, expectations will be matched
// in any order. Or otherwise if switched to true, any unmatched
// expectations will be expected in order
MatchExpectationsInOrder(bool)
// NewRows allows Rows to be created from a []string slice.
NewRows(columns []string) *Rows
// NewRowsWithColumnDefinition allows Rows to be created from a
// pgconn.FieldDescription slice with a definition of sql metadata
NewRowsWithColumnDefinition(columns ...pgconn.FieldDescription) *Rows
// New Column allows to create a Column
NewColumn(name string) *pgconn.FieldDescription
}
// PgxCommonIface represents common interface for all pgx connection interfaces:
// pgxpool.Pool, pgx.Conn and pgx.Tx
type PgxCommonIface interface {
Expecter
pgx.Tx
BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
Ping(context.Context) error
}
// PgxConnIface represents pgx.Conn specific interface
type PgxConnIface interface {
PgxCommonIface
Close(ctx context.Context) error
Deallocate(ctx context.Context, name string) error
DeallocateAll(ctx context.Context) error
Config() *pgx.ConnConfig
PgConn() *pgconn.PgConn
}
// PgxPoolIface represents pgxpool.Pool specific interface
type PgxPoolIface interface {
PgxCommonIface
Acquire(ctx context.Context) (*pgxpool.Conn, error)
AcquireAllIdle(ctx context.Context) []*pgxpool.Conn
AcquireFunc(ctx context.Context, f func(*pgxpool.Conn) error) error
AsConn() PgxConnIface
Close()
Stat() *pgxpool.Stat
Reset()
Config() *pgxpool.Config
}
type pgxmock struct {
ordered bool
queryMatcher QueryMatcher
expectations []expectation
}
func (c *pgxmock) AcquireAllIdle(_ context.Context) []*pgxpool.Conn {
return []*pgxpool.Conn{}
}
func (c *pgxmock) AcquireFunc(_ context.Context, _ func(*pgxpool.Conn) error) error {
return nil
}
// region Expectations
func (c *pgxmock) ExpectBatch() *ExpectedBatch {
e := &ExpectedBatch{mock: c}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectClose() *ExpectedClose {
e := &ExpectedClose{}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) MatchExpectationsInOrder(b bool) {
c.ordered = b
}
func (c *pgxmock) ExpectationsWereMet() error {
for _, e := range c.expectations {
e.Lock()
fulfilled := e.fulfilled() || !e.required()
e.Unlock()
if !fulfilled {
return fmt.Errorf("there is a remaining expectation which was not matched: %s", e)
}
// must check whether all expected queried rows are closed
if query, ok := e.(*ExpectedQuery); ok {
if query.rowsMustBeClosed && !query.rowsWereClosed {
return fmt.Errorf("expected query rows to be closed, but it was not: %s", query)
}
}
}
return nil
}
func (c *pgxmock) ExpectQuery(expectedSQL string) *ExpectedQuery {
e := &ExpectedQuery{}
e.expectSQL = expectedSQL
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectCommit() *ExpectedCommit {
e := &ExpectedCommit{}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectRollback() *ExpectedRollback {
e := &ExpectedRollback{}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectBegin() *ExpectedBegin {
e := &ExpectedBegin{}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectBeginTx(txOptions pgx.TxOptions) *ExpectedBegin {
e := &ExpectedBegin{opts: txOptions}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectExec(expectedSQL string) *ExpectedExec {
e := &ExpectedExec{}
e.expectSQL = expectedSQL
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectCopyFrom(expectedTableName pgx.Identifier, expectedColumns []string) *ExpectedCopyFrom {
e := &ExpectedCopyFrom{expectedTableName: expectedTableName, expectedColumns: expectedColumns}
c.expectations = append(c.expectations, e)
return e
}
// ExpectReset expects Reset to be called.
func (c *pgxmock) ExpectReset() *ExpectedReset {
e := &ExpectedReset{}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectPing() *ExpectedPing {
e := &ExpectedPing{}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectPrepare(expectedStmtName, expectedSQL string) *ExpectedPrepare {
e := &ExpectedPrepare{expectSQL: expectedSQL, expectStmtName: expectedStmtName}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectDeallocate(expectedStmtName string) *ExpectedDeallocate {
e := &ExpectedDeallocate{expectStmtName: expectedStmtName}
c.expectations = append(c.expectations, e)
return e
}
func (c *pgxmock) ExpectDeallocateAll() *ExpectedDeallocate {
e := &ExpectedDeallocate{expectAll: true}
c.expectations = append(c.expectations, e)
return e
}
//endregion Expectations
// NewRows allows Rows to be created from a
// atring slice or from the CSV string and
// to be used as sql driver.Rows.
func (c *pgxmock) NewRows(columns []string) *Rows {
r := NewRows(columns)
return r
}
// PgConn exposes the underlying low level postgres connection
// This is just here to support interfaces that use it. Here is just returns an empty PgConn
func (c *pgxmock) PgConn() *pgconn.PgConn {
p := pgconn.PgConn{}
return &p
}
// NewRowsWithColumnDefinition allows Rows to be created from a
// sql driver.Value slice with a definition of sql metadata
func (c *pgxmock) NewRowsWithColumnDefinition(columns ...pgconn.FieldDescription) *Rows {
r := NewRowsWithColumnDefinition(columns...)
return r
}
// NewColumn allows to create a Column that can be enhanced with metadata
// using OfType/Nullable/WithLength/WithPrecisionAndScale methods.
func (c *pgxmock) NewColumn(name string) *pgconn.FieldDescription {
return &pgconn.FieldDescription{Name: name}
}
// open a mock database driver connection
func (c *pgxmock) open(options []func(*pgxmock) error) error {
for _, option := range options {
err := option(c)
if err != nil {
return err
}
}
if c.queryMatcher == nil {
c.queryMatcher = QueryMatcherRegexp
}
return nil
}
// Close a mock database driver connection. It may or may not
// be called depending on the circumstances, but if it is called
// there must be an *ExpectedClose expectation satisfied.
func (c *pgxmock) Close(ctx context.Context) error {
ex, err := findExpectation[*ExpectedClose](c, "Close()")
if err != nil {
return err
}
return ex.waitForDelay(ctx)
}
func (c *pgxmock) Conn() *pgx.Conn {
panic("Conn() is not available in pgxmock")
}
func (c *pgxmock) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, _ pgx.CopyFromSource) (int64, error) {
ex, err := findExpectationFunc[*ExpectedCopyFrom](c, "BeginTx()", func(copyExp *ExpectedCopyFrom) error {
if !reflect.DeepEqual(copyExp.expectedTableName, tableName) {
return fmt.Errorf("CopyFrom: table name '%s' was not expected, expected table name is '%s'", tableName, copyExp.expectedTableName)
}
if !reflect.DeepEqual(copyExp.expectedColumns, columnNames) {
return fmt.Errorf("CopyFrom: column names '%v' were not expected, expected column names are '%v'", columnNames, copyExp.expectedColumns)
}
return nil
})
if err != nil {
return -1, err
}
return ex.rowsAffected, ex.waitForDelay(ctx)
}
func (c *pgxmock) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults {
ex, err := findExpectationFunc[*ExpectedBatch](c, "Batch()", func(batchExp *ExpectedBatch) error {
if len(batchExp.expectedQueries) != len(b.QueuedQueries) {
return fmt.Errorf("SendBatch: number of queries in batch '%d' was not expected, expected number of queries is '%d'",
len(b.QueuedQueries), len(batchExp.expectedQueries))
}
if !c.ordered { // postpone the check of every query until/if it is called
return nil
}
for i, query := range b.QueuedQueries {
if err := c.queryMatcher.Match(batchExp.expectedQueries[i].expectSQL, query.SQL); err != nil {
return err
}
if rewrittenSQL, err := batchExp.expectedQueries[i].argsMatches(query.SQL, query.Arguments); err != nil {
return err
} else if rewrittenSQL != "" && batchExp.expectedQueries[i].expectRewrittenSQL != "" {
if err := c.queryMatcher.Match(batchExp.expectedQueries[i].expectRewrittenSQL, rewrittenSQL); err != nil {
return err
}
}
}
return nil
})
br := &batchResults{mock: c, batch: b, expectedBatch: ex, err: err}
if err != nil {
return br
}
br.err = ex.waitForDelay(ctx)
return br
}
func (c *pgxmock) LargeObjects() pgx.LargeObjects {
return pgx.LargeObjects{}
}
func (c *pgxmock) Begin(ctx context.Context) (pgx.Tx, error) {
return c.BeginTx(ctx, pgx.TxOptions{})
}
func (c *pgxmock) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error) {
ex, err := findExpectationFunc[*ExpectedBegin](c, "BeginTx()", func(beginExp *ExpectedBegin) error {
if beginExp.opts != txOptions {
return fmt.Errorf("BeginTx: call with transaction options '%v' was not expected: %s", txOptions, beginExp)
}
return nil
})
if err != nil {
return nil, err
}
if err = ex.waitForDelay(ctx); err != nil {
return nil, err
}
return c, nil
}
func (c *pgxmock) Prepare(ctx context.Context, name, query string) (*pgconn.StatementDescription, error) {
ex, err := findExpectationFunc[*ExpectedPrepare](c, "Prepare()", func(prepareExp *ExpectedPrepare) error {
if err := c.queryMatcher.Match(prepareExp.expectSQL, query); err != nil {
return err
}
if prepareExp.expectStmtName != name {
return fmt.Errorf("Prepare: prepared statement name '%s' was not expected, expected name is '%s'", name, prepareExp.expectStmtName)
}
return nil
})
if err != nil {
return nil, err
}
if err = ex.waitForDelay(ctx); err != nil {
return nil, err
}
return &pgconn.StatementDescription{Name: name, SQL: query}, nil
}
func (c *pgxmock) Deallocate(ctx context.Context, name string) error {
ex, err := findExpectationFunc[*ExpectedDeallocate](c, "Deallocate()", func(deallocateExp *ExpectedDeallocate) error {
if deallocateExp.expectAll {
return fmt.Errorf("Deallocate: all prepared statements were expected to be deallocated, instead only '%s' specified", name)
}
if deallocateExp.expectStmtName != name {
return fmt.Errorf("Deallocate: prepared statement name '%s' was not expected, expected name is '%s'", name, deallocateExp.expectStmtName)
}
return nil
})
if err != nil {
return err
}
return ex.waitForDelay(ctx)
}
func (c *pgxmock) DeallocateAll(ctx context.Context) error {
ex, err := findExpectationFunc[*ExpectedDeallocate](c, "DeallocateAll()", func(deallocateExp *ExpectedDeallocate) error {
if !deallocateExp.expectAll {
return fmt.Errorf("Deallocate: deallocate all prepared statements was not expected, expected name is '%s'", deallocateExp.expectStmtName)
}
return nil
})
if err != nil {
return err
}
return ex.waitForDelay(ctx)
}
func (c *pgxmock) Commit(ctx context.Context) error {
ex, err := findExpectation[*ExpectedCommit](c, "Commit()")
if err != nil {
return err
}
return ex.waitForDelay(ctx)
}
func (c *pgxmock) Rollback(ctx context.Context) error {
ex, err := findExpectation[*ExpectedRollback](c, "Rollback()")
if err != nil {
return err
}
return ex.waitForDelay(ctx)
}
// Implement the "QueryerContext" interface
func (c *pgxmock) Query(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error) {
ex, err := findExpectationFunc[*ExpectedQuery](c, "Query()", func(queryExp *ExpectedQuery) error {
if err := c.queryMatcher.Match(queryExp.expectSQL, sql); err != nil {
return err
}
if rewrittenSQL, err := queryExp.argsMatches(sql, args); err != nil {
return err
} else if rewrittenSQL != "" && queryExp.expectRewrittenSQL != "" {
if err := c.queryMatcher.Match(queryExp.expectRewrittenSQL, rewrittenSQL); err != nil {
return err
}
}
if queryExp.err == nil && queryExp.rows == nil {
return fmt.Errorf("Query must return a result rows or raise an error: %v", queryExp)
}
return nil
})
if err != nil {
return nil, err
}
return ex.rows, ex.waitForDelay(ctx)
}
type errRow struct {
err error
}
func (er errRow) Scan(...interface{}) error {
return er.err
}
func (c *pgxmock) QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row {
rows, err := c.Query(ctx, sql, args...)
if err != nil {
return errRow{err: err}
}
return (*connRow)(rows.(*rowSets))
}
func (c *pgxmock) Exec(ctx context.Context, query string, args ...interface{}) (pgconn.CommandTag, error) {
ex, err := findExpectationFunc[*ExpectedExec](c, "Exec()", func(execExp *ExpectedExec) error {
if err := c.queryMatcher.Match(execExp.expectSQL, query); err != nil {
return err
}
if rewrittenSQL, err := execExp.argsMatches(query, args); err != nil {
return err
} else if rewrittenSQL != "" && execExp.expectRewrittenSQL != "" {
if err := c.queryMatcher.Match(execExp.expectRewrittenSQL, rewrittenSQL); err != nil {
return err
}
}
if execExp.result.String() == "" && execExp.err == nil {
return fmt.Errorf("Exec must return a result or raise an error: %s", execExp)
}
return nil
})
if err != nil {
return pgconn.NewCommandTag(""), err
}
return ex.result, ex.waitForDelay(ctx)
}
func (c *pgxmock) Ping(ctx context.Context) (err error) {
ex, err := findExpectation[*ExpectedPing](c, "Ping()")
if err != nil {
return err
}
return ex.waitForDelay(ctx)
}
func (c *pgxmock) Reset() {
if ex, err := findExpectation[*ExpectedReset](c, "Reset()"); err == nil {
_ = ex.waitForDelay(context.Background())
}
}
type expectationType[t any] interface {
*t
expectation
}
func findExpectationFunc[ET expectationType[t], t any](c *pgxmock, method string, cmp func(ET) error) (ET, error) {
var expected ET
var fulfilled int
var ok bool
var err error
for _, next := range c.expectations {
next.Lock()
if next.fulfilled() {
next.Unlock()
fulfilled++
continue
}
if expected, ok = next.(ET); ok {
if err = cmp(expected); err == nil {
break
}
}
expected = nil
next.Unlock()
if c.ordered {
if !next.required() {
continue
}
if err != nil {
return nil, err
}
return nil, fmt.Errorf("call to method %s, was not expected, next expectation is: %s", method, next)
}
}
if expected == nil {
msg := fmt.Sprintf("call to method %s was not expected", method)
if fulfilled == len(c.expectations) {
msg = "all expectations were already fulfilled, " + msg
}
return nil, errors.New(msg)
}
defer expected.Unlock()
expected.fulfill()
return expected, nil
}
func findExpectation[ET expectationType[t], t any](c *pgxmock, method string) (ET, error) {
return findExpectationFunc[ET, t](c, method, func(_ ET) error { return nil })
}