chore: enable gofumpt, gosimple and whitespace linters (#666)

Signed-off-by: Matthieu MOREL <[email protected]>

Author: mmorel-35

.golangci.yaml

@@ -1,12 +1,19 @@
 issues:
   exclude-files:
     - "pkg/diff/internal/fieldmanager/borrowed_.*\\.go$"
+  max-issues-per-linter: 0
+  max-same-issues: 0
 linters:
   enable:
+    - gofumpt
+    - gosimple
     - testifylint
+    - whitespace
 linters-settings:
   testifylint:
     enable-all: true
     disable:
       - go-require
       - require-error
+run:
+  timeout: 5m

pkg/cache/cluster.go

@@ -110,8 +110,10 @@ type OnProcessEventsHandler func(duration time.Duration, processedEventsNumber i
 type OnPopulateResourceInfoHandler func(un *unstructured.Unstructured, isRoot bool) (info interface{}, cacheManifest bool)
 
 // OnResourceUpdatedHandler handlers resource update event
-type OnResourceUpdatedHandler func(newRes *Resource, oldRes *Resource, namespaceResources map[kube.ResourceKey]*Resource)
-type Unsubscribe func()
+type (
+	OnResourceUpdatedHandler func(newRes *Resource, oldRes *Resource, namespaceResources map[kube.ResourceKey]*Resource)
+	Unsubscribe              func()
+)
 
 type ClusterCache interface {
 	// EnsureSynced checks cache state and synchronizes it if necessary
@@ -332,6 +334,7 @@ func (c *clusterCache) OnProcessEventsHandler(handler OnProcessEventsHandler) Un
 		delete(c.processEventsHandlers, key)
 	}
 }
+
 func (c *clusterCache) getProcessEventsHandlers() []OnProcessEventsHandler {
 	c.handlersLock.Lock()
 	defer c.handlersLock.Unlock()
@@ -559,7 +562,6 @@ func (c *clusterCache) startMissingWatches() error {
 						delete(namespacedResources, api.GroupKind)
 						return nil
 					}
-
 				}
 				go c.watchEvents(ctx, api, resClient, ns, resourceVersion)
 				return nil
@@ -635,7 +637,6 @@ func (c *clusterCache) loadInitialState(ctx context.Context, api kube.APIResourc
 			return nil
 		})
 	})
-
 	if err != nil {
 		return "", fmt.Errorf("failed to load initial state of resource %s: %w", api.GroupKind.String(), err)
 	}
@@ -727,9 +728,11 @@ func (c *clusterCache) watchEvents(ctx context.Context, api kube.APIResourceInfo
 					for _, v := range crd.Spec.Versions {
 						resources = append(resources, kube.APIResourceInfo{
 							GroupKind: schema.GroupKind{
-								Group: crd.Spec.Group, Kind: crd.Spec.Names.Kind},
+								Group: crd.Spec.Group, Kind: crd.Spec.Names.Kind,
+							},
 							GroupVersionResource: schema.GroupVersionResource{
-								Group: crd.Spec.Group, Version: v.Name, Resource: crd.Spec.Names.Plural},
+								Group: crd.Spec.Group, Version: v.Name, Resource: crd.Spec.Names.Plural,
+							},
 							Meta: metav1.APIResource{
 								Group:        crd.Spec.Group,
 								SingularName: crd.Spec.Names.Singular,
@@ -881,7 +884,6 @@ func (c *clusterCache) sync() error {
 	c.namespacedResources = make(map[schema.GroupKind]bool)
 	config := c.config
 	version, err := c.kubectl.GetServerVersion(config)
-
 	if err != nil {
 		return err
 	}
@@ -904,7 +906,6 @@ func (c *clusterCache) sync() error {
 	c.openAPISchema = openAPISchema
 
 	apis, err := c.kubectl.GetAPIResources(c.config, true, c.settings.ResourcesFilter)
-
 	if err != nil {
 		return err
 	}
@@ -974,7 +975,6 @@ func (c *clusterCache) sync() error {
 			return nil
 		})
 	})
-
 	if err != nil {
 		c.log.Error(err, "Failed to sync cluster")
 		return fmt.Errorf("failed to sync cluster %s: %v", c.config.Host, err)
@@ -1409,11 +1409,9 @@ func (c *clusterCache) onNodeRemoved(key kube.ResourceKey) {
 	}
 }
 
-var (
-	ignoredRefreshResources = map[string]bool{
-		"/" + kube.EndpointsKind: true,
-	}
-)
+var ignoredRefreshResources = map[string]bool{
+	"/" + kube.EndpointsKind: true,
+}
 
 // GetClusterInfo returns cluster cache statistics
 func (c *clusterCache) GetClusterInfo() ClusterInfo {

pkg/cache/cluster_test.go

@@ -148,7 +148,7 @@ func getChildren(cluster *clusterCache, un *unstructured.Unstructured) []*Resour
 
 // Benchmark_sync is meant to simulate cluster initialization when populateResourceInfoHandler does nontrivial work.
 func Benchmark_sync(t *testing.B) {
-	var resources = []runtime.Object{}
+	resources := []runtime.Object{}
 	for i := 0; i < 100; i++ {
 		resources = append(resources, &corev1.Pod{
 			ObjectMeta: metav1.ObjectMeta{
@@ -617,8 +617,8 @@ metadata:
   name: test-crontab
   namespace: default`)
 
-			var convertToVersionWasCalled = false
-			var getResourceWasCalled = false
+			convertToVersionWasCalled := false
+			getResourceWasCalled := false
 			cluster.kubectl.(*kubetest.MockKubectlCmd).
 				WithConvertToVersionFunc(func(obj *unstructured.Unstructured, _ string, _ string) (*unstructured.Unstructured, error) {
 					convertToVersionWasCalled = true
@@ -1059,7 +1059,8 @@ func TestIterateHierachy(t *testing.T) {
 				kube.GetResourceKey(mustToUnstructured(testPod1())),
 				kube.GetResourceKey(mustToUnstructured(testPod2())),
 				kube.GetResourceKey(mustToUnstructured(testRS())),
-				kube.GetResourceKey(mustToUnstructured(testDeploy()))},
+				kube.GetResourceKey(mustToUnstructured(testDeploy())),
+			},
 			keys)
 	})
 
@@ -1072,7 +1073,8 @@ func TestIterateHierachy(t *testing.T) {
 
 		assert.ElementsMatch(t,
 			[]kube.ResourceKey{
-				kube.GetResourceKey(mustToUnstructured(testDeploy()))},
+				kube.GetResourceKey(mustToUnstructured(testDeploy())),
+			},
 			keys)
 	})
 
@@ -1120,7 +1122,8 @@ func TestIterateHierachy(t *testing.T) {
 			[]kube.ResourceKey{
 				kube.GetResourceKey(mustToUnstructured(testPod1())),
 				kube.GetResourceKey(mustToUnstructured(testPod2())),
-				kube.GetResourceKey(mustToUnstructured(testExtensionsRS()))},
+				kube.GetResourceKey(mustToUnstructured(testExtensionsRS())),
+			},
 			keys)
 	})
 }
@@ -1143,7 +1146,8 @@ func TestIterateHierachyV2(t *testing.T) {
 				kube.GetResourceKey(mustToUnstructured(testPod1())),
 				kube.GetResourceKey(mustToUnstructured(testPod2())),
 				kube.GetResourceKey(mustToUnstructured(testRS())),
-				kube.GetResourceKey(mustToUnstructured(testDeploy()))},
+				kube.GetResourceKey(mustToUnstructured(testDeploy())),
+			},
 			keys)
 	})
 
@@ -1157,7 +1161,8 @@ func TestIterateHierachyV2(t *testing.T) {
 
 		assert.ElementsMatch(t,
 			[]kube.ResourceKey{
-				kube.GetResourceKey(mustToUnstructured(testDeploy()))},
+				kube.GetResourceKey(mustToUnstructured(testDeploy())),
+			},
 			keys)
 	})
 
@@ -1211,7 +1216,8 @@ func TestIterateHierachyV2(t *testing.T) {
 				kube.GetResourceKey(mustToUnstructured(testPod1())),
 				kube.GetResourceKey(mustToUnstructured(testPod2())),
 				kube.GetResourceKey(mustToUnstructured(testRS())),
-				kube.GetResourceKey(mustToUnstructured(testDeploy()))},
+				kube.GetResourceKey(mustToUnstructured(testDeploy())),
+			},
 			keys)
 	})
 
@@ -1228,7 +1234,8 @@ func TestIterateHierachyV2(t *testing.T) {
 			[]kube.ResourceKey{
 				kube.GetResourceKey(mustToUnstructured(testPod1())),
 				kube.GetResourceKey(mustToUnstructured(testPod2())),
-				kube.GetResourceKey(mustToUnstructured(testExtensionsRS()))},
+				kube.GetResourceKey(mustToUnstructured(testExtensionsRS())),
+			},
 			keys)
 	})
 }

pkg/cache/references.go

@@ -3,11 +3,12 @@ package cache
 import (
 	"encoding/json"
 	"fmt"
+	"regexp"
+
 	v1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/types"
-	"regexp"
 
 	"github.com/argoproj/gitops-engine/pkg/utils/kube"
 )
@@ -23,7 +24,6 @@ func (c *clusterCache) resolveResourceReferences(un *unstructured.Unstructured)
 	gvk := un.GroupVersionKind()
 
 	switch {
-
 	// Special case for endpoint. Remove after https://github.com/kubernetes/kubernetes/issues/28483 is fixed
 	case gvk.Group == "" && gvk.Kind == kube.EndpointsKind && len(ownerRefs) == 0:
 		ownerRefs = append(ownerRefs, metav1.OwnerReference{

pkg/cache/references_test.go

@@ -1,13 +1,14 @@
 package cache
 
 import (
+	"testing"
+
 	"github.com/argoproj/gitops-engine/pkg/utils/kube"
 	"github.com/stretchr/testify/assert"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
-	"testing"
 )
 
 func Test_isStatefulSetChild(t *testing.T) {

pkg/cache/resource.go

@@ -2,6 +2,7 @@ package cache
 
 import (
 	"fmt"
+
 	"k8s.io/apimachinery/pkg/types"
 
 	v1 "k8s.io/api/core/v1"
@@ -36,7 +37,6 @@ func (r *Resource) ResourceKey() kube.ResourceKey {
 
 func (r *Resource) isParentOf(child *Resource) bool {
 	for i, ownerRef := range child.OwnerRefs {
-
 		// backfill UID of inferred owner child references
 		if ownerRef.UID == "" && r.Ref.Kind == ownerRef.Kind && r.Ref.APIVersion == ownerRef.APIVersion && r.Ref.Name == ownerRef.Name {
 			ownerRef.UID = r.Ref.UID

pkg/cache/settings.go

@@ -17,8 +17,7 @@ func NewNoopSettings() *noopSettings {
 	return &noopSettings{}
 }
 
-type noopSettings struct {
-}
+type noopSettings struct{}
 
 func (f *noopSettings) GetResourceHealth(_ *unstructured.Unstructured) (*health.HealthStatus, error) {
 	return nil, nil

pkg/diff/diff.go

@@ -55,8 +55,7 @@ type DiffResultList struct {
 	Modified bool
 }
 
-type noopNormalizer struct {
-}
+type noopNormalizer struct{}
 
 func (n *noopNormalizer) Normalize(un *unstructured.Unstructured) error {
 	return nil
@@ -318,7 +317,6 @@ type SMDParams struct {
 }
 
 func structuredMergeDiff(p *SMDParams) (*DiffResult, error) {
-
 	gvk := p.config.GetObjectKind().GroupVersionKind()
 	pt := gescheme.ResolveParseableType(gvk, p.gvkParser)
 	if pt == nil {
@@ -372,7 +370,6 @@ func structuredMergeDiff(p *SMDParams) (*DiffResult, error) {
 // to correctly calculate the diff with the same logic used in k8s with server-side
 // apply.
 func apply(tvConfig, tvLive *typed.TypedValue, p *SMDParams) (*typed.TypedValue, error) {
-
 	// Build the structured-merge-diff Updater
 	updater := merge.Updater{
 		Converter: fieldmanager.NewVersionConverter(p.gvkParser, scheme.Scheme, p.config.GroupVersionKind().GroupVersion()),
@@ -485,7 +482,6 @@ func handleResourceCreateOrDeleteDiff(config, live *unstructured.Unstructured) (
 // generateSchemeDefaultPatch runs the scheme default functions on the given parameter, and
 // return a patch representing the delta vs the origin parameter object.
 func generateSchemeDefaultPatch(kubeObj runtime.Object) ([]byte, error) {
-
 	// 1) Call scheme defaulter functions on a clone of our k8s resource object
 	patched := kubeObj.DeepCopyObject()
 	gescheme.Scheme.Default(patched)
@@ -511,7 +507,6 @@ func generateSchemeDefaultPatch(kubeObj runtime.Object) ([]byte, error) {
 // applyPatch executes kubernetes server side patch:
 // uses corresponding data structure, applies appropriate defaults and executes strategic merge patch
 func applyPatch(liveBytes []byte, patchBytes []byte, newVersionedObject func() (runtime.Object, error)) ([]byte, []byte, error) {
-
 	// Construct an empty instance of the object we are applying a patch against
 	predictedLive, err := newVersionedObject()
 	if err != nil {
@@ -527,7 +522,6 @@ func applyPatch(liveBytes []byte, patchBytes []byte, newVersionedObject func() (
 	// Unmarshal predictedLiveBytes into predictedLive; note that this will discard JSON fields in predictedLiveBytes
 	// which are not in the predictedLive struct. predictedLive is thus "tainted" and we should not use it directly.
 	if err = json.Unmarshal(predictedLiveBytes, &predictedLive); err == nil {
-
 		// 1) Calls 'kubescheme.Scheme.Default(predictedLive)' and generates a patch containing the delta of that
 		// call, which can then be applied to predictedLiveBytes.
 		//
@@ -571,7 +565,6 @@ func applyPatch(liveBytes []byte, patchBytes []byte, newVersionedObject func() (
 	// However, this is much less likely since liveBytes is coming from a live k8s instance which
 	// has already accepted those resources. Regardless, we still treat 'live' as tainted.
 	if err = json.Unmarshal(liveBytes, live); err == nil {
-
 		// As above, indirectly apply the schema defaults against liveBytes
 		patch, err := generateSchemeDefaultPatch(live)
 		if err != nil {
@@ -592,7 +585,6 @@ func applyPatch(liveBytes []byte, patchBytes []byte, newVersionedObject func() (
 		if err != nil {
 			return nil, nil, err
 		}
-
 	}
 
 	return liveBytes, predictedLiveBytes, nil
@@ -968,7 +960,6 @@ func normalizeRole(un *unstructured.Unstructured, o options) {
 	if rules != nil && len(rules) == 0 {
 		un.Object["rules"] = nil
 	}
-
 }
 
 // CreateTwoWayMergePatch is a helper to construct a two-way merge patch from objects (instead of bytes)

pkg/diff/diff_test.go

@@ -58,7 +58,7 @@ func printDiffInternal(name string, live *unstructured.Unstructured, target *uns
 			return nil, err
 		}
 	}
-	err = os.WriteFile(targetFile, targetData, 0644)
+	err = os.WriteFile(targetFile, targetData, 0o644)
 	if err != nil {
 		return nil, err
 	}
@@ -70,7 +70,7 @@ func printDiffInternal(name string, live *unstructured.Unstructured, target *uns
 			return nil, err
 		}
 	}
-	err = os.WriteFile(liveFile, liveData, 0644)
+	err = os.WriteFile(liveFile, liveData, 0o644)
 	if err != nil {
 		return nil, err
 	}
@@ -390,7 +390,6 @@ func TestThreeWayDiffExample1(t *testing.T) {
 	if ascii != "" {
 		t.Log(ascii)
 	}
-
 }
 
 // Test for ignoring aggregated cluster roles
@@ -507,7 +506,6 @@ func TestThreeWayDiffExplicitNamespace(t *testing.T) {
 }
 
 func TestDiffResourceWithInvalidField(t *testing.T) {
-
 	// Diff(...) should not silently discard invalid fields (fields that are not present in the underlying k8s resource).
 
 	leftDep := `{
@@ -1091,7 +1089,7 @@ func TestHideStringDataInInvalidSecret(t *testing.T) {
 
 // stringData in secrets should be normalized even if it is invalid
 func TestNormalizeSecret(t *testing.T) {
-	var tests = []struct {
+	tests := []struct {
 		testname   string
 		data       map[string]interface{}
 		stringData map[string]interface{}
@@ -1223,7 +1221,6 @@ func TestHideSecretAnnotations(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-
 			unSecret := &unstructured.Unstructured{
 				Object: map[string]interface{}{
 					"apiVersion": "v1",
@@ -1395,7 +1392,6 @@ func TestHideSecretDataLastAppliedConfig(t *testing.T) {
 	assert.Equal(t, map[string]interface{}{"key1": replacement1}, secretData(target))
 	assert.Equal(t, map[string]interface{}{"key1": replacement2}, secretData(live))
 	assert.Equal(t, map[string]interface{}{"key1": replacement3}, secretData(lastAppliedSecret))
-
 }
 
 func TestRemarshal(t *testing.T) {