aboutsummaryrefslogtreecommitdiffstats
path: root/internal
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-01-06 11:15:53 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2024-01-06 11:15:53 -0500
commit3d66d23b7f1f8d496711f01a164ac1d7717527ca (patch)
treeb4ce8a4deda41c57b1ab13ac4e89bfb9e6978cf0 /internal
parentAdd to changelog (diff)
downloadcli-3d66d23b7f1f8d496711f01a164ac1d7717527ca.zip
Add database integration tests
Diffstat (limited to 'internal')
-rw-r--r--internal/commands/create.go12
-rw-r--r--internal/commands/list.go11
-rw-r--r--internal/commands/migrate.go11
-rw-r--r--internal/db/db.go48
-rw-r--r--internal/dbtest/dbtest.go24
-rw-r--r--internal/storage/storage.go40
-rw-r--r--internal/storage/storage_test.go76
7 files changed, 162 insertions, 60 deletions
diff --git a/internal/commands/create.go b/internal/commands/create.go
index 169bc4d..de71fd7 100644
--- a/internal/commands/create.go
+++ b/internal/commands/create.go
@@ -7,9 +7,9 @@ import (
"os"
"github.com/eugenetriguba/bolt/internal/configloader"
- "github.com/eugenetriguba/bolt/internal/db"
"github.com/eugenetriguba/bolt/internal/models"
"github.com/eugenetriguba/bolt/internal/repositories"
+ "github.com/eugenetriguba/bolt/internal/storage"
"github.com/eugenetriguba/bolt/internal/util"
"github.com/google/subcommands"
)
@@ -42,19 +42,23 @@ func (cmd *CreateCmd) Execute(
f *flag.FlagSet,
_ ...interface{},
) subcommands.ExitStatus {
- conn, err := db.Connect()
+ cfg, err := configloader.NewConfig()
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
}
- cfg, err := configloader.NewConfig()
+ db, err := storage.DBConnect(
+ cfg.Connection.Driver,
+ storage.DBConnectionString(&cfg.Connection),
+ )
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
}
+ defer db.Close()
- migrationRepo, err := repositories.NewMigrationRepo(conn, cfg)
+ migrationRepo, err := repositories.NewMigrationRepo(db, cfg)
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
diff --git a/internal/commands/list.go b/internal/commands/list.go
index 36600c9..0f03712 100644
--- a/internal/commands/list.go
+++ b/internal/commands/list.go
@@ -7,8 +7,8 @@ import (
"os"
"github.com/eugenetriguba/bolt/internal/configloader"
- "github.com/eugenetriguba/bolt/internal/db"
"github.com/eugenetriguba/bolt/internal/repositories"
+ "github.com/eugenetriguba/bolt/internal/storage"
"github.com/google/subcommands"
)
@@ -25,18 +25,21 @@ func (*ListCmd) Usage() string {
func (m *ListCmd) SetFlags(f *flag.FlagSet) {}
func (m *ListCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
- db, err := db.Connect()
+ cfg, err := configloader.NewConfig()
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
}
- defer db.Close()
- cfg, err := configloader.NewConfig()
+ db, err := storage.DBConnect(
+ cfg.Connection.Driver,
+ storage.DBConnectionString(&cfg.Connection),
+ )
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
}
+ defer db.Close()
migrationRepo, err := repositories.NewMigrationRepo(db, cfg)
if err != nil {
diff --git a/internal/commands/migrate.go b/internal/commands/migrate.go
index f3e4cbd..df1377a 100644
--- a/internal/commands/migrate.go
+++ b/internal/commands/migrate.go
@@ -7,8 +7,8 @@ import (
"os"
"github.com/eugenetriguba/bolt/internal/configloader"
- "github.com/eugenetriguba/bolt/internal/db"
"github.com/eugenetriguba/bolt/internal/repositories"
+ "github.com/eugenetriguba/bolt/internal/storage"
"github.com/google/subcommands"
)
@@ -25,18 +25,21 @@ func (*MigrateCmd) Usage() string {
func (m *MigrateCmd) SetFlags(f *flag.FlagSet) {}
func (m *MigrateCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
- db, err := db.Connect()
+ cfg, err := configloader.NewConfig()
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
}
- defer db.Close()
- cfg, err := configloader.NewConfig()
+ db, err := storage.DBConnect(
+ cfg.Connection.Driver,
+ storage.DBConnectionString(&cfg.Connection),
+ )
if err != nil {
fmt.Fprintln(os.Stderr, err)
return subcommands.ExitFailure
}
+ defer db.Close()
migrationRepo, err := repositories.NewMigrationRepo(db, cfg)
if err != nil {
diff --git a/internal/db/db.go b/internal/db/db.go
deleted file mode 100644
index 3927681..0000000
--- a/internal/db/db.go
+++ /dev/null
@@ -1,48 +0,0 @@
-package db
-
-import (
- "database/sql"
- "fmt"
-
- "github.com/eugenetriguba/bolt/internal/configloader"
- _ "github.com/lib/pq"
-)
-
-var db *sql.DB
-
-// Connect to the database using the driver and connection
-// parameter that are specified in the bolt configuration file.
-//
-// Note that subsequent calls to Connect return the same database
-// handle.
-func Connect() (*sql.DB, error) {
- if db == nil {
- config, err := configloader.NewConfig()
- if err != nil {
- return nil, err
- }
-
- connInfo := fmt.Sprintf(
- "host=%s port=%d user=%s password=%s dbname=%s sslmode=disable",
- config.Connection.Host, config.Connection.Port, config.Connection.User,
- config.Connection.Password, config.Connection.DBName,
- )
- newDb, err := sql.Open(config.Connection.Driver, connInfo)
- if err != nil {
- return nil, err
- }
-
- // Note: `sql.Open` only validates the connection string we provided
- // it 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 = newDb.Ping()
- if err != nil {
- return nil, err
- }
-
- db = newDb
- }
-
- return db, nil
-}
diff --git a/internal/dbtest/dbtest.go b/internal/dbtest/dbtest.go
new file mode 100644
index 0000000..c53c04a
--- /dev/null
+++ b/internal/dbtest/dbtest.go
@@ -0,0 +1,24 @@
+package dbtest
+
+import (
+ "os"
+ "strconv"
+
+ "github.com/eugenetriguba/bolt/internal/configloader"
+)
+
+func NewTestConnectionConfig(driver string) (*configloader.ConnectionConfig, error) {
+ port, err := strconv.Atoi(os.Getenv("DB_PORT"))
+ if err != nil {
+ return nil, err
+ }
+
+ return &configloader.ConnectionConfig{
+ Driver: driver,
+ DBName: os.Getenv("DB_NAME"),
+ Host: os.Getenv("DB_HOST"),
+ Port: port,
+ User: os.Getenv("DB_USERNAME"),
+ Password: os.Getenv("DB_PASSWORD"),
+ }, nil
+}
diff --git a/internal/storage/storage.go b/internal/storage/storage.go
new file mode 100644
index 0000000..cd6e514
--- /dev/null
+++ b/internal/storage/storage.go
@@ -0,0 +1,40 @@
+package storage
+
+import (
+ "database/sql"
+ "fmt"
+
+ "github.com/eugenetriguba/bolt/internal/configloader"
+ _ "github.com/lib/pq"
+)
+
+// DBConnect to the database using the driver and connection
+// information.
+func DBConnect(driver string, connectionInfo string) (*sql.DB, error) {
+ db, err := sql.Open(driver, connectionInfo)
+ if err != nil {
+ return nil, err
+ }
+
+ // Note: `sql.Open` only validates the connection string we provided
+ // it 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, err
+ }
+
+ return db, nil
+}
+
+// DBConnectionString generates a properly formatted connection
+// string to be passed to a database management system to initiate
+// a connection. It uses the passed in configuration values to create
+// the string. Note that sslmode is always 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,
+ )
+}
diff --git a/internal/storage/storage_test.go b/internal/storage/storage_test.go
new file mode 100644
index 0000000..53f7b49
--- /dev/null
+++ b/internal/storage/storage_test.go
@@ -0,0 +1,76 @@
+package storage_test
+
+import (
+ "fmt"
+ "strings"
+ "testing"
+
+ "github.com/eugenetriguba/bolt/internal/configloader"
+ "github.com/eugenetriguba/bolt/internal/dbtest"
+ "github.com/eugenetriguba/bolt/internal/storage"
+)
+
+func TestDBConnectWithPostgres(t *testing.T) {
+ cfg, err := dbtest.NewTestConnectionConfig("postgres")
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ conn, err := storage.DBConnect(cfg.Driver, storage.DBConnectionString(cfg))
+ if err != nil {
+ t.Fatalf("could not connect to postgres db using %s: %s",
+ storage.DBConnectionString(cfg),
+ err,
+ )
+ }
+ defer conn.Close()
+
+ _, err = conn.Exec("SELECT 1;")
+ if err != nil {
+ t.Fatalf("could not execute query against postgres db: %s", err)
+ }
+}
+
+func TestDBConnectMalformedConnectionString(t *testing.T) {
+ _, err := storage.DBConnect("postgres", "pizza=123")
+ if err == nil || (err != nil && !strings.Contains(err.Error(), "connection refused")) {
+ t.Fatalf("expected connection error, got %s", err)
+ }
+}
+
+func TestDBConnectUnsupportedDriver(t *testing.T) {
+ cfg, err := dbtest.NewTestConnectionConfig("redis")
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ _, err = storage.DBConnect(cfg.Driver, storage.DBConnectionString(cfg))
+ if err == nil || (err != nil && !strings.Contains(err.Error(), `unknown driver "redis"`)) {
+ t.Fatalf("expected bad driver, got %s", err)
+ }
+}
+
+func TestDBConnectionString(t *testing.T) {
+ cfg := configloader.Config{
+ MigrationsDir: "",
+ Connection: configloader.ConnectionConfig{
+ Driver: "postgres",
+ Host: "db1",
+ Port: 5432,
+ User: "testuser",
+ Password: "supersecretpassword",
+ DBName: "testdb",
+ },
+ }
+ expectedConnectionString := fmt.Sprintf(
+ "host=%s port=%d user=%s password=%s dbname=%s sslmode=disable",
+ cfg.Connection.Host, cfg.Connection.Port, cfg.Connection.User,
+ cfg.Connection.Password, cfg.Connection.DBName,
+ )
+
+ cs := storage.DBConnectionString(&cfg.Connection)
+
+ if cs != expectedConnectionString {
+ t.Fatalf("Expected %s, got %s", expectedConnectionString, cs)
+ }
+}