Skip to content

Commit b3c8663

Browse files
committed
refactoring
1 parent caefcc8 commit b3c8663

File tree

9 files changed

+61
-61
lines changed

9 files changed

+61
-61
lines changed

internal/cluster/client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import (
1313
"sigs.k8s.io/controller-runtime/pkg/client"
1414
)
1515

16-
func NewClient(client client.Client, discoveryClient discovery.DiscoveryInterface, eventRecorder record.EventRecorder) Client {
16+
func NewClient(clnt client.Client, discoveryClient discovery.DiscoveryInterface, eventRecorder record.EventRecorder) Client {
1717
return &clientImpl{
18-
Client: client,
18+
Client: clnt,
1919
discoveryClient: discoveryClient,
2020
eventRecorder: eventRecorder,
2121
}

internal/cluster/factory.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ func NewClientFactory(name string, config *rest.Config, schemeBuilders []types.S
6868
<-ticker.C
6969
now := time.Now()
7070
factory.mutex.Lock()
71-
for key, client := range factory.clients {
72-
if client.validUntil.Before(now) {
73-
client.eventBroadcaster.Shutdown()
71+
for key, clnt := range factory.clients {
72+
if clnt.validUntil.Before(now) {
73+
clnt.eventBroadcaster.Shutdown()
7474
// TODO: add some (debug) log output when client is removed; unfortunately, we have no logger in here ...
7575
// TODO: add metrics about running clients
7676
delete(factory.clients, key)
@@ -117,16 +117,16 @@ func (f *ClientFactory) Get(kubeConfig []byte, impersonationUser string, imperso
117117

118118
key := sha256sum(keyData)
119119

120-
if client, ok := f.clients[key]; ok {
121-
client.validUntil = time.Now().Add(validity)
122-
return client, nil
120+
if clnt, ok := f.clients[key]; ok {
121+
clnt.validUntil = time.Now().Add(validity)
122+
return clnt, nil
123123
}
124124

125125
httpClient, err := rest.HTTPClientFor(config)
126126
if err != nil {
127127
return nil, err
128128
}
129-
ctrlclient, err := client.New(config, client.Options{HTTPClient: httpClient, Scheme: f.scheme})
129+
ctrlClient, err := client.New(config, client.Options{HTTPClient: httpClient, Scheme: f.scheme})
130130
if err != nil {
131131
return nil, err
132132
}
@@ -137,19 +137,19 @@ func (f *ClientFactory) Get(kubeConfig []byte, impersonationUser string, imperso
137137
eventBroadcaster := record.NewBroadcaster()
138138
eventBroadcaster.StartRecordingToSink(&typedcorev1.EventSinkImpl{Interface: clientset.CoreV1().Events("")})
139139
eventRecorder := eventBroadcaster.NewRecorder(f.scheme, corev1.EventSource{Component: f.name})
140-
client := &clientImpl{
141-
Client: ctrlclient,
140+
clnt := &clientImpl{
141+
Client: ctrlClient,
142142
discoveryClient: clientset,
143143
eventBroadcaster: eventBroadcaster,
144144
eventRecorder: eventRecorder,
145145
validUntil: time.Now().Add(validity),
146146
}
147-
f.clients[key] = client
147+
f.clients[key] = clnt
148148

149149
// TODO: add some (debug) log output when new client is created; unfortunately, we have no logger in here ...
150150
// maybe we could (at least in Get()) get one from the reconcile context ...
151151
// TODO: add metrics about running clients
152-
return client, nil
152+
return clnt, nil
153153
}
154154

155155
func sha256sum(data any) string {

internal/helm/capabilities.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ import (
1111
"k8s.io/client-go/discovery"
1212
)
1313

14-
func GetCapabilities(client discovery.DiscoveryInterface) (*CapabilitiesData, error) {
15-
kubeVersion, err := client.ServerVersion()
14+
func GetCapabilities(discoveryClient discovery.DiscoveryInterface) (*CapabilitiesData, error) {
15+
kubeVersion, err := discoveryClient.ServerVersion()
1616
if err != nil {
1717
return nil, err
1818
}
1919
var apiVersions []string
20-
_, apiResourceLists, err := client.ServerGroupsAndResources()
20+
_, apiResourceLists, err := discoveryClient.ServerGroupsAndResources()
2121
if err != nil {
2222
return nil, err
2323
}

pkg/component/context.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ func (c *reconcileContext) WithReconcilerName(reconcilerName string) *reconcileC
2929
return &reconcileContext{Context: context.WithValue(c, reconcilerNameContextKey{}, reconcilerName)}
3030
}
3131

32-
func (c *reconcileContext) WithClient(client cluster.Client) *reconcileContext {
33-
return &reconcileContext{Context: context.WithValue(c, clientContextKey{}, client)}
32+
func (c *reconcileContext) WithClient(clnt cluster.Client) *reconcileContext {
33+
return &reconcileContext{Context: context.WithValue(c, clientContextKey{}, clnt)}
3434
}
3535

3636
func (c *reconcileContext) WithComponent(component Component) *reconcileContext {
@@ -49,8 +49,8 @@ func ReconcilerNameFromContext(ctx context.Context) (string, error) {
4949
}
5050

5151
func ClientFromContext(ctx context.Context) (cluster.Client, error) {
52-
if client, ok := ctx.Value(clientContextKey{}).(cluster.Client); ok {
53-
return client, nil
52+
if clnt, ok := ctx.Value(clientContextKey{}).(cluster.Client); ok {
53+
return clnt, nil
5454
}
5555
return nil, fmt.Errorf("client not found in context")
5656
}

pkg/component/reconcile.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ const (
6464
// manager), and the current (potentially unsaved) state of the component.
6565
// Post-hooks will only be called if the according operation (read, reconcile, delete)
6666
// has been successful.
67-
type HookFunc[T Component] func(ctx context.Context, client client.Client, component T) error
67+
type HookFunc[T Component] func(ctx context.Context, clnt client.Client, component T) error
6868

6969
// ReconcilerOptions are creation options for a Reconciler.
7070
type ReconcilerOptions struct {
@@ -500,9 +500,9 @@ func (r *Reconciler[T]) getClientForComponent(component T) (cluster.Client, erro
500500
}
501501
}
502502
}
503-
client, err := r.clients.Get(kubeconfig, impersonationUser, impersonationGroups)
503+
clnt, err := r.clients.Get(kubeconfig, impersonationUser, impersonationGroups)
504504
if err != nil {
505505
return nil, errors.Wrap(err, "error getting remote or impersonated client")
506506
}
507-
return client, nil
507+
return clnt, nil
508508
}

pkg/component/reference.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ type ConfigMapReference struct {
4242
loaded bool `json:"-"`
4343
}
4444

45-
func (r *ConfigMapReference) load(ctx context.Context, client client.Client, namespace string, ignoreNotFound bool) error {
45+
func (r *ConfigMapReference) load(ctx context.Context, clnt client.Client, namespace string, ignoreNotFound bool) error {
4646
configMap := &corev1.ConfigMap{}
47-
if err := client.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, configMap); err != nil {
47+
if err := clnt.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, configMap); err != nil {
4848
if apierrors.IsNotFound(err) {
4949
if ignoreNotFound {
5050
return nil
@@ -94,9 +94,9 @@ type ConfigMapKeyReference struct {
9494
loaded bool `json:"-"`
9595
}
9696

97-
func (r *ConfigMapKeyReference) load(ctx context.Context, client client.Client, namespace string, ignoreNotFound bool, fallbackKeys ...string) error {
97+
func (r *ConfigMapKeyReference) load(ctx context.Context, clnt client.Client, namespace string, ignoreNotFound bool, fallbackKeys ...string) error {
9898
configMap := &corev1.ConfigMap{}
99-
if err := client.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, configMap); err != nil {
99+
if err := clnt.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, configMap); err != nil {
100100
if apierrors.IsNotFound(err) {
101101
if ignoreNotFound {
102102
return nil
@@ -153,9 +153,9 @@ type SecretReference struct {
153153
loaded bool `json:"-"`
154154
}
155155

156-
func (r *SecretReference) load(ctx context.Context, client client.Client, namespace string, ignoreNotFound bool) error {
156+
func (r *SecretReference) load(ctx context.Context, clnt client.Client, namespace string, ignoreNotFound bool) error {
157157
secret := &corev1.Secret{}
158-
if err := client.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, secret); err != nil {
158+
if err := clnt.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, secret); err != nil {
159159
if apierrors.IsNotFound(err) {
160160
if ignoreNotFound {
161161
return nil
@@ -205,9 +205,9 @@ type SecretKeyReference struct {
205205
loaded bool `json:"-"`
206206
}
207207

208-
func (r *SecretKeyReference) load(ctx context.Context, client client.Client, namespace string, ignoreNotFound bool, fallbackKeys ...string) error {
208+
func (r *SecretKeyReference) load(ctx context.Context, clnt client.Client, namespace string, ignoreNotFound bool, fallbackKeys ...string) error {
209209
secret := &corev1.Secret{}
210-
if err := client.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, secret); err != nil {
210+
if err := clnt.Get(ctx, apitypes.NamespacedName{Namespace: namespace, Name: r.Name}, secret); err != nil {
211211
if apierrors.IsNotFound(err) {
212212
if ignoreNotFound {
213213
return nil
@@ -253,15 +253,15 @@ func (r *SecretKeyReference) Value() []byte {
253253
return r.value
254254
}
255255

256-
func resolveReferences[T Component](ctx context.Context, client client.Client, component T) error {
256+
func resolveReferences[T Component](ctx context.Context, clnt client.Client, component T) error {
257257
return walk.Walk(getSpec(component), func(x any, path []string, tag reflect.StructTag) error {
258258
switch r := x.(type) {
259259
case *ConfigMapReference:
260260
if r == nil {
261261
return nil
262262
}
263263
ignoreNotFound := !component.GetDeletionTimestamp().IsZero() && tag.Get(tagNotFoundPolicy) == notFoundPolicyIgnoreOnDeletion
264-
return r.load(ctx, client, component.GetNamespace(), ignoreNotFound)
264+
return r.load(ctx, clnt, component.GetNamespace(), ignoreNotFound)
265265
case *ConfigMapKeyReference:
266266
if r == nil {
267267
return nil
@@ -271,13 +271,13 @@ func resolveReferences[T Component](ctx context.Context, client client.Client, c
271271
if s := tag.Get(tagFallbackKeys); s != "" {
272272
fallbackKeys = strings.Split(s, ",")
273273
}
274-
return r.load(ctx, client, component.GetNamespace(), ignoreNotFound, fallbackKeys...)
274+
return r.load(ctx, clnt, component.GetNamespace(), ignoreNotFound, fallbackKeys...)
275275
case *SecretReference:
276276
if r == nil {
277277
return nil
278278
}
279279
ignoreNotFound := !component.GetDeletionTimestamp().IsZero() && tag.Get(tagNotFoundPolicy) == notFoundPolicyIgnoreOnDeletion
280-
return r.load(ctx, client, component.GetNamespace(), ignoreNotFound)
280+
return r.load(ctx, clnt, component.GetNamespace(), ignoreNotFound)
281281
case *SecretKeyReference:
282282
if r == nil {
283283
return nil
@@ -287,7 +287,7 @@ func resolveReferences[T Component](ctx context.Context, client client.Client, c
287287
if s := tag.Get(tagFallbackKeys); s != "" {
288288
fallbackKeys = strings.Split(s, ",")
289289
}
290-
return r.load(ctx, client, component.GetNamespace(), ignoreNotFound, fallbackKeys...)
290+
return r.load(ctx, clnt, component.GetNamespace(), ignoreNotFound, fallbackKeys...)
291291
}
292292
return nil
293293
})

pkg/component/target.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ type reconcileTarget[T Component] struct {
6868
annotationKeyOwnerId string
6969
}
7070

71-
func newReconcileTarget[T Component](reconcilerName string, reconcilerId string, client cluster.Client, resourceGenerator manifests.Generator, createMissingNamespaces bool, adoptionPolicy AdoptionPolicy) *reconcileTarget[T] {
71+
func newReconcileTarget[T Component](reconcilerName string, reconcilerId string, clnt cluster.Client, resourceGenerator manifests.Generator, createMissingNamespaces bool, adoptionPolicy AdoptionPolicy) *reconcileTarget[T] {
7272
return &reconcileTarget[T]{
7373
reconcilerName: reconcilerName,
7474
reconcilerId: reconcilerId,
75-
client: client,
75+
client: clnt,
7676
resourceGenerator: resourceGenerator,
7777
createMissingNamespaces: createMissingNamespaces,
7878
adoptionPolicy: adoptionPolicy,

pkg/manifests/helm/generator.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ var _ manifests.Generator = &HelmGenerator{}
5353
// If fsys is nil, the local operating system filesystem will be used, and chartPath can be an absolute or relative path (in the latter case it will be considered
5454
// relative to the current working directory). If fsys is non-nil, then chartPath should be a relative path; if an absolute path is supplied, it will be turned
5555
// An empty chartPath will be treated like ".".
56-
func NewHelmGenerator(fsys fs.FS, chartPath string, client client.Client) (*HelmGenerator, error) {
56+
func NewHelmGenerator(fsys fs.FS, chartPath string, clnt client.Client) (*HelmGenerator, error) {
5757
g := HelmGenerator{
5858
data: make(map[string]any),
5959
}
@@ -162,7 +162,7 @@ func NewHelmGenerator(fsys fs.FS, chartPath string, client client.Client) (*Helm
162162
Funcs(sprig.TxtFuncMap()).
163163
Funcs(templatex.FuncMap()).
164164
Funcs(templatex.FuncMapForTemplate(t)).
165-
Funcs(templatex.FuncMapForLocalClient(client)).
165+
Funcs(templatex.FuncMapForLocalClient(clnt)).
166166
Funcs(templatex.FuncMapForClient(nil))
167167
} else {
168168
t = t.New(manifest)
@@ -189,26 +189,26 @@ func NewHelmGenerator(fsys fs.FS, chartPath string, client client.Client) (*Helm
189189
}
190190

191191
// Create a new HelmGenerator as TransformableGenerator.
192-
func NewTransformableHelmGenerator(fsys fs.FS, chartPath string, client client.Client) (manifests.TransformableGenerator, error) {
193-
g, err := NewHelmGenerator(fsys, chartPath, client)
192+
func NewTransformableHelmGenerator(fsys fs.FS, chartPath string, clnt client.Client) (manifests.TransformableGenerator, error) {
193+
g, err := NewHelmGenerator(fsys, chartPath, clnt)
194194
if err != nil {
195195
return nil, err
196196
}
197197
return manifests.NewGenerator(g), nil
198198
}
199199

200200
// Create a new HelmGenerator with a ParameterTransformer attached (further transformers can be attached to the returned generator object).
201-
func NewHelmGeneratorWithParameterTransformer(fsys fs.FS, chartPath string, client client.Client, transformer manifests.ParameterTransformer) (manifests.TransformableGenerator, error) {
202-
g, err := NewTransformableHelmGenerator(fsys, chartPath, client)
201+
func NewHelmGeneratorWithParameterTransformer(fsys fs.FS, chartPath string, clnt client.Client, transformer manifests.ParameterTransformer) (manifests.TransformableGenerator, error) {
202+
g, err := NewTransformableHelmGenerator(fsys, chartPath, clnt)
203203
if err != nil {
204204
return nil, err
205205
}
206206
return g.WithParameterTransformer(transformer), nil
207207
}
208208

209209
// Create a new HelmGenerator with an ObjectTransformer attached (further transformers can be attached to the returned generator object).
210-
func NewHelmGeneratorWithObjectTransformer(fsys fs.FS, chartPath string, client client.Client, transformer manifests.ObjectTransformer) (manifests.TransformableGenerator, error) {
211-
g, err := NewTransformableHelmGenerator(fsys, chartPath, client)
210+
func NewHelmGeneratorWithObjectTransformer(fsys fs.FS, chartPath string, clnt client.Client, transformer manifests.ObjectTransformer) (manifests.TransformableGenerator, error) {
211+
g, err := NewTransformableHelmGenerator(fsys, chartPath, clnt)
212212
if err != nil {
213213
return nil, err
214214
}
@@ -223,7 +223,7 @@ func (g *HelmGenerator) Generate(ctx context.Context, namespace string, name str
223223
if err != nil {
224224
return nil, err
225225
}
226-
client, err := component.ClientFromContext(ctx)
226+
clnt, err := component.ClientFromContext(ctx)
227227
if err != nil {
228228
return nil, err
229229
}
@@ -238,7 +238,7 @@ func (g *HelmGenerator) Generate(ctx context.Context, namespace string, name str
238238
data[k] = v
239239
}
240240

241-
capabilities, err := helm.GetCapabilities(client.DiscoveryClient())
241+
capabilities, err := helm.GetCapabilities(clnt.DiscoveryClient())
242242
if err != nil {
243243
return nil, err
244244
}
@@ -280,7 +280,7 @@ func (g *HelmGenerator) Generate(ctx context.Context, namespace string, name str
280280
return nil, err
281281
}
282282
t0.Option("missingkey=zero").
283-
Funcs(templatex.FuncMapForClient(client))
283+
Funcs(templatex.FuncMapForClient(clnt))
284284
}
285285
for _, t := range g.templates {
286286
data["Template"] = &helm.TemplateData{

pkg/manifests/kustomize/generator.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ var _ manifests.Generator = &KustomizeGenerator{}
5252
// If fsys is nil, the local operating system filesystem will be used, and kustomizationPath can be an absolute or relative path (in the latter case it will be considered
5353
// relative to the current working directory). If fsys is non-nil, then kustomizationPath should be a relative path; if an absolute path is supplied, it will be turned
5454
// An empty kustomizationPath will be treated like ".".
55-
func NewKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix string, client client.Client) (*KustomizeGenerator, error) {
55+
func NewKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix string, clnt client.Client) (*KustomizeGenerator, error) {
5656
g := KustomizeGenerator{
5757
files: make(map[string][]byte),
5858
templates: make(map[string]*template.Template),
@@ -105,7 +105,7 @@ func NewKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix
105105
Funcs(sprig.TxtFuncMap()).
106106
Funcs(templatex.FuncMap()).
107107
Funcs(templatex.FuncMapForTemplate(t)).
108-
Funcs(templatex.FuncMapForLocalClient(client)).
108+
Funcs(templatex.FuncMapForLocalClient(clnt)).
109109
Funcs(templatex.FuncMapForClient(nil)).
110110
Funcs(funcMapForGenerateContext(nil, nil, "", ""))
111111
} else {
@@ -126,26 +126,26 @@ func NewKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix
126126
}
127127

128128
// Create a new KustomizeGenerator as TransformableGenerator.
129-
func NewTransformableKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix string, client client.Client) (manifests.TransformableGenerator, error) {
130-
g, err := NewKustomizeGenerator(fsys, kustomizationPath, templateSuffix, client)
129+
func NewTransformableKustomizeGenerator(fsys fs.FS, kustomizationPath string, templateSuffix string, clnt client.Client) (manifests.TransformableGenerator, error) {
130+
g, err := NewKustomizeGenerator(fsys, kustomizationPath, templateSuffix, clnt)
131131
if err != nil {
132132
return nil, err
133133
}
134134
return manifests.NewGenerator(g), nil
135135
}
136136

137137
// Create a new KustomizeGenerator with a ParameterTransformer attached (further transformers can be attached to the returned generator object).
138-
func NewKustomizeGeneratorWithParameterTransformer(fsys fs.FS, kustomizationPath string, templateSuffix string, client client.Client, transformer manifests.ParameterTransformer) (manifests.TransformableGenerator, error) {
139-
g, err := NewTransformableKustomizeGenerator(fsys, kustomizationPath, templateSuffix, client)
138+
func NewKustomizeGeneratorWithParameterTransformer(fsys fs.FS, kustomizationPath string, templateSuffix string, clnt client.Client, transformer manifests.ParameterTransformer) (manifests.TransformableGenerator, error) {
139+
g, err := NewTransformableKustomizeGenerator(fsys, kustomizationPath, templateSuffix, clnt)
140140
if err != nil {
141141
return nil, err
142142
}
143143
return g.WithParameterTransformer(transformer), nil
144144
}
145145

146146
// Create a new KustomizeGenerator with an ObjectTransformer attached (further transformers can be attached to the returned generator object).
147-
func NewKustomizeGeneratorWithObjectTransformer(fsys fs.FS, kustomizationPath string, templateSuffix string, client client.Client, transformer manifests.ObjectTransformer) (manifests.TransformableGenerator, error) {
148-
g, err := NewTransformableKustomizeGenerator(fsys, kustomizationPath, templateSuffix, client)
147+
func NewKustomizeGeneratorWithObjectTransformer(fsys fs.FS, kustomizationPath string, templateSuffix string, clnt client.Client, transformer manifests.ObjectTransformer) (manifests.TransformableGenerator, error) {
148+
g, err := NewTransformableKustomizeGenerator(fsys, kustomizationPath, templateSuffix, clnt)
149149
if err != nil {
150150
return nil, err
151151
}
@@ -156,7 +156,7 @@ func NewKustomizeGeneratorWithObjectTransformer(fsys fs.FS, kustomizationPath st
156156
func (g *KustomizeGenerator) Generate(ctx context.Context, namespace string, name string, parameters types.Unstructurable) ([]client.Object, error) {
157157
var objects []client.Object
158158

159-
client, err := component.ClientFromContext(ctx)
159+
clnt, err := component.ClientFromContext(ctx)
160160
if err != nil {
161161
return nil, err
162162
}
@@ -182,8 +182,8 @@ func (g *KustomizeGenerator) Generate(ctx context.Context, namespace string, nam
182182
return nil, err
183183
}
184184
t0.Option("missingkey=zero").
185-
Funcs(templatex.FuncMapForClient(client)).
186-
Funcs(funcMapForGenerateContext(client, component, namespace, name))
185+
Funcs(templatex.FuncMapForClient(clnt)).
186+
Funcs(funcMapForGenerateContext(clnt, component, namespace, name))
187187
}
188188
var buf bytes.Buffer
189189
if err := t0.ExecuteTemplate(&buf, t.Name(), data); err != nil {
@@ -239,7 +239,7 @@ func (g *KustomizeGenerator) Generate(ctx context.Context, namespace string, nam
239239
return objects, nil
240240
}
241241

242-
func funcMapForGenerateContext(client cluster.Client, component component.Component, namespace string, name string) template.FuncMap {
242+
func funcMapForGenerateContext(clnt cluster.Client, component component.Component, namespace string, name string) template.FuncMap {
243243
// TODO: add accessors for Kubernetes version etc.
244244
return template.FuncMap{
245245
// TODO: maybe it would it be better to convert component to unstructured;

0 commit comments

Comments
 (0)