Validate cross-referenced parameters between PostgresCluster and PostgresClusterClass #1858
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,32 +17,119 @@ limitations under the License. | |
| package webhook | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strconv" | ||
|
|
||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
| "k8s.io/apimachinery/pkg/util/validation/field" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| enterpriseApi "github.com/splunk/splunk-operator/api/v4" | ||
| core "github.com/splunk/splunk-operator/pkg/postgresql/cluster/core" | ||
| ) | ||
|
|
||
| // ValidatePostgresClusterCreate validates a PostgresCluster on CREATE. | ||
| func ValidatePostgresClusterCreate(obj *enterpriseApi.PostgresCluster, reader client.Reader) field.ErrorList { | ||
| var allErrs field.ErrorList | ||
|
|
||
| if len(obj.Spec.PgHBA) > 0 { | ||
| pgHBAPath := field.NewPath("spec").Child("pgHBA") | ||
| for _, re := range core.ValidateRules(obj.Spec.PgHBA) { | ||
| allErrs = append(allErrs, field.Invalid( | ||
| pgHBAPath.Index(re.Index), | ||
| obj.Spec.PgHBA[re.Index], | ||
| re.Message)) | ||
| } | ||
| } | ||
|
|
||
| if reader != nil { | ||
|
Collaborator
There was a problem hiding this comment. could you elab why we expect some reader to validate against class logic? |
||
| allErrs = append(allErrs, validateAgainstClass(obj, reader)...) | ||
| } | ||
|
|
||
| return allErrs | ||
| } | ||
|
|
||
| // ValidatePostgresClusterUpdate validates a PostgresCluster on UPDATE. | ||
| func ValidatePostgresClusterUpdate(obj, oldObj *enterpriseApi.PostgresCluster, reader client.Reader) field.ErrorList { | ||
|
Author
There was a problem hiding this comment. yes, we don't care about oldObj |
||
| return ValidatePostgresClusterCreate(obj, reader) | ||
| } | ||
|
|
||
| func validateAgainstClass(obj *enterpriseApi.PostgresCluster, reader client.Reader) field.ErrorList { | ||
| var allErrs field.ErrorList | ||
|
|
||
| class := &enterpriseApi.PostgresClusterClass{} | ||
| if err := reader.Get(context.Background(), client.ObjectKey{Name: obj.Spec.Class}, class); err != nil { | ||
| classPath := field.NewPath("spec").Child("class") | ||
| if apierrors.IsNotFound(err) { | ||
| allErrs = append(allErrs, field.Invalid(classPath, obj.Spec.Class, | ||
| "referenced PostgresClusterClass not found")) | ||
| } else { | ||
| allErrs = append(allErrs, field.InternalError(classPath, | ||
| fmt.Errorf("failed to look up PostgresClusterClass %q: %w", obj.Spec.Class, err))) | ||
| } | ||
| return allErrs | ||
| } | ||
|
Comment on lines
+61
to
+72
There was a problem hiding this comment.
|
||
|
|
||
| merged, err := core.GetMergedConfig(class, obj) | ||
| if err != nil { | ||
| specPath := field.NewPath("spec") | ||
| if merged == nil || merged.Spec.Instances == nil { | ||
| allErrs = append(allErrs, field.Required(specPath.Child("instances"), | ||
| "must be set in PostgresCluster or PostgresClusterClass")) | ||
| } | ||
| if merged == nil || merged.Spec.PostgresVersion == nil { | ||
| allErrs = append(allErrs, field.Required(specPath.Child("postgresVersion"), | ||
| "must be set in PostgresCluster or PostgresClusterClass")) | ||
| } | ||
| if merged == nil || merged.Spec.Storage == nil { | ||
| allErrs = append(allErrs, field.Required(specPath.Child("storage"), | ||
| "must be set in PostgresCluster or PostgresClusterClass")) | ||
| } | ||
| return allErrs | ||
| } | ||
|
|
||
| if classConfig := class.Spec.Config; classConfig != nil { | ||
| // Class version acts as a minimum floor for compliance; clusters may override higher but not lower. | ||
| if obj.Spec.PostgresVersion != nil && classConfig.PostgresVersion != nil { | ||
| clusterMajor, clusterMinor := parseVersion(*obj.Spec.PostgresVersion) | ||
| classMajor, classMinor := parseVersion(*classConfig.PostgresVersion) | ||
| if clusterMajor > 0 && classMajor > 0 { | ||
| versionTooLow := clusterMajor < classMajor || | ||
| (clusterMajor == classMajor && classMinor >= 0 && clusterMinor >= 0 && clusterMinor < classMinor) | ||
| if versionTooLow { | ||
| allErrs = append(allErrs, field.Invalid( | ||
| field.NewPath("spec").Child("postgresVersion"), | ||
| *obj.Spec.PostgresVersion, | ||
| "postgresVersion cannot be lower than class default ("+*classConfig.PostgresVersion+")")) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| poolerEnabled := (obj.Spec.ConnectionPoolerEnabled != nil && *obj.Spec.ConnectionPoolerEnabled) || | ||
| (obj.Spec.ConnectionPoolerEnabled == nil && classConfig.ConnectionPoolerEnabled != nil && *classConfig.ConnectionPoolerEnabled) | ||
| if poolerEnabled && (class.Spec.CNPG == nil || class.Spec.CNPG.ConnectionPooler == nil) { | ||
| allErrs = append(allErrs, field.Invalid( | ||
| field.NewPath("spec").Child("connectionPoolerEnabled"), | ||
| true, | ||
| "connection pooler requires cnpg.connectionPooler configuration in PostgresClusterClass")) | ||
| } | ||
| } | ||
|
|
||
| _ = merged | ||
| return allErrs | ||
| } | ||
|
|
||
| func parseVersion(version string) (major, minor int) { | ||
| for i, ch := range version { | ||
| if ch == '.' { | ||
| major, _ = strconv.Atoi(version[:i]) | ||
| minor, _ = strconv.Atoi(version[i+1:]) | ||
| return major, minor | ||
| } | ||
| } | ||
| major, _ = strconv.Atoi(version) | ||
| return major, -1 | ||
|
Comment on lines
+123
to
+132
There was a problem hiding this comment. Do we need to check for minor at all? I mean, we are allowed to downgrade minor version, don't we?
Author
There was a problem hiding this comment. resolved, #1858 (comment), downgrading while being alligned with version set in class is allowed. |
||
| } | ||
|
|
||
| // GetPostgresClusterWarningsOnCreate returns warnings for PostgresCluster CREATE. | ||
|
|
||
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.
The new tests cover the happy path well, but they mostly assert error count/field or Allowed. I’d add message assertions for the unit tests and one update-path integration case for the cross-resource checks, so semantic regressions in the comparison logic are easier to catch.
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.
done