Enable golangci-lint (#241)

Author: onematchfox

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    timeout-minutes: 5
+    timeout-minutes: 10
 
     steps:
 
@@ -24,11 +24,10 @@ jobs:
         go-version-file: 'go.mod'
       id: go
 
-    # TODO: Add linting (in upcoming PR)
-    # - name: Run linters
-    #   uses: golangci/golangci-lint-action@0ad9a0988b3973e851ab0a07adf248ec2e100376 # v3.3.1
-    #   with:
-    #     version: latest
+    - name: Run linters
+      uses: golangci/golangci-lint-action@08e2f20817b15149a52b5b3ebe7de50aff2ba8c5 # v3.4.0
+      with:
+        version: v1.51.2
 
     - name: Generate
       run: make generate

.golangci.yml

@@ -0,0 +1,119 @@
+issues:
+  exclude-rules:
+    - linters:
+        - paralleltest
+      text: "Function TestAcc"
+    - linters:
+        - tparallel
+      text: "TestAcc"
+    - linters:
+        - unparam
+      text: "always receives"
+    - path: _test\.go
+      linters:
+        - contextcheck
+  max-per-linter: 0
+  max-same-issues: 0
+
+linters:
+  disable-all: true
+  enable:
+    - asasalint
+    - asciicheck
+    - containedctx
+    - contextcheck
+    - dogsled
+    - durationcheck
+    - errcheck
+    - errname
+    - errorlint
+    - exportloopref
+    - goconst
+    - gocritic
+    - gofmt
+    - gomnd
+    - gosimple
+    - govet
+    - ineffassign
+    - makezero
+    - misspell
+    - nakedret
+    - nilerr
+    - nolintlint
+    - paralleltest
+    - predeclared
+    - staticcheck
+    - stylecheck
+    - tenv
+    - tparallel
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - vet
+    - vetshadow
+    - whitespace
+    - wsl
+
+linters-settings:
+  dogsled:
+    max-blank-identifiers: 3
+  errcheck:
+    ignore: github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema:ForceNew|Set,fmt:.*,io:Close
+  errorlint:
+    errorf: false
+  goconst:
+    ignore-tests: true
+    min-occurrences: 6
+  gocritic:
+    enabled-tags:
+      - diagnostic
+    disabled-tags:
+      - style
+      - performance
+      - experimental
+      - opinionated
+  gomnd:
+    settings:
+      mnd:
+        checks:
+          - argument
+        ignored-functions:
+          # Terraform Plugin SDK
+          - resource.Retry
+          - schema.DefaultTimeout
+          - validation.*
+          # Terraform Plugin Framework
+          - int64validator.*
+          - listvalidator.*
+          - stringvalidator.*
+          - SetDefaultCreateTimeout
+          - SetDefaultReadTimeout
+          - SetDefaultUpdateTimeout
+          - SetDefaultDeleteTimeout
+          # Go
+          - make
+          - strconv.FormatFloat
+          - strconv.FormatInt
+          - strconv.ParseFloat
+          - strconv.ParseInt
+          - strings.SplitN
+  nolintlint:
+    allow-unused: false
+    allow-leading-space: false
+    require-explanation: true
+    require-specific: true
+    allow-no-explanation:
+      - gomnd
+      - paralleltest
+      - tparallel
+      - unparam
+  predeclared:
+    ignore: cap,close,copy,delete,len,new
+  staticcheck:
+    checks: ["all", "-SA1019"]
+  stylecheck:
+    checks: ["all", "-ST1005", "-ST1003"]
+
+run:
+  timeout: 5m

argocd/features.go

@@ -63,7 +63,7 @@ type ServerInterface struct {
 	initialized bool
 }
 
-func (p *ServerInterface) initClients() error {
+func (p *ServerInterface) initClients(ctx context.Context) error {
 	if p.initialized {
 		return nil
 	}
@@ -74,10 +74,11 @@ func (p *ServerInterface) initClients() error {
 	defer p.Unlock()
 
 	if p.ApiClient == nil {
-		apiClient, err := initApiClient(d)
+		apiClient, err := initApiClient(ctx, d)
 		if err != nil {
 			return err
 		}
+
 		p.ApiClient = &apiClient
 	}
 
@@ -86,6 +87,7 @@ func (p *ServerInterface) initClients() error {
 		if err != nil {
 			return err
 		}
+
 		p.ClusterClient = &clusterClient
 	}
 
@@ -94,6 +96,7 @@ func (p *ServerInterface) initClients() error {
 		if err != nil {
 			return err
 		}
+
 		p.CertificateClient = &certClient
 	}
 
@@ -102,6 +105,7 @@ func (p *ServerInterface) initClients() error {
 		if err != nil {
 			return err
 		}
+
 		p.ApplicationClient = &applicationClient
 	}
 
@@ -110,6 +114,7 @@ func (p *ServerInterface) initClients() error {
 		if err != nil {
 			return err
 		}
+
 		p.ProjectClient = &projectClient
 	}
 
@@ -118,6 +123,7 @@ func (p *ServerInterface) initClients() error {
 		if err != nil {
 			return err
 		}
+
 		p.RepositoryClient = &repositoryClient
 	}
 
@@ -126,6 +132,7 @@ func (p *ServerInterface) initClients() error {
 		if err != nil {
 			return err
 		}
+
 		p.RepoCredsClient = &repoCredsClient
 	}
 
@@ -135,33 +142,39 @@ func (p *ServerInterface) initClients() error {
 	}
 	defer io.Close(acCloser)
 
-	serverVersionMessage, err := versionClient.Version(context.Background(), &empty.Empty{})
+	serverVersionMessage, err := versionClient.Version(ctx, &empty.Empty{})
 	if err != nil {
 		return err
 	}
+
 	if serverVersionMessage == nil {
 		return fmt.Errorf("could not get server version information")
 	}
+
 	p.ServerVersionMessage = serverVersionMessage
+
 	serverVersion, err := semver.NewVersion(serverVersionMessage.Version)
 	if err != nil {
 		return fmt.Errorf("could not parse server semantic version: %s", serverVersionMessage.Version)
 	}
-	p.ServerVersion = serverVersion
 
+	p.ServerVersion = serverVersion
 	p.initialized = true
+
 	return nil
 }
 
 // Checks that a specific feature is available for the current ArgoCD server version.
 // 'feature' argument must match one of the predefined feature* constants.
-func (p ServerInterface) isFeatureSupported(feature int) (bool, error) {
+func (p *ServerInterface) isFeatureSupported(feature int) (bool, error) {
 	versionConstraint, ok := featureVersionConstraintsMap[feature]
 	if !ok {
 		return false, fmt.Errorf("feature constraint is not handled by the provider")
 	}
+
 	if i := versionConstraint.Compare(p.ServerVersion); i == 1 {
 		return false, nil
 	}
+
 	return true, nil
 }

argocd/features_test.go

@@ -2,12 +2,13 @@ package argocd
 
 import (
 	"fmt"
+	"math/rand"
+	"testing"
+
 	"github.com/Masterminds/semver"
 	"github.com/argoproj/argo-cd/v2/pkg/apiclient/version"
 	"github.com/stretchr/testify/assert"
-	"math/rand"
 	"modernc.org/mathutil"
-	"testing"
 )
 
 const (
@@ -16,7 +17,7 @@ const (
 	semverLess
 )
 
-func serverInterfaceTestData(t *testing.T, argocdVersion string, semverOperator int) ServerInterface {
+func serverInterfaceTestData(t *testing.T, argocdVersion string, semverOperator int) *ServerInterface {
 	v, err := semver.NewVersion(argocdVersion)
 	assert.NoError(t, err)
 
@@ -49,66 +50,71 @@ func serverInterfaceTestData(t *testing.T, argocdVersion string, semverOperator
 	vm := &version.VersionMessage{
 		Version: v.String(),
 	}
-	return ServerInterface{
+
+	return &ServerInterface{
 		ApiClient:            nil,
 		ServerVersion:        v,
 		ServerVersionMessage: vm,
 	}
 }
 
 func TestServerInterface_isFeatureSupported(t *testing.T) {
+	t.Parallel()
+
 	type args struct {
 		feature int
 	}
+
 	tests := []struct {
 		name    string
-		fields  ServerInterface
+		si      *ServerInterface
 		args    args
 		want    bool
 		wantErr bool
 	}{
 		{
 			name:    "featureTokenID-1.5.3",
-			fields:  serverInterfaceTestData(t, "1.5.3", semverEquals),
+			si:      serverInterfaceTestData(t, "1.5.3", semverEquals),
 			args:    args{feature: featureTokenIDs},
 			want:    true,
 			wantErr: false,
 		},
 		{
 			name:    "featureTokenID-1.5.3+",
-			fields:  serverInterfaceTestData(t, "1.5.3", semverGreater),
+			si:      serverInterfaceTestData(t, "1.5.3", semverGreater),
 			args:    args{feature: featureTokenIDs},
 			want:    true,
 			wantErr: false,
 		},
 		{
 			name:    "featureTokenID-1.5.3-",
-			fields:  serverInterfaceTestData(t, "1.5.3", semverLess),
+			si:      serverInterfaceTestData(t, "1.5.3", semverLess),
 			args:    args{feature: featureTokenIDs},
 			want:    false,
 			wantErr: false,
 		},
 	}
+
 	for _, tt := range tests {
+		tt := tt
+
 		t.Run(tt.name, func(t *testing.T) {
-			p := ServerInterface{
-				ApiClient:            tt.fields.ApiClient,
-				ServerVersion:        tt.fields.ServerVersion,
-				ServerVersionMessage: tt.fields.ServerVersionMessage,
-			}
-			got, err := p.isFeatureSupported(tt.args.feature)
+			t.Parallel()
+
+			got, err := tt.si.isFeatureSupported(tt.args.feature)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("isFeatureSupported() error = %v, wantErr %v",
 					err,
 					tt.wantErr,
 				)
 				return
 			}
+
 			if got != tt.want {
 				t.Errorf("isFeatureSupported() got = %v, want %v, version %s",
 					got,
 					tt.want,
-					tt.fields.ServerVersion.String(),
+					tt.si.ServerVersion.String(),
 				)
 			}
 		})