Lint fixes

Danil-Grigorev · Danil-Grigorev · commit 1b3bc4b36d16 · 2025-04-09T15:28:09.000+02:00
Signed-off-by: Danil Grigorev &lt;danil.grigorev@suse.com&gt;
diff --git a/cmd/main.go b/cmd/main.go
@@ -136,7 +136,9 @@ func main() {
 	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
 	pflag.Parse()
 
-	ctrl.SetLogger(textlogger.NewLogger(textlogger.NewConfig()))
+	loggerConfig := textlogger.NewConfig([]textlogger.ConfigOption{}...)
+	ctrl.SetLogger(textlogger.NewLogger(loggerConfig))
+
 	restConfig := ctrl.GetConfigOrDie()
 
 	tlsOptions, metricsOptions, err := flags.GetManagerOptions(managerOptions)
diff --git a/cmd/plugin/cmd/delete.go b/cmd/plugin/cmd/delete.go
@@ -28,9 +28,10 @@ import (
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/fields"
-	kerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/wait"
 	"k8s.io/klog/v2/textlogger"
+
+	kerrors "k8s.io/apimachinery/pkg/util/errors"
 	ctrl "sigs.k8s.io/controller-runtime"
 
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
@@ -140,7 +141,8 @@ func init() {
 func runDelete() error {
 	ctx := context.Background()
 
-	ctrl.SetLogger(textlogger.NewLogger(textlogger.NewConfig()))
+	loggerConfig := textlogger.NewConfig([]textlogger.ConfigOption{}...)
+	ctrl.SetLogger(textlogger.NewLogger(loggerConfig))
 
 	hasProviderNames := deleteOpts.coreProvider ||
 		(len(deleteOpts.bootstrapProviders) > 0) ||
diff --git a/cmd/plugin/cmd/init_test.go b/cmd/plugin/cmd/init_test.go
@@ -327,7 +327,7 @@ func TestInitProviders(t *testing.T) {
 
 			for _, genericProvider := range tt.wantedProviders {
 				g.Eventually(func(g Gomega) {
-					copy := genericProvider.DeepCopyObject().(generic.Provider)
+					copy := genericProvider.DeepCopyObject().(generic.Provider) //nolint
 					g.Expect(env.Get(ctx, ctrlclient.ObjectKeyFromObject(genericProvider), copy)).To(Succeed())
 					g.Expect(copy.GetSpec().Version).To(Equal(genericProvider.GetSpec().Version))
 				}, waitShort).Should(Succeed())
diff --git a/cmd/plugin/cmd/suite_test.go b/cmd/plugin/cmd/suite_test.go
@@ -28,7 +28,7 @@ import (
 
 	operatorv1 "sigs.k8s.io/cluster-api-operator/api/v1alpha2"
 
-	// We need to initalize all registered providers
+	// We need to initialize all registered providers.
 	_ "sigs.k8s.io/cluster-api-operator/internal/controller/providers"
 )
 
diff --git a/cmd/plugin/main.go b/cmd/plugin/main.go
@@ -21,7 +21,7 @@ import (
 
 	"sigs.k8s.io/cluster-api-operator/cmd/plugin/cmd"
 
-	// We need to initalize all registered providers
+	// We need to initialize all registered providers.
 	_ "sigs.k8s.io/cluster-api-operator/internal/controller/providers"
 )
 
diff --git a/go.mod b/go.mod
@@ -13,6 +13,7 @@ require (
 	github.com/google/go-cmp v0.7.0
 	github.com/google/go-github/v52 v52.0.0
 	github.com/google/gofuzz v1.2.0
+	github.com/onsi/ginkgo/v2 v2.23.3
 	github.com/onsi/gomega v1.37.0
 	github.com/opencontainers/image-spec v1.1.1
 	github.com/spf13/cobra v1.9.1
@@ -57,6 +58,7 @@ require (
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/jsonreference v0.20.2 // indirect
 	github.com/go-openapi/swag v0.23.0 // indirect
+	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
 	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
 	github.com/gobuffalo/flect v1.0.3 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
@@ -66,6 +68,7 @@ require (
 	github.com/google/gnostic-models v0.6.9-0.20230804172637-c7be7c783f49 // indirect
 	github.com/google/go-github/v53 v53.2.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/google/pprof v0.0.0-20241210010833-40e02aabc2ad // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 // indirect
 	github.com/huandu/xstrings v1.5.0 // indirect
@@ -112,6 +115,7 @@ require (
 	golang.org/x/term v0.30.0 // indirect
 	golang.org/x/text v0.23.0 // indirect
 	golang.org/x/time v0.8.0 // indirect
+	golang.org/x/tools v0.30.0 // indirect
 	gomodules.xyz/jsonpatch/v2 v2.5.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20241223144023-3abc09e42ca8 // indirect
diff --git a/internal/controller/generic/interfaces.go b/internal/controller/generic/interfaces.go
@@ -59,7 +59,7 @@ type Group[P Provider] interface {
 	GetClusterctlProvider() *clusterctlv1.Provider
 }
 
-// NewGroup is a function that creates a new group
+// NewGroup is a function that creates a new group.
 type NewGroup[P Provider] func(P, ProviderList, GroupBuilder[P]) Group[P]
 
 type ProviderReconciler[P Provider] interface {
diff --git a/internal/controller/phases/preflight_checks_test.go b/internal/controller/phases/preflight_checks_test.go
@@ -457,7 +457,7 @@ func TestInfrastructurePreflightChecks(t *testing.T) {
 			}
 
 			for _, c := range tc.otherProviders {
-				gs.Expect(fakeclient.Create(ctx, c.DeepCopyObject().(client.Object))).To(Succeed())
+				gs.Expect(fakeclient.Create(ctx, c.DeepCopyObject().(client.Object))).To(Succeed()) //nolint:forcetypeassert
 			}
 
 			rec := providercontroller.NewProviderControllerWrapper(
diff --git a/internal/controller/provider_controller_wrapper.go b/internal/controller/provider_controller_wrapper.go
@@ -25,8 +25,6 @@ import (
 	"hash"
 	"reflect"
 
-	"reflect"
-
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
@@ -64,7 +62,7 @@ const (
 )
 
 func (r *ProviderControllerWrapper[P, R]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, options controller.Options) error {
-	provider := reflect.New(reflect.TypeOf(*new(P)).Elem()).Interface().(P)
+	provider := reflect.New(reflect.TypeOf(*new(P)).Elem()).Interface().(P) //nolint:forcetypeassert
 	builder := ctrl.NewControllerManagedBy(mgr).
 		For(provider).
 		WithOptions(options)
@@ -85,7 +83,7 @@ func (r *ProviderControllerWrapper[P, R]) SetupWithManager(ctx context.Context,
 	}
 
 	// We don't want to receive secondary events from the CoreProvider for itself.
-	if reflect.TypeOf(provider) != reflect.TypeOf(genericprovider.GenericProvider(&operatorv1.CoreProvider{})) {
+	if reflect.TypeOf(provider) != reflect.TypeOf(&operatorv1.CoreProvider{}) {
 		builder.Watches(
 			&operatorv1.CoreProvider{},
 			handler.EnqueueRequestsFromMapFunc(newCoreProviderToProviderFuncMapForProviderList(mgr.GetClient(), r.Reconciler.GetProviderList())),
diff --git a/internal/controller/provider_controller_wrapper_test.go b/internal/controller/provider_controller_wrapper_test.go
@@ -392,6 +392,7 @@ releaseSeries:
 		}
 
 		conditions.MarkTrue(core, clusterv1.ReadyCondition)
+
 		return env.Status().Update(ctx, core)
 	}).Should(Succeed())
 
diff --git a/internal/controller/providers/addon.go b/internal/controller/providers/addon.go
@@ -36,17 +36,18 @@ func NewAddonProviderReconciler(conn generic.Connector) generic.ProviderReconcil
 	}
 }
 
-// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider
+// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider.
 func (r *AddonProviderReconciler) ClusterctlProviderType() clusterctlv1.ProviderType {
 	return clusterctlv1.AddonProviderType
 }
 
-// ClusterctlProvider returns Provider stucture of the underlying clusterctl provider
+// ClusterctlProvider returns Provider structure of the underlying clusterctl provider.
 func (r *AddonProviderReconciler) ClusterctlProvider(provider *operatorv1.AddonProvider) *clusterctlv1.Provider {
-	clusterctlProvider := &clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{
-		Name:      "addon-" + provider.GetName(),
-		Namespace: provider.GetNamespace(),
-	},
+	clusterctlProvider := &clusterctlv1.Provider{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "addon-" + provider.GetName(),
+			Namespace: provider.GetNamespace(),
+		},
 		Type:         string(r.ClusterctlProviderType()),
 		ProviderName: provider.GetName(),
 		Version:      *util.Or(provider.GetStatus().InstalledVersion, ptr.To("")),
@@ -55,7 +56,7 @@ func (r *AddonProviderReconciler) ClusterctlProvider(provider *operatorv1.AddonP
 	return clusterctlProvider
 }
 
-// ProviderList returns empty typed list for provider
+// GetProviderList returns empty typed list for provider.
 func (r *AddonProviderReconciler) GetProviderList() generic.ProviderList {
 	return &operatorv1.AddonProviderList{}
 }
diff --git a/internal/controller/providers/bootstrap.go b/internal/controller/providers/bootstrap.go
@@ -36,17 +36,18 @@ func NewBootstrapProviderReconciler(conn generic.Connector) generic.ProviderReco
 	}
 }
 
-// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider
+// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider.
 func (r *BootstrapProviderReconciler) ClusterctlProviderType() clusterctlv1.ProviderType {
 	return clusterctlv1.BootstrapProviderType
 }
 
-// ClusterctlProvider returns Provider stucture of the underlying clusterctl provider
+// ClusterctlProvider returns Provider structure of the underlying clusterctl provider.
 func (r *BootstrapProviderReconciler) ClusterctlProvider(provider *operatorv1.BootstrapProvider) *clusterctlv1.Provider {
-	clusterctlProvider := &clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{
-		Name:      "bootstrap-" + provider.GetName(),
-		Namespace: provider.GetNamespace(),
-	},
+	clusterctlProvider := &clusterctlv1.Provider{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "bootstrap-" + provider.GetName(),
+			Namespace: provider.GetNamespace(),
+		},
 		Type:         string(r.ClusterctlProviderType()),
 		ProviderName: provider.GetName(),
 		Version:      *util.Or(provider.GetStatus().InstalledVersion, ptr.To("")),
@@ -55,7 +56,7 @@ func (r *BootstrapProviderReconciler) ClusterctlProvider(provider *operatorv1.Bo
 	return clusterctlProvider
 }
 
-// ProviderList returns empty typed list for provider
+// GetProviderList returns empty typed list for provider.
 func (r *BootstrapProviderReconciler) GetProviderList() generic.ProviderList {
 	return &operatorv1.BootstrapProviderList{}
 }
diff --git a/internal/controller/providers/control_plane.go b/internal/controller/providers/control_plane.go
@@ -35,17 +35,18 @@ func NewControlPlaneProviderReconciler(conn generic.Connector) generic.ProviderR
 	}
 }
 
-// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider
+// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider.
 func (r *ControlPlaneProviderReconciler) ClusterctlProviderType() clusterctlv1.ProviderType {
 	return clusterctlv1.ControlPlaneProviderType
 }
 
-// ClusterctlProvider returns Provider stucture of the underlying clusterctl provider
+// ClusterctlProvider returns Provider structure of the underlying clusterctl provider.
 func (r *ControlPlaneProviderReconciler) ClusterctlProvider(provider *operatorv1.ControlPlaneProvider) *clusterctlv1.Provider {
-	clusterctlProvider := &clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{
-		Name:      "control-plane-" + provider.GetName(),
-		Namespace: provider.GetNamespace(),
-	},
+	clusterctlProvider := &clusterctlv1.Provider{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "control-plane-" + provider.GetName(),
+			Namespace: provider.GetNamespace(),
+		},
 		Type:         string(r.ClusterctlProviderType()),
 		ProviderName: provider.GetName(),
 		Version:      *util.Or(provider.GetStatus().InstalledVersion, ptr.To("")),
@@ -54,7 +55,7 @@ func (r *ControlPlaneProviderReconciler) ClusterctlProvider(provider *operatorv1
 	return clusterctlProvider
 }
 
-// ProviderList returns empty typed list for provider
+// GetProviderList returns empty typed list for provider.
 func (r *ControlPlaneProviderReconciler) GetProviderList() generic.ProviderList {
 	return &operatorv1.ControlPlaneProviderList{}
 }
diff --git a/internal/controller/providers/core.go b/internal/controller/providers/core.go
@@ -42,7 +42,7 @@ func NewCoreProviderReconcier(conn generic.Connector) generic.ProviderReconciler
 	}
 }
 
-// ReconcileNormal implements GenericReconciler.
+// PreflightChecks implements GenericReconciler.
 func (r *CoreProviderReconciler) PreflightChecks(
 	ctx context.Context,
 	provider *operatorv1.CoreProvider,
@@ -53,17 +53,18 @@ func (r *CoreProviderReconciler) PreflightChecks(
 	)
 }
 
-// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider
+// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider.
 func (r *CoreProviderReconciler) ClusterctlProviderType() clusterctlv1.ProviderType {
 	return clusterctlv1.CoreProviderType
 }
 
-// ClusterctlProvider returns Provider stucture of the underlying clusterctl provider
+// ClusterctlProvider returns Provider structure of the underlying clusterctl provider.
 func (r *CoreProviderReconciler) ClusterctlProvider(provider *operatorv1.CoreProvider) *clusterctlv1.Provider {
-	clusterctlProvider := &clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{
-		Name:      provider.GetName(),
-		Namespace: provider.GetNamespace(),
-	},
+	clusterctlProvider := &clusterctlv1.Provider{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      provider.GetName(),
+			Namespace: provider.GetNamespace(),
+		},
 		Type:         string(r.ClusterctlProviderType()),
 		ProviderName: provider.GetName(),
 		Version:      *util.Or(provider.GetStatus().InstalledVersion, ptr.To("")),
@@ -72,7 +73,7 @@ func (r *CoreProviderReconciler) ClusterctlProvider(provider *operatorv1.CorePro
 	return clusterctlProvider
 }
 
-// ProviderList returns empty typed list for provider
+// GetProviderList returns empty typed list for provider.
 func (r *CoreProviderReconciler) GetProviderList() generic.ProviderList {
 	return &operatorv1.CoreProviderList{}
 }
@@ -110,7 +111,6 @@ func (r *CoreProviderReconciler) corePreflightChecks(ctx context.Context, phase
 		conditions.Set(phase.GetProvider(), preflightFalseCondition)
 
 		return ctrl.Result{}, fmt.Errorf("only one instance of CoreProvider is allowed")
-
 	}
 
 	return ctrl.Result{}, nil
diff --git a/internal/controller/providers/generic_provider.go b/internal/controller/providers/generic_provider.go
@@ -97,24 +97,24 @@ func (r *GenericProviderReconcier[P]) ReportStatus(ctx context.Context, provider
 	)
 }
 
-// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider
+// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider.
 func (r *GenericProviderReconcier[P]) ClusterctlProviderType() clusterctlv1.ProviderType {
 	panic("Generic Provider Reconciler has no provider type")
 }
 
-// ClusterctlProvider returns initialized underlying clusterctl provider
+// ClusterctlProvider returns initialized underlying clusterctl provider.
 func (r *GenericProviderReconcier[P]) ClusterctlProvider(provider P) *clusterctlv1.Provider {
 	panic("Generic Provider Reconciler has no clusterctl provider")
 }
 
-// GetProviderList returns empty typed list for provider
+// GetProviderList returns empty typed list for provider.
 func (r *GenericProviderReconcier[P]) GetProviderList() generic.ProviderList {
 	panic("Generic Provider Reconciler has no provider list")
 }
 
-// GenericProvider returns empty typed provider for generic reconciler
+// GenericProvider returns empty typed provider for generic reconciler.
 func (r *GenericProviderReconcier[P]) GenericProvider() generic.Provider {
-	return reflect.New(reflect.TypeOf(*new(P)).Elem()).Interface().(P)
+	return reflect.New(reflect.TypeOf(*new(P)).Elem()).Interface().(P) //nolint:forcetypeassert
 }
 
 type CommonProviderReconciler[P generic.Provider] struct {
@@ -127,7 +127,7 @@ func NewCommonProviderReconciler[P generic.Provider](conn generic.Connector) gen
 	}
 }
 
-// ReconcileNormal implements GenericReconciler.
+// PreflightChecks implements GenericReconciler.
 func (r *CommonProviderReconciler[P]) PreflightChecks(
 	ctx context.Context,
 	provider P,
diff --git a/internal/controller/providers/infrastructure.go b/internal/controller/providers/infrastructure.go
@@ -35,17 +35,18 @@ func NewInfrastructureProviderReconciler(conn generic.Connector) generic.Provide
 	}
 }
 
-// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider
+// ClusterctlProviderType returns ProviderType for the underlying clusterctl provider.
 func (r *InfrastructureProviderReconciler) ClusterctlProviderType() clusterctlv1.ProviderType {
 	return clusterctlv1.InfrastructureProviderType
 }
 
-// ClusterctlProvider returns Provider stucture of the underlying clusterctl provider
+// ClusterctlProvider returns Provider structure of the underlying clusterctl provider.
 func (r *InfrastructureProviderReconciler) ClusterctlProvider(provider *operatorv1.InfrastructureProvider) *clusterctlv1.Provider {
-	clusterctlProvider := &clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{
-		Name:      "infrastructure-" + provider.GetName(),
-		Namespace: provider.GetNamespace(),
-	},
+	clusterctlProvider := &clusterctlv1.Provider{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "infrastructure-" + provider.GetName(),
+			Namespace: provider.GetNamespace(),
+		},
 		Type:         string(r.ClusterctlProviderType()),
 		ProviderName: provider.GetName(),
 		Version:      *util.Or(provider.GetStatus().InstalledVersion, ptr.To("")),
@@ -54,7 +55,7 @@ func (r *InfrastructureProviderReconciler) ClusterctlProvider(provider *operator
 	return clusterctlProvider
 }
 
-// ProviderList returns empty typed list for provider
+// GetProviderList returns empty typed list for provider.
 func (r *InfrastructureProviderReconciler) GetProviderList() generic.ProviderList {
 	return &operatorv1.InfrastructureProviderList{}
 }
diff --git a/internal/controller/providers/ipam.go b/internal/controller/providers/ipam.go
diff --git a/internal/controller/proxy/client_proxy.go b/internal/controller/proxy/client_proxy.go
diff --git a/internal/envtest/environment.go b/internal/envtest/environment.go
diff --git a/util/util.go b/util/util.go

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ import (`
`28`	`28`
`29`	`29`	`operatorv1 "sigs.k8s.io/cluster-api-operator/api/v1alpha2"`
`30`	`30`
`31`		`- // We need to initalize all registered providers`
	`31`	`+ // We need to initialize all registered providers.`
`32`	`32`	`_ "sigs.k8s.io/cluster-api-operator/internal/controller/providers"`
`33`	`33`	`)`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ import (`
`21`	`21`
`22`	`22`	`"sigs.k8s.io/cluster-api-operator/cmd/plugin/cmd"`
`23`	`23`
`24`		`- // We need to initalize all registered providers`
	`24`	`+ // We need to initialize all registered providers.`
`25`	`25`	`_ "sigs.k8s.io/cluster-api-operator/internal/controller/providers"`
`26`	`26`	`)`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ type Group[P Provider] interface {`
`59`	`59`	`GetClusterctlProvider() *clusterctlv1.Provider`
`60`	`60`	`}`
`61`	`61`
`62`		`-// NewGroup is a function that creates a new group`
	`62`	`+// NewGroup is a function that creates a new group.`
`63`	`63`	`type NewGroup[P Provider] func(P, ProviderList, GroupBuilder[P]) Group[P]`
`64`	`64`
`65`	`65`	`type ProviderReconciler[P Provider] interface {`
Original file line number	Diff line number	Diff line change
`@@ -457,7 +457,7 @@ func TestInfrastructurePreflightChecks(t *testing.T) {`
`457`	`457`	`}`
`458`	`458`
`459`	`459`	`for _, c := range tc.otherProviders {`
`460`		`- gs.Expect(fakeclient.Create(ctx, c.DeepCopyObject().(client.Object))).To(Succeed())`
	`460`	`+ gs.Expect(fakeclient.Create(ctx, c.DeepCopyObject().(client.Object))).To(Succeed()) //nolint:forcetypeassert`
`461`	`461`	`}`
`462`	`462`
`463`	`463`	`rec := providercontroller.NewProviderControllerWrapper(`
Original file line number	Diff line number	Diff line change
`@@ -392,6 +392,7 @@ releaseSeries:`
`392`	`392`	`}`
`393`	`393`
`394`	`394`	`conditions.MarkTrue(core, clusterv1.ReadyCondition)`
	`395`	`+`
`395`	`396`	`return env.Status().Update(ctx, core)`
`396`	`397`	`}).Should(Succeed())`
`397`	`398`