pgxpoolmock

package module
v5.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2024 License: MIT Imports: 10 Imported by: 0

README

Mock implementation for pgx/v5/pgxpool.Pool

Forked from driftprogramming/pgxpoolmock and updated for pgx/v5

This repo implements a mock for pgx/v5/pgxpool.Pool in https://github.com/jackc/pgx, allowing you to test your data access code locally without actually hitting a real database.

We strongly recommend you use pgxpool.Pool rather than pgx.Conn directly.

See https://github.com/jackc/pgx/tree/master/pgxpool for more details.

Installation

You can add the library via go get.

go get -u github.com/omnipeak/pgxpoolmock/v5
Usage

Basic usage with go's built-in testing.T is as follows:

package pgxpoolmock_test

import (
  "testing"

  "github.com/golang/mock/gomock"
  "github.com/jackc/pgx/v5/pgconn"
  "github.com/stretchr/testify/assert"

  "github.com/omnipeak/pgxpoolmock/v5"
  "github.com/omnipeak/pgxpoolmock/v5/testdata"
)


func TestInsertOrder(t *testing.T) {
  ctrl := gomock.NewController(t)
  defer ctrl.Finish()

  mockPool := pgxpoolmock.NewMockPgxPool(ctrl)
  commandTag := pgconn.NewCommandTag("INSERT 0 1")
  mockPool.EXPECT().Exec(gomock.Any(), "insert into order (id, price) values ($1, $2)", 1, 2.3).Return(commandTag, nil)
  orderDao := testdata.OrderDAO{
    Pool: mockPool,
  }

  order := &testdata.Order{
    ID:    1,
    Price: 2.3,
  }
  err := orderDao.InsertOrder(order)
  if err != nil {
    t.Fatalf("%v", err)
  }
}

func TestGetOneOrderByID(t *testing.T) {
  ctrl := gomock.NewController(t)
  defer ctrl.Finish()
  mockPool := pgxpoolmock.NewMockPgxPool(ctrl)
  columns := []string{"id", "price"}
  pgxRow := pgxpoolmock.NewRow(columns, 1, 2.3)
  mockPool.EXPECT().QueryRow(gomock.Any(), "select id, price from order where id = $1", 1).Return(pgxRow)
  orderDao := testdata.OrderDAO{
    Pool: mockPool,
  }
  actualOrder, err := orderDao.GetOneOrderByID(1)
  if err != nil {
    t.Fatalf("%v", err)
  }
  assert.NotNil(t, actualOrder)
  assert.Equal(t, 1, actualOrder.ID)
  assert.Equal(t, 2.3, actualOrder.Price)
}

func TestName(t *testing.T) {
  t.Parallel()
  ctrl := gomock.NewController(t)
  defer ctrl.Finish()

  // given
  mockPool := pgxpoolmock.NewMockPgxPool(ctrl)
  columns := []string{"id", "price"}
  pgxRows := pgxpoolmock.NewRows(columns).AddRow(100, 100000.9).ToPgxRows()
  mockPool.EXPECT().Query(gomock.Any(), gomock.Any(), gomock.Any()).Return(pgxRows, nil)
  orderDao := testdata.OrderDAO{
    Pool: mockPool,
  }

  // when
  actualOrder := orderDao.GetOrderByID(1)

  // then
  assert.NotNil(t, actualOrder)
  assert.Equal(t, 100, actualOrder.ID)
  assert.Equal(t, 100000.9, actualOrder.Price)
}

You can find a more complete example in order_dao_example_test.go.

Documentation

Overview

Package pgxpoolmock is a generated GoMock package.

Index

Constants

This section is empty.

Variables

View Source 
var CSVColumnParser = func(s string) interface{} {
	switch {
	case strings.ToLower(s) == "null":
		return nil
	}
	return s
}

CSVColumnParser is a function which converts trimmed csv column string to a []byte representation. Currently transforms NULL to nil

Functions

This section is empty.

Types

type MockPgxPool 

type MockPgxPool struct {
	// contains filtered or unexported fields
}

MockPgxPool is a mock of PgxPool interface.

func NewMockPgxPool 

func NewMockPgxPool(ctrl *gomock.Controller) *MockPgxPool

NewMockPgxPool creates a new mock instance.

func (*MockPgxPool) Acquire 

func (m *MockPgxPool) Acquire(arg0 context.Context) (*pgxpool.Conn, error)

Acquire mocks base method.

func (*MockPgxPool) AcquireAllIdle 

func (m *MockPgxPool) AcquireAllIdle(arg0 context.Context) []*pgxpool.Conn

AcquireAllIdle mocks base method.

func (*MockPgxPool) AcquireFunc 

func (m *MockPgxPool) AcquireFunc(arg0 context.Context, arg1 func(*pgxpool.Conn) error) error

AcquireFunc mocks base method.

func (*MockPgxPool) Begin 

func (m *MockPgxPool) Begin(arg0 context.Context) (pgx.Tx, error)

Begin mocks base method.

func (*MockPgxPool) BeginFunc 

func (m *MockPgxPool) BeginFunc(arg0 context.Context, arg1 func(pgx.Tx) error) error

BeginFunc mocks base method.

func (*MockPgxPool) BeginTx 

func (m *MockPgxPool) BeginTx(arg0 context.Context, arg1 pgx.TxOptions) (pgx.Tx, error)

BeginTx mocks base method.

func (*MockPgxPool) BeginTxFunc 

func (m *MockPgxPool) BeginTxFunc(arg0 context.Context, arg1 pgx.TxOptions, arg2 func(pgx.Tx) error) error

BeginTxFunc mocks base method.

func (*MockPgxPool) Close 

func (m *MockPgxPool) Close()

Close mocks base method.

func (*MockPgxPool) Config 

func (m *MockPgxPool) Config() *pgxpool.Config

Config mocks base method.

func (*MockPgxPool) CopyFrom 

func (m *MockPgxPool) CopyFrom(arg0 context.Context, arg1 pgx.Identifier, arg2 []string, arg3 pgx.CopyFromSource) (int64, error)

CopyFrom mocks base method.

func (*MockPgxPool) EXPECT 

func (m *MockPgxPool) EXPECT() *MockPgxPoolMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockPgxPool) Exec 

func (m *MockPgxPool) Exec(arg0 context.Context, arg1 string, arg2 ...interface{}) (pgconn.CommandTag, error)

Exec mocks base method.

func (*MockPgxPool) Ping 

func (m *MockPgxPool) Ping(arg0 context.Context) error

Ping mocks base method.

func (*MockPgxPool) Query 

func (m *MockPgxPool) Query(arg0 context.Context, arg1 string, arg2 ...interface{}) (pgx.Rows, error)

Query mocks base method.

func (*MockPgxPool) QueryRow 

func (m *MockPgxPool) QueryRow(arg0 context.Context, arg1 string, arg2 ...interface{}) pgx.Row

QueryRow mocks base method.

func (*MockPgxPool) Reset 

func (m *MockPgxPool) Reset()

Reset mocks base method.

func (*MockPgxPool) SendBatch 

func (m *MockPgxPool) SendBatch(arg0 context.Context, arg1 *pgx.Batch) pgx.BatchResults

SendBatch mocks base method.

func (*MockPgxPool) Stat 

func (m *MockPgxPool) Stat() *pgxpool.Stat

Stat mocks base method.

type MockPgxPoolMockRecorder 

type MockPgxPoolMockRecorder struct {
	// contains filtered or unexported fields
}

MockPgxPoolMockRecorder is the mock recorder for MockPgxPool.

func (*MockPgxPoolMockRecorder) Acquire 

func (mr *MockPgxPoolMockRecorder) Acquire(arg0 interface{}) *gomock.Call

Acquire indicates an expected call of Acquire.

func (*MockPgxPoolMockRecorder) AcquireAllIdle 

func (mr *MockPgxPoolMockRecorder) AcquireAllIdle(arg0 interface{}) *gomock.Call

AcquireAllIdle indicates an expected call of AcquireAllIdle.

func (*MockPgxPoolMockRecorder) AcquireFunc 

func (mr *MockPgxPoolMockRecorder) AcquireFunc(arg0, arg1 interface{}) *gomock.Call

AcquireFunc indicates an expected call of AcquireFunc.

func (*MockPgxPoolMockRecorder) Begin 

func (mr *MockPgxPoolMockRecorder) Begin(arg0 interface{}) *gomock.Call

Begin indicates an expected call of Begin.

func (*MockPgxPoolMockRecorder) BeginFunc 

func (mr *MockPgxPoolMockRecorder) BeginFunc(arg0, arg1 interface{}) *gomock.Call

BeginFunc indicates an expected call of BeginFunc.

func (*MockPgxPoolMockRecorder) BeginTx 

func (mr *MockPgxPoolMockRecorder) BeginTx(arg0, arg1 interface{}) *gomock.Call

BeginTx indicates an expected call of BeginTx.

func (*MockPgxPoolMockRecorder) BeginTxFunc 

func (mr *MockPgxPoolMockRecorder) BeginTxFunc(arg0, arg1, arg2 interface{}) *gomock.Call

BeginTxFunc indicates an expected call of BeginTxFunc.

func (*MockPgxPoolMockRecorder) Close 

func (mr *MockPgxPoolMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close.

func (*MockPgxPoolMockRecorder) Config 

func (mr *MockPgxPoolMockRecorder) Config() *gomock.Call

Config indicates an expected call of Config.

func (*MockPgxPoolMockRecorder) CopyFrom 

func (mr *MockPgxPoolMockRecorder) CopyFrom(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

CopyFrom indicates an expected call of CopyFrom.

func (*MockPgxPoolMockRecorder) Exec 

func (mr *MockPgxPoolMockRecorder) Exec(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call

Exec indicates an expected call of Exec.

func (*MockPgxPoolMockRecorder) Ping 

func (mr *MockPgxPoolMockRecorder) Ping(arg0 interface{}) *gomock.Call

Ping indicates an expected call of Ping.

func (*MockPgxPoolMockRecorder) Query 

func (mr *MockPgxPoolMockRecorder) Query(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call

Query indicates an expected call of Query.

func (*MockPgxPoolMockRecorder) QueryRow 

func (mr *MockPgxPoolMockRecorder) QueryRow(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call

QueryRow indicates an expected call of QueryRow.

func (*MockPgxPoolMockRecorder) Reset 

func (mr *MockPgxPoolMockRecorder) Reset() *gomock.Call

Reset indicates an expected call of Reset.

func (*MockPgxPoolMockRecorder) SendBatch 

func (mr *MockPgxPoolMockRecorder) SendBatch(arg0, arg1 interface{}) *gomock.Call

SendBatch indicates an expected call of SendBatch.

func (*MockPgxPoolMockRecorder) Stat 

func (mr *MockPgxPoolMockRecorder) Stat() *gomock.Call

Stat indicates an expected call of Stat.

type MockPgxTx added in v5.0.1 

type MockPgxTx struct {
	// contains filtered or unexported fields
}

MockPgxTx is a mock of pgx.Tx interface.

func NewMockPgxTx added in v5.0.1 

func NewMockPgxTx(ctrl *gomock.Controller) *MockPgxTx

NewMockPgxTx creates a new mock instance.

func (*MockPgxTx) Begin added in v5.0.1 

func (m *MockPgxTx) Begin(arg0 context.Context) (pgx.Tx, error)

Begin mocks base method.

func (*MockPgxTx) Commit added in v5.0.1 

func (m *MockPgxTx) Commit(arg0 context.Context) error

Commit mocks base method.

func (*MockPgxTx) Conn added in v5.0.1 

func (m *MockPgxTx) Conn() *pgx.Conn

Conn mocks base method.

func (*MockPgxTx) CopyFrom added in v5.0.1 

func (m *MockPgxTx) CopyFrom(arg0 context.Context, arg1 pgx.Identifier, arg2 []string, arg3 pgx.CopyFromSource) (int64, error)

CopyFrom mocks base method.

func (*MockPgxTx) EXPECT added in v5.0.1 

func (m *MockPgxTx) EXPECT() *MockPgxTxMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockPgxTx) Exec added in v5.0.1 

func (m *MockPgxTx) Exec(arg0 context.Context, arg1 string, arg2 ...interface{}) (pgconn.CommandTag, error)

Exec mocks base method.

func (*MockPgxTx) LargeObjects added in v5.0.1 

func (m *MockPgxTx) LargeObjects() pgx.LargeObjects

LargeObjects mocks base method.

func (*MockPgxTx) Prepare added in v5.0.1 

func (m *MockPgxTx) Prepare(arg0 context.Context, arg1 string, arg2 string) (*pgconn.StatementDescription, error)

Prepare mocks base method.

func (*MockPgxTx) Query added in v5.0.1 

func (m *MockPgxTx) Query(arg0 context.Context, arg1 string, arg2 ...interface{}) (pgx.Rows, error)

Query mocks base method.

func (*MockPgxTx) QueryRow added in v5.0.1 

func (m *MockPgxTx) QueryRow(arg0 context.Context, arg1 string, arg2 ...interface{}) pgx.Row

QueryRow mocks base method.

func (*MockPgxTx) Rollback added in v5.0.1 

func (m *MockPgxTx) Rollback(arg0 context.Context) error

Rollback mocks base method.

func (*MockPgxTx) SendBatch added in v5.0.1 

func (m *MockPgxTx) SendBatch(arg0 context.Context, arg1 *pgx.Batch) pgx.BatchResults

SendBatch mocks base method.

type MockPgxTxMockRecorder added in v5.0.1 

type MockPgxTxMockRecorder struct {
	// contains filtered or unexported fields
}

MockPgxTxMockRecorder is the mock recorder for MockPgxTx.

func (*MockPgxTxMockRecorder) Begin added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Begin(ctx interface{}) *gomock.Call

Begin indicates an expected call of Begin.

func (*MockPgxTxMockRecorder) Commit added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Commit(ctx interface{}) *gomock.Call

Commit indicates an expected call of Commit.

func (*MockPgxTxMockRecorder) Conn added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Conn() *gomock.Call

Conn indicates an expected call of Conn.

func (*MockPgxTxMockRecorder) CopyFrom added in v5.0.1 

func (mr *MockPgxTxMockRecorder) CopyFrom(ctx, tableName, columnNames, rowSrc interface{}) *gomock.Call

CopyFrom indicates an expected call of CopyFrom.

func (*MockPgxTxMockRecorder) Exec added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Exec(ctx, sql, arguments interface{}) *gomock.Call

Exec indicates an expected call of Exec.

func (*MockPgxTxMockRecorder) LargeObjects added in v5.0.1 

func (mr *MockPgxTxMockRecorder) LargeObjects() *gomock.Call

LargeObjects indicates an expected call of LargeObjects.

func (*MockPgxTxMockRecorder) Prepare added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Prepare(ctx, name, sql interface{}) *gomock.Call

Prepare indicates an expected call of Prepare.

func (*MockPgxTxMockRecorder) Query added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Query(ctx, sql, args interface{}) *gomock.Call

Query indicates an expected call of Query.

func (*MockPgxTxMockRecorder) QueryRow added in v5.0.1 

func (mr *MockPgxTxMockRecorder) QueryRow(ctx, sql, args interface{}) *gomock.Call

QueryRow indicates an expected call of QueryRow.

func (*MockPgxTxMockRecorder) Rollback added in v5.0.1 

func (mr *MockPgxTxMockRecorder) Rollback(ctx interface{}) *gomock.Call

Rollback indicates an expected call of Rollback.

func (*MockPgxTxMockRecorder) SendBatch added in v5.0.1 

func (mr *MockPgxTxMockRecorder) SendBatch(ctx, b interface{}) *gomock.Call

SendBatch indicates an expected call of SendBatch.

type PgxPool 

type PgxPool interface {
	Acquire(ctx context.Context) (*pgxpool.Conn, error)
	AcquireAllIdle(ctx context.Context) []*pgxpool.Conn
	AcquireFunc(ctx context.Context, f func(*pgxpool.Conn) error) error
	Begin(ctx context.Context) (pgx.Tx, error)
	BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
	Close()
	Config() *pgxpool.Config
	CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)
	Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error)
	Ping(ctx context.Context) error
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
	QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
	Reset()
	SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
	Stat() *pgxpool.Stat
}

type Row 

type Row struct {
	// contains filtered or unexported fields
}

Row is a mocked row that can be returned from QueryRow

func NewRow 

func NewRow(columns []string, values ...interface{}) *Row

func (*Row) RowError 

func (r *Row) RowError(row int, err error) *Row

RowError allows to set an error which will be returned when the row is read

func (*Row) Scan 

func (r *Row) Scan(dest ...interface{}) error

type Rows 

type Rows struct {
	// contains filtered or unexported fields
}

Rows is a mocked collection of rows to return for Query result

func NewRows 

func NewRows(columns []string) *Rows

NewMockRows allows Rows to be created from a sql interface{} slice or from the CSV string and to be used as sql driver.Rows. Use Sqlmock.NewRows instead if using a custom converter

func NewRowsWithColumnDefinition 

func NewRowsWithColumnDefinition(columns ...pgconn.FieldDescription) *Rows

NewRowsWithColumnDefinition return rows with columns metadata

func (*Rows) AddRow 

func (r *Rows) AddRow(values ...interface{}) *Rows

AddRow composed from database interface{} slice return the same instance to perform subsequent actions. Note that the number of values must match the number of columns

func (*Rows) CloseError 

func (r *Rows) CloseError(err error) *Rows

CloseError allows to set an error which will be returned by rows.Close function.

The close error will be triggered only in cases when rows.Next() EOF was not yet reached, that is a default sql library behavior

func (*Rows) FromCSVString 

func (r *Rows) FromCSVString(s string) *Rows

FromCSVString build rows from csv string. return the same instance to perform subsequent actions. Note that the number of values must match the number of columns

func (*Rows) RowError 

func (r *Rows) RowError(row int, err error) *Rows

RowError allows to set an error which will be returned when a given row number is read

func (*Rows) ToPgxRows 

func (r *Rows) ToPgxRows() pgx.Rows

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.