diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-01-06 11:15:53 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-01-06 11:15:53 -0500 |
| commit | 3d66d23b7f1f8d496711f01a164ac1d7717527ca (patch) | |
| tree | b4ce8a4deda41c57b1ab13ac4e89bfb9e6978cf0 /internal/storage | |
| parent | Add to changelog (diff) | |
| download | cli-3d66d23b7f1f8d496711f01a164ac1d7717527ca.zip | |
Add database integration tests
Diffstat (limited to 'internal/storage')
| -rw-r--r-- | internal/storage/storage.go | 40 | ||||
| -rw-r--r-- | internal/storage/storage_test.go | 76 |
2 files changed, 116 insertions, 0 deletions
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) + } +} |