aboutsummaryrefslogtreecommitdiffstats
path: root/internal/storage
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-03-09 15:50:21 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2024-03-09 15:50:21 -0500
commit9d2abbe510d1719bcfe31db901423376f79b7894 (patch)
tree00f5a057571a3ca779e5bbe96655169c58a692f9 /internal/storage
parentuse docker compose to start database in workflow (diff)
downloadcli-9d2abbe510d1719bcfe31db901423376f79b7894.zip
Add MySQL support
Diffstat (limited to 'internal/storage')
-rw-r--r--internal/storage/db.go65
-rw-r--r--internal/storage/db_test.go49
2 files changed, 50 insertions, 64 deletions
diff --git a/internal/storage/db.go b/internal/storage/db.go
index d83e71d..7f1d93d 100644
--- a/internal/storage/db.go
+++ b/internal/storage/db.go
@@ -1,16 +1,18 @@
package storage
import (
- "database/sql"
"errors"
"fmt"
- "slices"
"github.com/eugenetriguba/bolt/internal/configloader"
- _ "github.com/jackc/pgx/v5/stdlib"
+ "github.com/upper/db/v4"
+ "github.com/upper/db/v4/adapter/mysql"
+ "github.com/upper/db/v4/adapter/postgresql"
)
-var supportedDrivers = []string{"postgres"}
+var postgresqlDriverName = "postgresql"
+var mysqlDriverName = "mysql"
+var supportedDrivers = []string{postgresqlDriverName, mysqlDriverName}
var (
ErrMalformedConnectionString = errors.New(
@@ -20,42 +22,43 @@ var (
ErrUnsupportedDriver = fmt.Errorf("unsupported driver, supported drivers are %s", supportedDrivers)
)
-// DBConnect establishes a connection to the database using the driver
-// and connection information. Only "postgres" is supported as the driver.
+type DB struct {
+ Session db.Session
+}
+
+// DBConnect establishes a connection to the database using the
+// connection configuration.
//
// The following errors may be returned:
-// - ErrMalformedConnectionString: The provided connection parameters are
-// not in a valid format.
// - ErrUnableToConnect: Unable to make a connection to the database with
// the provided connection parameters.
// - ErrUnsupportedDriver: The provided driver is not supported.
-func DBConnect(driver string, connectionParams string) (*sql.DB, error) {
- if !slices.Contains(supportedDrivers, driver) {
- return nil, ErrUnsupportedDriver
- }
+func DBConnect(cfg configloader.ConnectionConfig) (DB, error) {
+ var db db.Session
+ var err error = nil
- db, err := sql.Open("pgx", connectionParams)
- if err != nil {
- return nil, fmt.Errorf("%w: %v", ErrMalformedConnectionString, err)
+ switch cfg.Driver {
+ case postgresqlDriverName:
+ db, err = postgresql.Open(postgresql.ConnectionURL{
+ User: cfg.User,
+ Password: cfg.Password,
+ Host: cfg.Host,
+ Database: cfg.DBName,
+ })
+ case mysqlDriverName:
+ db, err = mysql.Open(mysql.ConnectionURL{
+ User: cfg.User,
+ Password: cfg.Password,
+ Host: cfg.Host,
+ Database: cfg.DBName,
+ })
+ default:
+ return DB{}, ErrUnsupportedDriver
}
- // Note: `sql.Open` only validates the connection string we provided is sane.
- // It doesn't actually open up a connection to the database. For that, we ping
- // the database to ensure the connection string is fully valid.
- err = db.Ping()
if err != nil {
- return nil, fmt.Errorf("%w: %v", ErrUnableToConnect, err)
+ return DB{}, fmt.Errorf("%w: %v", ErrUnableToConnect, err)
}
- return db, nil
-}
-
-// DBConnectionString generates a properly formatted connection
-// string that can be used to establish a database connection.
-// Note that it always creates a connection string with sslmode disabled.
-func DBConnectionString(cfg *configloader.ConnectionConfig) string {
- return fmt.Sprintf(
- "host=%s port=%d user=%s password=%s dbname=%s sslmode=disable",
- cfg.Host, cfg.Port, cfg.User, cfg.Password, cfg.DBName,
- )
+ return DB{Session: db}, nil
}
diff --git a/internal/storage/db_test.go b/internal/storage/db_test.go
index 9f87d4c..8162898 100644
--- a/internal/storage/db_test.go
+++ b/internal/storage/db_test.go
@@ -1,55 +1,38 @@
package storage_test
import (
- "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 TestDBConnect_Success(t *testing.T) {
- cfg := bolttest.NewTestConnectionConfig(t, "postgres")
- connParams := storage.DBConnectionString(cfg)
-
- conn, err := storage.DBConnect(cfg.Driver, connParams)
+ cfg := bolttest.NewTestConnectionConfig()
+ conn, err := storage.DBConnect(cfg)
assert.Nil(t, err)
- defer conn.Close()
+ defer conn.Session.Close()
- _, err = conn.Exec("SELECT 1;")
+ _, err = conn.Session.SQL().Exec("SELECT 1;")
assert.Nil(t, err)
}
-func TestDBConnect_BadConnectionString(t *testing.T) {
- _, err := storage.DBConnect("postgres", "pizza=123")
- assert.ErrorIs(t, err, storage.ErrUnableToConnect)
- assert.ErrorContains(t, err, "unable to open connection to database")
-}
-
func TestDBConnect_UnsupportedDriver(t *testing.T) {
- cfg := bolttest.NewTestConnectionConfig(t, "redis")
+ t.Setenv("BOLT_DB_CONN_DRIVER", "abc123")
+ cfg := bolttest.NewTestConnectionConfig()
- _, err := storage.DBConnect(cfg.Driver, storage.DBConnectionString(cfg))
+ _, err := storage.DBConnect(cfg)
assert.ErrorIs(t, err, storage.ErrUnsupportedDriver)
}
-func TestDBConnectionString(t *testing.T) {
- cfg := configloader.ConnectionConfig{
- Driver: "postgres",
- Host: "db1",
- Port: 5432,
- User: "testuser",
- Password: "supersecretpassword",
- DBName: "testdb",
- }
-
- cs := storage.DBConnectionString(&cfg)
-
- expectedConnectionString := fmt.Sprintf(
- "host=%s port=%d user=%s password=%s dbname=%s sslmode=disable",
- cfg.Host, cfg.Port, cfg.User, cfg.Password, cfg.DBName,
- )
- assert.Equal(t, cs, expectedConnectionString)
+func TestDBConnect_BadConnectionString(t *testing.T) {
+ t.Setenv("BOLT_DB_CONN_DRIVER", "mysql")
+ t.Setenv("BOLT_DB_CONN_HOST", "abc123")
+ cfg := bolttest.NewTestConnectionConfig()
+
+ _, err := storage.DBConnect(cfg)
+
+ assert.ErrorIs(t, err, storage.ErrUnableToConnect)
+ assert.ErrorContains(t, err, "unable to open connection to database")
}