|
| 1 | +// SPDX-License-Identifier: Apache-2.0 |
| 2 | + |
| 3 | +package main |
| 4 | + |
| 5 | +import ( |
| 6 | + "context" |
| 7 | + "encoding/json" |
| 8 | + "strings" |
| 9 | + "testing" |
| 10 | + "time" |
| 11 | + |
| 12 | + helmv2 "github.com/fluxcd/helm-controller/api/v2" |
| 13 | + corev1 "k8s.io/api/core/v1" |
| 14 | + apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" |
| 15 | + apierrors "k8s.io/apimachinery/pkg/api/errors" |
| 16 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 17 | + "k8s.io/apimachinery/pkg/runtime" |
| 18 | + "k8s.io/apimachinery/pkg/types" |
| 19 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 20 | + "sigs.k8s.io/controller-runtime/pkg/client/fake" |
| 21 | + |
| 22 | + appsv1alpha1 "github.com/cozystack/cozystack/pkg/apis/apps/v1alpha1" |
| 23 | + corev1alpha1 "github.com/cozystack/cozystack/pkg/apis/core/v1alpha1" |
| 24 | + "github.com/cozystack/cozystack/pkg/credentials/account" |
| 25 | + "github.com/cozystack/cozystack/pkg/credentials/format" |
| 26 | +) |
| 27 | + |
| 28 | +func newMigrator(t *testing.T, objs ...client.Object) *migrator { |
| 29 | + t.Helper() |
| 30 | + scheme := runtime.NewScheme() |
| 31 | + if err := corev1.AddToScheme(scheme); err != nil { |
| 32 | + t.Fatal(err) |
| 33 | + } |
| 34 | + if err := helmv2.AddToScheme(scheme); err != nil { |
| 35 | + t.Fatal(err) |
| 36 | + } |
| 37 | + c := fake.NewClientBuilder().WithScheme(scheme).WithObjects(objs...).WithStatusSubresource(&helmv2.HelmRelease{}).Build() |
| 38 | + o := &options{ |
| 39 | + migration: 60, kind: "Postgres", formatName: format.ScramSHA256, accountsPath: "users", |
| 40 | + labels: labelFlags{"cnpg.io/reload": "true"}, sourceSuffix: "-credentials", |
| 41 | + stateNamespace: "cozy-system", actor: "migration", timeout: -time.Second, |
| 42 | + } |
| 43 | + return &migrator{c: c, o: o, now: func() time.Time { return time.Date(2026, 10, 14, 12, 0, 0, 0, time.UTC) }} |
| 44 | +} |
| 45 | + |
| 46 | +func release(values string, chartVersion string, ready bool) *helmv2.HelmRelease { |
| 47 | + hr := &helmv2.HelmRelease{ |
| 48 | + ObjectMeta: metav1.ObjectMeta{Name: "postgres-orders", Namespace: "tenant-foo", UID: "hr-uid", Labels: map[string]string{ |
| 49 | + appsv1alpha1.ApplicationGroupLabel: appsv1alpha1.GroupName, |
| 50 | + appsv1alpha1.ApplicationKindLabel: "Postgres", |
| 51 | + appsv1alpha1.ApplicationNameLabel: "orders", |
| 52 | + }}, |
| 53 | + Spec: helmv2.HelmReleaseSpec{Values: &apiextv1.JSON{Raw: []byte(values)}}, |
| 54 | + } |
| 55 | + if chartVersion != "" { |
| 56 | + hr.Status.History = helmv2.Snapshots{{Version: 1, ChartVersion: chartVersion, Status: "deployed"}} |
| 57 | + } |
| 58 | + if ready { |
| 59 | + hr.Status.Conditions = []metav1.Condition{{Type: "Ready", Status: metav1.ConditionTrue, Reason: "x", LastTransitionTime: metav1.Now()}} |
| 60 | + } |
| 61 | + return hr |
| 62 | +} |
| 63 | + |
| 64 | +func sourceSecret(data map[string]string) *corev1.Secret { |
| 65 | + sec := &corev1.Secret{ObjectMeta: metav1.ObjectMeta{Name: "postgres-orders-credentials", Namespace: "tenant-foo"}, Data: map[string][]byte{}} |
| 66 | + for k, v := range data { |
| 67 | + sec.Data[k] = []byte(v) |
| 68 | + } |
| 69 | + return sec |
| 70 | +} |
| 71 | + |
| 72 | +func (m *migrator) secret(t *testing.T, name string) (*corev1.Secret, bool) { |
| 73 | + t.Helper() |
| 74 | + sec := &corev1.Secret{} |
| 75 | + err := m.c.Get(context.Background(), types.NamespacedName{Namespace: "tenant-foo", Name: name}, sec) |
| 76 | + if apierrors.IsNotFound(err) { |
| 77 | + return nil, false |
| 78 | + } |
| 79 | + if err != nil { |
| 80 | + t.Fatal(err) |
| 81 | + } |
| 82 | + return sec, true |
| 83 | +} |
| 84 | + |
| 85 | +func TestSeedRecordsAndMigrates(t *testing.T) { |
| 86 | + ctx := context.Background() |
| 87 | + m := newMigrator(t, release(`{"users":{"web":{},"Api.1":{}}}`, "0.1.0", true), sourceSecret(map[string]string{"web": "hunter2", "Api.1": "secret"})) |
| 88 | + if err := m.seed(ctx); err != nil { |
| 89 | + t.Fatal(err) |
| 90 | + } |
| 91 | + st, err := m.loadState(ctx) |
| 92 | + if err != nil { |
| 93 | + t.Fatal(err) |
| 94 | + } |
| 95 | + rec := st.Releases["tenant-foo/postgres-orders"] |
| 96 | + if rec == nil || rec.ChartVersion != "0.1.0" || rec.Done || len(st.Skipped) != 0 { |
| 97 | + t.Fatalf("state = %+v", st) |
| 98 | + } |
| 99 | + for _, c := range []struct{ secret, user, plain string }{{"postgres-orders.web.account", "web", "hunter2"}, {"postgres-orders.api-1.account", "Api.1", "secret"}} { |
| 100 | + sec, ok := m.secret(t, c.secret) |
| 101 | + if !ok { |
| 102 | + t.Fatalf("%s not written", c.secret) |
| 103 | + } |
| 104 | + if string(sec.Data[account.UsernameKey]) != c.user || !strings.HasPrefix(string(sec.Data[account.PasswordKey]), "SCRAM-SHA-256$4096:") { |
| 105 | + t.Fatalf("%s data = %q", c.secret, sec.Data) |
| 106 | + } |
| 107 | + if strings.Contains(string(sec.Data[account.PasswordKey]), c.plain) { |
| 108 | + t.Fatal("the plaintext must not be stored") |
| 109 | + } |
| 110 | + if sec.Labels["cnpg.io/reload"] != "true" || sec.Labels[account.AccountLabel] != "true" || len(sec.OwnerReferences) != 1 || sec.OwnerReferences[0].UID != "hr-uid" { |
| 111 | + t.Fatalf("%s meta = %+v", c.secret, sec.ObjectMeta) |
| 112 | + } |
| 113 | + r := account.ReadRecord(sec) |
| 114 | + if r.Origin != corev1alpha1.CredentialOriginMigrated || r.By != "migration" || len(r.History) != 1 || r.History[0].Operation != corev1alpha1.CredentialOperationMigrate { |
| 115 | + t.Fatalf("%s record = %+v", c.secret, r) |
| 116 | + } |
| 117 | + } |
| 118 | + // A second run keeps what it wrote. |
| 119 | + before, _ := m.secret(t, "postgres-orders.web.account") |
| 120 | + if err := m.seed(ctx); err != nil { |
| 121 | + t.Fatal(err) |
| 122 | + } |
| 123 | + after, _ := m.secret(t, "postgres-orders.web.account") |
| 124 | + if string(after.Data[account.PasswordKey]) != string(before.Data[account.PasswordKey]) { |
| 125 | + t.Fatal("seed must be idempotent") |
| 126 | + } |
| 127 | +} |
| 128 | + |
| 129 | +func TestSeedLeavesOutUnresolvableAndRecordsMissingSource(t *testing.T) { |
| 130 | + ctx := context.Background() |
| 131 | + colliding := release(`{"users":{"web_app":{},"web-app":{}}}`, "0.1.0", true) |
| 132 | + m := newMigrator(t, colliding) |
| 133 | + if err := m.seed(ctx); err != nil { |
| 134 | + t.Fatal(err) |
| 135 | + } |
| 136 | + st, _ := m.loadState(ctx) |
| 137 | + if why := st.Skipped["tenant-foo/postgres-orders"]; !strings.Contains(why, "both map to the name") { |
| 138 | + t.Fatalf("skipped = %v", st.Skipped) |
| 139 | + } |
| 140 | + evs := &corev1.EventList{} |
| 141 | + if err := m.c.List(ctx, evs, client.InNamespace("tenant-foo")); err != nil || len(evs.Items) != 1 || evs.Items[0].Reason != reasonSkipped { |
| 142 | + t.Fatalf("events = %+v err=%v", evs.Items, err) |
| 143 | + } |
| 144 | + |
| 145 | + // No source Secret: recorded, nothing seeded, not skipped. |
| 146 | + m = newMigrator(t, release(`{"users":{"web":{}}}`, "0.1.0", true)) |
| 147 | + if err := m.seed(ctx); err != nil { |
| 148 | + t.Fatal(err) |
| 149 | + } |
| 150 | + st, _ = m.loadState(ctx) |
| 151 | + if st.Releases["tenant-foo/postgres-orders"] == nil || len(st.Skipped) != 0 { |
| 152 | + t.Fatalf("state = %+v", st) |
| 153 | + } |
| 154 | + if _, ok := m.secret(t, "postgres-orders.web.account"); ok { |
| 155 | + t.Fatal("nothing to seed from") |
| 156 | + } |
| 157 | +} |
| 158 | + |
| 159 | +func TestFinishWaitsForTheSwitchThenStripsAndRetires(t *testing.T) { |
| 160 | + ctx := context.Background() |
| 161 | + hr := release(`{"users":{"web":{"password":"leftover"}},"size":"10Gi"}`, "0.1.0", true) |
| 162 | + m := newMigrator(t, hr, sourceSecret(map[string]string{"web": "hunter2"})) |
| 163 | + if err := m.seed(ctx); err != nil { |
| 164 | + t.Fatal(err) |
| 165 | + } |
| 166 | + // Still on the recorded chart version: left out, reported, state kept. |
| 167 | + err := m.finish(ctx) |
| 168 | + if err == nil || !strings.Contains(err.Error(), "1 release(s) left out") { |
| 169 | + t.Fatalf("finish on an unswitched release: %v", err) |
| 170 | + } |
| 171 | + if _, ok := m.secret(t, "postgres-orders-credentials"); !ok { |
| 172 | + t.Fatal("the source must survive until the chart has switched") |
| 173 | + } |
| 174 | + |
| 175 | + // Switched and Ready. |
| 176 | + cur := &helmv2.HelmRelease{} |
| 177 | + if err := m.c.Get(ctx, client.ObjectKeyFromObject(hr), cur); err != nil { |
| 178 | + t.Fatal(err) |
| 179 | + } |
| 180 | + cur.Status.History = helmv2.Snapshots{{Version: 2, ChartVersion: "0.2.0", Status: "deployed"}} |
| 181 | + if err := m.c.Status().Update(ctx, cur); err != nil { |
| 182 | + t.Fatal(err) |
| 183 | + } |
| 184 | + if err := m.finish(ctx); err != nil { |
| 185 | + t.Fatal(err) |
| 186 | + } |
| 187 | + st, _ := m.loadState(ctx) |
| 188 | + if rec := st.Releases["tenant-foo/postgres-orders"]; rec == nil || !rec.Done || len(st.Skipped) != 0 { |
| 189 | + t.Fatalf("state = %+v", st) |
| 190 | + } |
| 191 | + if err := m.c.Get(ctx, client.ObjectKeyFromObject(hr), cur); err != nil { |
| 192 | + t.Fatal(err) |
| 193 | + } |
| 194 | + var values map[string]any |
| 195 | + if err := json.Unmarshal(cur.Spec.Values.Raw, &values); err != nil { |
| 196 | + t.Fatal(err) |
| 197 | + } |
| 198 | + if _, has := values["users"].(map[string]any)["web"].(map[string]any)["password"]; has || values["size"] != "10Gi" { |
| 199 | + t.Fatalf("values = %v", values) |
| 200 | + } |
| 201 | + if _, ok := m.secret(t, "postgres-orders-credentials"); ok { |
| 202 | + t.Fatal("the source Secret of a kind without platform accounts must be deleted") |
| 203 | + } |
| 204 | + if _, ok := m.secret(t, "postgres-orders.web.account"); !ok { |
| 205 | + t.Fatal("the account Secret must stay") |
| 206 | + } |
| 207 | +} |
| 208 | + |
| 209 | +func TestRetireSourceKeepsPlatformKeys(t *testing.T) { |
| 210 | + ctx := context.Background() |
| 211 | + hr := release(`{"users":{"web":{}}}`, "0.1.0", true) |
| 212 | + m := newMigrator(t, hr, sourceSecret(map[string]string{"web": "hunter2", "root": "toor"})) |
| 213 | + m.o.platformKeys = stringFlags{"root"} |
| 214 | + if err := m.retireSource(ctx, hr); err != nil { |
| 215 | + t.Fatal(err) |
| 216 | + } |
| 217 | + sec, ok := m.secret(t, "postgres-orders-credentials") |
| 218 | + if !ok || string(sec.Data["root"]) != "toor" || len(sec.Data) != 1 { |
| 219 | + t.Fatalf("source = %v", sec) |
| 220 | + } |
| 221 | +} |
0 commit comments