Package sqlmock

// Open new mock database
db, mock, err := New()
if err != nil {
    fmt.Println("error creating mock database")
    return
}
// columns to be used for result
columns := []string{"id", "status"}
// expect transaction begin
mock.ExpectBegin()
// expect query to fetch order, match it with regexp
mock.ExpectQuery("SELECT (.+) FROM orders (.+) FOR UPDATE").
    WithArgs(1).
    WillReturnRows(NewRows(columns).AddRow(1, 1))
// expect transaction rollback, since order status is "cancelled"
mock.ExpectRollback()

// run the cancel order function
someOrderID := 1
// call a function which executes expected database operations
err = cancelOrder(db, someOrderID)
if err != nil {
    fmt.Printf("unexpected error: %s", err)
    return
}

// ensure all expectations have been met
if err = mock.ExpectationsWereMet(); err != nil {
    fmt.Printf("unmet expectation error: %s", err)
}

Variables

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

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

ErrCancelled defines an error value, which can be expected in case of such cancellation error.

var ErrCancelled = errors.New("canceling query due to user request")

func MonitorPingsOption ¶

func MonitorPingsOption(monitorPings bool) func(*sqlmock) error

MonitorPingsOption determines whether calls to Ping on the driver should be observed and mocked.

If true is passed, we will check these calls were expected. Expectations can be registered using the ExpectPing() method on the mock.

If false is passed or this option is omitted, calls to Ping will not be considered when determining expectations and calls to ExpectPing will have no effect.

func NewErrorResult ¶

func NewErrorResult(err error) driver.Result

NewErrorResult creates a new sql driver Result which returns an error given for both interface methods

db, mock, _ := New()
result := NewErrorResult(fmt.Errorf("some error"))
mock.ExpectExec("^INSERT (.+)").WillReturnResult(result)
res, _ := db.Exec("INSERT something")
_, err := res.LastInsertId()
fmt.Println(err)

some error

func NewResult ¶

func NewResult(lastInsertID int64, rowsAffected int64) driver.Result

NewResult creates a new sql driver Result for Exec based query mocks.

var lastInsertID, affected int64
result := NewResult(lastInsertID, affected)
mock.ExpectExec("^INSERT (.+)").WillReturnResult(result)
fmt.Println(mock.ExpectationsWereMet())

there is a remaining expectation which was not matched: ExpectedExec => expecting Exec or ExecContext which:
  - matches sql: '^INSERT (.+)'
  - is without arguments
  - should return Result having:
      LastInsertId: 0
      RowsAffected: 0

func QueryMatcherOption ¶

func QueryMatcherOption(queryMatcher QueryMatcher) func(*sqlmock) error

QueryMatcherOption allows to customize SQL query matcher and match SQL query strings in more sophisticated ways. The default QueryMatcher is QueryMatcherRegexp.

func ValueConverterOption ¶

func ValueConverterOption(converter driver.ValueConverter) func(*sqlmock) error

ValueConverterOption allows to create a sqlmock connection with a custom ValueConverter to support drivers with special data types.

type Argument ¶

Argument interface allows to match any argument in specific way when used with ExpectedQuery and ExpectedExec expectations.

type Argument interface {
    Match(driver.Value) bool
}

func AnyArg ¶

func AnyArg() Argument

AnyArg will return an Argument which can match any kind of arguments.

Useful for time.Time or similar kinds of arguments.

type Column ¶

Column is a mocked column Metadata for rows.ColumnTypes()

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

func NewColumn ¶

func NewColumn(name string) *Column

NewColumn returns a Column with specified name

func (*Column) DbType ¶

func (c *Column) DbType() string

func (*Column) IsNullable ¶

func (c *Column) IsNullable() (bool, bool)

func (*Column) Length ¶

func (c *Column) Length() (int64, bool)

func (*Column) Name ¶

func (c *Column) Name() string

func (*Column) Nullable ¶

func (c *Column) Nullable(nullable bool) *Column

Nullable returns the column with nullable metadata set

func (*Column) OfType ¶

func (c *Column) OfType(dbType string, sampleValue interface{}) *Column

OfType returns the column with type metadata set

func (*Column) PrecisionScale ¶

func (c *Column) PrecisionScale() (int64, int64, bool)

func (*Column) ScanType ¶

func (c *Column) ScanType() reflect.Type

func (*Column) WithLength ¶

func (c *Column) WithLength(length int64) *Column

WithLength returns the column with length metadata set.

func (*Column) WithPrecisionAndScale ¶

func (c *Column) WithPrecisionAndScale(precision, scale int64) *Column

WithPrecisionAndScale returns the column with precision and scale metadata set.

type ExpectedBegin ¶

ExpectedBegin is used to manage *sql.DB.Begin expectation returned by *Sqlmock.ExpectBegin.

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

func (*ExpectedBegin) String ¶

func (e *ExpectedBegin) String() string

String returns string representation

func (*ExpectedBegin) WillDelayFor ¶

func (e *ExpectedBegin) WillDelayFor(duration time.Duration) *ExpectedBegin

WillDelayFor allows to specify duration for which it will delay result. May be used together with Context

func (*ExpectedBegin) WillReturnError ¶

func (e *ExpectedBegin) WillReturnError(err error) *ExpectedBegin

WillReturnError allows to set an error for *sql.DB.Begin action

type ExpectedClose ¶

ExpectedClose is used to manage *sql.DB.Close expectation returned by *Sqlmock.ExpectClose.

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

func (*ExpectedClose) String ¶

func (e *ExpectedClose) String() string

String returns string representation

func (*ExpectedClose) WillReturnError ¶

func (e *ExpectedClose) WillReturnError(err error) *ExpectedClose

WillReturnError allows to set an error for *sql.DB.Close action

type ExpectedCommit ¶

ExpectedCommit is used to manage *sql.Tx.Commit expectation returned by *Sqlmock.ExpectCommit.

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

func (*ExpectedCommit) String ¶

func (e *ExpectedCommit) String() string

String returns string representation

func (*ExpectedCommit) WillReturnError ¶

func (e *ExpectedCommit) WillReturnError(err error) *ExpectedCommit

WillReturnError allows to set an error for *sql.Tx.Close action

type ExpectedExec ¶

ExpectedExec is used to manage *sql.DB.Exec, *sql.Tx.Exec or *sql.Stmt.Exec expectations. Returned by *Sqlmock.ExpectExec.

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

db, mock, _ := New()
result := NewErrorResult(fmt.Errorf("some error"))
mock.ExpectExec("^INSERT (.+)").WillReturnResult(result)
res, _ := db.Exec("INSERT something")
_, err := res.LastInsertId()
fmt.Println(err)

some error

func (*ExpectedExec) String ¶

func (e *ExpectedExec) String() string

String returns string representation

func (*ExpectedExec) WillDelayFor ¶

func (e *ExpectedExec) WillDelayFor(duration time.Duration) *ExpectedExec

WillDelayFor allows to specify duration for which it will delay result. May be used together with Context

func (*ExpectedExec) WillReturnError ¶

func (e *ExpectedExec) WillReturnError(err error) *ExpectedExec

WillReturnError allows to set an error for expected database exec action

func (*ExpectedExec) WillReturnResult ¶

func (e *ExpectedExec) WillReturnResult(result driver.Result) *ExpectedExec

WillReturnResult arranges for an expected Exec() to return a particular result, there is sqlmock.NewResult(lastInsertID int64, affectedRows int64) method to build a corresponding result. Or if actions needs to be tested against errors sqlmock.NewErrorResult(err error) to return a given error.

func (*ExpectedExec) WithArgs ¶

func (e *ExpectedExec) WithArgs(args ...driver.Value) *ExpectedExec

WithArgs will match given expected args to actual database exec operation arguments. if at least one argument does not match, it will return an error. For specific arguments an sqlmock.Argument interface can be used to match an argument. Must not be used together with WithoutArgs()

func (*ExpectedExec) WithoutArgs ¶

func (e *ExpectedExec) WithoutArgs() *ExpectedExec

WithoutArgs will ensure that no args are passed for this expected database exec action. if at least one argument is passed, it will return an error. This allows for stricter validation of the query arguments. Must not be used together with WithArgs()

type ExpectedPing ¶

ExpectedPing is used to manage *sql.DB.Ping expectations. Returned by *Sqlmock.ExpectPing.

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

func (*ExpectedPing) String ¶

func (e *ExpectedPing) String() string

String returns string representation

func (*ExpectedPing) WillDelayFor ¶

func (e *ExpectedPing) WillDelayFor(duration time.Duration) *ExpectedPing

WillDelayFor allows to specify duration for which it will delay result. May be used together with Context.

func (*ExpectedPing) WillReturnError ¶

func (e *ExpectedPing) WillReturnError(err error) *ExpectedPing

WillReturnError allows to set an error for expected database ping

type ExpectedPrepare ¶

ExpectedPrepare is used to manage *sql.DB.Prepare or *sql.Tx.Prepare expectations. Returned by *Sqlmock.ExpectPrepare.

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

func (*ExpectedPrepare) ExpectExec ¶

func (e *ExpectedPrepare) ExpectExec() *ExpectedExec

ExpectExec allows to expect Exec() on this prepared statement. This method is convenient in order to prevent duplicating sql query string matching.

func (*ExpectedPrepare) ExpectQuery ¶

func (e *ExpectedPrepare) ExpectQuery() *ExpectedQuery

ExpectQuery allows to expect Query() or QueryRow() on this prepared statement. This method is convenient in order to prevent duplicating sql query string matching.

func (*ExpectedPrepare) String ¶

func (e *ExpectedPrepare) String() string

String returns string representation

func (*ExpectedPrepare) WillBeClosed ¶

func (e *ExpectedPrepare) WillBeClosed() *ExpectedPrepare

WillBeClosed expects this prepared statement to be closed.

func (*ExpectedPrepare) WillDelayFor ¶

func (e *ExpectedPrepare) WillDelayFor(duration time.Duration) *ExpectedPrepare

WillDelayFor allows to specify duration for which it will delay result. May be used together with Context

func (*ExpectedPrepare) WillReturnCloseError ¶

func (e *ExpectedPrepare) WillReturnCloseError(err error) *ExpectedPrepare

WillReturnCloseError allows to set an error for this prepared statement Close action

func (*ExpectedPrepare) WillReturnError ¶

func (e *ExpectedPrepare) WillReturnError(err error) *ExpectedPrepare

WillReturnError allows to set an error for the expected *sql.DB.Prepare or *sql.Tx.Prepare action.

type ExpectedQuery ¶

ExpectedQuery is used to manage *sql.DB.Query, *dql.DB.QueryRow, *sql.Tx.Query, *sql.Tx.QueryRow, *sql.Stmt.Query or *sql.Stmt.QueryRow expectations. Returned by *Sqlmock.ExpectQuery.

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

func (*ExpectedQuery) RowsWillBeClosed ¶

func (e *ExpectedQuery) RowsWillBeClosed() *ExpectedQuery

RowsWillBeClosed expects this query rows to be closed.

func (*ExpectedQuery) String ¶

func (e *ExpectedQuery) String() string

String returns string representation

func (*ExpectedQuery) WillDelayFor ¶

func (e *ExpectedQuery) WillDelayFor(duration time.Duration) *ExpectedQuery

WillDelayFor allows to specify duration for which it will delay result. May be used together with Context

func (*ExpectedQuery) WillReturnError ¶

func (e *ExpectedQuery) WillReturnError(err error) *ExpectedQuery

WillReturnError allows to set an error for expected database query

func (*ExpectedQuery) WillReturnRows ¶

func (e *ExpectedQuery) WillReturnRows(rows ...*Rows) *ExpectedQuery

WillReturnRows specifies the set of resulting rows that will be returned by the triggered query

func (*ExpectedQuery) WithArgs ¶

func (e *ExpectedQuery) WithArgs(args ...driver.Value) *ExpectedQuery

WithArgs will match given expected args to actual database query arguments. if at least one argument does not match, it will return an error. For specific arguments an sqlmock.Argument interface can be used to match an argument. Must not be used together with WithoutArgs()

func (*ExpectedQuery) WithoutArgs ¶

func (e *ExpectedQuery) WithoutArgs() *ExpectedQuery

WithoutArgs will ensure that no arguments are passed for this query. if at least one argument is passed, it will return an error. This allows for stricter validation of the query arguments. Must no be used together with WithArgs()

type ExpectedRollback ¶

ExpectedRollback is used to manage *sql.Tx.Rollback expectation returned by *Sqlmock.ExpectRollback.

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

func (*ExpectedRollback) String ¶

func (e *ExpectedRollback) String() string

String returns string representation

func (*ExpectedRollback) WillReturnError ¶

func (e *ExpectedRollback) WillReturnError(err error) *ExpectedRollback

WillReturnError allows to set an error for *sql.Tx.Rollback action

type QueryMatcher ¶

QueryMatcher is an SQL query string matcher interface, which can be used to customize validation of SQL query strings. As an example, external library could be used to build and validate SQL ast, columns selected.

sqlmock can be customized to implement a different QueryMatcher configured through an option when sqlmock.New or sqlmock.NewWithDSN is called, default QueryMatcher is QueryMatcherRegexp.

type QueryMatcher interface {

    // Match expected SQL query string without whitespace to
    // actual SQL.
    Match(expectedSQL, actualSQL string) error
}

QueryMatcherEqual is the SQL query matcher which simply tries a case sensitive match of expected and actual SQL strings without whitespace.

var QueryMatcherEqual QueryMatcher = QueryMatcherFunc(func(expectedSQL, actualSQL string) error {
    expect := stripQuery(expectedSQL)
    actual := stripQuery(actualSQL)
    if actual != expect {
        return fmt.Errorf(`actual sql: "%s" does not equal to expected "%s"`, actual, expect)
    }
    return nil
})

QueryMatcherRegexp is the default SQL query matcher used by sqlmock. It parses expectedSQL to a regular expression and attempts to match actualSQL.

var QueryMatcherRegexp QueryMatcher = QueryMatcherFunc(func(expectedSQL, actualSQL string) error {
    expect := stripQuery(expectedSQL)
    actual := stripQuery(actualSQL)
    re, err := regexp.Compile(expect)
    if err != nil {
        return err
    }
    if !re.MatchString(actual) {
        return fmt.Errorf(`could not match actual sql: "%s" with expected regexp "%s"`, actual, re.String())
    }
    return nil
})

// configure to use case sensitive SQL query matcher
// instead of default regular expression matcher
db, mock, err := New(QueryMatcherOption(QueryMatcherEqual))
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "title"}).
    AddRow(1, "one").
    AddRow(2, "two")

mock.ExpectQuery("SELECT * FROM users").WillReturnRows(rows)

rs, err := db.Query("SELECT * FROM users")
if err != nil {
    fmt.Println("failed to match expected query")
    return
}
defer rs.Close()

for rs.Next() {
    var id int
    var title string
    rs.Scan(&id, &title)
    fmt.Println("scanned id:", id, "and title:", title)
}

if rs.Err() != nil {
    fmt.Println("got rows error:", rs.Err())
}

scanned id: 1 and title: one
scanned id: 2 and title: two

type QueryMatcherFunc ¶

QueryMatcherFunc type is an adapter to allow the use of ordinary functions as QueryMatcher. If f is a function with the appropriate signature, QueryMatcherFunc(f) is a QueryMatcher that calls f.

type QueryMatcherFunc func(expectedSQL, actualSQL string) error

func (QueryMatcherFunc) Match ¶

func (f QueryMatcherFunc) Match(expectedSQL, actualSQL string) error

Match implements the QueryMatcher

type Rows ¶

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

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

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "title"}).
    AddRow(1, "one").
    AddRow(2, "two")

mock.ExpectQuery("SELECT").WillReturnRows(rows)

rs, _ := db.Query("SELECT")
defer rs.Close()

for rs.Next() {
    var id int
    var title string
    rs.Scan(&id, &title)
    fmt.Println("scanned id:", id, "and title:", title)
}

if rs.Err() != nil {
    fmt.Println("got rows error:", rs.Err())
}

scanned id: 1 and title: one
scanned id: 2 and title: two

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "title"}).CloseError(fmt.Errorf("close error"))
mock.ExpectQuery("SELECT").WillReturnRows(rows)

rs, _ := db.Query("SELECT")

// Note: that close will return error only before rows EOF
// that is a default sql package behavior. If you run rs.Next()
// it will handle the error internally and return nil bellow
if err := rs.Close(); err != nil {
    fmt.Println("got error:", err)
}

got error: close error

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "null_int"}).
    AddRow(1, 7).
    AddRow(5, sql.NullInt64{Int64: 5, Valid: true}).
    AddRow(2, sql.NullInt64{})

mock.ExpectQuery("SELECT").WillReturnRows(rows)

rs, _ := db.Query("SELECT")
defer rs.Close()

for rs.Next() {
    var id int
    var num sql.NullInt64
    rs.Scan(&id, &num)
    fmt.Println("scanned id:", id, "and null int64:", num)
}

if rs.Err() != nil {
    fmt.Println("got rows error:", rs.Err())
}

scanned id: 1 and null int64: {7 true}
scanned id: 5 and null int64: {5 true}
scanned id: 2 and null int64: {0 false}

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "title"}).AddRow(1, "john")
mock.ExpectQuery("SELECT").WillReturnRows(rows).RowsWillBeClosed()

db.Query("SELECT")

if err := mock.ExpectationsWereMet(); err != nil {
    fmt.Println("got error:", err)
}

got error: expected query rows to be closed, but it was not: ExpectedQuery => expecting Query, QueryContext or QueryRow which:
  - matches sql: 'SELECT'
  - is without arguments
  - should return rows:
    row 0 - [1 john]

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "binary"}).
    AddRow(1, []byte(`one binary value with some text!`)).
    AddRow(2, []byte(`two binary value with even more text than the first one`))

mock.ExpectQuery("SELECT").WillReturnRows(rows)

rs, _ := db.Query("SELECT")
defer rs.Close()

type scanned struct {
    id  int
    raw sql.RawBytes
}
fmt.Println("initial read...")
var ss []scanned
for rs.Next() {
    var s scanned
    rs.Scan(&s.id, &s.raw)
    ss = append(ss, s)
    fmt.Println("scanned id:", s.id, "and raw:", string(s.raw))
}

if rs.Err() != nil {
    fmt.Println("got rows error:", rs.Err())
}

fmt.Println("after reading all...")
for _, s := range ss {
    fmt.Println("scanned id:", s.id, "and raw:", string(s.raw))
}

initial read...
scanned id: 1 and raw: one binary value with some text!
scanned id: 2 and raw: two binary value with even more text than the first one
after reading all...
scanned id: 1 and raw: ☠☠☠ MEMORY OVERWRITTEN ☠
scanned id: 2 and raw: ☠☠☠ MEMORY OVERWRITTEN ☠☠☠ ☠☠☠ MEMORY

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

rows := NewRows([]string{"id", "title"}).
    AddRow(0, "one").
    AddRow(1, "two").
    RowError(1, fmt.Errorf("row error"))
mock.ExpectQuery("SELECT").WillReturnRows(rows)

rs, _ := db.Query("SELECT")
defer rs.Close()

for rs.Next() {
    var id int
    var title string
    rs.Scan(&id, &title)
    fmt.Println("scanned id:", id, "and title:", title)
}

if rs.Err() != nil {
    fmt.Println("got rows error:", rs.Err())
}

scanned id: 0 and title: one
got rows error: row error

func NewRows ¶

func NewRows(columns []string) *Rows

NewRows allows Rows to be created from a sql driver.Value 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 ...*Column) *Rows

NewRowsWithColumnDefinition return rows with columns metadata

func (*Rows) AddRow ¶

func (r *Rows) AddRow(values ...driver.Value) *Rows

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

func (*Rows) AddRows ¶

func (r *Rows) AddRows(values ...[]driver.Value) *Rows

AddRows adds multiple rows composed from database driver.Value slice and returns the same instance to perform subsequent actions.

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

values := [][]driver.Value{
    {
        1, "one",
    },
    {
        2, "two",
    },
}

rows := NewRows([]string{"id", "title"}).AddRows(values...)

mock.ExpectQuery("SELECT").WillReturnRows(rows)

rs, _ := db.Query("SELECT")
defer rs.Close()

for rs.Next() {
    var id int
    var title string
    rs.Scan(&id, &title)
    fmt.Println("scanned id:", id, "and title:", title)
}

if rs.Err() != nil {
    fmt.Println("got rows error:", rs.Err())
}

scanned id: 1 and title: one
scanned id: 2 and title: two

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

type Sqlmock ¶

Sqlmock interface for Go 1.8+

type Sqlmock interface {
    // Embed common methods
    SqlmockCommon

    // NewRowsWithColumnDefinition allows Rows to be created from a
    // sql driver.Value slice with a definition of sql metadata
    NewRowsWithColumnDefinition(columns ...*Column) *Rows

    // New Column allows to create a Column
    NewColumn(name string) *Column
}

db, mock, err := New()
if err != nil {
    fmt.Println("failed to open sqlmock database:", err)
}
defer db.Close()

// note this line is important for unordered expectation matching
mock.MatchExpectationsInOrder(false)

result := NewResult(1, 1)

mock.ExpectExec("^UPDATE one").WithArgs("one").WillReturnResult(result)
mock.ExpectExec("^UPDATE two").WithArgs("one", "two").WillReturnResult(result)
mock.ExpectExec("^UPDATE three").WithArgs("one", "two", "three").WillReturnResult(result)

var wg sync.WaitGroup
queries := map[string][]interface{}{
    "one":   {"one"},
    "two":   {"one", "two"},
    "three": {"one", "two", "three"},
}

wg.Add(len(queries))
for table, args := range queries {
    go func(tbl string, a []interface{}) {
        if _, err := db.Exec("UPDATE "+tbl, a...); err != nil {
            fmt.Println("error was not expected:", err)
        }
        wg.Done()
    }(table, args)
}

wg.Wait()

if err := mock.ExpectationsWereMet(); err != nil {
    fmt.Println("there were unfulfilled expectations:", err)
}

func New ¶

func New(options ...func(*sqlmock) error) (*sql.DB, Sqlmock, error)

New creates sqlmock database connection and a mock to manage expectations. Accepts options, like ValueConverterOption, to use a ValueConverter from a specific driver. Pings db so that all expectations could be asserted.

db, mock, err := New()
if err != nil {
    fmt.Println("expected no error, but got:", err)
    return
}
defer db.Close()
// now we can expect operations performed on db
mock.ExpectBegin().WillReturnError(fmt.Errorf("an error will occur on db.Begin() call"))

func NewWithDSN ¶

func NewWithDSN(dsn string, options ...func(*sqlmock) error) (*sql.DB, Sqlmock, error)

NewWithDSN creates sqlmock database connection with a specific DSN and a mock to manage expectations. Accepts options, like ValueConverterOption, to use a ValueConverter from a specific driver. Pings db so that all expectations could be asserted.

This method is introduced because of sql abstraction libraries, which do not provide a way to initialize with sql.DB instance. For example GORM library.

Note, it will error if attempted to create with an already used dsn

It is not recommended to use this method, unless you really need it and there is no other way around.

type SqlmockCommon ¶

Sqlmock interface serves to create expectations for any kind of database action in order to mock and test real database behavior.

type SqlmockCommon interface {
    // ExpectClose queues an expectation for this database
    // action to be triggered. the *ExpectedClose allows
    // to mock database response
    ExpectClose() *ExpectedClose

    // ExpectationsWereMet checks whether all queued expectations
    // were met in order. If any of them was not met - an error is returned.
    ExpectationsWereMet() error

    // ExpectPrepare expects Prepare() to be called with expectedSQL query.
    // the *ExpectedPrepare allows to mock database response.
    // Note that you may expect Query() or Exec() on the *ExpectedPrepare
    // statement to prevent repeating expectedSQL
    ExpectPrepare(expectedSQL string) *ExpectedPrepare

    // 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 *sql.DB.Begin to be called.
    // the *ExpectedBegin allows to mock database response
    ExpectBegin() *ExpectedBegin

    // ExpectCommit expects *sql.Tx.Commit to be called.
    // the *ExpectedCommit allows to mock database response
    ExpectCommit() *ExpectedCommit

    // ExpectRollback expects *sql.Tx.Rollback to be called.
    // the *ExpectedRollback allows to mock database response
    ExpectRollback() *ExpectedRollback

    // ExpectPing expected *sql.DB.Ping to be called.
    // the *ExpectedPing allows to mock database response
    //
    // Ping support only exists in the SQL library in Go 1.8 and above.
    // ExpectPing in Go <=1.7 will return an ExpectedPing but not register
    // any expectations.
    //
    // You must enable pings using MonitorPingsOption for this to register
    // any expectations.
    ExpectPing() *ExpectedPing

    // 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
    // sql driver.Value slice or from the CSV string and
    // to be used as sql driver.Rows.
    NewRows(columns []string) *Rows
}

Subdirectories