mock.go

package sqlmock

import (
	"errors"
	"sync"
)

type (
	// Option configures Mock behavior.
	Option func(*Mock)

	// Mock stores queued SQL and transaction expectations for a mock session.
	Mock struct {
		mu       sync.Mutex
		ops      []expectedOp
		strictTx bool
	}

	expectedOp interface {
		match(op runtimeOp) error
	}

	runtimeOp struct {
		kind string
		sql  string
		args []any
	}
)

// NewMock creates an empty mock expectation registry.
//
// By default, strict transaction mode is disabled.
func NewMock(opts ...Option) *Mock {
	m := &Mock{
		strictTx: false,
	}

	for _, opt := range opts {
		opt(m)
	}

	return m
}

// WithStrictTx enables transaction enforcement for query and exec operations.
//
// When enabled, QueryContext and ExecContext return an error unless a
// transaction has been started with Begin/BeginTx.
func WithStrictTx() Option {
	return func(m *Mock) {
		m.strictTx = true
	}
}

// next returns the next expected operation without removing it.
func (m *Mock) next() (expectedOp, error) {
	if len(m.ops) == 0 {
		return nil, errors.New("no expectation remaining")
	}

	return m.ops[0], nil
}

// consume removes the current expected operation from the queue.
func (m *Mock) consume() {
	m.ops = m.ops[1:]
}