sqlmock.go

// Package sqlmock provides a lightweight SQL driver mock for testing code that uses database/sql.
package sqlmock

import (
	"database/sql"
	"fmt"
	"sync/atomic"
)

const driverNamePrefix = "sqlmock"

var driverCounter atomic.Uint64

// New registers the mock SQL driver and returns a DB handle with its mock state.
//
// New uses a unique driver name per call, allowing repeated and parallel usage.
func New() (*sql.DB, *Mock, error) {
	return NewWithOptions()
}

// NewWithOptions registers the mock SQL driver and returns a DB handle with its
// configured mock state.
//
// NewWithOptions uses a unique driver name per call, allowing repeated and
// parallel usage.
func NewWithOptions(opts ...Option) (*sql.DB, *Mock, error) {
	mock := NewMock(opts...)
	driverName := fmt.Sprintf("%s_%d", driverNamePrefix, driverCounter.Add(1))

	sql.Register(driverName, &Driver{
		mock: mock,
	})

	db, err := sql.Open(driverName, "")
	if err != nil {
		return nil, nil, err
	}

	return db, mock, nil
}