Skip to content

Commit 5b3dda0

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #4627 from koba1t/fix/use_limited_scoped_error_in_generated_main.go
🐛 (go/v4) Update main.go scaffold to follow Go best practices by reducing the scope of err using short variable declarations (:=)
2 parents ab2821c + ddbfbbb commit 5b3dda0

File tree

9 files changed

+55
-55
lines changed

9 files changed

+55
-55
lines changed

‎docs/book/src/cronjob-tutorial/testdata/project/cmd/main.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ func main() {
224224

225225
// +kubebuilder:docs-gen:collapse=old stuff
226226

227-
if err = (&controller.CronJobReconciler{
227+
if err := (&controller.CronJobReconciler{
228228
Client: mgr.GetClient(),
229229
Scheme: mgr.GetScheme(),
230230
}).SetupWithManager(mgr); err != nil {
@@ -242,7 +242,7 @@ func main() {
242242
*/
243243
// nolint:goconst
244244
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
245-
if err = webhookbatchv1.SetupCronJobWebhookWithManager(mgr); err != nil {
245+
if err := webhookbatchv1.SetupCronJobWebhookWithManager(mgr); err != nil {
246246
setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
247247
os.Exit(1)
248248
}

‎docs/book/src/getting-started/testdata/project/cmd/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ func main() {
202202
os.Exit(1)
203203
}
204204

205-
if err = (&controller.MemcachedReconciler{
205+
if err := (&controller.MemcachedReconciler{
206206
Client: mgr.GetClient(),
207207
Scheme: mgr.GetScheme(),
208208
}).SetupWithManager(mgr); err != nil {

‎docs/book/src/multiversion-tutorial/testdata/project/cmd/main.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ func main() {
221221
os.Exit(1)
222222
}
223223

224-
if err = (&controller.CronJobReconciler{
224+
if err := (&controller.CronJobReconciler{
225225
Client: mgr.GetClient(),
226226
Scheme: mgr.GetScheme(),
227227
}).SetupWithManager(mgr); err != nil {
@@ -235,14 +235,14 @@ func main() {
235235
*/
236236
// nolint:goconst
237237
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
238-
if err = webhookbatchv1.SetupCronJobWebhookWithManager(mgr); err != nil {
238+
if err := webhookbatchv1.SetupCronJobWebhookWithManager(mgr); err != nil {
239239
setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
240240
os.Exit(1)
241241
}
242242
}
243243
// nolint:goconst
244244
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
245-
if err = webhookbatchv2.SetupCronJobWebhookWithManager(mgr); err != nil {
245+
if err := webhookbatchv2.SetupCronJobWebhookWithManager(mgr); err != nil {
246246
setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
247247
os.Exit(1)
248248
}

‎docs/book/src/reference/raising-events.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Events are published from a Controller using an [EventRecorder][Events]`type Cor
4747
which can be created for a Controller by calling `GetRecorder(name string)` on a Manager. See that we will change the implementation scaffolded in `cmd/main.go`:
4848

4949
```go
50-
if err = (&controller.MyKindReconciler{
50+
if err := (&controller.MyKindReconciler{
5151
Client: mgr.GetClient(),
5252
Scheme: mgr.GetScheme(),
5353
// Note that we added the following line:
@@ -81,7 +81,7 @@ Events are published from a Controller using an [EventRecorder]`type CorrelatorO
8181
which can be created for a Controller by calling `GetRecorder(name string)` on a Manager. See that we will change the implementation scaffolded in `cmd/main.go`:
8282

8383
```go
84-
if err = (&controller.MyKindReconciler{
84+
if err := (&controller.MyKindReconciler{
8585
Client: mgr.GetClient(),
8686
Scheme: mgr.GetScheme(),
8787
// Note that we added the following line:

‎hack/docs/internal/multiversion-tutorial/generate_multiversion.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ interfaces, a conversion webhook will be registered.
276276
"Expected validation to pass for a valid update")
277277
})
278278
})
279-
279+
280280
`)
281281
hackutils.CheckError("fix cronjob v1 tests after each", err)
282282
}
@@ -465,7 +465,7 @@ func (sp *Sample) updateWebhookV2() {
465465
"fmt"`,
466466
`
467467
"strings"
468-
468+
469469
"github.com/robfig/cron"
470470
apierrors "k8s.io/apimachinery/pkg/api/errors"
471471
"k8s.io/apimachinery/pkg/runtime/schema"
@@ -613,7 +613,7 @@ CronJob controller's `+"`SetupWithManager`"+` method.
613613

614614
err = pluginutil.InsertCode(
615615
filepath.Join(sp.ctx.Dir, path),
616-
`if err = (&controller.CronJobReconciler{
616+
`if err := (&controller.CronJobReconciler{
617617
Client: mgr.GetClient(),
618618
Scheme: mgr.GetScheme(),
619619
}).SetupWithManager(mgr); err != nil {

‎pkg/plugins/golang/v4/scaffolds/internal/templates/cmd/main.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,15 @@ const (
108108
`
109109
addschemeCodeFragment = `utilruntime.Must(%s.AddToScheme(scheme))
110110
`
111-
reconcilerSetupCodeFragment = `if err = (&controller.%sReconciler{
111+
reconcilerSetupCodeFragment = `if err := (&controller.%sReconciler{
112112
Client: mgr.GetClient(),
113113
Scheme: mgr.GetScheme(),
114114
}).SetupWithManager(mgr); err != nil {
115115
setupLog.Error(err, "unable to create controller", "controller", "%s")
116116
os.Exit(1)
117117
}
118118
`
119-
multiGroupReconcilerSetupCodeFragment = `if err = (&%scontroller.%sReconciler{
119+
multiGroupReconcilerSetupCodeFragment = `if err := (&%scontroller.%sReconciler{
120120
Client: mgr.GetClient(),
121121
Scheme: mgr.GetScheme(),
122122
}).SetupWithManager(mgr); err != nil {
@@ -126,7 +126,7 @@ const (
126126
`
127127
webhookSetupCodeFragmentLegacy = `// nolint:goconst
128128
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
129-
if err = (&%s.%s{}).SetupWebhookWithManager(mgr); err != nil {
129+
if err := (&%s.%s{}).SetupWebhookWithManager(mgr); err != nil {
130130
setupLog.Error(err, "unable to create webhook", "webhook", "%s")
131131
os.Exit(1)
132132
}
@@ -135,7 +135,7 @@ const (
135135

136136
webhookSetupCodeFragment = `// nolint:goconst
137137
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
138-
if err = %s.Setup%sWebhookWithManager(mgr); err != nil {
138+
if err := %s.Setup%sWebhookWithManager(mgr); err != nil {
139139
setupLog.Error(err, "unable to create webhook", "webhook", "%s")
140140
os.Exit(1)
141141
}
@@ -277,7 +277,7 @@ func main() {
277277
flag.StringVar(&webhookCertPath, "webhook-cert-path", "", "The directory that contains the webhook certificate.")
278278
flag.StringVar(&webhookCertName, "webhook-cert-name", "tls.crt", "The name of the webhook certificate file.")
279279
flag.StringVar(&webhookCertKey, "webhook-cert-key", "tls.key", "The name of the webhook key file.")
280-
flag.StringVar(&metricsCertPath, "metrics-cert-path", "",
280+
flag.StringVar(&metricsCertPath, "metrics-cert-path", "",
281281
"The directory that contains the metrics server certificate.")
282282
flag.StringVar(&metricsCertName, "metrics-cert-name", "tls.crt", "The name of the metrics server certificate file.")
283283
flag.StringVar(&metricsCertKey, "metrics-cert-key", "tls.key", "The name of the metrics server key file.")
@@ -315,7 +315,7 @@ func main() {
315315
if len(webhookCertPath) > 0 {
316316
setupLog.Info("Initializing webhook certificate watcher using provided certificates",
317317
"webhook-cert-path", webhookCertPath, "webhook-cert-name", webhookCertName, "webhook-cert-key", webhookCertKey)
318-
318+
319319
var err error
320320
webhookCertWatcher, err = certwatcher.New(
321321
filepath.Join(webhookCertPath, webhookCertName),
@@ -325,7 +325,7 @@ func main() {
325325
setupLog.Error(err, "Failed to initialize webhook certificate watcher")
326326
os.Exit(1)
327327
}
328-
328+
329329
webhookTLSOpts = append(webhookTLSOpts, func(config *tls.Config) {
330330
config.GetCertificate = webhookCertWatcher.GetCertificate
331331
})

‎testdata/project-v4-multigroup/cmd/main.go‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ func main() {
243243
os.Exit(1)
244244
}
245245

246-
if err = (&crewcontroller.CaptainReconciler{
246+
if err := (&crewcontroller.CaptainReconciler{
247247
Client: mgr.GetClient(),
248248
Scheme: mgr.GetScheme(),
249249
}).SetupWithManager(mgr); err != nil {
@@ -252,19 +252,19 @@ func main() {
252252
}
253253
// nolint:goconst
254254
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
255-
if err = webhookcrewv1.SetupCaptainWebhookWithManager(mgr); err != nil {
255+
if err := webhookcrewv1.SetupCaptainWebhookWithManager(mgr); err != nil {
256256
setupLog.Error(err, "unable to create webhook", "webhook", "Captain")
257257
os.Exit(1)
258258
}
259259
}
260-
if err = (&shipcontroller.FrigateReconciler{
260+
if err := (&shipcontroller.FrigateReconciler{
261261
Client: mgr.GetClient(),
262262
Scheme: mgr.GetScheme(),
263263
}).SetupWithManager(mgr); err != nil {
264264
setupLog.Error(err, "unable to create controller", "controller", "Frigate")
265265
os.Exit(1)
266266
}
267-
if err = (&shipcontroller.DestroyerReconciler{
267+
if err := (&shipcontroller.DestroyerReconciler{
268268
Client: mgr.GetClient(),
269269
Scheme: mgr.GetScheme(),
270270
}).SetupWithManager(mgr); err != nil {
@@ -273,12 +273,12 @@ func main() {
273273
}
274274
// nolint:goconst
275275
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
276-
if err = webhookshipv1.SetupDestroyerWebhookWithManager(mgr); err != nil {
276+
if err := webhookshipv1.SetupDestroyerWebhookWithManager(mgr); err != nil {
277277
setupLog.Error(err, "unable to create webhook", "webhook", "Destroyer")
278278
os.Exit(1)
279279
}
280280
}
281-
if err = (&shipcontroller.CruiserReconciler{
281+
if err := (&shipcontroller.CruiserReconciler{
282282
Client: mgr.GetClient(),
283283
Scheme: mgr.GetScheme(),
284284
}).SetupWithManager(mgr); err != nil {
@@ -287,54 +287,54 @@ func main() {
287287
}
288288
// nolint:goconst
289289
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
290-
if err = webhookshipv2alpha1.SetupCruiserWebhookWithManager(mgr); err != nil {
290+
if err := webhookshipv2alpha1.SetupCruiserWebhookWithManager(mgr); err != nil {
291291
setupLog.Error(err, "unable to create webhook", "webhook", "Cruiser")
292292
os.Exit(1)
293293
}
294294
}
295-
if err = (&seacreaturescontroller.KrakenReconciler{
295+
if err := (&seacreaturescontroller.KrakenReconciler{
296296
Client: mgr.GetClient(),
297297
Scheme: mgr.GetScheme(),
298298
}).SetupWithManager(mgr); err != nil {
299299
setupLog.Error(err, "unable to create controller", "controller", "Kraken")
300300
os.Exit(1)
301301
}
302-
if err = (&seacreaturescontroller.LeviathanReconciler{
302+
if err := (&seacreaturescontroller.LeviathanReconciler{
303303
Client: mgr.GetClient(),
304304
Scheme: mgr.GetScheme(),
305305
}).SetupWithManager(mgr); err != nil {
306306
setupLog.Error(err, "unable to create controller", "controller", "Leviathan")
307307
os.Exit(1)
308308
}
309-
if err = (&foopolicycontroller.HealthCheckPolicyReconciler{
309+
if err := (&foopolicycontroller.HealthCheckPolicyReconciler{
310310
Client: mgr.GetClient(),
311311
Scheme: mgr.GetScheme(),
312312
}).SetupWithManager(mgr); err != nil {
313313
setupLog.Error(err, "unable to create controller", "controller", "HealthCheckPolicy")
314314
os.Exit(1)
315315
}
316-
if err = (&appscontroller.DeploymentReconciler{
316+
if err := (&appscontroller.DeploymentReconciler{
317317
Client: mgr.GetClient(),
318318
Scheme: mgr.GetScheme(),
319319
}).SetupWithManager(mgr); err != nil {
320320
setupLog.Error(err, "unable to create controller", "controller", "Deployment")
321321
os.Exit(1)
322322
}
323-
if err = (&foocontroller.BarReconciler{
323+
if err := (&foocontroller.BarReconciler{
324324
Client: mgr.GetClient(),
325325
Scheme: mgr.GetScheme(),
326326
}).SetupWithManager(mgr); err != nil {
327327
setupLog.Error(err, "unable to create controller", "controller", "Bar")
328328
os.Exit(1)
329329
}
330-
if err = (&fizcontroller.BarReconciler{
330+
if err := (&fizcontroller.BarReconciler{
331331
Client: mgr.GetClient(),
332332
Scheme: mgr.GetScheme(),
333333
}).SetupWithManager(mgr); err != nil {
334334
setupLog.Error(err, "unable to create controller", "controller", "Bar")
335335
os.Exit(1)
336336
}
337-
if err = (&certmanagercontroller.CertificateReconciler{
337+
if err := (&certmanagercontroller.CertificateReconciler{
338338
Client: mgr.GetClient(),
339339
Scheme: mgr.GetScheme(),
340340
}).SetupWithManager(mgr); err != nil {
@@ -343,34 +343,34 @@ func main() {
343343
}
344344
// nolint:goconst
345345
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
346-
if err = webhookcertmanagerv1.SetupIssuerWebhookWithManager(mgr); err != nil {
346+
if err := webhookcertmanagerv1.SetupIssuerWebhookWithManager(mgr); err != nil {
347347
setupLog.Error(err, "unable to create webhook", "webhook", "Issuer")
348348
os.Exit(1)
349349
}
350350
}
351351
// nolint:goconst
352352
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
353-
if err = webhookcorev1.SetupPodWebhookWithManager(mgr); err != nil {
353+
if err := webhookcorev1.SetupPodWebhookWithManager(mgr); err != nil {
354354
setupLog.Error(err, "unable to create webhook", "webhook", "Pod")
355355
os.Exit(1)
356356
}
357357
}
358358
// nolint:goconst
359359
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
360-
if err = webhookappsv1.SetupDeploymentWebhookWithManager(mgr); err != nil {
360+
if err := webhookappsv1.SetupDeploymentWebhookWithManager(mgr); err != nil {
361361
setupLog.Error(err, "unable to create webhook", "webhook", "Deployment")
362362
os.Exit(1)
363363
}
364364
}
365-
if err = (&examplecomcontroller.MemcachedReconciler{
365+
if err := (&examplecomcontroller.MemcachedReconciler{
366366
Client: mgr.GetClient(),
367367
Scheme: mgr.GetScheme(),
368368
Recorder: mgr.GetEventRecorderFor("memcached-controller"),
369369
}).SetupWithManager(mgr); err != nil {
370370
setupLog.Error(err, "unable to create controller", "controller", "Memcached")
371371
os.Exit(1)
372372
}
373-
if err = (&examplecomcontroller.BusyboxReconciler{
373+
if err := (&examplecomcontroller.BusyboxReconciler{
374374
Client: mgr.GetClient(),
375375
Scheme: mgr.GetScheme(),
376376
Recorder: mgr.GetEventRecorderFor("busybox-controller"),
@@ -380,12 +380,12 @@ func main() {
380380
}
381381
// nolint:goconst
382382
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
383-
if err = webhookexamplecomv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {
383+
if err := webhookexamplecomv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {
384384
setupLog.Error(err, "unable to create webhook", "webhook", "Memcached")
385385
os.Exit(1)
386386
}
387387
}
388-
if err = (&examplecomcontroller.WordpressReconciler{
388+
if err := (&examplecomcontroller.WordpressReconciler{
389389
Client: mgr.GetClient(),
390390
Scheme: mgr.GetScheme(),
391391
}).SetupWithManager(mgr); err != nil {
@@ -394,7 +394,7 @@ func main() {
394394
}
395395
// nolint:goconst
396396
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
397-
if err = webhookexamplecomv1.SetupWordpressWebhookWithManager(mgr); err != nil {
397+
if err := webhookexamplecomv1.SetupWordpressWebhookWithManager(mgr); err != nil {
398398
setupLog.Error(err, "unable to create webhook", "webhook", "Wordpress")
399399
os.Exit(1)
400400
}

‎testdata/project-v4-with-plugins/cmd/main.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -208,15 +208,15 @@ func main() {
208208
os.Exit(1)
209209
}
210210

211-
if err = (&controller.MemcachedReconciler{
211+
if err := (&controller.MemcachedReconciler{
212212
Client: mgr.GetClient(),
213213
Scheme: mgr.GetScheme(),
214214
Recorder: mgr.GetEventRecorderFor("memcached-controller"),
215215
}).SetupWithManager(mgr); err != nil {
216216
setupLog.Error(err, "unable to create controller", "controller", "Memcached")
217217
os.Exit(1)
218218
}
219-
if err = (&controller.BusyboxReconciler{
219+
if err := (&controller.BusyboxReconciler{
220220
Client: mgr.GetClient(),
221221
Scheme: mgr.GetScheme(),
222222
Recorder: mgr.GetEventRecorderFor("busybox-controller"),
@@ -226,12 +226,12 @@ func main() {
226226
}
227227
// nolint:goconst
228228
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
229-
if err = webhookexamplecomv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {
229+
if err := webhookexamplecomv1alpha1.SetupMemcachedWebhookWithManager(mgr); err != nil {
230230
setupLog.Error(err, "unable to create webhook", "webhook", "Memcached")
231231
os.Exit(1)
232232
}
233233
}
234-
if err = (&controller.WordpressReconciler{
234+
if err := (&controller.WordpressReconciler{
235235
Client: mgr.GetClient(),
236236
Scheme: mgr.GetScheme(),
237237
}).SetupWithManager(mgr); err != nil {
@@ -240,7 +240,7 @@ func main() {
240240
}
241241
// nolint:goconst
242242
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
243-
if err = webhookexamplecomv1.SetupWordpressWebhookWithManager(mgr); err != nil {
243+
if err := webhookexamplecomv1.SetupWordpressWebhookWithManager(mgr); err != nil {
244244
setupLog.Error(err, "unable to create webhook", "webhook", "Wordpress")
245245
os.Exit(1)
246246
}

0 commit comments

Comments
 (0)