K8SPSMDB-1562: fix creation of nonvoting hookscript#2200
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes an issue with the creation of nonvoting hookscript ConfigMap names by ensuring they are lowercase. The problem likely arises because Kubernetes resource names (including ConfigMaps) must be lowercase, and the ComponentNonVoting constant is "nonVoting" with camelCase, which would produce invalid ConfigMap names when used in the hookscript name.
Changes:
- Added
strings.ToLower()wrapper toHookScriptConfigMapNamefunction to ensure ConfigMap names are always lowercase
Comments suppressed due to low confidence (1)
pkg/naming/naming.go:86
- The
MongosHookScriptConfigMapNameandPBMHookScriptConfigMapNamefunctions should also applystrings.ToLower()to ensure consistency withHookScriptConfigMapNameand to guarantee Kubernetes-compliant lowercase names in casecr.Nameor components contain uppercase characters.
func MongosHookScriptConfigMapName(cr *psmdbv1.PerconaServerMongoDB) string {
return fmt.Sprintf("%s-%s-hookscript", cr.Name, ComponentMongos)
}
func PBMHookScriptConfigMapName(cr *psmdbv1.PerconaServerMongoDB) string {
return fmt.Sprintf("%s-pbm-hookscript", cr.Name)
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pooknull
requested review from
egegunes,
gkech,
hors,
mayankshah1607,
nmarukovich and
oksana-grishchenko
as code owners
mayankshah1607
approved these changes
Jan 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
pkg/naming/naming.go:82
- The
MongosHookScriptConfigMapNamefunction should also applystrings.ToLower()for consistency withHookScriptConfigMapName. WhileComponentMongosis already lowercase,cr.Namecould theoretically contain uppercase characters in edge cases, and applying lowercase conversion would make the function more defensive and consistent with the fix applied toHookScriptConfigMapName.
func MongosHookScriptConfigMapName(cr *psmdbv1.PerconaServerMongoDB) string {
return fmt.Sprintf("%s-%s-hookscript", cr.Name, ComponentMongos)
}
pkg/naming/naming.go:86
- The
PBMHookScriptConfigMapNamefunction should also applystrings.ToLower()for consistency withHookScriptConfigMapName. While 'pbm' is already lowercase,cr.Namecould theoretically contain uppercase characters in edge cases, and applying lowercase conversion would make the function more defensive and consistent with the fix applied toHookScriptConfigMapName.
func PBMHookScriptConfigMapName(cr *psmdbv1.PerconaServerMongoDB) string {
return fmt.Sprintf("%s-pbm-hookscript", cr.Name)
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
egegunes
approved these changes
Jan 16, 2026
gkech
reviewed
Jan 16, 2026
| func HookScriptConfigMapName(cr *psmdbv1.PerconaServerMongoDB, rs *psmdbv1.ReplsetSpec, component string) string { | ||
| if rs == nil { | ||
| return fmt.Sprintf("%s-%s-hookscript", cr.Name, component) | ||
| return strings.ToLower(fmt.Sprintf("%s-%s-hookscript", cr.Name, component)) |
Contributor
There was a problem hiding this comment.
let's add a unit test for this given that we had an issue:
package naming
import (
"testing"
psmdbv1 "github.com/percona/percona-server-mongodb-operator/pkg/apis/psmdb/v1"
"github.com/stretchr/testify/assert"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func TestHookScriptConfigMapName(t *testing.T) {
tests := map[string]struct {
cr *psmdbv1.PerconaServerMongoDB
rs *psmdbv1.ReplsetSpec
component string
expected string
}{
"rs is nil": {
cr: &psmdbv1.PerconaServerMongoDB{
ObjectMeta: metav1.ObjectMeta{
Name: "my-cluster",
},
},
component: "mongos",
expected: "my-cluster-mongos-hookscript",
},
"rs is not nil": {
cr: &psmdbv1.PerconaServerMongoDB{
ObjectMeta: metav1.ObjectMeta{
Name: "my-cluster",
},
},
rs: &psmdbv1.ReplsetSpec{
Name: "rs0",
},
component: "mongod",
expected: "my-cluster-rs0-mongod-hookscript",
},
"mixed case cr name - should be lowercased": {
cr: &psmdbv1.PerconaServerMongoDB{
ObjectMeta: metav1.ObjectMeta{
Name: "My-Cluster",
},
},
rs: nil,
component: "MONGOS",
expected: "my-cluster-mongos-hookscript",
},
"mixed case with rs - should be lowercased": {
cr: &psmdbv1.PerconaServerMongoDB{
ObjectMeta: metav1.ObjectMeta{
Name: "My-Cluster",
},
},
rs: &psmdbv1.ReplsetSpec{
Name: "RS0",
},
component: "NonVoting",
expected: "my-cluster-rs0-nonvoting-hookscript",
},
}
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
got := HookScriptConfigMapName(tt.cr, tt.rs, tt.component)
assert.Equal(t, tt.expected, got)
})
}
}
Collaborator
commit: 9fe54ad |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://perconadev.atlassian.net/browse/K8SPSMDB-1562
DESCRIPTION
Problem:
Operator fails to deploy a cluster when
.nonVoting.hookscript.scriptis specified:Cause:
The
HookScriptConfigMapNamefunction generates a hook script name using the component label value. For non-voting pods, this value isnonVoting, which contains an uppercase letter.Solution:
Force the
HookScriptConfigMapNamefunction to return a lowercase nameCHECKLIST
Jira
Needs Doc) and QA (Needs QA)?Tests
compare/*-oc.yml)?Config/Logging/Testability