Skip to content

K8SPS-464 set crVersion #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

K8SPS-464 set crVersion #985

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fbc6bda
K8SPS-464 set crVersion
nmarukovich Aug 6, 2025
9a1a7fc
fix test
nmarukovich Aug 6, 2025
fb74e75
Merge branch 'main' into K8SPS-464
nmarukovich Aug 6, 2025
03dce94
Merge branch 'main' into K8SPS-464
nmarukovich Aug 18, 2025
12b0057
Merge branch 'main' into K8SPS-464
nmarukovich Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions api/v1alpha1/perconaservermysql_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ import (

"github.com/percona/percona-server-mysql-operator/pkg/naming"
"github.com/percona/percona-server-mysql-operator/pkg/platform"
"github.com/percona/percona-server-mysql-operator/pkg/version"
)

const (
Expand Down Expand Up @@ -581,15 +580,6 @@ func (cr *PerconaServerMySQL) OrchestratorSpec() *OrchestratorSpec {
return &cr.Spec.Orchestrator
}

// SetVersion sets the CRVersion to the version value if it's not already set.
func (cr *PerconaServerMySQL) SetVersion() {
if len(cr.Spec.CRVersion) > 0 {
return
}

cr.Spec.CRVersion = version.Version()
}

// CheckNSetDefaults validates and sets default values for the PerconaServerMySQL custom resource.
func (cr *PerconaServerMySQL) CheckNSetDefaults(_ context.Context, serverVersion *platform.ServerVersion) error {
if len(cr.Spec.MySQL.ClusterType) == 0 {
Expand All @@ -600,8 +590,6 @@ func (cr *PerconaServerMySQL) CheckNSetDefaults(_ context.Context, serverVersion
return errors.Errorf("%s is not a valid clusterType, valid options are %s and %s", cr.Spec.MySQL.ClusterType, ClusterTypeGR, ClusterTypeAsync)
}

cr.SetVersion()

if cr.Spec.Backup == nil {
cr.Spec.Backup = new(BackupSpec)
}
Expand Down
4 changes: 4 additions & 0 deletions pkg/controller/ps/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,10 @@ func (r *PerconaServerMySQLReconciler) Reconcile(
return ctrl.Result{}, errors.Wrap(err, "get CR")
}

if err := r.setCRVersion(ctx, cr); err != nil {
return ctrl.Result{}, errors.Wrap(err, "set CR version")
}

if cr.ObjectMeta.DeletionTimestamp != nil {
log.Info("CR marked for deletion, applying finalizers", "name", cr.Name)
if err := r.applyFinalizers(ctx, cr); err != nil {
Expand Down
75 changes: 75 additions & 0 deletions pkg/controller/ps/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import (
psv1alpha1 "github.com/percona/percona-server-mysql-operator/api/v1alpha1"
"github.com/percona/percona-server-mysql-operator/pkg/mysql"
"github.com/percona/percona-server-mysql-operator/pkg/naming"
"github.com/percona/percona-server-mysql-operator/pkg/version"
)

var _ = Describe("Sidecars", Ordered, func() {
Expand Down Expand Up @@ -1067,3 +1068,77 @@ var _ = Describe("Primary mysql service", Ordered, func() {
})
})
})

var _ = Describe("CR Version Management", Ordered, func() {
ctx := context.Background()
const crName = "cr-version"
const ns = crName

namespace := &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: crName,
Namespace: ns,
},
}

BeforeAll(func() {
By("Creating the Namespace for CR version tests")
err := k8sClient.Create(ctx, namespace)
Expect(err).To(Not(HaveOccurred()))
})

AfterAll(func() {
By("Deleting the Namespace after CR version tests")
_ = k8sClient.Delete(ctx, namespace)
})

Context("setCRVersion logic", Ordered, func() {
When("the CRVersion is already set", func() {
It("should not change the CRVersion", func() {
cr, err := readDefaultCR("cr-version-1", ns)
Expect(err).NotTo(HaveOccurred())

cr.Spec.CRVersion = "0.11.0"
Expect(k8sClient.Create(ctx, cr)).Should(Succeed())

reconciler := &PerconaServerMySQLReconciler{Client: k8sClient}
err = reconciler.setCRVersion(ctx, cr)
Expect(err).NotTo(HaveOccurred())
Expect(cr.Spec.CRVersion).To(Equal("0.11.0"))
})
})

When("the CRVersion is empty", func() {
It("should set CRVersion and patch the resource", func() {
cr, err := readDefaultCR("cr-version-2", ns)
Expect(err).NotTo(HaveOccurred())

cr.Spec.CRVersion = ""
Expect(k8sClient.Create(ctx, cr)).Should(Succeed())

reconciler := &PerconaServerMySQLReconciler{Client: k8sClient}
err = reconciler.setCRVersion(ctx, cr)
Expect(err).NotTo(HaveOccurred())

// Fetch the CR again to verify the patch was applied in the cluster
updated := &psv1alpha1.PerconaServerMySQL{}
Expect(k8sClient.Get(ctx, types.NamespacedName{Name: cr.Name, Namespace: cr.Namespace}, updated)).Should(Succeed())
Expect(updated.Spec.CRVersion).To(Equal(version.Version()))
})
})

When("the patch operation fails", func() {
It("should return an error", func() {
cr, err := readDefaultCR("cr-version-3", ns)
Expect(err).NotTo(HaveOccurred())
cr.Spec.CRVersion = ""

// Do NOT create the CR in k8s, so Patch will fail (object does not exist)
reconciler := &PerconaServerMySQLReconciler{Client: k8sClient}
err = reconciler.setCRVersion(ctx, cr)
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("patch CR"))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it might be better to explicitly check that error is not found, it might be another error and we might miss it

})
})
})
})
21 changes: 21 additions & 0 deletions pkg/controller/ps/version.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
apiv1alpha1 "github.com/percona/percona-server-mysql-operator/api/v1alpha1"
"github.com/percona/percona-server-mysql-operator/pkg/k8s"
"github.com/percona/percona-server-mysql-operator/pkg/mysql"
"github.com/percona/percona-server-mysql-operator/pkg/version"
vs "github.com/percona/percona-server-mysql-operator/pkg/version/service"
)

Expand Down Expand Up @@ -194,3 +195,23 @@ func (r *PerconaServerMySQLReconciler) upgradeVersions(ctx context.Context, cr *
cr.Status.ToolkitVersion = version.ToolkitVersion
return nil
}

// setCRVersion sets operator version of PerconaServerMySQL.
// The new (semver-matching) version is determined by the CR's crVersion field.
// If the crVersion is an empty string, it sets the current operator version.
func (r *PerconaServerMySQLReconciler) setCRVersion(ctx context.Context, cr *apiv1alpha1.PerconaServerMySQL) error {
if len(cr.Spec.CRVersion) > 0 {
return nil
}

orig := cr.DeepCopy()
cr.Spec.CRVersion = version.Version()

if err := r.Patch(ctx, cr, client.MergeFrom(orig)); err != nil {
return errors.Wrap(err, "patch CR")
}

logf.FromContext(ctx).Info("Set CR version", "version", cr.Spec.CRVersion)

return nil
}
3 changes: 2 additions & 1 deletion pkg/controller/ps/version_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ func TestReconcileVersions(t *testing.T) {
Backup: &apiv1alpha1.BackupSpec{
Image: "some-image",
},
CRVersion: version.Version(),
MySQL: apiv1alpha1.MySQLSpec{
ClusterType: apiv1alpha1.ClusterTypeGR,
PodSpec: apiv1alpha1.PodSpec{
Expand Down Expand Up @@ -347,6 +348,7 @@ func TestGetVersion(t *testing.T) {
Backup: &apiv1alpha1.BackupSpec{
Image: "some-image",
},
CRVersion: version.Version(),
MySQL: apiv1alpha1.MySQLSpec{
ClusterType: apiv1alpha1.ClusterTypeGR,
PodSpec: apiv1alpha1.PodSpec{
Expand Down Expand Up @@ -429,7 +431,6 @@ func TestGetVersion(t *testing.T) {
if err != nil {
t.Fatal(err, "failed to get cr")
}

dv, err := vs.GetVersion(ctx, cr, fmt.Sprintf("http://%s:%d", addr, gwPort), r.ServerVersion)
if err != nil {
t.Fatal(err, "failed to get version")
Expand Down
Loading