Merge branch 'master' into k8s-image-logging

.golangci.yml

@@ -28,38 +28,27 @@ linters-settings:
 
   # https://github.com/ultraware/funlen
   funlen:
-    lines: 100
-    statements: 50
+    # accounting for comments
+    lines: 160
+    statements: 70
 
-  # https://github.com/golang/lint
-  golint:
-    min-confidence: 0
-
-  # https://github.com/tommy-muehle/go-mnd
-  gomnd:
-    settings:
-      mnd:
-        # don't include the "operation" and "assign"
-        checks: argument,case,condition,return
-
-  # https://github.com/walle/lll
-  lll:
-    line-length: 100
-
-  # https://github.com/mdempsky/maligned
-  maligned:
-    suggest-new: true
+  # https://github.com/denis-tingaikin/go-header
+  goheader:
+    template: |-
+      Copyright (c) {{ YEAR }} Target Brands, Inc. All rights reserved.
+      
+      Use of this source code is governed by the LICENSE file in this repository.
 
   # https://github.com/client9/misspell
   misspell:
     locale: US
 
   # https://github.com/golangci/golangci-lint/blob/master/pkg/golinters/nolintlint
   nolintlint:
-    allow-leading-space: true # allow non-"machine-readable" format (ie. with leading space) 
-    allow-unused: false # allow nolint directives that don't address a linting issue
-    require-explanation: true # require an explanation for nolint directives
-    require-specific: true # require nolint directives to be specific about which linter is being skipped
+    allow-leading-space: true     # allow non-"machine-readable" format (ie. with leading space) 
+    allow-unused: false           # allow nolint directives that don't address a linting issue
+    require-explanation: true     # require an explanation for nolint directives
+    require-specific: true        # require nolint directives to be specific about which linter is being skipped
 
 # This section provides the configuration for which linters
 # golangci will execute. Several of them were disabled by
@@ -70,58 +59,91 @@ linters:
 
   # enable a specific set of linters to run
   enable:
-    - bodyclose
-    - deadcode # enabled by default
-    - dupl
-    - errcheck # enabled by default
-    - funlen
-    - goconst
-    - gocyclo
-    - godot
-    - gofmt
-    - goimports
-    - golint
-    - gomnd
-    - goprintffuncname
-    - gosec
-    - gosimple # enabled by default
-    - govet # enabled by default
-    - ineffassign # enabled by default
-    - lll
-    - maligned
-    - misspell
-    - nakedret
-    - nolintlint
-    - staticcheck # enabled by default
-    - structcheck # enabled by default
-    - stylecheck
-    - typecheck # enabled by default
-    - unconvert
-    - unparam
-    - unused # enabled by default
-    - varcheck # enabled by default
-    - whitespace
-
+    - bidichk             # checks for dangerous unicode character sequences
+    - bodyclose           # checks whether HTTP response body is closed successfully
+    - contextcheck        # check the function whether use a non-inherited context
+    - deadcode            # finds unused code
+    - dupl                # code clone detection
+    - errcheck            # checks for unchecked errors
+    - errorlint           # find misuses of errors
+    - exportloopref       # check for exported loop vars
+    - funlen              # detects long functions
+    - goconst             # finds repeated strings that could be replaced by a constant
+    - gocyclo             # computes and checks the cyclomatic complexity of functions
+    - godot               # checks if comments end in a period
+    - gofmt               # checks whether code was gofmt-ed
+    - goheader            # checks is file header matches to pattern
+    - goimports           # fixes imports and formats code in same style as gofmt
+    - gomoddirectives     # manage the use of 'replace', 'retract', and 'excludes' directives in go.mod
+    - goprintffuncname    # checks that printf-like functions are named with f at the end
+    - gosec               # inspects code for security problems
+    - gosimple            # linter that specializes in simplifying a code
+    - govet               # reports suspicious constructs, ex. Printf calls whose arguments don't align with the format string
+    - ineffassign         # detects when assignments to existing variables aren't used
+    - makezero            # finds slice declarations with non-zero initial length
+    - misspell            # finds commonly misspelled English words in comments
+    - nakedret            # finds naked returns in functions greater than a specified function length
+    - nilerr              # finds the code that returns nil even if it checks that the error is not nil
+    - noctx               # noctx finds sending http request without context.Context
+    - nolintlint          # reports ill-formed or insufficient nolint directives
+    - revive              # linter for go
+    - staticcheck         # applies static analysis checks, go vet on steroids
+    - structcheck         # finds unused struct fields
+    - stylecheck          # replacement for golint
+    - tenv                # analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
+    - typecheck           # parses and type-checks go code, like the front-end of a go compiler
+    - unconvert           # remove unnecessary type conversions
+    - unparam             # reports unused function parameters
+    - unused              # checks for unused constants, variables, functions and types
+    - varcheck            # finds unused global variables and constants
+    - whitespace          # detects leading and trailing whitespace
+    - wsl                 # forces code to use empty lines
+
   # static list of linters we know golangci can run but we've
   # chosen to leave disabled for now
-  # - asciicheck
-  # - depguard
-  # - dogsled
-  # - exhaustive
-  # - gochecknoinits
-  # - gochecknoglobals
-  # - gocognit
-  # - gocritic
-  # - godox
-  # - goerr113
-  # - interfacer
-  # - nestif
-  # - noctx
-  # - prealloc
-  # - rowserrcheck
-  # - scopelint
-  # - testpackage
-  # - wsl
+  # - asciicheck          - non-critical
+  # - cyclop              - unused complexity metric
+  # - depguard            - unused
+  # - dogsled             - blanks allowed
+  # - durationcheck       - unused
+  # - errname             - unused
+  # - exhaustive          - unused
+  # - exhaustivestruct    - style preference
+  # - forbidigo           - unused
+  # - forcetypeassert     - unused
+  # - gci                 - use goimports
+  # - gochecknoinits      - unused
+  # - gochecknoglobals    - global variables allowed
+  # - gocognit            - unused complexity metric 
+  # - gocritic            - style preference
+  # - godox               - to be used in the future
+  # - goerr113            - to be used in the future
+  # - golint              - archived, replaced with revive
+  # - gofumpt             - use gofmt
+  # - gomnd               - get too many false-positives
+  # - gomodguard          - unused
+  # - ifshort             - use both styles
+  # - ireturn             - allow interfaces to be returned
+  # - importas            - want flexibility with naming
+  # - lll                 - not too concerned about line length 
+  # - interfacer          - archived
+  # - nestif              - non-critical
+  # - nilnil              - style preference
+  # - nlreturn            - style preference
+  # - maligned            - archived, replaced with govet 'fieldalignment'
+  # - paralleltest        - false-positives
+  # - prealloc            - don't use
+  # - predeclared         - unused
+  # - promlinter          - style preference 
+  # - rowserrcheck        - unused
+  # - scopelint           - deprecated - replaced with exportloopref
+  # - sqlclosecheck       - unused
+  # - tagliatelle         - use a mix of variable naming
+  # - testpackage         - don't use this style of testing
+  # - thelper             - false-positives
+  # - varnamelen          - unused
+  # - wastedassign        - duplicate functionality
+  # - wrapcheck           - style preference
 
 # This section provides the configuration for how golangci
 # will report the issues it finds.
@@ -135,5 +157,3 @@ issues:
         - funlen
         - goconst
         - gocyclo
-        - gomnd
-        - lll

cmd/vela-worker/exec.go

@@ -17,8 +17,7 @@ import (
 
 // exec is a helper function to poll the queue
 // and execute Vela pipelines for the Worker.
-//
-// nolint:funlen // ignore function length due to comments and log messages
+// nolint: nilerr // ignore returning nil - don't want to crash worker
 func (w *Worker) exec(index int) error {
 	var err error
 

cmd/vela-worker/operate.go

@@ -19,7 +19,6 @@ import (
 // operate is a helper function to initiate all
 // subprocesses for the operator to poll the
 // queue and execute Vela pipelines.
-// nolint: funlen // ignore function length
 func (w *Worker) operate(ctx context.Context) error {
 	var err error
 
@@ -63,7 +62,6 @@ func (w *Worker) operate(ctx context.Context) error {
 
 				// if unable to update the worker, log the error but allow the worker to continue running
 				if err != nil {
-					// nolint: lll // ignore long line length due to error message
 					logrus.Errorf("unable to update worker %s on the server: %v", registryWorker.GetHostname(), err)
 				}
 
@@ -107,6 +105,7 @@ func (w *Worker) operate(ctx context.Context) error {
 					return nil
 				default:
 					// exec operator subprocess to poll and execute builds
+					// nolint: contextcheck // ignore passing context
 					err = w.exec(id)
 					if err != nil {
 						// log the error received from the executor

cmd/vela-worker/register.go

@@ -16,9 +16,10 @@ import (
 func (w *Worker) checkIn(config *library.Worker) error {
 	// check to see if the worker already exists in the database
 	logrus.Infof("retrieving worker %s from the server", config.GetHostname())
+
 	_, resp, err := w.VelaClient.Worker.Get(config.GetHostname())
 	if err != nil {
-		respErr := fmt.Errorf("unable to retrieve worker %s from the server: %v", config.GetHostname(), err)
+		respErr := fmt.Errorf("unable to retrieve worker %s from the server: %w", config.GetHostname(), err)
 		if resp == nil {
 			return respErr
 		}
@@ -32,9 +33,10 @@ func (w *Worker) checkIn(config *library.Worker) error {
 
 	// if we were able to GET the worker, update it
 	logrus.Infof("checking worker %s into the server", config.GetHostname())
+
 	_, _, err = w.VelaClient.Worker.Update(config.GetHostname(), config)
 	if err != nil {
-		return fmt.Errorf("unable to update worker %s on the server: %v", config.GetHostname(), err)
+		return fmt.Errorf("unable to update worker %s on the server: %w", config.GetHostname(), err)
 	}
 
 	return nil
@@ -43,10 +45,11 @@ func (w *Worker) checkIn(config *library.Worker) error {
 // register is a helper function to register the worker with the server.
 func (w *Worker) register(config *library.Worker) error {
 	logrus.Infof("worker %s not found, registering it with the server", config.GetHostname())
+
 	_, _, err := w.VelaClient.Worker.Add(config)
 	if err != nil {
 		// log the error instead of returning so the operation doesn't block worker deployment
-		return fmt.Errorf("unable to register worker %s with the server: %v", config.GetHostname(), err)
+		return fmt.Errorf("unable to register worker %s with the server: %w", config.GetHostname(), err)
 	}
 
 	// successfully added the worker so return nil

cmd/vela-worker/run.go

@@ -23,8 +23,6 @@ import (
 
 // run executes the worker based
 // off the configuration provided.
-//
-// nolint: funlen // ignore function length due to comments
 func run(c *cli.Context) error {
 	// set log format for the worker
 	switch c.String("log.format") {