TER-186 resolve panic when db password is not set (#83)

src/api/internal/config/defaults.yaml

@@ -19,7 +19,7 @@
 db:
   host: "localhost"      # db host name
   user: "postgres"       # db username
-  # password:            # db password no default, panic if not set.
+  password: ""           # db password no default, panic if not set.
   name: "cc_terrarium"   # database name
   port: 5432             # db port
   ssl_mode: false        # enable SSL mode

src/cli/internal/config/defaults.yaml

@@ -19,7 +19,7 @@
 db:
   host: "localhost"      # db host name
   user: "postgres"       # db username
-  # password:            # db password no default, panic if not set.
+  password: ""           # db password no default, panic if not set.
   name: "cc_terrarium"   # database name
   port: 5432             # db port
   ssl_mode: false        # enable SSL mode

src/pkg/db/dbhelper/connection.go

@@ -35,19 +35,26 @@ func Connect(dialector gorm.Dialector, options ...ConnOption) (*gorm.DB, error)
 	return db, err
 }
 
-// createDSN creates the DSN (Data Source Name) string for the database connection.
-func createDSN(host, user, password, dbName string, port int, sslMode bool) string {
+// createPostgresDSN creates the DSN (Data Source Name) string for the postgres database connection.
+func createPostgresDSN(host, user, password, dbName string, port int, sslMode bool) string {
 	sslModeStr := "disable"
 	if sslMode {
 		sslModeStr = "enable"
 	}
 
-	return fmt.Sprintf("host=%s user=%s password=%s dbname=%s port=%d sslmode=%s", host, user, password, dbName, port, sslModeStr)
+	passwordStr := ""
+	if password != "" {
+		// omitting the password block when not set, allows the library to look at
+		// other standard sources like `~/.pgpass`
+		passwordStr = "password=" + password
+	}
+
+	return fmt.Sprintf("host=%s user=%s %s dbname=%s port=%d sslmode=%s", host, user, passwordStr, dbName, port, sslModeStr)
 }
 
 // ConnectPG establishes a connection to a postgres database using the provided connection parameters.
 func ConnectPG(host, user, password, dbName string, port int, sslMode bool, options ...ConnOption) (*gorm.DB, error) {
-	dsn := createDSN(host, user, password, dbName, port, sslMode)
+	dsn := createPostgresDSN(host, user, password, dbName, port, sslMode)
 	return Connect(postgres.Open(dsn), options...)
 }
 

src/pkg/db/dbhelper/connection_test.go

@@ -46,11 +46,21 @@ func TestCreateDSN(t *testing.T) {
 			sslMode:  true,
 			expected: "host=localhost user=test password=test dbname=test port=5432 sslmode=enable",
 		},
+		{
+			name:     "no password",
+			host:     "localhost",
+			user:     "test",
+			password: "",
+			dbName:   "test",
+			port:     5432,
+			sslMode:  true,
+			expected: "host=localhost user=test  dbname=test port=5432 sslmode=enable",
+		},
 	}
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			dsn := createDSN(tc.host, tc.user, tc.password, tc.dbName, tc.port, tc.sslMode)
+			dsn := createPostgresDSN(tc.host, tc.user, tc.password, tc.dbName, tc.port, tc.sslMode)
 			assert.Equal(t, tc.expected, dsn)
 		})
 	}