Merge pull request scrapli#125 from scrapli/chore/linterupdates

Chore/linterupdates

Author: carlmontanari

.github/workflows/commit.yaml

@@ -31,7 +31,7 @@ jobs:
       - name: lint
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.50
+          version: v1.52
           args: --timeout 5m
       - name: install gotestsum
         run: go install gotest.tools/gotestsum@latest

.golangci.yaml

@@ -1,14 +1,7 @@
 linters-settings:
-  depguard:
-    list-type: blacklist
-  dupl:
-    threshold: 100
   funlen:
-    lines: 100
+    lines: 150
     statements: 50
-  goconst:
-    min-len: 2
-    min-occurrences: 2
   gocritic:
     enabled-tags:
       - diagnostic
@@ -17,95 +10,87 @@ linters-settings:
       - performance
       - style
     disabled-checks:
-      - dupImport # https://github.com/go-critic/go-critic/issues/845
-      - ifElseChain
-      - octalLiteral
       - whyNoLint
-      - wrapperFunc
   gocyclo:
     min-complexity: 15
-  goimports:
-    local-prefixes: github.com/golangci/golangci-lint
-  gomnd:
-    settings:
-      mnd:
-        # don't include the "operation" and "assign"
-        checks: argument,case,condition,return
-  govet:
-    check-shadowing: true
-    settings:
-      printf:
-        funcs:
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
   lll:
     line-length: 100
+    tab-width: 4
   stylecheck:
     checks:
       - "-ST1000"
-  misspell:
-    locale: US
-  nolintlint:
-    allow-leading-space: true # don't require machine-readable nolint directives (i.e. with no leading space)
-    allow-unused: false # report any unused nolint directives
-    require-explanation: false # don't require an explanation for nolint directives
-    require-specific: false # don't require nolint directives to be specific about which linter is being skipped
-  revive:
-    rules:
-      - name: exported
+
 linters:
   enable:
-    - nlreturn
-    - forbidigo
-    - gofumpt
+    - asciicheck
     - bodyclose
+    - decorder
     - depguard
     - dogsled
     - dupl
+    - dupword
+    - durationcheck
     - errcheck
+    - errchkjson
+    - errname
     - exhaustive
+    - exportloopref
+    - forbidigo
+    - forcetypeassert
     - funlen
+    - gocheckcompilerdirectives
+    - gochecknoglobals
     - gochecknoinits
+    - gocognit
     - goconst
     - gocritic
     - gocyclo
+    - godot
+    - godox
+    - goerr113
     - gofmt
+    - gofumpt
     - goimports
     - gomnd
     - goprintffuncname
     - gosec
     - gosimple
     - govet
+    - grouper
+    - importas
     - ineffassign
     - lll
+    - maintidx
+    - makezero
     - misspell
     - nakedret
+    - nestif
+    - nilerr
+    - nlreturn
     - noctx
     - nolintlint
+    - nolintlint
+    - prealloc
+    - predeclared
+    - reassign
     - revive
-    - rowserrcheck
-    - exportloopref
     - staticcheck
     - stylecheck
+    - tenv
+    - testpackage
+    - tparallel
     - typecheck
     - unconvert
     - unparam
     - unused
+    - usestdlibvars
+    - wastedassign
     - whitespace
-    - asciicheck
-    - gochecknoglobals
-    - gocognit
-    - godot
-    - godox
-    - goerr113
-    - nestif
-    - prealloc
-    - testpackage
     - wsl
 
 issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
   # https://github.com/golangci/golangci-lint/issues/2439#issuecomment-1002912465
   exclude-use-default: false
   exclude-rules:
@@ -116,20 +101,24 @@ issues:
         - structcheck
         - unused
         - unparam
+
     # ignoring long lines due to json/yaml tags in platform
     - path: platform/definition.go
       linters:
         - lll
 
+    # ignore package comments complaints in revive
+    - linters:
+        - revive
+      text: "package-comments"
+
 run:
-  # running w/ 1.17 because we dont actually need/use 1.18 things and 1.18 breaks some linters.
-  go: '1.17'
+  go: '1.19'
   skip-dirs:
     - private
 
-# golangci.com configuration
-# https://github.com/golangci/golangci/wiki/Configuration
+output:
+  uniq-by-line: false
+
 service:
-  golangci-lint-version: 1.49.x # use the fixed version to not introduce new linters unexpectedly
-  prepare:
-    - echo "here I can run custom commands, but no preparation needed for this repo"
+  golangci-lint-version: 1.52.x

channel/auth.go

@@ -38,7 +38,7 @@ func getAuthPatterns() *authPatterns {
 	return authPatternsInstance
 }
 
-func (c *Channel) authenticateSSH(p, pp []byte) *result { //nolint:dupl
+func (c *Channel) authenticateSSH(p, pp []byte) *result {
 	pCount := 0
 
 	ppCount := 0
@@ -87,13 +87,15 @@ func (c *Channel) authenticateSSH(p, pp []byte) *result { //nolint:dupl
 
 			if ppCount > passphraseSeenMax {
 				c.l.Critical(
-					"private key passphrase prompt seen multiple times, assuming authentication failed",
+					"private key passphrase prompt seen multiple times," +
+						" assuming authentication failed",
 				)
 
 				return &result{
 					nil,
 					fmt.Errorf(
-						"%w: private key passphrase prompt seen multiple times, assuming authentication failed",
+						"%w: private key passphrase prompt seen multiple times,"+
+							" assuming authentication failed",
 						util.ErrAuthError,
 					),
 				}
@@ -130,7 +132,7 @@ func (c *Channel) AuthenticateSSH(p, pp []byte) ([]byte, error) {
 	}
 }
 
-func (c *Channel) authenticateTelnet(u, p []byte) *result { //nolint:dupl
+func (c *Channel) authenticateTelnet(u, p []byte) *result {
 	uCount := 0
 
 	pCount := 0

channel/channel.go

@@ -26,6 +26,7 @@ const (
 	// bytes.
 	DefaultPromptSearchDepth = 1_000
 	redacted                 = "redacted"
+	readDelayDivisor         = 1_000
 )
 
 var (
@@ -181,7 +182,7 @@ func (c *Channel) Close() error {
 		c.l.Debug("closing underlying transport...")
 
 		return c.t.Close(false)
-	case <-time.After(c.ReadDelay * (c.ReadDelay / 1000)):
+	case <-time.After(c.ReadDelay * (c.ReadDelay / readDelayDivisor)): //nolint:durationcheck
 		// channel is stuck in a blocking read (almost always the case for netconf!), force close
 		// transport to finish closing connection, so give it c.ReadDelay*(c.ReadDelay/1000) to
 		// "nicely" exit -- with defaults this ends up being 62.5ms.

channel/read.go

@@ -2,6 +2,7 @@ package channel
 
 import (
 	"bytes"
+	"errors"
 	"io"
 	"regexp"
 	"time"
@@ -19,7 +20,7 @@ func (c *Channel) read() {
 
 		b, err := c.t.Read()
 		if err != nil {
-			if err == io.EOF {
+			if errors.Is(err, io.EOF) {
 				// the underlying transport was closed so just return
 				return
 			}

driver/generic/sendcommands.go

@@ -36,7 +36,8 @@ func (d *Driver) SendCommands(
 
 		if op.StopOnFailed && r.Failed != nil {
 			d.Logger.Info(
-				"encountered failed command, and stop on failed is true, discontinuing send commands operation",
+				"encountered failed command, and stop on failed is true," +
+					" discontinuing send commands operation",
 			)
 
 			return m, err

driver/generic/sendwithcallbacks_test.go

@@ -39,7 +39,8 @@ func testSendWithCallbacks(
 
 		if r.Failed != nil {
 			t.Fatalf(
-				"%s: response object indicates failure, this shouldn't happenf or send with callbacks",
+				"%s: response object indicates failure,"+
+					" this shouldn't happenf or send with callbacks",
 				testName,
 			)
 		}

driver/generic/test-fixtures/golden/send-commands-from-file-simple-out.txt

@@ -1,5 +1,3 @@
-
-
 Building configuration...
 
 Current configuration : 38 bytes

driver/generic/test-fixtures/golden/send-commands-simple-out.txt

@@ -1,5 +1,3 @@
-
-
 Building configuration...
 
 Current configuration : 38 bytes

driver/netconf/capabilities.go

@@ -43,7 +43,7 @@ func (d *Driver) processServerCapabilities() error {
 }
 
 func (d *Driver) determineVersion() error {
-	if d.ServerHasCapability(v1Dot1Cap) {
+	if d.ServerHasCapability(v1Dot1Cap) { //nolint: gocritic
 		d.SelectedVersion = V1Dot1
 	} else if d.ServerHasCapability(v1Dot0Cap) {
 		d.SelectedVersion = V1Dot0
@@ -57,7 +57,8 @@ func (d *Driver) determineVersion() error {
 			d.SelectedVersion = V1Dot0
 		} else {
 			return fmt.Errorf(
-				"%w: user requested netconf version 1.0, but server does not support this capability",
+				"%w: user requested netconf version 1.0,"+
+					" but server does not support this capability",
 				util.ErrNetconfError,
 			)
 		}
@@ -66,7 +67,8 @@ func (d *Driver) determineVersion() error {
 			d.SelectedVersion = V1Dot1
 		} else {
 			return fmt.Errorf(
-				"%w: user requested netconf version 1.1, but server does not support this capability",
+				"%w: user requested netconf version 1.1,"+
+					" but server does not support this capability",
 				util.ErrNetconfError)
 		}
 	}

driver/netconf/deleteconfig.go

@@ -1,4 +1,4 @@
-package netconf //nolint: dupl
+package netconf
 
 import (
 	"encoding/xml"

driver/netconf/driver.go

@@ -56,6 +56,8 @@ const (
 	defaultNamespace = "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"
 
 	xmlHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+
+	initialMessageID = 101
 )
 
 type netconfPatterns struct {
@@ -129,7 +131,7 @@ func NewDriver(
 		Transport:     gd.Transport,
 		Channel:       gd.Channel,
 
-		messageID: 101,
+		messageID: initialMessageID,
 
 		messages:     map[int][]byte{},
 		messagesLock: &sync.Mutex{},

driver/netconf/lock_test.go

@@ -89,7 +89,7 @@ func TestLockUnlock(t *testing.T) {
 	}
 }
 
-func testLockUnlockFunctional( //nolint: funlen
+func testLockUnlockFunctional(
 	testName, platformName, transportName string,
 ) func(t *testing.T) {
 	return func(t *testing.T) {

driver/netconf/read.go

@@ -70,13 +70,17 @@ func (d *Driver) read() {
 				}
 
 				if messageID != 0 {
-					d.Logger.Debugf("Received message response for message ID '%d', storing", messageID)
+					d.Logger.Debugf(
+						"Received message response for message ID '%d', storing", messageID,
+					)
 
 					d.storeMessage(messageID, b)
 				}
 
 				if subID != 0 {
-					d.Logger.Debugf("Received message response for subscription ID '%d', storing", subID)
+					d.Logger.Debugf(
+						"Received message response for subscription ID '%d', storing", subID,
+					)
 
 					d.storeSubscriptionMessage(subID, b)
 				}

driver/netconf/rpc_test.go

@@ -31,7 +31,7 @@ func TestForceSelfClosingTags(t *testing.T) {
 		},
 		"empty_tag_with_attrs_and_spaces": {
 			got: []byte(
-				`<routing-policy xmlns="http://openconfig.net/yang/routing-policy">    </routing-policy>`,
+				`<routing-policy xmlns="http://openconfig.net/yang/routing-policy">    </routing-policy>`, //nolint: lll
 			),
 			want: []byte(`<routing-policy xmlns="http://openconfig.net/yang/routing-policy"/>`),
 		},

driver/netconf/test-fixtures/golden/functional-getconfig-simple-arista_eos-standard-out.txt

@@ -32,9 +32,6 @@
                                 </If-list>
                             </if-items>
                         </Dom-list>
-                        <Dom-list>
-                            <name>default</name>
-                        </Dom-list>
                     </dom-items>
                     <evpn_timeout>600</evpn_timeout>
                     <ipAdjRouteDistance>250</ipAdjRouteDistance>