diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-10 20:03:50 -0400 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-03-10 20:03:50 -0400 |
| commit | f0ee4ba310f7034f549570a0833ac7ba41e9ab7f (patch) | |
| tree | 8791281d7c144209d2d3dd1b99e785f294dcdeab /internal/storage | |
| parent | Use pgx v5 and update changelog (diff) | |
| download | cli-f0ee4ba310f7034f549570a0833ac7ba41e9ab7f.zip | |
Add adapter tests
Diffstat (limited to 'internal/storage')
| -rw-r--r-- | internal/storage/adapter.go | 8 | ||||
| -rw-r--r-- | internal/storage/db.go | 35 | ||||
| -rw-r--r-- | internal/storage/db_test.go | 133 | ||||
| -rw-r--r-- | internal/storage/mysql_test.go | 103 | ||||
| -rw-r--r-- | internal/storage/postgresql.go | 2 | ||||
| -rw-r--r-- | internal/storage/postgresql_test.go | 103 |
6 files changed, 361 insertions, 23 deletions
diff --git a/internal/storage/adapter.go b/internal/storage/adapter.go index ce01989..d4573f0 100644 --- a/internal/storage/adapter.go +++ b/internal/storage/adapter.go @@ -3,8 +3,16 @@ package storage import "github.com/eugenetriguba/bolt/internal/configloader" type DBAdapter interface { + // ConvertGenericPlaceholders replaces any generic `?` placeholders + // in `query` for the database driver specific placeholders and returns + // the updated query. ConvertGenericPlaceholders(query string, argsCount int) string + // TableExists checks if the tableName exists within the + // database currently connected to. TableExists(executor sqlExecutor, tableName string) (bool, error) + // DatabaseName retrieves the currently selected database name. DatabaseName(executor sqlExecutor) (string, error) + // CreateDSN creates a DSN to be used with sql.Open in the database + // driver specific format. CreateDSN(cfg configloader.ConnectionConfig) string } diff --git a/internal/storage/db.go b/internal/storage/db.go index 66b13b3..70c3344 100644 --- a/internal/storage/db.go +++ b/internal/storage/db.go @@ -13,14 +13,14 @@ import ( var postgresqlDriverName = "postgresql" var mysqlDriverName = "mysql" -var supportedDrivers = map[string]string{ - postgresqlDriverName: "pgx", - mysqlDriverName: "mysql", +var supportedDrivers = map[string]dbDriver{ + postgresqlDriverName: {name: "pgx", adapter: PostgresqlAdapter{}}, + mysqlDriverName: {name: "mysql", adapter: MySQLAdapter{}}, } -var driverAdapters = map[string]DBAdapter{ - postgresqlDriverName: PostgresqlAdapter{}, - mysqlDriverName: MySQLAdapter{}, +type dbDriver struct { + name string + adapter DBAdapter } var ( @@ -56,17 +56,12 @@ type DB struct { // the provided connection parameters. // - ErrUnsupportedDriver: The provided driver is not supported. func NewDB(cfg configloader.ConnectionConfig) (DB, error) { - driverName, exists := supportedDrivers[cfg.Driver] + driver, exists := supportedDrivers[cfg.Driver] if !exists { return DB{}, ErrUnsupportedDriver } - adapter, exists := driverAdapters[cfg.Driver] - if !exists { - return DB{}, ErrUnsupportedDriver - } - - db, err := sql.Open(driverName, adapter.CreateDSN(cfg)) + db, err := sql.Open(driver.name, driver.adapter.CreateDSN(cfg)) if err != nil { return DB{}, fmt.Errorf("%w: %v", ErrMalformedConnectionString, err) } @@ -79,7 +74,7 @@ func NewDB(cfg configloader.ConnectionConfig) (DB, error) { return DB{}, fmt.Errorf("%w: %v", ErrUnableToConnect, err) } - return DB{executor: db, sqlDB: db, adapter: adapter}, nil + return DB{executor: db, sqlDB: db, adapter: driver.adapter}, nil } // Close closes the database connection. Any further @@ -89,27 +84,35 @@ func (db DB) Close() error { return db.sqlDB.Close() } +// Exec is a wrapper around the sql.DB Exec. func (db DB) Exec(query string, args ...any) (sql.Result, error) { newQuery := db.adapter.ConvertGenericPlaceholders(query, len(args)) return db.executor.Exec(newQuery, args...) } +// Query is a wrapper around the sql.DB Query. func (db DB) Query(query string, args ...any) (*sql.Rows, error) { newQuery := db.adapter.ConvertGenericPlaceholders(query, len(args)) return db.executor.Query(newQuery, args...) } +// QueryRow is a wrapper around the sql.DB QueryRow. func (db DB) QueryRow(query string, args ...any) *sql.Row { newQuery := db.adapter.ConvertGenericPlaceholders(query, len(args)) return db.executor.QueryRow(newQuery, args...) } +// TableExists checks if the tableName exists within the +// database currently connected to. func (db DB) TableExists(tableName string) (bool, error) { return db.adapter.TableExists(db.executor, tableName) } type txFunc func(db DB) error +// Tx executes fn within a transaction block. If +// fn returns an error, the transaction will be rolled +// back. Otherwise, it will be committed. func (db *DB) Tx(fn txFunc) error { tx, err := db.sqlDB.Begin() if err != nil { @@ -127,12 +130,12 @@ func (db *DB) Tx(fn txFunc) error { err = fn(txDB) if err != nil { - return err + return fmt.Errorf("unable to execute transaction: %w", err) } err = tx.Commit() if err != nil { - return err + return fmt.Errorf("unable to commit transaction: %w", err) } return nil diff --git a/internal/storage/db_test.go b/internal/storage/db_test.go index 0eacd23..6dc1e14 100644 --- a/internal/storage/db_test.go +++ b/internal/storage/db_test.go @@ -1,6 +1,8 @@ package storage_test import ( + "database/sql" + "errors" "testing" "github.com/eugenetriguba/bolt/internal/bolttest" @@ -9,21 +11,140 @@ import ( ) func TestNewDB_Success(t *testing.T) { + db, err := storage.NewDB(bolttest.NewTestConnectionConfig()) + assert.Nil(t, err) + t.Cleanup(func() { + assert.Nil(t, db.Close()) + }) + _, err = db.Exec("SELECT 1;") + assert.Nil(t, err) +} + +func TestNewDB_UnsupportedDriver(t *testing.T) { + t.Setenv("BOLT_DB_CONN_DRIVER", "abc123") + _, err := storage.NewDB(bolttest.NewTestConnectionConfig()) + assert.ErrorIs(t, err, storage.ErrUnsupportedDriver) +} + +func TestNewDB_UnableToConnect(t *testing.T) { + t.Setenv("BOLT_DB_CONN_HOST", "") + t.Setenv("BOLT_DB_CONN_PORT", "") + _, err := storage.NewDB(bolttest.NewTestConnectionConfig()) + assert.ErrorIs(t, err, storage.ErrUnableToConnect) +} + +func TestClose_IsClosed(t *testing.T) { + db, err := storage.NewDB(bolttest.NewTestConnectionConfig()) + assert.Nil(t, err) + + err = db.Close() + assert.Nil(t, err) + + _, err = db.Exec("SELECT 1;") + assert.ErrorContains(t, err, "sql: database is closed") +} + +func TestTableExists_DoesExist(t *testing.T) { + db, err := storage.NewDB(bolttest.NewTestConnectionConfig()) + assert.Nil(t, err) + t.Cleanup(func() { + bolttest.DropTable(t, db, "tmp") + assert.Nil(t, db.Close()) + }) + _, err = db.Exec("CREATE TABLE tmp(id int primary key);") + assert.Nil(t, err) + + exists, err := db.TableExists("tmp") + + assert.Nil(t, err) + assert.True(t, exists) +} + +func TestTableExists_DoesNotExist(t *testing.T) { cfg := bolttest.NewTestConnectionConfig() + db, err := storage.NewDB(cfg) + assert.Nil(t, err) + t.Cleanup(func() { + assert.Nil(t, db.Close()) + }) + exists, err := db.TableExists("tmp") + + assert.Nil(t, err) + assert.False(t, exists) +} + +func TestQueryPlaceholders(t *testing.T) { + cfg := bolttest.NewTestConnectionConfig() db, err := storage.NewDB(cfg) + assert.Nil(t, err) + t.Cleanup(func() { + bolttest.DropTable(t, db, "tmp") + assert.Nil(t, db.Close()) + }) + _, err = db.Exec(`CREATE TABLE tmp(id int primary key);`) + assert.Nil(t, err) + _, err = db.Exec(`INSERT INTO tmp(id) VALUES(1);`) + assert.Nil(t, err) + _, err = db.Exec(`INSERT INTO tmp(id) VALUES(2);`) + assert.Nil(t, err) + var queryRowId int + err = db.QueryRow("SELECT id FROM tmp WHERE id = ?", 1).Scan(&queryRowId) assert.Nil(t, err) - defer db.Close() - _, err = db.Exec("SELECT 1;") + assert.Equal(t, queryRowId, 1) + + rows, err := db.Query("SELECT id FROM tmp WHERE id = ?", 1) assert.Nil(t, err) + assert.True(t, rows.Next()) + var queryId int + err = rows.Scan(&queryId) + assert.Nil(t, err) + assert.Equal(t, queryId, 1) + assert.False(t, rows.Next()) } -func TestNewDB_UnsupportedDriver(t *testing.T) { - t.Setenv("BOLT_DB_CONN_DRIVER", "abc123") +func TestTx_Commit(t *testing.T) { cfg := bolttest.NewTestConnectionConfig() + db, err := storage.NewDB(cfg) + assert.Nil(t, err) + t.Cleanup(func() { + bolttest.DropTable(t, db, "tmp") + assert.Nil(t, db.Close()) + }) - _, err := storage.NewDB(cfg) + err = db.Tx(func(db storage.DB) error { + _, err = db.Exec(`CREATE TABLE tmp(id int primary key);`) + assert.Nil(t, err) + return nil + }) + assert.Nil(t, err) - assert.ErrorIs(t, err, storage.ErrUnsupportedDriver) + exists, err := db.TableExists("tmp") + assert.Nil(t, err) + assert.True(t, exists) +} + +func TestTx_Rollback(t *testing.T) { + cfg := bolttest.NewTestConnectionConfig() + db, err := storage.NewDB(cfg) + assert.Nil(t, err) + t.Cleanup(func() { + bolttest.DropTable(t, db, "tmp") + assert.Nil(t, db.Close()) + }) + _, err = db.Exec(`CREATE TABLE tmp(id INT PRIMARY KEY);`) + assert.Nil(t, err) + expectedErr := errors.New("error!") + + err = db.Tx(func(db storage.DB) error { + _, err = db.Exec(`INSERT INTO tmp(id) VALUES(1)`) + assert.Nil(t, err) + return expectedErr + }) + assert.ErrorIs(t, err, expectedErr) + + var id int + err = db.QueryRow("SELECT id FROM tmp WHERE id = 1;").Scan(&id) + assert.ErrorIs(t, err, sql.ErrNoRows) } diff --git a/internal/storage/mysql_test.go b/internal/storage/mysql_test.go new file mode 100644 index 0000000..76f1098 --- /dev/null +++ b/internal/storage/mysql_test.go @@ -0,0 +1,103 @@ +//go:build mysql + +package storage_test + +import ( + "database/sql" + "fmt" + "testing" + + "github.com/eugenetriguba/bolt/internal/bolttest" + "github.com/eugenetriguba/bolt/internal/configloader" + "github.com/eugenetriguba/bolt/internal/storage" + "github.com/eugenetriguba/checkmate/assert" +) + +func TestConvertGenericPlaceholders(t *testing.T) { + type test struct { + query string + argCount int + expectedQuery string + } + + testCases := []test{ + { + query: "SELECT id, name FROM some_table;", + argCount: 0, + expectedQuery: "SELECT id, name FROM some_table;", + }, + { + query: "SELECT id, name FROM some_table WHERE id = ?;", + argCount: 1, + expectedQuery: "SELECT id, name FROM some_table WHERE id = ?;", + }, + { + query: "SELECT id, name FROM some_table WHERE id = ? AND name = ?;", + argCount: 2, + expectedQuery: "SELECT id, name FROM some_table WHERE id = ? AND name = ?;", + }, + } + for _, tc := range testCases { + adapter := storage.MySQLAdapter{} + newQuery := adapter.ConvertGenericPlaceholders(tc.query, tc.argCount) + assert.Equal(t, newQuery, tc.expectedQuery) + } +} + +func TestTableExists(t *testing.T) { + cfg := bolttest.NewTestConnectionConfig() + adapter := storage.MySQLAdapter{} + db, err := sql.Open("mysql", adapter.CreateDSN(cfg)) + assert.Nil(t, err) + t.Cleanup(func() { + _, err = db.Exec("DROP TABLE IF EXISTS tmp;") + assert.Nil(t, err) + assert.Nil(t, db.Close()) + }) + + exists, err := adapter.TableExists(db, "tmp") + assert.Nil(t, err) + assert.False(t, exists) + + _, err = db.Exec("CREATE TABLE tmp(id INT PRIMARY KEY);") + assert.Nil(t, err) + + exists, err = adapter.TableExists(db, "tmp") + assert.Nil(t, err) + assert.True(t, exists) +} + +func TestDatabaseName(t *testing.T) { + cfg := bolttest.NewTestConnectionConfig() + adapter := storage.MySQLAdapter{} + db, err := sql.Open("mysql", adapter.CreateDSN(cfg)) + assert.Nil(t, err) + t.Cleanup(func() { + assert.Nil(t, db.Close()) + }) + + name, err := adapter.DatabaseName(db) + assert.Nil(t, err) + + assert.Equal(t, name, cfg.DBName) +} + +func TestCreateDSN(t *testing.T) { + cfg := configloader.ConnectionConfig{ + Driver: "mysql", + Host: "db1", + Port: "5432", + User: "testuser", + Password: "supersecretpassword", + DBName: "testdb", + } + adapter := storage.PostgresqlAdapter{} + + cs := adapter.CreateDSN(cfg) + + expectedConnectionString := fmt.Sprintf( + "host=%s port=%s user=%s password=%s dbname=%s sslmode=disable", + cfg.Host, cfg.Port, cfg.User, cfg.Password, cfg.DBName, + ) + assert.Equal(t, cs, expectedConnectionString) +} diff --git a/internal/storage/postgresql.go b/internal/storage/postgresql.go index f728514..dee0288 100644 --- a/internal/storage/postgresql.go +++ b/internal/storage/postgresql.go @@ -55,7 +55,7 @@ func (p PostgresqlAdapter) TableExists( func (p PostgresqlAdapter) DatabaseName(executor sqlExecutor) (string, error) { var name string - err := executor.QueryRow("SELECT database_name();").Scan(&name) + err := executor.QueryRow("SELECT current_database();").Scan(&name) if err != nil { return "", fmt.Errorf("unable to retrieve database name: %w", err) } diff --git a/internal/storage/postgresql_test.go b/internal/storage/postgresql_test.go new file mode 100644 index 0000000..8218cc1 --- /dev/null +++ b/internal/storage/postgresql_test.go @@ -0,0 +1,103 @@ +//go:build postgresql + +package storage_test + +import ( + "database/sql" + "fmt" + "testing" + + "github.com/eugenetriguba/bolt/internal/bolttest" + "github.com/eugenetriguba/bolt/internal/configloader" + "github.com/eugenetriguba/bolt/internal/storage" + "github.com/eugenetriguba/checkmate/assert" +) + +func TestConvertGenericPlaceholders(t *testing.T) { + type test struct { + query string + argCount int + expectedQuery string + } + + testCases := []test{ + { + query: "SELECT id, name FROM some_table;", + argCount: 0, + expectedQuery: "SELECT id, name FROM some_table;", + }, + { + query: "SELECT id, name FROM some_table WHERE id = ?;", + argCount: 1, + expectedQuery: "SELECT id, name FROM some_table WHERE id = $1;", + }, + { + query: "SELECT id, name FROM some_table WHERE id = ? AND name = ?;", + argCount: 2, + expectedQuery: "SELECT id, name FROM some_table WHERE id = $1 AND name = $2;", + }, + } + for _, tc := range testCases { + adapter := storage.PostgresqlAdapter{} + newQuery := adapter.ConvertGenericPlaceholders(tc.query, tc.argCount) + assert.Equal(t, newQuery, tc.expectedQuery) + } +} + +func TestTableExists(t *testing.T) { + cfg := bolttest.NewTestConnectionConfig() + adapter := storage.PostgresqlAdapter{} + db, err := sql.Open("pgx", adapter.CreateDSN(cfg)) + assert.Nil(t, err) + t.Cleanup(func() { + _, err = db.Exec("DROP TABLE IF EXISTS tmp;") + assert.Nil(t, err) + assert.Nil(t, db.Close()) + }) + + exists, err := adapter.TableExists(db, "tmp") + assert.Nil(t, err) + assert.False(t, exists) + + _, err = db.Exec("CREATE TABLE tmp(id INT PRIMARY KEY);") + assert.Nil(t, err) + + exists, err = adapter.TableExists(db, "tmp") + assert.Nil(t, err) + assert.True(t, exists) +} + +func TestDatabaseName(t *testing.T) { + cfg := bolttest.NewTestConnectionConfig() + adapter := storage.PostgresqlAdapter{} + db, err := sql.Open("pgx", adapter.CreateDSN(cfg)) + assert.Nil(t, err) + t.Cleanup(func() { + assert.Nil(t, db.Close()) + }) + + name, err := adapter.DatabaseName(db) + assert.Nil(t, err) + + assert.Equal(t, name, cfg.DBName) +} + +func TestCreateDSN(t *testing.T) { + cfg := configloader.ConnectionConfig{ + Driver: "postgres", + Host: "db1", + Port: "5432", + User: "testuser", + Password: "supersecretpassword", + DBName: "testdb", + } + adapter := storage.PostgresqlAdapter{} + + cs := adapter.CreateDSN(cfg) + + expectedConnectionString := fmt.Sprintf( + "host=%s port=%s user=%s password=%s dbname=%s sslmode=disable", + cfg.Host, cfg.Port, cfg.User, cfg.Password, cfg.DBName, + ) + assert.Equal(t, cs, expectedConnectionString) +} |