fest: support reading the db address from the secret instead spec.address (#163)

raffis · web-flow · commit edde88306661 · 2025-03-31T12:28:05.000+02:00
* fest: support reading the db address from the secret instead spec.address

* x

* fix: addr field

* f

* fix: goreleaser config
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -11,7 +11,7 @@ builds:
 archives:
 - id: manager
   name_template: "manager_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
-  builds:
+  ids:
   - manager
 
 checksum:
diff --git a/api/v1beta1/database_types.go b/api/v1beta1/database_types.go
@@ -79,6 +79,10 @@ type SecretReference struct {
 	// +optional
 	// +kubebuilder:default:=password
 	PasswordField string `json:"passwordField"`
+
+	// +optional
+	// +kubebuilder:default:=address
+	AddressField string `json:"addressField"`
 }
 
 // conditionalResource is a resource with conditions
diff --git a/chart/db-controller/crds/dbprovisioning.infra.doodle.com_mongodbdatabases.yaml b/chart/db-controller/crds/dbprovisioning.infra.doodle.com_mongodbdatabases.yaml
@@ -63,6 +63,9 @@ spec:
                 description: Contains a credentials set of a user with enough permission
                   to manage databases and user accounts
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/chart/db-controller/crds/dbprovisioning.infra.doodle.com_mongodbusers.yaml b/chart/db-controller/crds/dbprovisioning.infra.doodle.com_mongodbusers.yaml
@@ -54,6 +54,9 @@ spec:
                 description: SecretReference is a named reference to a secret which
                   contains user credentials
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/chart/db-controller/crds/dbprovisioning.infra.doodle.com_postgresqldatabases.yaml b/chart/db-controller/crds/dbprovisioning.infra.doodle.com_postgresqldatabases.yaml
@@ -72,6 +72,9 @@ spec:
                 description: Contains a credentials set of a user with enough permission
                   to manage databases and user accounts
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/chart/db-controller/crds/dbprovisioning.infra.doodle.com_postgresqlusers.yaml b/chart/db-controller/crds/dbprovisioning.infra.doodle.com_postgresqlusers.yaml
@@ -54,6 +54,9 @@ spec:
                 description: SecretReference is a named reference to a secret which
                   contains user credentials
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/config/base/crd/bases/dbprovisioning.infra.doodle.com_mongodbdatabases.yaml b/config/base/crd/bases/dbprovisioning.infra.doodle.com_mongodbdatabases.yaml
@@ -63,6 +63,9 @@ spec:
                 description: Contains a credentials set of a user with enough permission
                   to manage databases and user accounts
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/config/base/crd/bases/dbprovisioning.infra.doodle.com_mongodbusers.yaml b/config/base/crd/bases/dbprovisioning.infra.doodle.com_mongodbusers.yaml
@@ -54,6 +54,9 @@ spec:
                 description: SecretReference is a named reference to a secret which
                   contains user credentials
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/config/base/crd/bases/dbprovisioning.infra.doodle.com_postgresqldatabases.yaml b/config/base/crd/bases/dbprovisioning.infra.doodle.com_postgresqldatabases.yaml
@@ -72,6 +72,9 @@ spec:
                 description: Contains a credentials set of a user with enough permission
                   to manage databases and user accounts
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/config/base/crd/bases/dbprovisioning.infra.doodle.com_postgresqlusers.yaml b/config/base/crd/bases/dbprovisioning.infra.doodle.com_postgresqlusers.yaml
@@ -54,6 +54,9 @@ spec:
                 description: SecretReference is a named reference to a secret which
                   contains user credentials
                 properties:
+                  addressField:
+                    default: address
+                    type: string
                   name:
                     description: Name referrs to the name of the secret, must be located
                       whithin the same namespace
diff --git a/config/tests/cases/mongodb/verify.sh b/config/tests/cases/mongodb/verify.sh
@@ -1,8 +1,8 @@
 #!/bin/sh
 
 set -e
-kubectl --context kind-$1 -n db-system wait mongodbdatabase --all --for=condition=DatabaseReady --timeout=1m
-kubectl --context kind-$1 -n db-system wait mongodbuser --all --for=condition=UserReady --timeout=1m
+kubectl --context kind-$1 -n db-system wait mongodbdatabase --all --for=condition=DatabaseReady --timeout=3m
+kubectl --context kind-$1 -n db-system wait mongodbuser --all --for=condition=UserReady --timeout=3m
 kubectl --context kind-$1 -n db-system exec -ti deployment/mongodb mongodb -- mongosh mongodb://localhost:27017/foo --authenticationDatabase=admin -u foo -p password --eval 'db.bar.insert({"foo":"bar"})'
 ! kubectl --context kind-$1 -n db-system exec -ti deployment/mongodb mongodb -- mongosh mongodb://localhost:27017/foo --authenticationDatabase=admin -u foo -p password --eval 'db.bar.insert({"foo":"bar"})'
 kubectl --context kind-$1 -n db-system delete -f ./config/tests/cases/mongodb/user.yaml
diff --git a/config/tests/cases/postgresql/verify.sh b/config/tests/cases/postgresql/verify.sh
@@ -2,8 +2,8 @@
 
 set -e
 
-kubectl --context kind-$1 -n db-system wait postgresqldatabase --all --for=condition=DatabaseReady --timeout=1m
-kubectl --context kind-$1 -n db-system wait postgresqluser --all --for=condition=UserReady --timeout=1m
+kubectl --context kind-$1 -n db-system wait postgresqldatabase --all --for=condition=DatabaseReady --timeout=3m
+kubectl --context kind-$1 -n db-system wait postgresqluser --all --for=condition=UserReady --timeout=3m
 kubectl --context kind-$1 -n db-system exec -ti sts/postgresql postgresql -- bash -c "PGPASSWORD=password psql -h localhost -U foo foo -c '\l'"
 ! kubectl -n postgresql exec -ti sts/postgresql postgresql -- bash -c "PGPASSWORD=password psql -h localhost -U foo foo -c '\l'"
 kubectl --context kind-$1  -n db-system delete -f ./config/tests/cases/postgresql/user.yaml
diff --git a/internal/controllers/common.go b/internal/controllers/common.go
@@ -45,10 +45,11 @@ func extractMongoDBUserRoles(roles []infrav1beta1.MongoDBUserRole) database.Mong
 	return list
 }
 
-func extractCredentials(credentials *infrav1beta1.SecretReference, secret *corev1.Secret) (string, string, error) {
+func extractCredentials(credentials *infrav1beta1.SecretReference, secret *corev1.Secret) (string, string, string, error) {
 	var (
 		user string
 		pw   string
+		addr string
 	)
 
 	userField := credentials.UserField
@@ -61,22 +62,31 @@ func extractCredentials(credentials *infrav1beta1.SecretReference, secret *corev
 		pwField = "password"
 	}
 
+	addrField := credentials.AddressField
+	if addrField == "" {
+		addrField = "address"
+	}
+
 	if val, ok := secret.Data[userField]; !ok {
-		return "", "", errors.New("defined username field not found in secret")
+		return "", "", "", errors.New("defined username field not found in secret")
 	} else {
 		user = string(val)
 	}
 
 	if val, ok := secret.Data[pwField]; !ok {
-		return "", "", errors.New("defined password field not found in secret")
+		return "", "", "", errors.New("defined password field not found in secret")
 	} else {
 		pw = string(val)
 	}
 
-	return user, pw, nil
+	if val, ok := secret.Data[addrField]; ok {
+		addr = string(val)
+	}
+
+	return user, pw, addr, nil
 }
 
-func setupAtlas(ctx context.Context, db infrav1beta1.MongoDBDatabase, pubKey, privKey string) (*database.AtlasRepository, error) {
+func setupAtlas(ctx context.Context, db infrav1beta1.MongoDBDatabase, pubKey, privKey, addr string) (*database.AtlasRepository, error) {
 	handler, err := database.NewAtlasRepository(ctx, database.AtlasOptions{
 		GroupID:    db.Spec.AtlasGroupId,
 		PrivateKey: privKey,
@@ -90,13 +100,17 @@ func setupAtlas(ctx context.Context, db infrav1beta1.MongoDBDatabase, pubKey, pr
 	return handler, nil
 }
 
-func setupPostgreSQL(ctx context.Context, db infrav1beta1.PostgreSQLDatabase, usr, pw string, switchDB bool) (*database.PostgreSQLRepository, error) {
+func setupPostgreSQL(ctx context.Context, db infrav1beta1.PostgreSQLDatabase, usr, pw, addr string, switchDB bool) (*database.PostgreSQLRepository, error) {
 	opts := database.PostgreSQLOptions{
-		URI:      db.Spec.Address,
+		URI:      addr,
 		Username: usr,
 		Password: pw,
 	}
 
+	if db.Spec.Address != "" {
+		opts.URI = db.Spec.Address
+	}
+
 	if switchDB {
 		opts.DatabaseName = db.GetDatabaseName()
 	}
@@ -110,14 +124,20 @@ func setupPostgreSQL(ctx context.Context, db infrav1beta1.PostgreSQLDatabase, us
 	return handler, nil
 }
 
-func setupMongoDB(ctx context.Context, db infrav1beta1.MongoDBDatabase, usr, pw string) (*database.MongoDBRepository, error) {
-	handler, err := database.NewMongoDBRepository(ctx, database.MongoDBOptions{
-		URI:              db.Spec.Address,
+func setupMongoDB(ctx context.Context, db infrav1beta1.MongoDBDatabase, usr, pw, addr string) (*database.MongoDBRepository, error) {
+	opts := database.MongoDBOptions{
+		URI:              addr,
 		AuthDatabaseName: db.GetRootDatabaseName(),
 		DatabaseName:     db.GetDatabaseName(),
 		Username:         usr,
 		Password:         pw,
-	})
+	}
+
+	if db.Spec.Address != "" {
+		opts.URI = db.Spec.Address
+	}
+
+	handler, err := database.NewMongoDBRepository(ctx, opts)
 
 	if err != nil {
 		return handler, fmt.Errorf("failed to setup connection to mongodb: %w", err)
@@ -126,7 +146,7 @@ func setupMongoDB(ctx context.Context, db infrav1beta1.MongoDBDatabase, usr, pw
 	return handler, nil
 }
 
-func getSecret(ctx context.Context, c client.Client, sec *infrav1beta1.SecretReference) (string, string, error) {
+func getSecret(ctx context.Context, c client.Client, sec *infrav1beta1.SecretReference) (string, string, string, error) {
 	// Fetch referencing root secret
 	secret := &corev1.Secret{}
 	secretName := types.NamespacedName{
@@ -137,13 +157,13 @@ func getSecret(ctx context.Context, c client.Client, sec *infrav1beta1.SecretRef
 
 	// Failed to fetch referenced secret, requeue immediately
 	if err != nil {
-		return "", "", fmt.Errorf("referencing secret was not found: %w", err)
+		return "", "", "", fmt.Errorf("referencing secret was not found: %w", err)
 	}
 
-	usr, pw, err := extractCredentials(sec, secret)
+	usr, pw, addr, err := extractCredentials(sec, secret)
 	if err != nil {
-		return usr, pw, fmt.Errorf("credentials field not found in referenced secret: %w", err)
+		return usr, pw, "", fmt.Errorf("credentials field not found in referenced secret: %w", err)
 	}
 
-	return usr, pw, err
+	return usr, pw, addr, err
 }
diff --git a/internal/controllers/mongodb_test.go b/internal/controllers/mongodb_test.go
@@ -1,19 +1,16 @@
 /*
-
-
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-
 package controllers
 
 import (
diff --git a/internal/controllers/mongodbdatabase_controller.go b/internal/controllers/mongodbdatabase_controller.go
@@ -169,14 +169,14 @@ func (r *MongoDBDatabaseReconciler) reconcileGenericDatabase(ctx context.Context
 }
 
 func (r *MongoDBDatabaseReconciler) reconcileAtlasDatabase(ctx context.Context, db infrav1beta1.MongoDBDatabase) (infrav1beta1.MongoDBDatabase, error) {
-	pubKey, privKey, err := getSecret(ctx, r.Client, db.GetRootSecret())
+	pubKey, privKey, addr, err := getSecret(ctx, r.Client, db.GetRootSecret())
 
 	if err != nil {
 		infrav1beta1.DatabaseNotReadyCondition(&db, infrav1beta1.CredentialsNotFoundReason, err.Error())
 		return db, err
 	}
 
-	dbHandler, err := setupAtlas(ctx, db, pubKey, privKey)
+	dbHandler, err := setupAtlas(ctx, db, pubKey, privKey, addr)
 
 	if err != nil {
 		infrav1beta1.DatabaseNotReadyCondition(&db, infrav1beta1.ConnectionFailedReason, err.Error())
diff --git a/internal/controllers/mongodbuser_controller.go b/internal/controllers/mongodbuser_controller.go
@@ -211,22 +211,22 @@ func (r *MongoDBUserReconciler) reconcile(ctx context.Context, user infrav1beta1
 
 func (r *MongoDBUserReconciler) reconcileGenericUser(ctx context.Context, user infrav1beta1.MongoDBUser, db infrav1beta1.MongoDBDatabase) (infrav1beta1.MongoDBUser, error) {
 	// Fetch referencing root secret
-	rootUsr, rootPw, err := getSecret(ctx, r.Client, db.GetRootSecret())
+	rootUsr, rootPw, _, err := getSecret(ctx, r.Client, db.GetRootSecret())
 
 	if err != nil {
 		infrav1beta1.UserNotReadyCondition(&user, infrav1beta1.CredentialsNotFoundReason, err.Error())
 		return user, err
 	}
 
 	// Fetch referencing secret
-	usr, pw, err := getSecret(ctx, r.Client, user.GetCredentials())
+	usr, pw, addr, err := getSecret(ctx, r.Client, user.GetCredentials())
 
 	if err != nil {
 		infrav1beta1.UserNotReadyCondition(&user, infrav1beta1.CredentialsNotFoundReason, err.Error())
 		return user, err
 	}
 
-	dbHandler, err := setupMongoDB(ctx, db, rootUsr, rootPw)
+	dbHandler, err := setupMongoDB(ctx, db, rootUsr, rootPw, addr)
 
 	if err != nil {
 		infrav1beta1.UserNotReadyCondition(&user, infrav1beta1.ConnectionFailedReason, err.Error())
@@ -253,22 +253,22 @@ func (r *MongoDBUserReconciler) reconcileGenericUser(ctx context.Context, user i
 
 func (r *MongoDBUserReconciler) reconcileAtlasUser(ctx context.Context, user infrav1beta1.MongoDBUser, db infrav1beta1.MongoDBDatabase) (infrav1beta1.MongoDBUser, error) {
 	// Fetch referencing root secret
-	pubKey, privKey, err := getSecret(ctx, r.Client, db.GetRootSecret())
+	pubKey, privKey, _, err := getSecret(ctx, r.Client, db.GetRootSecret())
 
 	if err != nil {
 		infrav1beta1.UserNotReadyCondition(&user, infrav1beta1.CredentialsNotFoundReason, err.Error())
 		return user, err
 	}
 
 	// Fetch referencing secret
-	usr, pw, err := getSecret(ctx, r.Client, user.GetCredentials())
+	usr, pw, addr, err := getSecret(ctx, r.Client, user.GetCredentials())
 
 	if err != nil {
 		infrav1beta1.UserNotReadyCondition(&user, infrav1beta1.CredentialsNotFoundReason, err.Error())
 		return user, err
 	}
 
-	dbHandler, err := setupAtlas(ctx, db, pubKey, privKey)
+	dbHandler, err := setupAtlas(ctx, db, pubKey, privKey, addr)
 
 	if err != nil {
 		infrav1beta1.UserNotReadyCondition(&user, infrav1beta1.ConnectionFailedReason, err.Error())
diff --git a/internal/controllers/postgresql_test.go b/internal/controllers/postgresql_test.go
@@ -72,11 +72,11 @@ func setupPostgreSQLContainer(ctx context.Context, image string) (*postgresqlCon
 
 var _ = Describe("PostgreSQL", func() {
 	const (
-		timeout  = time.Second * 10
+		timeout  = time.Second * 5
 		interval = time.Second * 1
 	)
 
-	for _, image := range []string{"postgres:12", "postgres:13", "postgres:14", "postgres:15"} {
+	for _, image := range []string{"postgres:13", "postgres:14", "postgres:15"} {
 		var _ = Describe(image, func() {
 			var (
 				container *postgresqlContainer
@@ -130,7 +130,7 @@ var _ = Describe("PostgreSQL", func() {
 				})
 			})
 
-			Describe("fails if datatabase root secret not found", Ordered, func() {
+			Describe("fails if database root secret not found", Ordered, func() {
 				var (
 					createdDB   *infrav1beta1.PostgreSQLDatabase
 					createdUser *infrav1beta1.PostgreSQLUser
diff --git a/internal/controllers/postgresqldatabase_controller.go b/internal/controllers/postgresqldatabase_controller.go
@@ -153,14 +153,14 @@ func (r *PostgreSQLDatabaseReconciler) Reconcile(ctx context.Context, req ctrl.R
 }
 
 func (r *PostgreSQLDatabaseReconciler) reconcile(ctx context.Context, db infrav1beta1.PostgreSQLDatabase) (infrav1beta1.PostgreSQLDatabase, error) {
-	usr, pw, err := getSecret(ctx, r.Client, db.GetRootSecret())
+	usr, pw, addr, err := getSecret(ctx, r.Client, db.GetRootSecret())
 
 	if err != nil {
 		infrav1beta1.DatabaseNotReadyCondition(&db, infrav1beta1.CredentialsNotFoundReason, err.Error())
 		return db, err
 	}
 
-	rootDBHandler, err := setupPostgreSQL(ctx, db, usr, pw, false)
+	rootDBHandler, err := setupPostgreSQL(ctx, db, usr, pw, addr, false)
 
 	if err != nil {
 		infrav1beta1.DatabaseNotReadyCondition(&db, infrav1beta1.ConnectionFailedReason, err.Error())
@@ -180,7 +180,7 @@ func (r *PostgreSQLDatabaseReconciler) reconcile(ctx context.Context, db infrav1
 		return db, err
 	}
 
-	dbHandler, err := setupPostgreSQL(ctx, db, usr, pw, true)
+	dbHandler, err := setupPostgreSQL(ctx, db, usr, pw, addr, true)
 
 	if err != nil {
 		infrav1beta1.DatabaseNotReadyCondition(&db, infrav1beta1.ConnectionFailedReason, err.Error())
diff --git a/internal/controllers/postgresqluser_controller.go b/internal/controllers/postgresqluser_controller.go
diff --git a/internal/database/mongodb.go b/internal/database/mongodb.go
diff --git a/internal/database/postgresql.go b/internal/database/postgresql.go
