Add validation for pgbouncer logfile #4280
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| // Copyright 2021 - 2025 Crunchy Data Solutions, Inc. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package validation | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "gotest.tools/v3/assert" | ||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| "github.com/crunchydata/postgres-operator/internal/testing/require" | ||
| v1 "github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1" | ||
| ) | ||
|
|
||
| func TestV1PGBouncerLogging(t *testing.T) { | ||
| ctx := context.Background() | ||
| cc := require.Kubernetes(t) | ||
| t.Parallel() | ||
|
|
||
| namespace := require.Namespace(t, cc) | ||
|
|
||
| base := v1.NewPostgresCluster() | ||
| base.Namespace = namespace.Name | ||
| base.Name = "pgbouncer-logging" | ||
| // required fields | ||
| require.UnmarshalInto(t, &base.Spec, `{ | ||
| postgresVersion: 16, | ||
| instances: [{ | ||
| dataVolumeClaimSpec: { | ||
| accessModes: [ReadWriteOnce], | ||
| resources: { requests: { storage: 1Mi } }, | ||
| }, | ||
| }], | ||
| }`) | ||
|
|
||
| assert.NilError(t, cc.Create(ctx, base.DeepCopy(), client.DryRunAll), | ||
| "expected this base to be valid") | ||
|
|
||
| t.Run("Can set logging on tmp with .log", func(t *testing.T) { | ||
| tmp := base.DeepCopy() | ||
|
|
||
| require.UnmarshalInto(t, &tmp.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/tmp/logs/pgbouncer/log.log" | ||
| } | ||
| } | ||
| } | ||
| }`) | ||
| assert.NilError(t, cc.Create(ctx, base.DeepCopy(), client.DryRunAll), | ||
| "expected this option to be valid") | ||
| }) | ||
|
|
||
| t.Run("Cannot set logging on tmp without .log", func(t *testing.T) { | ||
| tmp := base.DeepCopy() | ||
|
|
||
| require.UnmarshalInto(t, &tmp.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/tmp/logs/pgbouncer/log.txt" | ||
| } | ||
| } | ||
| } | ||
| }`) | ||
|
|
||
| err := cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll) | ||
| assert.Assert(t, apierrors.IsInvalid(err)) | ||
| assert.ErrorContains(t, err, "logfile config must end with '.log'") | ||
| }) | ||
|
|
||
| t.Run("Cannot set logging on tmp without correct subdir", func(t *testing.T) { | ||
| tmp := base.DeepCopy() | ||
|
|
||
| require.UnmarshalInto(t, &tmp.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/tmp/logs/log.log" | ||
| } | ||
| } | ||
| } | ||
| }`) | ||
|
|
||
| err := cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll) | ||
| assert.Assert(t, apierrors.IsInvalid(err)) | ||
| assert.ErrorContains(t, err, "logfile destination is restricted to '/tmp/logs/pgbouncer/' or an existing additional volume") | ||
|
|
||
| require.UnmarshalInto(t, &tmp.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/tmp/pgbouncer/log.log" | ||
| } | ||
| } | ||
| } | ||
| }`) | ||
|
|
||
| err = cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll) | ||
| assert.Assert(t, apierrors.IsInvalid(err)) | ||
| assert.ErrorContains(t, err, "logfile destination is restricted to '/tmp/logs/pgbouncer/' or an existing additional volume") | ||
| }) | ||
|
|
||
| t.Run("Cannot set logging on volumes that don't exist", func(t *testing.T) { | ||
| vol := base.DeepCopy() | ||
|
|
||
| require.UnmarshalInto(t, &vol.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/volumes/logging/log.log" | ||
| } | ||
| } | ||
| } | ||
| }`) | ||
|
|
||
| err := cc.Create(ctx, vol.DeepCopy(), client.DryRunAll) | ||
| assert.Assert(t, apierrors.IsInvalid(err)) | ||
| assert.ErrorContains(t, err, "logfile destination is restricted to '/tmp/logs/pgbouncer/' or an existing additional volume") | ||
| }) | ||
|
|
||
| t.Run("Cannot set logging elsewhere", func(t *testing.T) { | ||
| vol := base.DeepCopy() | ||
|
|
||
| require.UnmarshalInto(t, &vol.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/var/log.log" | ||
| } | ||
| } | ||
| } | ||
| }`) | ||
|
|
||
| err := cc.Create(ctx, vol.DeepCopy(), client.DryRunAll) | ||
| assert.Assert(t, apierrors.IsInvalid(err)) | ||
| assert.ErrorContains(t, err, "logfile destination is restricted to '/tmp/logs/pgbouncer/' or an existing additional volume") | ||
| }) | ||
|
|
||
| t.Run("Can set logging on volumes that exist", func(t *testing.T) { | ||
| vol := base.DeepCopy() | ||
|
|
||
| require.UnmarshalInto(t, &vol.Spec.Proxy, `{ | ||
| pgBouncer: { | ||
| config: { | ||
| global: { | ||
| logfile: "/volumes/logging/log.log" | ||
| } | ||
| }, | ||
| volumes: { | ||
| additional: [ | ||
| { | ||
| name: logging, | ||
| claimName: required-1 | ||
| }] | ||
| } | ||
| } | ||
| }`) | ||
|
|
||
| assert.NilError(t, cc.Create(ctx, vol.DeepCopy(), client.DryRunAll), | ||
| "expected this option to be valid") | ||
| }) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // Copyright 2021 - 2025 Crunchy Data Solutions, Inc. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package v1 | ||
|
|
||
| import ( | ||
| "github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1" | ||
| ) | ||
|
|
||
| // PGBouncerPodSpec defines the desired state of a PgBouncer connection pooler. | ||
| // +kubebuilder:validation:XValidation:rule=`self.?config.global.logfile.optMap(f, f.startsWith("/tmp/logs/pgbouncer/") || (self.?volumes.additional.hasValue() && self.volumes.additional.exists(v, f.startsWith("/volumes/" + v.name)))).orValue(true)`,message=`config.global.logfile destination is restricted to '/tmp/logs/pgbouncer/' or an existing additional volume` | ||
| type PGBouncerPodSpec struct { | ||
| v1beta1.PGBouncerPodSpec `json:",inline"` | ||
| } | ||
benjaminjb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missed this in an earlier PR re: OTEL handling user-set logfiles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch.