Enable stylecheck linter

.golangci.yml

@@ -24,6 +24,10 @@ linters:
     - importas
     - misspell
     - nestif
+    - gci
+    - goprintffuncname
+    - nolintlint
+    - stylecheck
 
 run:
   timeout: 10m                          # golangci-lint run's timeout.
@@ -32,6 +36,7 @@ run:
     - "integration"
 
 issues:
+  exclude-use-default: false
   exclude-rules:
     - path: '_test.go'
       linters:
@@ -41,6 +46,8 @@ issues:
         - dupl
         - misspell
         - nestif
+        - gci
+        - stylecheck
 
     - text: "`ctx` is unused"           # Context might not be in use in places, but for consistency, we pass it.
       linters:
@@ -66,3 +73,19 @@ linters-settings:
         alias: crv1alpha1
   nestif:
     min-complexity: 6
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/kanisterio/kanister)
+      - blank
+      - dot
+    skip-generated: true
+  stylecheck:
+    checks: [ "all", "-ST1001", "-ST1005", "-ST1016", "-ST1023", "-ST1000"]
+
+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

.goreleaser.yml

@@ -12,9 +12,9 @@ builds:
   main: cmd/kanctl/main.go
   ldflags: &ldflags
   - -extldflags "-static"
-    -X github.com/kanisterio/kanister/pkg/version.VERSION={{.Version}}
-    -X github.com/kanisterio/kanister/pkg/version.GIT_COMMIT={{.Commit}}
-    -X github.com/kanisterio/kanister/pkg/version.BUILD_DATE={{.Date}}
+    -X github.com/kanisterio/kanister/pkg/version.Version={{.Version}}
+    -X github.com/kanisterio/kanister/pkg/version.GitCommit={{.Commit}}
+    -X github.com/kanisterio/kanister/pkg/version.BuildDate={{.Date}}
   env: &env
   - GO111MODULE=on
   - CGO_ENABLED=1

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 (

design/kanister-prometheus-integration.md

@@ -215,7 +215,7 @@ controller/metrics.go
 
 ```golang
 const (
-	ACTION_SET_COUNTER_VEC_LABEL_RES     = "resolution"
+	ActionSetCounterVecLabelRes     = "resolution"
 	ACTION_SET_COUNTER_VEC_LABEL_OP_TYPE = "operation_type"
 )
 
@@ -228,7 +228,7 @@ type metrics struct {
 func getActionSetCounterVecLabels() []kanistermetrics.BoundedLabel {
 	bl := make([]kanistermetrics.BoundedLabel, 2)
 	bl[0] = kanistermetrics.BoundedLabel{
-		LabelName:   ACTION_SET_COUNTER_VEC_LABEL_RES,
+		LabelName:   ActionSetCounterVecLabelRes,
 		LabelValues: []string{"success", "failure"},
 	}
 	bl[1] = kanistermetrics.BoundedLabel{
@@ -244,7 +244,7 @@ func getActionSetCounterVecLabels() []kanistermetrics.BoundedLabel {
 func constructActionSetCounterVecLabels(operation_type string, resolution string) prometheus.Labels {
 	return prometheus.Labels{
 		ACTION_SET_COUNTER_VEC_LABEL_OP_TYPE: operation_type,
-		ACTION_SET_COUNTER_VEC_LABEL_RES:     resolution,
+		ActionSetCounterVecLabelRes:     resolution,
 	}
 }
 

pkg/apis/cr/v1alpha1/types.go

@@ -332,7 +332,6 @@ type Profile struct {
 	SkipSSLVerify bool `json:"skipSSLVerify"`
 }
 
-// LocationType
 type LocationType string
 
 const (
@@ -342,7 +341,6 @@ const (
 	LocationTypeKopia       LocationType = "kopia"
 )
 
-// Location
 type Location struct {
 	// Type specifies the kind of object storage that would be used to upload the
 	// backup objects. Currently supported values are: "GCS", "S3Compliant",
@@ -359,7 +357,6 @@ type Location struct {
 	Region string `json:"region"`
 }
 
-// CredentialType
 type CredentialType string
 
 const (
@@ -368,7 +365,6 @@ const (
 	CredentialTypeKopia   CredentialType = "kopia"
 )
 
-// Credential
 type Credential struct {
 	// Type represents the information about how the credentials are provided for the respective object storage.
 	Type CredentialType `json:"type"`
@@ -380,7 +376,6 @@ type Credential struct {
 	KopiaServerSecret *KopiaServerSecret `json:"kopiaServerSecret,omitempty"`
 }
 
-// KeyPair
 type KeyPair struct {
 	// IDField specifies the corresponding key in the secret where the AWS Key ID value is stored.
 	IDField string `json:"idField"`

pkg/app/bp.go

@@ -34,7 +34,7 @@ const (
 	imagePrefix = "ghcr.io/kanisterio"
 )
 
-// Blueprint implements Blueprint() to return Blueprint specs for the app
+// AppBlueprint implements Blueprint() to return Blueprint specs for the app
 // Blueprint() returns Blueprint placed at ./blueprints/{app-name}-blueprint.yaml
 type AppBlueprint struct {
 	App          string
@@ -109,7 +109,7 @@ func updateImageTags(bp *crv1alpha1.Blueprint) {
 	}
 }
 
-// Blueprint returns Blueprint placed at ./blueprints/{app-name}-blueprint.yaml
+// NewPITRBlueprint returns blueprint placed at ./blueprints/{app-name}-blueprint.yaml
 func NewPITRBlueprint(app string, bpReposPath string, useDevImages bool) Blueprinter {
 	if bpReposPath == "" {
 		bpReposPath = blueprintsRepo

pkg/app/cockroachdb.go

@@ -127,16 +127,16 @@ func (c *CockroachDB) IsReady(ctx context.Context) (bool, error) {
 		return false, errkit.Wrap(err, "Error while Creating ca.crt", "stderr", stderr)
 	}
 
-	createTlsCrtCmd := fmt.Sprintf("echo '%s'>> /cockroach/cockroach-client-certs/client.root.crt", c.tlscrt)
-	createTlsCrt := []string{"sh", "-c", createTlsCrtCmd}
-	_, stderr, err = c.execCommand(ctx, createTlsCrt)
+	createTLSCrtCmd := fmt.Sprintf("echo '%s'>> /cockroach/cockroach-client-certs/client.root.crt", c.tlscrt)
+	createTLSCrt := []string{"sh", "-c", createTLSCrtCmd}
+	_, stderr, err = c.execCommand(ctx, createTLSCrt)
 	if err != nil {
 		return false, errkit.Wrap(err, "Error while Creating tls.crt", "stderr", stderr)
 	}
 
-	createTlsKeyCmd := fmt.Sprintf("echo '%s' >> /cockroach/cockroach-client-certs/client.root.key", c.tlskey)
-	createTlsKey := []string{"sh", "-c", createTlsKeyCmd}
-	_, stderr, err = c.execCommand(ctx, createTlsKey)
+	createTLSKeyCmd := fmt.Sprintf("echo '%s' >> /cockroach/cockroach-client-certs/client.root.key", c.tlskey)
+	createTLSKey := []string{"sh", "-c", createTLSKeyCmd}
+	_, stderr, err = c.execCommand(ctx, createTLSKey)
 	if err != nil {
 		return false, errkit.Wrap(err, "Error while Creating tls.key", "stderr", stderr)
 	}

pkg/app/couchbase.go

@@ -52,6 +52,8 @@ type CouchbaseDB struct {
 }
 
 // Last tested woking version "2.3.0"
+//
+//nolint:stylecheck
 func NewCouchbaseDB(name string) App {
 	return &CouchbaseDB{
 		name: name,

pkg/app/csi-snapshot.go

@@ -30,7 +30,7 @@ import (
 	"github.com/kanisterio/kanister/pkg/log"
 )
 
-// Integration test app for CSI Snapshot functions
+// TimeLogCSI is integration test app for CSI Snapshot functions.
 type TimeLogCSI struct {
 	cli        kubernetes.Interface
 	namespace  string

pkg/app/elasticsearch.go

@@ -56,6 +56,8 @@ type ElasticsearchInstance struct {
 }
 
 // Last tested on 8.5.1
+//
+//nolint:stylecheck
 func NewElasticsearchInstance(name string) App {
 	return &ElasticsearchInstance{
 		name:      name,

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

pkg/app/mongodb.go

@@ -36,7 +36,7 @@ const (
 	mongoWaitTimeout = 5 * time.Minute
 )
 
-// IsMaster struct gets mapped to the output of the mongo command that checks if node is master or not.
+// IsMasterOutput struct gets mapped to the output of the mongo command that checks if node is master or not.
 type IsMasterOutput struct {
 	Ismaster bool `json:"ismaster"`
 }
@@ -52,6 +52,8 @@ type MongoDB struct {
 }
 
 // Last tested working version "9.0.0"
+//
+//nolint:stylecheck
 func NewMongoDB(name string) HelmApp {
 	return &MongoDB{
 		username: "root",

pkg/app/mysql.go

@@ -44,7 +44,7 @@ type MysqlDB struct {
 
 var _ HelmApp = &MysqlDB{}
 
-// Last tested working version "6.14.11"
+// NewMysqlDB was last tested with working version "6.14.11"
 func NewMysqlDB(name string) HelmApp {
 	return &MysqlDB{
 		name: name,

pkg/app/postgresql.go

@@ -40,7 +40,9 @@ type PostgresDB struct {
 	namespace string
 }
 
-// Last tested chart version "10.12.3". Also we are using postgres version 13.4
+// Last tested chart version "10.12.3". Also, we are using postgres version 13.4
+//
+//nolint:stylecheck
 func NewPostgresDB(name string, subPath string) App {
 	return &PostgresDB{
 		name: name,

pkg/aws/ec2/ec2.go

@@ -33,7 +33,7 @@ type EC2 struct {
 	DryRun bool
 }
 
-// NewEC2Client returns ec2 client struct.
+// NewClient returns ec2 client struct.
 func NewClient(ctx context.Context, awsConfig *aws.Config, region string) (*EC2, error) {
 	s, err := session.NewSession(awsConfig)
 	if err != nil {
@@ -50,20 +50,20 @@ func (e EC2) DescribeSecurityGroup(ctx context.Context, groupName string) (*ec2.
 	return e.DescribeSecurityGroupsWithContext(ctx, sgi)
 }
 
-func (e EC2) CreateSecurityGroup(ctx context.Context, groupName, description, vpcId string) (*ec2.CreateSecurityGroupOutput, error) {
+func (e EC2) CreateSecurityGroup(ctx context.Context, groupName, description, vpcID string) (*ec2.CreateSecurityGroupOutput, error) {
 	sgi := &ec2.CreateSecurityGroupInput{
 		DryRun:      &e.DryRun,
 		Description: &description,
 		GroupName:   &groupName,
-		VpcId:       aws.String(vpcId),
+		VpcId:       aws.String(vpcID),
 	}
 	return e.CreateSecurityGroupWithContext(ctx, sgi)
 }
 
-func (e EC2) AuthorizeSecurityGroupIngress(ctx context.Context, groupId, cidr, protocol string, port int64) (*ec2.AuthorizeSecurityGroupIngressOutput, error) {
+func (e EC2) AuthorizeSecurityGroupIngress(ctx context.Context, groupID, cidr, protocol string, port int64) (*ec2.AuthorizeSecurityGroupIngressOutput, error) {
 	sgi := &ec2.AuthorizeSecurityGroupIngressInput{
 		DryRun:     &e.DryRun,
-		GroupId:    &groupId,
+		GroupId:    &groupID,
 		CidrIp:     &cidr,
 		IpProtocol: &protocol,
 		ToPort:     &port,
@@ -72,20 +72,20 @@ func (e EC2) AuthorizeSecurityGroupIngress(ctx context.Context, groupId, cidr, p
 	return e.AuthorizeSecurityGroupIngressWithContext(ctx, sgi)
 }
 
-func (e EC2) DeleteSecurityGroup(ctx context.Context, groupId string) (*ec2.DeleteSecurityGroupOutput, error) {
+func (e EC2) DeleteSecurityGroup(ctx context.Context, groupID string) (*ec2.DeleteSecurityGroupOutput, error) {
 	sgi := &ec2.DeleteSecurityGroupInput{
 		DryRun:  &e.DryRun,
-		GroupId: aws.String(groupId),
+		GroupId: aws.String(groupID),
 	}
 	return e.DeleteSecurityGroupWithContext(ctx, sgi)
 }
 
-func (e EC2) DescribeSubnets(ctx context.Context, vpcId string) (*ec2.DescribeSubnetsOutput, error) {
+func (e EC2) DescribeSubnets(ctx context.Context, vpcID string) (*ec2.DescribeSubnetsOutput, error) {
 	paramsEC2 := &ec2.DescribeSubnetsInput{
 		Filters: []*ec2.Filter{
 			{
 				Name:   aws.String("vpc-id"),
-				Values: []*string{aws.String(vpcId)},
+				Values: []*string{aws.String(vpcID)},
 			},
 		},
 	}

pkg/aws/rds/rds.go

@@ -39,7 +39,7 @@ type RDS struct {
 	*rds.RDS
 }
 
-// NewRDSClient returns ec2 client struct.
+// NewClient returns ec2 client struct.
 func NewClient(ctx context.Context, awsConfig *aws.Config, region string) (*RDS, error) {
 	s, err := session.NewSession(awsConfig)
 	if err != nil {
@@ -48,7 +48,7 @@ func NewClient(ctx context.Context, awsConfig *aws.Config, region string) (*RDS,
 	return &RDS{RDS: rds.New(s, awsConfig.WithMaxRetries(maxRetries).WithRegion(region).WithCredentials(awsConfig.Credentials))}, nil
 }
 
-// CreateDBInstanceWithContext
+// CreateDBInstance return DBInstance with context
 func (r RDS) CreateDBInstance(
 	ctx context.Context,
 	storage *int64,
@@ -129,7 +129,7 @@ func (r RDS) WaitUntilDBClusterAvailable(ctx context.Context, dbClusterID string
 	})
 }
 
-// WaitDBCluster waits for DB cluster with instanceID
+// WaitOnDBCluster waits for DB cluster with instanceID
 func (r RDS) WaitOnDBCluster(ctx context.Context, dbClusterID, status string) error {
 	// describe the cluster return err if status is !Available
 	dci := &rds.DescribeDBClustersInput{

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.