Skip to content

Commit cedeb8f

Browse files
jimmidysonjimmidyson
committed
refactor: Use consistent decoder in mutators
Also fixes my typo in `mutater` to `mutator`.
1 parent 1ed01f4 commit cedeb8f

File tree

13 files changed

+39
-60
lines changed

13 files changed

+39
-60
lines changed

‎common/pkg/capi/clustertopology/handlers/mutation/meta.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
1616
)
1717

18-
type MetaMutater interface {
18+
type MetaMutator interface {
1919
Mutate(
2020
ctx context.Context,
2121
obj runtime.Object,
@@ -28,18 +28,18 @@ type MetaMutater interface {
2828
type metaGeneratePatches struct {
2929
name string
3030
decoder runtime.Decoder
31-
mutaters []MetaMutater
31+
mutators []MetaMutator
3232
}
3333

3434
func NewMetaGeneratePatchesHandler(
3535
name string,
3636
decoder runtime.Decoder,
37-
mutators ...MetaMutater,
37+
mutators ...MetaMutator,
3838
) handlers.Named {
3939
return metaGeneratePatches{
4040
name: name,
4141
decoder: decoder,
42-
mutaters: mutators,
42+
mutators: mutators,
4343
}
4444
}
4545

@@ -65,7 +65,7 @@ func (mgp metaGeneratePatches) GeneratePatches(
6565
vars map[string]apiextensionsv1.JSON,
6666
holderRef runtimehooksv1.HolderReference,
6767
) error {
68-
for _, h := range mgp.mutaters {
68+
for _, h := range mgp.mutators {
6969
if err := h.Mutate(ctx, obj, vars, holderRef, clusterKey); err != nil {
7070
return err
7171
}

‎common/pkg/capi/clustertopology/handlers/mutation/meta_test.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ type testHandler struct {
3030
mutateControlPlane bool
3131
}
3232

33-
var _ MetaMutater = &testHandler{}
33+
var _ MetaMutator = &testHandler{}
3434

3535
func (h *testHandler) Mutate(
3636
_ context.Context,
@@ -89,7 +89,7 @@ func TestMetaGeneratePatches(t *testing.T) {
8989

9090
tests := []struct {
9191
name string
92-
mutaters []MetaMutater
92+
mutaters []MetaMutator
9393
expectedResponse *runtimehooksv1.GeneratePatchesResponse
9494
}{{
9595
name: "no handlers",
@@ -109,7 +109,7 @@ func TestMetaGeneratePatches(t *testing.T) {
109109
},
110110
}, {
111111
name: "single success handler",
112-
mutaters: []MetaMutater{
112+
mutaters: []MetaMutator{
113113
&testHandler{},
114114
},
115115
expectedResponse: &runtimehooksv1.GeneratePatchesResponse{
@@ -134,7 +134,7 @@ func TestMetaGeneratePatches(t *testing.T) {
134134
},
135135
}, {
136136
name: "single failure handler",
137-
mutaters: []MetaMutater{
137+
mutaters: []MetaMutator{
138138
&testHandler{
139139
returnErr: true,
140140
},
@@ -147,7 +147,7 @@ func TestMetaGeneratePatches(t *testing.T) {
147147
},
148148
}, {
149149
name: "multiple success handlers",
150-
mutaters: []MetaMutater{
150+
mutaters: []MetaMutator{
151151
&testHandler{},
152152
&testHandler{},
153153
&testHandler{mutateControlPlane: true},
@@ -184,7 +184,7 @@ func TestMetaGeneratePatches(t *testing.T) {
184184
},
185185
}, {
186186
name: "success handler followed by failure handler",
187-
mutaters: []MetaMutater{
187+
mutaters: []MetaMutator{
188188
&testHandler{},
189189
&testHandler{
190190
returnErr: true,
@@ -198,7 +198,7 @@ func TestMetaGeneratePatches(t *testing.T) {
198198
},
199199
}, {
200200
name: "failure handler followed by success handler",
201-
mutaters: []MetaMutater{
201+
mutaters: []MetaMutator{
202202
&testHandler{
203203
returnErr: true,
204204
},

‎pkg/handlers/aws/mutation/metapatch_handler.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ import (
1616
// MetaPatchHandler returns a meta patch handler for mutating CAPD clusters.
1717
func MetaPatchHandler(mgr manager.Manager) handlers.Named {
1818
patchHandlers := append(
19-
[]mutation.MetaMutater{
19+
[]mutation.MetaMutator{
2020
region.NewMetaPatch(),
2121
},
22-
genericmutation.MetaMutaters(mgr)...,
22+
genericmutation.MetaMutators(mgr)...,
2323
)
2424

2525
return mutation.NewMetaGeneratePatchesHandler(

‎pkg/handlers/aws/mutation/region/inject.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,14 @@ const (
3131
)
3232

3333
type awsRegionPatchHandler struct {
34-
decoder runtime.Decoder
3534
variableName string
3635
variableFieldPath []string
3736
}
3837

3938
var (
4039
_ commonhandlers.Named = &awsRegionPatchHandler{}
4140
_ mutation.GeneratePatches = &awsRegionPatchHandler{}
42-
_ mutation.MetaMutater = &awsRegionPatchHandler{}
41+
_ mutation.MetaMutator = &awsRegionPatchHandler{}
4342
)
4443

4544
func NewPatch() *awsRegionPatchHandler {
@@ -55,7 +54,6 @@ func newAWSRegionPatchHandler(
5554
variableFieldPath ...string,
5655
) *awsRegionPatchHandler {
5756
return &awsRegionPatchHandler{
58-
decoder: apis.CAPADecoder(),
5957
variableName: variableName,
6058
variableFieldPath: variableFieldPath,
6159
}
@@ -124,7 +122,7 @@ func (h *awsRegionPatchHandler) GeneratePatches(
124122
) {
125123
topologymutation.WalkTemplates(
126124
ctx,
127-
h.decoder,
125+
apis.CAPADecoder(),
128126
req,
129127
resp,
130128
func(

‎pkg/handlers/docker/mutation/customimage/inject.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,14 @@ const (
3535
)
3636

3737
type customImagePatchHandler struct {
38-
decoder runtime.Decoder
3938
variableName string
4039
variableFieldPath []string
4140
}
4241

4342
var (
4443
_ commonhandlers.Named = &customImagePatchHandler{}
4544
_ mutation.GeneratePatches = &customImagePatchHandler{}
46-
_ mutation.MetaMutater = &customImagePatchHandler{}
45+
_ mutation.MetaMutator = &customImagePatchHandler{}
4746
)
4847

4948
func NewPatch() *customImagePatchHandler {
@@ -59,7 +58,6 @@ func newCustomImagePatchHandler(
5958
variableFieldPath ...string,
6059
) *customImagePatchHandler {
6160
return &customImagePatchHandler{
62-
decoder: apis.CAPDDecoder(),
6361
variableName: variableName,
6462
variableFieldPath: variableFieldPath,
6563
}
@@ -195,7 +193,7 @@ func (h *customImagePatchHandler) GeneratePatches(
195193
) {
196194
topologymutation.WalkTemplates(
197195
ctx,
198-
h.decoder,
196+
apis.CAPDDecoder(),
199197
req,
200198
resp,
201199
func(

‎pkg/handlers/docker/mutation/metapatch_handler.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ import (
1616
// MetaPatchHandler returns a meta patch handler for mutating CAPD clusters.
1717
func MetaPatchHandler(mgr manager.Manager) handlers.Named {
1818
patchHandlers := append(
19-
[]mutation.MetaMutater{
19+
[]mutation.MetaMutator{
2020
customimage.NewMetaPatch(),
2121
},
22-
genericmutation.MetaMutaters(mgr)...,
22+
genericmutation.MetaMutators(mgr)...,
2323
)
2424

2525
return mutation.NewMetaGeneratePatchesHandler(

‎pkg/handlers/generic/mutation/auditpolicy/inject.go

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,12 @@ const (
2828
HandlerNamePatch = "AuditPolicyPatch"
2929
)
3030

31-
type auditPolicyPatchHandler struct {
32-
decoder runtime.Decoder
33-
}
31+
type auditPolicyPatchHandler struct{}
3432

3533
var (
3634
_ handlers.Named = &auditPolicyPatchHandler{}
3735
_ mutation.GeneratePatches = &auditPolicyPatchHandler{}
38-
_ mutation.MetaMutater = &auditPolicyPatchHandler{}
36+
_ mutation.MetaMutator = &auditPolicyPatchHandler{}
3937

4038
//go:embed embedded/apiserver-audit-policy.yaml
4139
auditPolicy string
@@ -44,9 +42,7 @@ var (
4442
const auditPolicyPath = "/etc/kubernetes/audit-policy/apiserver-audit-policy.yaml"
4543

4644
func NewPatch() *auditPolicyPatchHandler {
47-
return &auditPolicyPatchHandler{
48-
decoder: apis.CAPIDecoder(),
49-
}
45+
return &auditPolicyPatchHandler{}
5046
}
5147

5248
func (h *auditPolicyPatchHandler) Name() string {
@@ -126,7 +122,7 @@ func (h *auditPolicyPatchHandler) GeneratePatches(
126122
) {
127123
topologymutation.WalkTemplates(
128124
ctx,
129-
h.decoder,
125+
apis.CAPIDecoder(),
130126
req,
131127
resp,
132128
func(

‎pkg/handlers/generic/mutation/etcd/inject.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,14 @@ const (
3232
)
3333

3434
type etcdPatchHandler struct {
35-
decoder runtime.Decoder
3635
variableName string
3736
variableFieldPath []string
3837
}
3938

4039
var (
4140
_ commonhandlers.Named = &etcdPatchHandler{}
4241
_ mutation.GeneratePatches = &etcdPatchHandler{}
43-
_ mutation.MetaMutater = &etcdPatchHandler{}
42+
_ mutation.MetaMutator = &etcdPatchHandler{}
4443
)
4544

4645
func NewPatch() *etcdPatchHandler {
@@ -56,7 +55,6 @@ func newEtcdPatchHandler(
5655
variableFieldPath ...string,
5756
) *etcdPatchHandler {
5857
return &etcdPatchHandler{
59-
decoder: apis.CAPIDecoder(),
6058
variableName: variableName,
6159
variableFieldPath: variableFieldPath,
6260
}
@@ -134,7 +132,7 @@ func (h *etcdPatchHandler) GeneratePatches(
134132
) {
135133
topologymutation.WalkTemplates(
136134
ctx,
137-
h.decoder,
135+
apis.CAPIDecoder(),
138136
req,
139137
resp,
140138
func(

‎pkg/handlers/generic/mutation/extraapiservercertsans/inject.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,14 @@ const (
3232
)
3333

3434
type extraAPIServerCertSANsPatchHandler struct {
35-
decoder runtime.Decoder
3635
variableName string
3736
variableFieldPath []string
3837
}
3938

4039
var (
4140
_ commonhandlers.Named = &extraAPIServerCertSANsPatchHandler{}
4241
_ mutation.GeneratePatches = &extraAPIServerCertSANsPatchHandler{}
43-
_ mutation.MetaMutater = &extraAPIServerCertSANsPatchHandler{}
42+
_ mutation.MetaMutator = &extraAPIServerCertSANsPatchHandler{}
4443
)
4544

4645
func NewPatch() *extraAPIServerCertSANsPatchHandler {
@@ -56,7 +55,6 @@ func newExtraAPIServerCertSANsPatchHandler(
5655
variableFieldPath ...string,
5756
) *extraAPIServerCertSANsPatchHandler {
5857
return &extraAPIServerCertSANsPatchHandler{
59-
decoder: apis.CAPIDecoder(),
6058
variableName: variableName,
6159
variableFieldPath: variableFieldPath,
6260
}
@@ -124,7 +122,7 @@ func (h *extraAPIServerCertSANsPatchHandler) GeneratePatches(
124122
) {
125123
topologymutation.WalkTemplates(
126124
ctx,
127-
h.decoder,
125+
apis.CAPIDecoder(),
128126
req,
129127
resp,
130128
func(

‎pkg/handlers/generic/mutation/handlers.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ import (
1515
"github.com/d2iq-labs/capi-runtime-extensions/pkg/handlers/generic/mutation/kubernetesimagerepository"
1616
)
1717

18-
// MetaMutaters returns all generic patch handlers.
19-
func MetaMutaters(mgr manager.Manager) []mutation.MetaMutater {
20-
return []mutation.MetaMutater{
18+
// MetaMutators returns all generic patch handlers.
19+
func MetaMutators(mgr manager.Manager) []mutation.MetaMutator {
20+
return []mutation.MetaMutator{
2121
auditpolicy.NewPatch(),
2222
etcd.NewMetaPatch(),
2323
extraapiservercertsans.NewMetaPatch(),

‎pkg/handlers/generic/mutation/httpproxy/inject.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ const (
3838
)
3939

4040
type httpProxyPatchHandler struct {
41-
decoder runtime.Decoder
42-
client ctrlclient.Reader
41+
client ctrlclient.Reader
4342

4443
variableName string
4544
variableFieldPath []string
@@ -68,7 +67,6 @@ func newHTTPProxyPatchHandler(
6867
variableFieldPath ...string,
6968
) *httpProxyPatchHandler {
7069
return &httpProxyPatchHandler{
71-
decoder: apis.CAPIDecoder(),
7270
client: cl,
7371
variableName: variableName,
7472
variableFieldPath: variableFieldPath,
@@ -159,7 +157,7 @@ func (h *httpProxyPatchHandler) GeneratePatches(
159157

160158
topologymutation.WalkTemplates(
161159
ctx,
162-
h.decoder,
160+
apis.CAPIDecoder(),
163161
req,
164162
resp,
165163
func(

‎pkg/handlers/generic/mutation/imageregistries/credentials/inject.go

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111
corev1 "k8s.io/api/core/v1"
1212
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
1313
"k8s.io/apimachinery/pkg/runtime"
14-
"k8s.io/apimachinery/pkg/runtime/serializer"
1514
bootstrapv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1"
1615
controlplanev1 "sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1"
1716
runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
@@ -20,6 +19,7 @@ import (
2019
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
2120

2221
"github.com/d2iq-labs/capi-runtime-extensions/api/v1alpha1"
22+
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/apis"
2323
commonhandlers "github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers"
2424
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/handlers/mutation"
2525
"github.com/d2iq-labs/capi-runtime-extensions/common/pkg/capi/clustertopology/patches"
@@ -36,8 +36,7 @@ const (
3636
)
3737

3838
type imageRegistriesPatchHandler struct {
39-
decoder runtime.Decoder
40-
client ctrlclient.Client
39+
client ctrlclient.Client
4140

4241
variableName string
4342
variableFieldPath []string
@@ -46,7 +45,7 @@ type imageRegistriesPatchHandler struct {
4645
var (
4746
_ commonhandlers.Named = &imageRegistriesPatchHandler{}
4847
_ mutation.GeneratePatches = &imageRegistriesPatchHandler{}
49-
_ mutation.MetaMutater = &imageRegistriesPatchHandler{}
48+
_ mutation.MetaMutator = &imageRegistriesPatchHandler{}
5049
)
5150

5251
func NewPatch(
@@ -75,10 +74,6 @@ func newImageRegistriesPatchHandler(
7574
_ = bootstrapv1.AddToScheme(scheme)
7675
_ = controlplanev1.AddToScheme(scheme)
7776
return &imageRegistriesPatchHandler{
78-
decoder: serializer.NewCodecFactory(scheme).UniversalDecoder(
79-
controlplanev1.GroupVersion,
80-
bootstrapv1.GroupVersion,
81-
),
8277
client: cl,
8378
variableName: variableName,
8479
variableFieldPath: variableFieldPath,
@@ -248,7 +243,7 @@ func (h *imageRegistriesPatchHandler) GeneratePatches(
248243

249244
topologymutation.WalkTemplates(
250245
ctx,
251-
h.decoder,
246+
apis.CAPIDecoder(),
252247
req,
253248
resp,
254249
func(

0 commit comments

Comments
 (0)