Skip to content

Commit 606e66b

Browse files
liggittnyodas
liggitt
authored and
nyodas
committed
Add unit test detecting spurious statefulset rollout
1 parent 6b2856c commit 606e66b

File tree

6 files changed

+406
-1
lines changed

6 files changed

+406
-1
lines changed

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ require (
118118
k8s.io/sample-apiserver v0.0.0
119119
k8s.io/system-validators v1.10.1
120120
k8s.io/utils v0.0.0-20250604170112-4c0f3b243397
121+
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8
121122
sigs.k8s.io/knftables v0.0.17
122123
sigs.k8s.io/randfill v1.0.0
123124
sigs.k8s.io/structured-merge-diff/v6 v6.3.0
@@ -217,7 +218,6 @@ require (
217218
gopkg.in/yaml.v3 v3.0.1 // indirect
218219
k8s.io/gengo/v2 v2.0.0-20250604051438-85fd79dbfd9f // indirect
219220
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.31.2 // indirect
220-
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
221221
sigs.k8s.io/kustomize/api v0.20.1 // indirect
222222
sigs.k8s.io/kustomize/kustomize/v5 v5.7.1 // indirect
223223
sigs.k8s.io/kustomize/kyaml v0.20.1 // indirect

‎pkg/controller/statefulset/stateful_set_compatibility_test.go‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
/*
2+
Copyright 2025 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package statefulset
18+
19+
import (
20+
"os"
21+
"reflect"
22+
"testing"
23+
24+
"github.com/google/go-cmp/cmp"
25+
"sigs.k8s.io/json"
26+
27+
appsv1 "k8s.io/api/apps/v1"
28+
"k8s.io/apimachinery/pkg/runtime"
29+
"k8s.io/client-go/kubernetes/fake"
30+
"k8s.io/kubernetes/pkg/api/legacyscheme"
31+
)
32+
33+
func TestStatefulSetCompatibility(t *testing.T) {
34+
set133 := &appsv1.StatefulSet{}
35+
set134 := &appsv1.StatefulSet{}
36+
rev133 := &appsv1.ControllerRevision{}
37+
rev134 := &appsv1.ControllerRevision{}
38+
load(t, "compatibility_set_1.33.0.json", set133)
39+
load(t, "compatibility_set_1.34.0.json", set134)
40+
load(t, "compatibility_revision_1.33.0.json", rev133)
41+
load(t, "compatibility_revision_1.34.0.json", rev134)
42+
43+
testcases := []struct {
44+
name string
45+
set *appsv1.StatefulSet
46+
revisions []*appsv1.ControllerRevision
47+
}{
48+
{
49+
name: "1.33 set, 1.33 rev",
50+
set: set133.DeepCopy(),
51+
revisions: []*appsv1.ControllerRevision{rev133.DeepCopy()},
52+
},
53+
{
54+
name: "1.34 set, 1.34 rev",
55+
set: set134.DeepCopy(),
56+
revisions: []*appsv1.ControllerRevision{rev134.DeepCopy()},
57+
},
58+
{
59+
name: "1.34 set, 1.33+1.34 rev",
60+
set: set134.DeepCopy(),
61+
revisions: []*appsv1.ControllerRevision{rev133.DeepCopy(), rev134.DeepCopy()},
62+
},
63+
}
64+
65+
for _, tc := range testcases {
66+
t.Run(tc.name, func(t *testing.T) {
67+
latestRev := tc.revisions[len(tc.revisions)-1]
68+
client := fake.NewClientset(tc.set)
69+
_, _, ssc := setupController(client)
70+
currentRev, updateRev, _, err := ssc.(*defaultStatefulSetControl).getStatefulSetRevisions(tc.set, tc.revisions)
71+
if err != nil {
72+
t.Fatal(err)
73+
}
74+
if !reflect.DeepEqual(currentRev, latestRev) {
75+
t.Fatalf("expected no change from latestRev, got %s", cmp.Diff(latestRev, currentRev))
76+
}
77+
if !reflect.DeepEqual(updateRev, latestRev) {
78+
t.Fatalf("expected no change from latestRev, got %s", cmp.Diff(latestRev, updateRev))
79+
}
80+
})
81+
}
82+
}
83+
84+
func BenchmarkStatefulSetCompatibility(b *testing.B) {
85+
set133 := &appsv1.StatefulSet{}
86+
set134 := &appsv1.StatefulSet{}
87+
rev133 := &appsv1.ControllerRevision{}
88+
rev134 := &appsv1.ControllerRevision{}
89+
load(b, "compatibility_set_1.33.0.json", set133)
90+
load(b, "compatibility_set_1.34.0.json", set134)
91+
load(b, "compatibility_revision_1.33.0.json", rev133)
92+
load(b, "compatibility_revision_1.34.0.json", rev134)
93+
94+
testcases := []struct {
95+
name string
96+
set *appsv1.StatefulSet
97+
revisions []*appsv1.ControllerRevision
98+
}{
99+
{
100+
name: "1.33 set, 1.33 rev",
101+
set: set133.DeepCopy(),
102+
revisions: []*appsv1.ControllerRevision{rev133.DeepCopy()},
103+
},
104+
{
105+
name: "1.34 set, 1.34 rev",
106+
set: set134.DeepCopy(),
107+
revisions: []*appsv1.ControllerRevision{rev134.DeepCopy()},
108+
},
109+
{
110+
name: "1.34 set, 1.33+1.34 rev",
111+
set: set134.DeepCopy(),
112+
revisions: []*appsv1.ControllerRevision{rev133.DeepCopy(), rev134.DeepCopy()},
113+
},
114+
}
115+
116+
for _, tc := range testcases {
117+
b.Run(tc.name, func(b *testing.B) {
118+
latestRev := tc.revisions[len(tc.revisions)-1]
119+
client := fake.NewClientset(tc.set)
120+
_, _, ssc := setupController(client)
121+
for i := 0; i < b.N; i++ {
122+
currentRev, updateRev, _, err := ssc.(*defaultStatefulSetControl).getStatefulSetRevisions(tc.set, tc.revisions)
123+
if err != nil {
124+
b.Fatal(err)
125+
}
126+
if !reflect.DeepEqual(currentRev, latestRev) {
127+
b.Fatalf("expected no change from latestRev, got %s", cmp.Diff(latestRev, currentRev))
128+
}
129+
if !reflect.DeepEqual(updateRev, latestRev) {
130+
b.Fatalf("expected no change from latestRev, got %s", cmp.Diff(latestRev, updateRev))
131+
}
132+
}
133+
})
134+
}
135+
}
136+
137+
func load(t testing.TB, filename string, object runtime.Object) {
138+
data, err := os.ReadFile("testdata/" + filename)
139+
if err != nil {
140+
t.Fatal(err)
141+
}
142+
if strictErrs, err := json.UnmarshalStrict(data, object); err != nil {
143+
t.Fatal(err)
144+
} else if len(strictErrs) > 0 {
145+
t.Fatal(strictErrs)
146+
}
147+
// apply defaulting just as if it was read from etcd
148+
legacyscheme.Scheme.Default(object)
149+
}

‎pkg/controller/statefulset/testdata/compatibility_revision_1.33.0.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"apiVersion":"apps/v1",
3+
"kind":"ControllerRevision",
4+
"metadata":{
5+
"creationTimestamp":"2025-10-31T18:19:02Z",
6+
"labels":{
7+
"app":"foo",
8+
"controller.kubernetes.io/hash":"c77f6d978"
9+
},
10+
"name":"test-c77f6d978",
11+
"namespace":"default",
12+
"ownerReferences":[{
13+
"apiVersion":"apps/v1",
14+
"blockOwnerDeletion":true,
15+
"controller":true,
16+
"kind":"StatefulSet",
17+
"name":"test",
18+
"uid":"ec335e25-1045-4216-8634-50cfbe05f3d6"
19+
}],
20+
"resourceVersion":"2209",
21+
"uid":"af6e1945-ed14-4d1a-b420-813aa683a0fd"
22+
},
23+
"data":{"spec":{"template":{"$patch":"replace","metadata":{"annotations":{"test":"value"},"creationTimestamp":null,"labels":{"app":"foo"}},"spec":{"containers":[{"image":"test","imagePullPolicy":"Always","name":"test","resources":{},"terminationMessagePath":"/dev/termination-log","terminationMessagePolicy":"File"}],"dnsPolicy":"ClusterFirst","restartPolicy":"Always","schedulerName":"default-scheduler","securityContext":{},"terminationGracePeriodSeconds":30}}}},
24+
"revision":1
25+
}

‎pkg/controller/statefulset/testdata/compatibility_revision_1.34.0.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"apiVersion":"apps/v1",
3+
"kind":"ControllerRevision",
4+
"metadata":{
5+
"creationTimestamp":"2025-11-03T19:46:23Z",
6+
"labels":{
7+
"app":"foo",
8+
"controller.kubernetes.io/hash":"776999688b"
9+
},
10+
"name":"test-776999688b",
11+
"namespace":"default",
12+
"ownerReferences":[{
13+
"apiVersion":"apps/v1",
14+
"blockOwnerDeletion":true,
15+
"controller":true,
16+
"kind":"StatefulSet",
17+
"name":"test",
18+
"uid":"ec335e25-1045-4216-8634-50cfbe05f3d6"
19+
}],
20+
"resourceVersion":"16318",
21+
"uid":"47df387b-5f17-40b6-9964-4c43cf6ad5d1"
22+
},
23+
"data":{"spec":{"template":{"$patch":"replace","metadata":{"annotations":{"test":"value"},"labels":{"app":"foo"}},"spec":{"containers":[{"image":"test","imagePullPolicy":"Always","name":"test","resources":{},"terminationMessagePath":"/dev/termination-log","terminationMessagePolicy":"File"}],"dnsPolicy":"ClusterFirst","restartPolicy":"Always","schedulerName":"default-scheduler","securityContext":{},"terminationGracePeriodSeconds":30}}}},
24+
"revision":2
25+
}

‎pkg/controller/statefulset/testdata/compatibility_set_1.33.0.json‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
{
2+
"apiVersion": "apps/v1",
3+
"kind": "StatefulSet",
4+
"metadata": {
5+
"creationTimestamp": "2025-10-31T18:19:02Z",
6+
"generation": 1,
7+
"labels": {
8+
"sslabel": "value"
9+
},
10+
"name": "test",
11+
"namespace": "default",
12+
"resourceVersion": "2219",
13+
"uid": "ec335e25-1045-4216-8634-50cfbe05f3d6"
14+
},
15+
"spec": {
16+
"persistentVolumeClaimRetentionPolicy": {
17+
"whenDeleted": "Retain",
18+
"whenScaled": "Retain"
19+
},
20+
"podManagementPolicy": "OrderedReady",
21+
"replicas": 1,
22+
"revisionHistoryLimit": 10,
23+
"selector": {
24+
"matchLabels": {
25+
"app": "foo"
26+
}
27+
},
28+
"serviceName": "",
29+
"template": {
30+
"metadata": {
31+
"annotations": {
32+
"test": "value"
33+
},
34+
"creationTimestamp": null,
35+
"labels": {
36+
"app": "foo"
37+
}
38+
},
39+
"spec": {
40+
"containers": [
41+
{
42+
"image": "test",
43+
"imagePullPolicy": "Always",
44+
"name": "test",
45+
"resources": {},
46+
"terminationMessagePath": "/dev/termination-log",
47+
"terminationMessagePolicy": "File"
48+
}
49+
],
50+
"dnsPolicy": "ClusterFirst",
51+
"restartPolicy": "Always",
52+
"schedulerName": "default-scheduler",
53+
"securityContext": {},
54+
"terminationGracePeriodSeconds": 30
55+
}
56+
},
57+
"updateStrategy": {
58+
"rollingUpdate": {
59+
"partition": 0
60+
},
61+
"type": "RollingUpdate"
62+
},
63+
"volumeClaimTemplates": [
64+
{
65+
"apiVersion": "v1",
66+
"kind": "PersistentVolumeClaim",
67+
"metadata": {
68+
"annotations": {
69+
"key": "value"
70+
},
71+
"creationTimestamp": null,
72+
"labels": {
73+
"key": "value"
74+
},
75+
"name": "test"
76+
},
77+
"spec": {
78+
"accessModes": [
79+
"ReadWriteOnce"
80+
],
81+
"resources": {
82+
"requests": {
83+
"storage": "1Gi"
84+
}
85+
},
86+
"volumeMode": "Filesystem"
87+
},
88+
"status": {
89+
"phase": "Pending"
90+
}
91+
}
92+
]
93+
},
94+
"status": {
95+
"availableReplicas": 1,
96+
"collisionCount": 0,
97+
"currentReplicas": 1,
98+
"currentRevision": "test-c77f6d978",
99+
"observedGeneration": 1,
100+
"replicas": 1,
101+
"updateRevision": "test-c77f6d978",
102+
"updatedReplicas": 1
103+
}
104+
}

0 commit comments

Comments
 (0)