DATA-DOG/go-sqlmock
Go Sqlmock
go-sqlmock is a Go library that simulates SQL driver behavior for unit testing by intercepting database calls through the standard database/sql/driver interface, eliminating the need for a real database connection. It provides a comprehensive mocking framework that allows developers to define expectations for SQL operations, including queries, executions, prepared statements, and transaction lifecycles, with precise control over the results and errors returned.
The library distinguishes itself through its flexible matching and verification capabilities. It supports regex-based or exact SQL string matching, along with a custom argument matching interface that handles complex types like time.Time and provides wildcard matchers for flexible value comparison. Expectations can be enforced in a predefined order, and the library verifies that all registered expectations are fulfilled during the test, reporting any unmatched or missing calls. It also includes configurable delayed response simulation for testing timeout and context cancellation scenarios.
Beyond core query and exec mocking, go-sqlmock covers the full spectrum of database interaction testing. This includes simulating connection health through ping calls and sentinel errors, managing transaction begin/commit/rollback cycles with configurable errors, and building mock result sets with detailed column metadata such as names, types, nullability, and precision. The library also supports multiple result sets, named parameters, and session state reset, providing a complete toolkit for validating database interaction logic in Go tests.
Features
- Mock Driver Implementations - Intercepts database calls by implementing the database/sql/driver interfaces to simulate SQL driver behavior.
- Database Interaction Mocking - Simulates SQL driver behavior in tests by intercepting database calls through the standard database/sql interface.
- SQL Mocking Libraries - Simulate any SQL driver behavior in tests by intercepting database calls through the database/sql/driver interface without requiring a real database connection.
- SQL Pattern Matchers - Validates SQL query strings and arguments using regex, equality, or custom matchers in tests.
- Equality SQL Matchers - Validates incoming SQL strings against expected patterns using either regular expression or exact case-sensitive matching.
- Mock Transaction Lifecycles - Set expectations for Begin, Commit, and Rollback calls, optionally returning errors or delays to test transaction handling.
- Mock Result Set Builders - Creates mock result objects with configurable LastInsertId and RowsAffected values or error returns.
- Custom Result Returns - Configure mocked queries and execs to return specific row sets, last insert IDs, affected row counts, or errors.
- Error Simulators - Configures specific errors to be returned from any database operation to test error handling paths.
- SQL Query Execution - Executes SQL statements that return no rows and reports the number of affected rows.
- Mock Row Queries - Runs statements that return rows and provides an iterator over the result set for testing.
- Exec Statement Mocking - Expects Exec or ExecContext calls, returning configurable results or errors, with optional argument matching.
- Query Statement Mocking - Expects Query, QueryRow, or their context variants, returning configurable rows or errors, with optional argument matching.
- Database Transaction Management - Provides a mocking framework for programmatic control of database transaction boundaries in tests.
- Prepared Statements - Parses and stores query strings for repeated execution with different arguments.
- Mocking Frameworks - Expect Prepare calls and define subsequent Exec or Query expectations on the prepared statement, optionally simulating close errors.
- Mock Execution Mode Handlers - Returns predefined results or errors when matching INSERT/UPDATE/DELETE statements are executed with argument validation.
- Statement Executions - Runs SQL statements that do not return rows, such as INSERT or UPDATE operations.
- Transaction Management - Starts, commits, or rolls back transactions on a database connection.
- Mock Argument Matchers - Match query or exec arguments using custom logic, including a wildcard matcher for any value or type-specific matchers like time.Time.
- Database Type Converters - Ships a custom type conversion system for mapping Go values to database-compatible types in mock operations.
- Database Argument Matchers - Provides custom argument matchers for comparing complex types like time.Time in database query expectations.
- SQL Query String Matchers - Validates incoming SQL queries using regular expressions, exact equality, or custom matchers for flexible assertion control.
- Database Ping Simulators - Mocks database ping calls to verify connectivity checks without a real database.
- Interaction Expectations - Check that every registered expectation was fulfilled during the test and report any unmatched or missing calls.
- SQL Statement Expectation Registries - Registers expected SQL INSERT, UPDATE, or DELETE statements with argument matching and configurable results.
- Query Statement Expectations - Define expected Query calls with argument matching, returning custom rows or errors to test select operations.
- Mocked SQL Results - Returns predefined results or errors for SQL operations, including row sets, affected row counts, last insert IDs, and custom errors.
- Mock Response Delays - Introduces configurable time delays before returning results for any expected database operation.
- SQL Query Verifications - Validating that SQL queries, arguments, and execution order match expected patterns during automated testing.
- Database Connection Close Mocks - Expects Close calls on the database connection and returns configurable errors.
- Customizable SQL Matchers - Replace default regex-based SQL matching with equality matching or a fully custom query matcher for sophisticated validation.
- Database Operation Delays - Delays the response of SQL operations by a specified duration to test timeouts and context cancellation behavior.
- Health Validation - Signal whether a connection is still valid before it is returned to or reused from the connection pool.
- Bad Connection Signaling - Return a sentinel error to indicate a connection is invalid so the pool can discard and retry it.
- Connection Health Simulators - Simulates database connection health scenarios including pings, errors, and session resets for pool testing.
- Ping Output Normalization - Observes and mocks database ping calls to verify connection health checks in tests.
- Column Metadata Retrieval - Reports column names, types, nullability, length, precision, and scale for query result sets.
- Mock Column Metadata Builders - Builds mock column metadata with type, nullability, and precision details for simulating query results.
- Ordered - Enforces that database operations occur in a predefined sequence by tracking expectation order.
- Response Simulators - Adds configurable delays to any expected database operation to test timeout and context cancellation behavior.
- Mocking Tools - Mock SQL driver for testing database interactions.
- Testing and QA - SQL mock for database interaction testing.
- Testing and Quality Assurance - SQL mock for database interaction testing.
- Framework-uri de testare - SQL mocking library.
