Skip to content

Commit 429d04d

Browse files
committed
fix(registry): align dry-run with storage semantics
Dry-run must expose the same deletion state as a real request without persisting it. Shared option objects can hide dropped fields in tests, and an unreachable patch method offers no API coverage. Signed-off-by: Yan Bondarenko <[email protected]> Assisted-by: LLM
1 parent bdb5961 commit 429d04d

8 files changed

Lines changed: 176 additions & 148 deletions

File tree

‎pkg/registry/apps/application/rest.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ func (r *REST) Delete(ctx context.Context, name string, deleteValidation rest.Va
691691
err = r.c.Delete(ctx, helmRelease, registry.ClientDeleteOptions(options))
692692
if err != nil {
693693
klog.Errorf("Failed to delete HelmRelease %s: %v", helmReleaseName, err)
694-
return nil, false, fmt.Errorf("failed to delete HelmRelease: %v", err)
694+
return nil, false, fmt.Errorf("failed to delete HelmRelease: %w", err)
695695
}
696696

697697
klog.V(6).Infof("Successfully deleted HelmRelease %s", helmReleaseName)

‎pkg/registry/apps/application/rest_write_options_test.go‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,16 @@ package application
1818

1919
import (
2020
"context"
21+
"fmt"
2122
"reflect"
2223
"testing"
2324

2425
cozyv1alpha1 "github.com/cozystack/cozystack/api/v1alpha1"
2526
helmv2 "github.com/fluxcd/helm-controller/api/v2"
27+
apierrors "k8s.io/apimachinery/pkg/api/errors"
2628
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2729
"k8s.io/apimachinery/pkg/runtime"
30+
"k8s.io/apimachinery/pkg/runtime/schema"
2831
"k8s.io/apimachinery/pkg/types"
2932
"k8s.io/apiserver/pkg/endpoints/request"
3033
"k8s.io/apiserver/pkg/registry/rest"
@@ -108,6 +111,7 @@ func TestCreatePropagatesWriteOptions(t *testing.T) {
108111
FieldManager: "create-manager",
109112
FieldValidation: "Strict",
110113
}
114+
expected := want.DeepCopy()
111115
var got *metav1.CreateOptions
112116
r := newOptionsTestREST(t, interceptor.Funcs{
113117
Create: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.CreateOption) error {
@@ -119,8 +123,8 @@ func TestCreatePropagatesWriteOptions(t *testing.T) {
119123
if _, err := r.Create(ctx, optionsTestApplication(), nil, want); err != nil {
120124
t.Fatalf("Create returned error: %v", err)
121125
}
122-
if !reflect.DeepEqual(got, want) {
123-
t.Fatalf("Create options lost in controller-runtime conversion:\n got: %#v\nwant: %#v", got, want)
126+
if !reflect.DeepEqual(got, expected) {
127+
t.Fatalf("Create options lost in controller-runtime conversion:\n got: %#v\nwant: %#v", got, expected)
124128
}
125129
}
126130

@@ -130,6 +134,7 @@ func TestUpdatePropagatesWriteOptions(t *testing.T) {
130134
FieldManager: "update-manager",
131135
FieldValidation: "Warn",
132136
}
137+
expected := want.DeepCopy()
133138
var got *metav1.UpdateOptions
134139
r := newOptionsTestREST(t, interceptor.Funcs{
135140
Update: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.UpdateOption) error {
@@ -141,8 +146,8 @@ func TestUpdatePropagatesWriteOptions(t *testing.T) {
141146
if _, _, err := r.Update(ctx, "example", rest.DefaultUpdatedObjectInfo(optionsTestApplication()), nil, nil, false, want); err != nil {
142147
t.Fatalf("Update returned error: %v", err)
143148
}
144-
if !reflect.DeepEqual(got, want) {
145-
t.Fatalf("Update options lost in controller-runtime conversion:\n got: %#v\nwant: %#v", got, want)
149+
if !reflect.DeepEqual(got, expected) {
150+
t.Fatalf("Update options lost in controller-runtime conversion:\n got: %#v\nwant: %#v", got, expected)
146151
}
147152
}
148153

@@ -184,6 +189,7 @@ func TestDeletePropagatesWriteOptions(t *testing.T) {
184189
PropagationPolicy: &propagation,
185190
DryRun: []string{metav1.DryRunAll},
186191
}
192+
expected := want.DeepCopy()
187193
var got *metav1.DeleteOptions
188194
r := newOptionsTestREST(t, interceptor.Funcs{
189195
Delete: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.DeleteOption) error {
@@ -195,7 +201,24 @@ func TestDeletePropagatesWriteOptions(t *testing.T) {
195201
if _, _, err := r.Delete(ctx, "example", nil, want); err != nil {
196202
t.Fatalf("Delete returned error: %v", err)
197203
}
198-
if !reflect.DeepEqual(got, want) {
199-
t.Fatalf("Delete options lost in controller-runtime conversion:\n got: %#v\nwant: %#v", got, want)
204+
if !reflect.DeepEqual(got, expected) {
205+
t.Fatalf("Delete options lost in controller-runtime conversion:\n got: %#v\nwant: %#v", got, expected)
206+
}
207+
}
208+
209+
func TestDeletePreservesConflictError(t *testing.T) {
210+
conflict := apierrors.NewConflict(
211+
schema.GroupResource{Group: helmv2.GroupVersion.Group, Resource: "helmreleases"},
212+
"postgresql-example",
213+
fmt.Errorf("precondition failed"),
214+
)
215+
r := newOptionsTestREST(t, interceptor.Funcs{
216+
Delete: func(_ context.Context, _ client.WithWatch, _ client.Object, _ ...client.DeleteOption) error {
217+
return conflict
218+
},
219+
}, optionsTestHelmRelease())
220+
ctx := request.WithNamespace(context.Background(), optionsTestNamespace)
221+
if _, _, err := r.Delete(ctx, "example", nil, &metav1.DeleteOptions{}); !apierrors.IsConflict(err) {
222+
t.Fatalf("Delete returned %v, want a preserved Conflict", err)
200223
}
201224
}

‎pkg/registry/core/tenantsecret/rest_write_options_test.go‎

Lines changed: 9 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@ package tenantsecret
44

55
import (
66
"context"
7-
"errors"
87
"reflect"
98
"testing"
109

1110
corev1 "k8s.io/api/core/v1"
1211
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1312
"k8s.io/apimachinery/pkg/runtime"
1413
"k8s.io/apimachinery/pkg/runtime/schema"
15-
"k8s.io/apimachinery/pkg/types"
1614
"k8s.io/apiserver/pkg/endpoints/request"
1715
"k8s.io/apiserver/pkg/registry/rest"
1816
"sigs.k8s.io/controller-runtime/pkg/client"
@@ -46,11 +44,6 @@ func tenantSecretInput(name string) *corev1alpha1.TenantSecret {
4644
return &corev1alpha1.TenantSecret{ObjectMeta: metav1.ObjectMeta{Name: name, Namespace: testNamespace}}
4745
}
4846

49-
func capturePatchOptions(opts ...client.PatchOption) *metav1.PatchOptions {
50-
converted := (&client.PatchOptions{}).ApplyOptions(opts)
51-
return converted.AsPatchOptions().DeepCopy()
52-
}
53-
5447
func captureTenantCreateOptions(opts ...client.CreateOption) *metav1.CreateOptions {
5548
converted := (&client.CreateOptions{}).ApplyOptions(opts)
5649
return converted.AsCreateOptions().DeepCopy()
@@ -71,6 +64,7 @@ func captureTenantDeleteOptions(opts ...client.DeleteOption) *metav1.DeleteOptio
7164

7265
func TestTenantSecretCreatePropagatesWriteOptions(t *testing.T) {
7366
want := &metav1.CreateOptions{DryRun: []string{metav1.DryRunAll}, FieldManager: "creator", FieldValidation: "Strict"}
67+
expected := want.DeepCopy()
7468
var got *metav1.CreateOptions
7569
r := newWriteOptionsREST(t, interceptor.Funcs{
7670
Create: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.CreateOption) error {
@@ -81,13 +75,14 @@ func TestTenantSecretCreatePropagatesWriteOptions(t *testing.T) {
8175
if _, err := r.Create(request.WithNamespace(context.Background(), testNamespace), tenantSecretInput("new"), nil, want); err != nil {
8276
t.Fatalf("Create returned error: %v", err)
8377
}
84-
if !reflect.DeepEqual(got, want) {
85-
t.Fatalf("Create options lost: got %#v, want %#v", got, want)
78+
if !reflect.DeepEqual(got, expected) {
79+
t.Fatalf("Create options lost: got %#v, want %#v", got, expected)
8680
}
8781
}
8882

8983
func TestTenantSecretUpdatePropagatesWriteOptions(t *testing.T) {
9084
want := &metav1.UpdateOptions{DryRun: []string{metav1.DryRunAll}, FieldManager: "updater", FieldValidation: "Warn"}
85+
expected := want.DeepCopy()
9186
var got *metav1.UpdateOptions
9287
r := newWriteOptionsREST(t, interceptor.Funcs{
9388
Update: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.UpdateOption) error {
@@ -99,8 +94,8 @@ func TestTenantSecretUpdatePropagatesWriteOptions(t *testing.T) {
9994
if _, _, err := r.Update(ctx, "existing", rest.DefaultUpdatedObjectInfo(tenantSecretInput("existing")), nil, nil, false, want); err != nil {
10095
t.Fatalf("Update returned error: %v", err)
10196
}
102-
if !reflect.DeepEqual(got, want) {
103-
t.Fatalf("Update options lost: got %#v, want %#v", got, want)
97+
if !reflect.DeepEqual(got, expected) {
98+
t.Fatalf("Update options lost: got %#v, want %#v", got, expected)
10499
}
105100
}
106101

@@ -123,67 +118,10 @@ func TestTenantSecretForceCreatePropagatesWriteOptions(t *testing.T) {
123118
}
124119
}
125120

126-
func TestTenantSecretPatchPropagatesWriteOptions(t *testing.T) {
127-
want := &metav1.PatchOptions{DryRun: []string{metav1.DryRunAll}, FieldManager: "patcher", FieldValidation: "Warn"}
128-
var got *metav1.PatchOptions
129-
r := newWriteOptionsREST(t, interceptor.Funcs{
130-
Patch: func(ctx context.Context, c client.WithWatch, obj client.Object, patch client.Patch, opts ...client.PatchOption) error {
131-
got = capturePatchOptions(opts...)
132-
return c.Patch(ctx, obj, patch, opts...)
133-
},
134-
}, makeTenantSecret("existing", nil))
135-
ctx := request.WithNamespace(context.Background(), testNamespace)
136-
if _, err := r.Patch(ctx, "existing", types.MergePatchType, []byte(`{"metadata":{"annotations":{"test":"value"}}}`), want); err != nil {
137-
t.Fatalf("Patch returned error: %v", err)
138-
}
139-
if !reflect.DeepEqual(got, want) {
140-
t.Fatalf("Patch options lost: got %#v, want %#v", got, want)
141-
}
142-
}
143-
144-
func TestTenantSecretPatchRepairPreservesDryRun(t *testing.T) {
145-
want := &metav1.PatchOptions{DryRun: []string{metav1.DryRunAll}, FieldManager: "patcher", FieldValidation: "Strict"}
146-
var got *metav1.UpdateOptions
147-
r := newWriteOptionsREST(t, interceptor.Funcs{
148-
Patch: func(ctx context.Context, c client.WithWatch, obj client.Object, patch client.Patch, opts ...client.PatchOption) error {
149-
return c.Patch(ctx, obj, patch, opts...)
150-
},
151-
Update: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.UpdateOption) error {
152-
got = captureTenantUpdateOptions(opts...)
153-
return nil
154-
},
155-
}, makeTenantSecret("existing", nil))
156-
data := []byte(`{"metadata":{"labels":{"internal.cozystack.io/tenantresource":null}}}`)
157-
ctx := request.WithNamespace(context.Background(), testNamespace)
158-
if _, err := r.Patch(ctx, "existing", types.MergePatchType, data, want); err != nil {
159-
t.Fatalf("Patch returned error: %v", err)
160-
}
161-
expected := &metav1.UpdateOptions{DryRun: want.DryRun, FieldManager: want.FieldManager, FieldValidation: want.FieldValidation}
162-
if !reflect.DeepEqual(got, expected) {
163-
t.Fatalf("patch repair options lost: got %#v, want %#v", got, expected)
164-
}
165-
}
166-
167-
func TestTenantSecretPatchReturnsRepairFailure(t *testing.T) {
168-
sentinel := errors.New("repair failed")
169-
r := newWriteOptionsREST(t, interceptor.Funcs{
170-
Patch: func(ctx context.Context, c client.WithWatch, obj client.Object, patch client.Patch, opts ...client.PatchOption) error {
171-
return c.Patch(ctx, obj, patch, opts...)
172-
},
173-
Update: func(_ context.Context, _ client.WithWatch, _ client.Object, _ ...client.UpdateOption) error {
174-
return sentinel
175-
},
176-
}, makeTenantSecret("existing", nil))
177-
data := []byte(`{"metadata":{"labels":{"internal.cozystack.io/tenantresource":null}}}`)
178-
ctx := request.WithNamespace(context.Background(), testNamespace)
179-
if _, err := r.Patch(ctx, "existing", types.MergePatchType, data, &metav1.PatchOptions{}); !errors.Is(err, sentinel) {
180-
t.Fatalf("Patch returned %v, want repair error %v", err, sentinel)
181-
}
182-
}
183-
184121
func TestTenantSecretDeletePropagatesWriteOptions(t *testing.T) {
185122
propagation := metav1.DeletePropagationForeground
186123
want := &metav1.DeleteOptions{PropagationPolicy: &propagation, DryRun: []string{metav1.DryRunAll}}
124+
expected := want.DeepCopy()
187125
var got *metav1.DeleteOptions
188126
r := newWriteOptionsREST(t, interceptor.Funcs{
189127
Delete: func(_ context.Context, _ client.WithWatch, _ client.Object, opts ...client.DeleteOption) error {
@@ -195,7 +133,7 @@ func TestTenantSecretDeletePropagatesWriteOptions(t *testing.T) {
195133
if _, _, err := r.Delete(ctx, "existing", nil, want); err != nil {
196134
t.Fatalf("Delete returned error: %v", err)
197135
}
198-
if !reflect.DeepEqual(got, want) {
199-
t.Fatalf("Delete options lost: got %#v, want %#v", got, want)
136+
if !reflect.DeepEqual(got, expected) {
137+
t.Fatalf("Delete options lost: got %#v, want %#v", got, expected)
200138
}
201139
}

‎pkg/registry/sdn/securitygroup/rest.go‎

Lines changed: 54 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,54 @@ func hasFinalizer(list []string, name string) bool {
332332
return false
333333
}
334334

335+
// dryRunDeleteResult derives the object and synchronous-delete result that the
336+
// backing API would return without re-reading storage. A dry-run leaves the
337+
// stored object untouched, so a post-delete Get cannot distinguish an
338+
// immediate delete from one held by existing or garbage-collection finalizers.
339+
func dryRunDeleteResult(current *CiliumNetworkPolicy, opts *metav1.DeleteOptions) (*CiliumNetworkPolicy, bool) {
340+
out := current.DeepCopy()
341+
finalizers := make([]string, 0, len(current.Finalizers)+1)
342+
for _, finalizer := range current.Finalizers {
343+
if finalizer != metav1.FinalizerOrphanDependents && finalizer != metav1.FinalizerDeleteDependents {
344+
finalizers = append(finalizers, finalizer)
345+
}
346+
}
347+
348+
if opts != nil && opts.OrphanDependents != nil {
349+
if *opts.OrphanDependents {
350+
finalizers = append(finalizers, metav1.FinalizerOrphanDependents)
351+
}
352+
} else if opts != nil && opts.PropagationPolicy != nil {
353+
switch *opts.PropagationPolicy {
354+
case metav1.DeletePropagationOrphan:
355+
finalizers = append(finalizers, metav1.FinalizerOrphanDependents)
356+
case metav1.DeletePropagationForeground:
357+
finalizers = append(finalizers, metav1.FinalizerDeleteDependents)
358+
}
359+
} else {
360+
// With no explicit policy, the backing API preserves an existing GC
361+
// finalizer. CiliumNetworkPolicy uses background propagation by default,
362+
// so it does not synthesize one when neither is already present.
363+
if hasFinalizer(current.Finalizers, metav1.FinalizerOrphanDependents) {
364+
finalizers = append(finalizers, metav1.FinalizerOrphanDependents)
365+
} else if hasFinalizer(current.Finalizers, metav1.FinalizerDeleteDependents) {
366+
finalizers = append(finalizers, metav1.FinalizerDeleteDependents)
367+
}
368+
}
369+
370+
out.Finalizers = finalizers
371+
if len(finalizers) == 0 && out.DeletionTimestamp == nil {
372+
return out, true
373+
}
374+
if out.DeletionTimestamp == nil {
375+
now := metav1.Now()
376+
out.DeletionTimestamp = &now
377+
}
378+
zero := int64(0)
379+
out.DeletionGracePeriodSeconds = &zero
380+
return out, false
381+
}
382+
335383
func policyToSecurityGroup(np *CiliumNetworkPolicy) *sdnv1alpha1.SecurityGroup {
336384
sg := &sdnv1alpha1.SecurityGroup{
337385
TypeMeta: metav1.TypeMeta{
@@ -833,6 +881,10 @@ func (r *REST) Delete(
833881
if err = r.c.Delete(ctx, &CiliumNetworkPolicy{ObjectMeta: metav1.ObjectMeta{Namespace: ns, Name: name}}, registry.ClientDeleteOptions(opts)); err != nil {
834882
return nil, false, err
835883
}
884+
if opts != nil && len(opts.DryRun) > 0 {
885+
prospective, deleted := dryRunDeleteResult(current, opts)
886+
return policyToSecurityGroup(prospective), deleted, nil
887+
}
836888
// Report whether the delete completed synchronously, per the
837889
// rest.GracefulDeleter contract whose bool means "instantly deleted". Read the
838890
// post-delete state through the direct (uncached) client: the storage's
@@ -849,13 +901,8 @@ func (r *REST) Delete(
849901
if getErr != nil {
850902
return nil, false, getErr
851903
}
852-
// The object is still present. A dry-run never removes it, so the prospective
853-
// result is read from its authoritative finalizers: none means the real delete
854-
// would be instant. A non-dry-run delete that left the object means a finalizer
855-
// is holding it as Terminating, so it is asynchronous.
856-
if opts != nil && len(opts.DryRun) > 0 && len(after.Finalizers) == 0 {
857-
return policyToSecurityGroup(after), true, nil
858-
}
904+
// A non-dry-run delete that left the object means a finalizer is holding it
905+
// as Terminating, so it is asynchronous.
859906
return policyToSecurityGroup(after), false, nil
860907
}
861908

‎pkg/registry/sdn/securitygroup/rest_test.go‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,65 @@ func TestDeleteDryRunReportsPolicyWithoutFinalizerAsInstant(t *testing.T) {
443443
}
444444
}
445445

446+
func TestDeleteDryRunReportsProspectiveAsyncState(t *testing.T) {
447+
foreground := metav1.DeletePropagationForeground
448+
orphan := metav1.DeletePropagationOrphan
449+
tests := []struct {
450+
name string
451+
initialFinalizers []string
452+
options *metav1.DeleteOptions
453+
wantFinalizer string
454+
}{
455+
{
456+
name: "existing membership finalizer",
457+
initialFinalizers: []string{sdnv1alpha1.MembershipFinalizer},
458+
options: &metav1.DeleteOptions{DryRun: []string{metav1.DryRunAll}},
459+
wantFinalizer: sdnv1alpha1.MembershipFinalizer,
460+
},
461+
{
462+
name: "foreground propagation",
463+
options: &metav1.DeleteOptions{DryRun: []string{metav1.DryRunAll}, PropagationPolicy: &foreground},
464+
wantFinalizer: metav1.FinalizerDeleteDependents,
465+
},
466+
{
467+
name: "orphan propagation",
468+
options: &metav1.DeleteOptions{DryRun: []string{metav1.DryRunAll}, PropagationPolicy: &orphan},
469+
wantFinalizer: metav1.FinalizerOrphanDependents,
470+
},
471+
}
472+
473+
for _, tt := range tests {
474+
t.Run(tt.name, func(t *testing.T) {
475+
cnp := markedPolicy("sg-db")
476+
cnp.Finalizers = append([]string(nil), tt.initialFinalizers...)
477+
r := newTestREST(t, cnp)
478+
479+
obj, deleted, err := r.Delete(ctxNS(), "sg-db", nil, tt.options)
480+
if err != nil {
481+
t.Fatalf("dry-run Delete returned error: %v", err)
482+
}
483+
if deleted {
484+
t.Fatal("dry-run Delete reported deleted=true for a prospective finalizer-held delete")
485+
}
486+
sg, ok := obj.(*sdnv1alpha1.SecurityGroup)
487+
if !ok {
488+
t.Fatalf("dry-run Delete returned %T, want *SecurityGroup", obj)
489+
}
490+
if sg.DeletionTimestamp == nil || !hasFinalizer(sg.Finalizers, tt.wantFinalizer) {
491+
t.Fatalf("prospective result missing deletion state: timestamp=%v finalizers=%v", sg.DeletionTimestamp, sg.Finalizers)
492+
}
493+
494+
stored := &CiliumNetworkPolicy{}
495+
if err := r.c.Get(context.Background(), types.NamespacedName{Namespace: testNamespace, Name: "sg-db"}, stored); err != nil {
496+
t.Fatalf("dry-run changed object existence: %v", err)
497+
}
498+
if stored.DeletionTimestamp != nil || !reflect.DeepEqual(stored.Finalizers, tt.initialFinalizers) {
499+
t.Fatalf("dry-run persisted prospective state: timestamp=%v finalizers=%v", stored.DeletionTimestamp, stored.Finalizers)
500+
}
501+
})
502+
}
503+
}
504+
446505
func TestCreateOverExistingUnmarkedPolicyFails(t *testing.T) {
447506
r := newTestREST(t, unmarkedPolicy("tenant-isolation"))
448507

0 commit comments

Comments
 (0)