Enable gci, goprintffuncname, nolintlint linters (#2500)

Co-authored-by: saima-s <sultanasaima506@gmail.com>
kanisterio · Jul 12, 2024 · 80ef874 · 80ef874
1 parent 79c5c13
commit 80ef874
Show file tree

Hide file tree

Showing 44 changed files with 78 additions and 84 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -24,6 +24,9 @@ linters:
     - importas
     - misspell
     - nestif
+    - gci
+    - goprintffuncname
+    - nolintlint
 
 run:
   timeout: 10m                          # golangci-lint run's timeout.
@@ -32,6 +35,7 @@ run:
     - "integration"
 
 issues:
+  exclude-use-default: false
   exclude-rules:
     - path: '_test.go'
       linters:
@@ -41,7 +45,7 @@ issues:
         - dupl
         - misspell
         - nestif
-
+        - gci
     - text: "`ctx` is unused"           # Context might not be in use in places, but for consistency, we pass it.
       linters:
         - unparam
@@ -66,3 +70,17 @@ linters-settings:
         alias: crv1alpha1
   nestif:
     min-complexity: 6
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/kanisterio/kanister)
+      - blank
+      - dot
+    skip-generated: true
+
+exclude-dirs:
+  - pkg/client/applyconfiguration/cr/v1alpha1 # generated from code-gen
+  - pkg/client/clientset # generated from code-gen
+  - pkg/client/informers # generated from code-gen
+  - pkg/client/listers # generated from code-gen
diff --git a/cmd/reposervercontroller/main.go b/cmd/reposervercontroller/main.go
@@ -27,7 +27,6 @@ import (
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	"k8s.io/client-go/discovery"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
-	_ "k8s.io/client-go/plugin/pkg/client/auth"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
@@ -40,7 +39,10 @@ import (
 	"github.com/kanisterio/kanister/pkg/log"
 	"github.com/kanisterio/kanister/pkg/resource"
 	"github.com/kanisterio/kanister/pkg/validatingwebhook"
+	//nolint:gci
 	//+kubebuilder:scaffold:imports
+
+	_ "k8s.io/client-go/plugin/pkg/client/auth"
 )
 
 var (

diff --git a/pkg/app/kafka.go b/pkg/app/kafka.go
@@ -500,7 +500,7 @@ func (kc *KafkaCluster) InsertRecord(ctx context.Context, namespace string) erro
 	if resp.StatusCode != 200 {
 		return errkit.New("Error inserting records in topic")
 	}
-	defer resp.Body.Close()
+	defer resp.Body.Close() //nolint:errcheck
 	bytes, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return err
@@ -617,7 +617,7 @@ func createConsumerGroup(uri string) error {
 		// we are checking if consumer is already present and if not present it should be created
 		return errkit.New("Error creating consumer")
 	}
-	defer resp.Body.Close()
+	defer resp.Body.Close() //nolint:errcheck
 	bytes, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return err
@@ -650,7 +650,7 @@ func subscribe(uri string) error {
 	if resp.StatusCode != 204 {
 		return errkit.New("Error subscribing to the topic")
 	}
-	defer resp.Body.Close()
+	defer resp.Body.Close() //nolint:errcheck
 	bytes, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return err
@@ -674,7 +674,7 @@ func consumeMessage(uri string) (int, error) {
 	if err != nil {
 		return 0, err
 	}
-	defer resp.Body.Close()
+	defer resp.Body.Close() //nolint:errcheck
 	bytes, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return 0, err

diff --git a/pkg/blockstorage/awsebs/awsebs_test.go b/pkg/blockstorage/awsebs/awsebs_test.go
@@ -25,9 +25,8 @@ import (
 	. "gopkg.in/check.v1"
 
 	kaws "github.com/kanisterio/kanister/pkg/aws"
-	envconfig "github.com/kanisterio/kanister/pkg/config"
-
 	"github.com/kanisterio/kanister/pkg/blockstorage"
+	envconfig "github.com/kanisterio/kanister/pkg/config"
 )
 
 // Hook up gocheck into the "go test" runner.

diff --git a/pkg/blockstorage/azure/azure_instance_metadata.go b/pkg/blockstorage/azure/azure_instance_metadata.go
@@ -111,6 +111,6 @@ func (i *InstanceMetadata) queryMetadataBytes(path, format string) ([]byte, erro
 	if resp.StatusCode != http.StatusOK {
 		return nil, errors.Errorf("Failed to get instance metadata with statusCode: %d, Path: %s", resp.StatusCode, path)
 	}
-	defer resp.Body.Close()
+	defer resp.Body.Close() //nolint:errcheck
 	return io.ReadAll(resp.Body)
 }
diff --git a/pkg/blockstorage/azure/azuredisk.go b/pkg/blockstorage/azure/azuredisk.go
@@ -1,8 +1,5 @@
 // TODO: Switch to using the latest azure sdk and remove nolint.
 // Related Ticket- https://github.com/kanisterio/kanister/issues/1684
-//
-//nolint:staticcheck
-
 package azure
 
 import (

diff --git a/pkg/blockstorage/azure/client.go b/pkg/blockstorage/azure/client.go
@@ -14,8 +14,6 @@
 
 // TODO: Switch to using the latest azure sdk and remove nolint.
 // Related Ticket- https://github.com/kanisterio/kanister/issues/168
-//
-//nolint:staticcheck
 package azure
 
 import (

diff --git a/pkg/blueprint/validate/validate.go b/pkg/blueprint/validate/validate.go
@@ -21,9 +21,10 @@ import (
 
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
-	_ "github.com/kanisterio/kanister/pkg/function"
 	"github.com/kanisterio/kanister/pkg/param"
 	"github.com/kanisterio/kanister/pkg/utils"
+
+	_ "github.com/kanisterio/kanister/pkg/function"
 )
 
 const (

diff --git a/pkg/controller/controller.go b/pkg/controller/controller.go
@@ -27,6 +27,7 @@ import (
 	"strings"
 	"sync"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	"github.com/pkg/errors"
 	"github.com/prometheus/client_golang/prometheus"
 	"gopkg.in/tomb.v2"
@@ -40,8 +41,6 @@ import (
 	"k8s.io/client-go/tools/record"
 	"k8s.io/client-go/tools/reference"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	"github.com/kanisterio/kanister/pkg/client/clientset/versioned"
@@ -51,11 +50,12 @@ import (
 	"github.com/kanisterio/kanister/pkg/eventer"
 	"github.com/kanisterio/kanister/pkg/field"
 	"github.com/kanisterio/kanister/pkg/log"
-	_ "github.com/kanisterio/kanister/pkg/metrics"
 	"github.com/kanisterio/kanister/pkg/param"
 	"github.com/kanisterio/kanister/pkg/progress"
 	"github.com/kanisterio/kanister/pkg/reconcile"
 	"github.com/kanisterio/kanister/pkg/validate"
+
+	_ "github.com/kanisterio/kanister/pkg/metrics"
 )
 
 // Controller represents a controller object for kanister custom resources

diff --git a/pkg/controller/controller_test.go b/pkg/controller/controller_test.go
@@ -153,7 +153,6 @@ func (s *ControllerSuite) TestWatch(c *C) {
 	time.Sleep(5 * time.Second)
 }
 
-//nolint:unparam
 func (s *ControllerSuite) waitOnActionSetState(c *C, as *crv1alpha1.ActionSet, state crv1alpha1.State) error {
 	ctx, cancel := context.WithTimeout(context.Background(), 40*time.Second)
 	defer cancel()
@@ -180,7 +179,6 @@ func (s *ControllerSuite) waitOnActionSetState(c *C, as *crv1alpha1.ActionSet, s
 	return errors.Wrapf(err, "State '%s' never reached", state)
 }
 
-//nolint:unparam
 func (s *ControllerSuite) waitOnDeferPhaseState(c *C, as *crv1alpha1.ActionSet, state crv1alpha1.State) error {
 	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Minute)
 	defer cancel()
@@ -206,7 +204,6 @@ func (s *ControllerSuite) waitOnDeferPhaseState(c *C, as *crv1alpha1.ActionSet,
 	return errors.Wrapf(err, "State '%s' never reached", state)
 }
 
-//nolint:unparam
 func (s *ControllerSuite) waitOnActionSetCompleteWithRunningPhases(as *crv1alpha1.ActionSet, rp *sets.Set[string]) error {
 	ctx, cancel := context.WithTimeout(context.Background(), 120*time.Second)
 	defer cancel()

diff --git a/pkg/customresource/customresource.go b/pkg/customresource/customresource.go
@@ -32,8 +32,7 @@ import (
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/util/retry"
 
-	// importing go check to bypass the testing flags
-	_ "gopkg.in/check.v1"
+	_ "gopkg.in/check.v1" // importing go check to bypass the testing flags
 )
 
 const serverVersionV170 = "v1.7.0"

diff --git a/pkg/function/data_test.go b/pkg/function/data_test.go
@@ -20,15 +20,14 @@ import (
 	"fmt"
 	"os"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	. "gopkg.in/check.v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/dynamic/fake"
 	"k8s.io/client-go/kubernetes"
 	k8sscheme "k8s.io/client-go/kubernetes/scheme"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	"github.com/kanisterio/kanister/pkg/client/clientset/versioned"

diff --git a/pkg/function/e2e_volume_snapshot_test.go b/pkg/function/e2e_volume_snapshot_test.go
@@ -19,6 +19,7 @@ import (
 	"os"
 	"strings"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	"golang.org/x/oauth2/google"
 	"google.golang.org/api/compute/v1"
 	. "gopkg.in/check.v1"
@@ -30,8 +31,6 @@ import (
 	"k8s.io/client-go/kubernetes"
 	k8sscheme "k8s.io/client-go/kubernetes/scheme"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	awsconfig "github.com/kanisterio/kanister/pkg/aws"

diff --git a/pkg/function/kube_exec_all_test.go b/pkg/function/kube_exec_all_test.go
@@ -18,15 +18,14 @@ import (
 	"context"
 	"fmt"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	. "gopkg.in/check.v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/dynamic/fake"
 	"k8s.io/client-go/kubernetes"
 	k8sscheme "k8s.io/client-go/kubernetes/scheme"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	"github.com/kanisterio/kanister/pkg/client/clientset/versioned"

diff --git a/pkg/function/kube_exec_test.go b/pkg/function/kube_exec_test.go
@@ -19,15 +19,14 @@ import (
 	"fmt"
 	"strings"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	. "gopkg.in/check.v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/dynamic/fake"
 	"k8s.io/client-go/kubernetes"
 	k8sscheme "k8s.io/client-go/kubernetes/scheme"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	"github.com/kanisterio/kanister/pkg/client/clientset/versioned"

diff --git a/pkg/function/prepare_data.go b/pkg/function/prepare_data.go
@@ -132,7 +132,7 @@ func prepareDataPodFunc(cli kubernetes.Interface) func(ctx context.Context, pc k
 		if err != nil {
 			return nil, errors.Wrapf(err, "Failed to fetch logs from the pod")
 		}
-		defer r.Close()
+		defer r.Close() //nolint:errcheck
 
 		bytes, err := io.ReadAll(r)
 		if err != nil {

diff --git a/pkg/function/restore_csi_snapshot_test.go b/pkg/function/restore_csi_snapshot_test.go
@@ -17,15 +17,15 @@ package function
 import (
 	"context"
 
-	"github.com/kanisterio/kanister/pkg/kube/snapshot"
-
 	. "gopkg.in/check.v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	dynfake "k8s.io/client-go/dynamic/fake"
 	"k8s.io/client-go/kubernetes/fake"
+
+	"github.com/kanisterio/kanister/pkg/kube/snapshot"
 )
 
 const (

diff --git a/pkg/function/scale_test.go b/pkg/function/scale_test.go
@@ -18,15 +18,14 @@ import (
 	"context"
 	"fmt"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	. "gopkg.in/check.v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/dynamic/fake"
 	"k8s.io/client-go/kubernetes"
 	k8sscheme "k8s.io/client-go/kubernetes/scheme"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	kanister "github.com/kanisterio/kanister/pkg"
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	"github.com/kanisterio/kanister/pkg/client/clientset/versioned"

diff --git a/pkg/jsonpath/jsonpath_test.go b/pkg/jsonpath/jsonpath_test.go
@@ -18,7 +18,6 @@ import (
 	"testing"
 
 	. "gopkg.in/check.v1"
-
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/kubernetes/scheme"
 )

diff --git a/pkg/kancontroller/kancontroller.go b/pkg/kancontroller/kancontroller.go
@@ -34,12 +34,13 @@ import (
 	"k8s.io/client-go/rest"
 
 	"github.com/kanisterio/kanister/pkg/controller"
-	_ "github.com/kanisterio/kanister/pkg/function"
 	"github.com/kanisterio/kanister/pkg/handler"
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/log"
 	"github.com/kanisterio/kanister/pkg/resource"
 	"github.com/kanisterio/kanister/pkg/validatingwebhook"
+
+	_ "github.com/kanisterio/kanister/pkg/function"
 )
 
 const (

diff --git a/pkg/kanctl/actionset.go b/pkg/kanctl/actionset.go
@@ -1,4 +1,4 @@
-// Copyright 2019 The Kanister Authors.
+// Copyright 2024 The Kanister Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ import (
 	"strings"
 	"sync"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -31,8 +32,6 @@ import (
 	"k8s.io/client-go/kubernetes"
 	"sigs.k8s.io/yaml"
 
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
-
 	crv1alpha1 "github.com/kanisterio/kanister/pkg/apis/cr/v1alpha1"
 	"github.com/kanisterio/kanister/pkg/client/clientset/versioned"
 	"github.com/kanisterio/kanister/pkg/kube"

diff --git a/pkg/kanctl/kanctl.go b/pkg/kanctl/kanctl.go
@@ -17,6 +17,7 @@ package kanctl
 import (
 	"os"
 
+	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"k8s.io/client-go/kubernetes"
@@ -25,8 +26,6 @@ import (
 	"github.com/kanisterio/kanister/pkg/kube"
 	"github.com/kanisterio/kanister/pkg/log"
 	"github.com/kanisterio/kanister/pkg/version"
-
-	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 )
 
 const (