Skip to content
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

🐛 Handle a nil mutator by returning an error, not panicking #10951

Merged
merged 4 commits into from
Aug 1, 2024
Merged

🐛 Handle a nil mutator by returning an error, not panicking #10951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5fffb0f
Verify that mover can handle a nil mutator
dlipovetsky Jul 26, 2024
71a2394
Return an error if a mutator is nil
dlipovetsky Jul 26, 2024
e143580
Fix test that passes a nil mutator to 'move'
dlipovetsky Jul 26, 2024
12b0d07
fixup! Fix test that passes a nil mutator to 'move'
dlipovetsky Jul 29, 2024
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
8 changes: 7 additions & 1 deletion cmd/clusterctl/client/cluster/mover.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1329,7 +1329,13 @@ func applyMutators(object client.Object, mutators ...ResourceMutatorFunc) (*unst
}
u.SetUnstructuredContent(to)
for _, mutator := range mutators {
if err := mutator(u); err != nil {
var err error
if mutator != nil {
err = mutator(u)
} else {
err = errors.New("mutator is nil")
}
if err != nil {
return nil, errors.Wrapf(err, "error applying resource mutator to %q %s/%s",
u.GroupVersionKind(), object.GetNamespace(), object.GetName())
}
Expand Down
49 changes: 47 additions & 2 deletions cmd/clusterctl/client/cluster/mover_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
Expand Down Expand Up @@ -1202,7 +1203,7 @@ func Test_objectMover_move_dryRun(t *testing.T) {
dryRun: true,
}

err := mover.move(ctx, graph, toProxy, nil)
err := mover.move(ctx, graph, toProxy)
if tt.wantErr {
g.Expect(err).To(HaveOccurred())
return
Expand Down Expand Up @@ -1876,7 +1877,6 @@ func Test_objectMoverService_ensureNamespaces(t *testing.T) {
expectedNamespaces: []string{"namespace-1", "namespace-2"},
},
{

name: "ensureNamespaces moves namespace-2 to target which already has namespace-1",
fields: fields{
objs: cluster2.Objs(),
Expand Down Expand Up @@ -2408,3 +2408,48 @@ func TestWaitReadyForMove(t *testing.T) {
})
}
}

func Test_applyMutators(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

How about using t. Parallel?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not a bad suggestion, but I'd rather not, because
(a) There's no measurable decrease in time for this specific test, and
(b) relatively few tests across the repo use it.

tests := []struct {
name string
object client.Object
mutators []ResourceMutatorFunc
want *unstructured.Unstructured
wantErr bool
}{
{
name: "do nothing if object is nil",
},
{
name: "do nothing if mutators is a nil slice",
object: test.NewFakeCluster("example", "example").Objs()[0],
want: func() *unstructured.Unstructured {
g := NewWithT(t)
obj := test.NewFakeCluster("example", "example").Objs()[0]
u := &unstructured.Unstructured{}
to, err := runtime.DefaultUnstructuredConverter.ToUnstructured(obj)
g.Expect(err).NotTo(HaveOccurred())
u.SetUnstructuredContent(to)
return u
}(),
},
{
name: "return error if any element in mutators slice is nil",
mutators: []ResourceMutatorFunc{nil},
object: test.NewFakeCluster("example", "example").Objs()[0],
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)
got, err := applyMutators(tt.object, tt.mutators...)
g.Expect(got).To(Equal(tt.want))
if tt.wantErr {
g.Expect(err).To(HaveOccurred())
} else {
g.Expect(err).NotTo(HaveOccurred())
}
})
}
}
Loading