Updated linters, and builds with golang 1.8 (#15)

- Updated golangci-lint, and enabled more linters. This came with lots of changes related to the new linters, mostly formatting and newlines - Replaced go fmt with gofumpt - Updated min golang version to 1.17 (required mainly by gofumpt) - Building against 1.17 and 1.18 - Updated dependencies
ThalesGroup · Mar 28, 2022 · be5ce44 · be5ce44
1 parent aeff56b
commit be5ce44
Show file tree

Hide file tree

Showing 35 changed files with 766 additions and 435 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -11,29 +11,21 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: ['v1.17.x', 'v1.18.x']
     steps:
-
-    - name: Set up Go 1.x
-      uses: actions/setup-go@v2
+    - uses: actions/setup-go@v3
       with:
-        go-version: ^1.14
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v2
-
-    - name: Debug
-      run: |
+        go-version: ${{ matrix.go }}
+        check-latest: true
+    - uses: actions/checkout@v2
+    - run: |
         pwd
         echo ${HOME}
         echo ${GITHUB_WORKSPACE}
         echo ${GOPATH}
         echo ${GOROOT}
-      env:
-        GOPATH: /home/runner/work/go
-
-    - name: Build
-      run: |
         mkdir -p $GOPATH/bin
         echo 'export PATH=$PATH:$GOPATH/bin' > runme.sh
         echo 'make tools all' >> runme.sh

diff --git a/.golangci.yml b/.golangci.yml
@@ -3,50 +3,10 @@
 
 # options for analysis running
 run:
-  # default concurrency is a available CPU number
-#  concurrency: 4
-
-  # timeout for analysis, e.g. 30s, 5m, default is 1m
-#  deadline: 1m
-
-  # exit code when at least one issue was found, default is 1
-#  issues-exit-code: 1
-
-  # include test files or not, default is true
   tests: true
-
-  # list of build tags, all linters use it. Default is empty list.
-#  build-tags:
-#    - mytag
-
-  # which dirs to skip: they won't be analyzed;
-  # can use regexp here: generated.*, regexp is applied on full path;
-  # default value is empty list, but next dirs are always skipped independently
-  # from this option's value:
-  #   	vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
-#  skip-dirs:
-#    - src/external_libs
-#    - autogenerated_by_my_lib
-
-  # which files to skip: they will be analyzed, but issues from them
-  # won't be reported. Default value is empty list, but there is
-  # no need to include all autogenerated files, we confidently recognize
-  # autogenerated files. If it's not please let us know.
   skip-files:
-#    - ".*\\.my\\.go$"
     - requests.go
 
-  # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
-  # If invoked with -mod=readonly, the go command is disallowed from the implicit
-  # automatic updating of go.mod described above. Instead, it fails when any changes
-  # to go.mod are needed. This setting is most useful to check that go.mod does
-  # not need updates, such as in a continuous integration and testing system.
-  # If invoked with -mod=vendor, the go command assumes that the vendor
-  # directory holds the correct copies of dependencies and ignores
-  # the dependency descriptions in go.mod.
-  # modules-download-mode:
-
-
 # output configuration options
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
@@ -61,54 +21,14 @@ output:
 
 # all available settings of specific linters
 linters-settings:
-  errcheck:
-    # report about not checking of errors in type assetions: `a := b.(MyStruct)`;
-    # default is false: such cases aren't reported by default.
-#    check-type-assertions: false
-
-    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
-    # default is false: such cases aren't reported by default.
-#    check-blank: false
-
-    # [deprecated] comma-separated list of pairs of the form pkg:regex
-    # the regex is used to ignore names within pkg. (default "fmt:.*").
-    # see https://github.com/kisielk/errcheck#the-deprecated-method for details
-#    ignore: fmt:.*,io/ioutil:^Read.*
-
-    # path to a file containing a list of functions to exclude from checking
-    # see https://github.com/kisielk/errcheck#excluding-functions for details
-#    exclude: /path/to/file.txt
   govet:
     # report about shadowed variables
     check-shadowing: false
-
-    # settings per analyzer
-#    settings:
-#      printf: # analyzer name, run `go tool vet help` to see all analyzers
-#        funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
-#          - (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
-  golint:
-    # minimal confidence for issues, default is 0.8
-#    min-confidence: 0.8
-  gofmt:
-    # simplify code: gofmt with `-s` option, true by default
-#    simplify: true
-  goimports:
-    # put imports beginning with prefix after 3rd-party packages;
-    # it's a comma-separated list of prefixes
-#    local-prefixes: github.com/org/project
-  gocyclo:
-    # minimal code complexity to report, 30 by default (but we recommend 10-20)
-    min-complexity: 10
-  maligned:
-    # print struct with more effective memory layout or not, false by default
-    suggest-new: true
   dupl:
     # tokens count to trigger issue, 150 by default
     threshold: 100
+  exhaustive:
+    default-signifies-exhaustive: true
   goconst:
     # minimal length of string constant, 3 by default
     min-len: 3
@@ -129,98 +49,110 @@ linters-settings:
     # Default is to use a neutral variety of English.
     # Setting locale to US will correct the British spelling of 'colour' to 'color'.
     locale: US
-#    ignore-words:
-#      - someword
-  lll:
-    # max line length, lines longer will be reported. Default is 120.
-    # '\t' is counted as 1 character by default, and can be changed with the tab-width option
-#    line-length: 120
-    # tab width in spaces. Default to 1.
-#    tab-width: 1
   unused:
     # treat code as a program (not a library) and report unused exported identifiers; default is false.
     # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
     # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
     # with golangci-lint call it on a directory with the changed file.
     check-exported: false
-  unparam:
-    # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
-    # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
-    # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
-    # with golangci-lint call it on a directory with the changed file.
-    check-exported: false
-  nakedret:
-    # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
-#    max-func-lines: 30
-  prealloc:
-    # XXX: we don't recommend using this linter before doing performance profiling.
-    # For most programs usage of prealloc will be a premature optimization.
-
-    # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
-    # True by default.
-    simple: true
-    range-loops: true # Report preallocation suggestions on range loops, true by default
-    for-loops: false # Report preallocation suggestions on for loops, false by default
   gocritic:
-    # Which checks should be enabled; can't be combined with 'disabled-checks';
-    # See https://go-critic.github.io/overview#checks-overview
-    # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
-    # By default list of stable checks is used.
-#    enabled-checks:
-#      - rangeValCopy
-
     # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
     disabled-checks:
       - commentFormatting
-
-    # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint` run to see all tags and checks.
-    # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
-#    enabled-tags:
-#      - performance
-
-#    settings: # settings passed to gocritic
-#      captLocal: # must be valid enabled check name
-#        paramsOnly: true
-#      rangeValCopy:
-#        sizeThreshold: 32
+  revive:
+    ignore-generated-header: true
+  wsl:
+    allow-cuddle-declarations: true
+    allow-separated-leading-comment: true
+    allow-assign-and-anything: true
 
 linters:
   # to try out individual linters: golangci-lint run -E gocyclo,gosimple
   enable:
+    # default linters
     - staticcheck
     - deadcode
     - errcheck
     - gosimple
     - govet
     - ineffassign
     - structcheck
-##    - typecheck          # redundant?  compiler does this
     - unused
     - varcheck
+
+    # additional linters
+    - asciicheck
+    - bidichk
 ##    - bodyclose          # its all false positives with requester and sling, which both close the body already
+    - containedctx
+    - contextcheck
+#    - cyclop              # need to analyze findings
+    - decorder
     - depguard
 ##    - dogsled            # checks for too many blank identifiers.  don't care
     - dupl
+    - durationcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - exportloopref
+    - forbidigo
+    - forcetypeassert
 ##    - funlen              # checks function length.  don't care
+#    - gci                  # not sure why this is complaining
 ##    - gochecknoglobals    # too common
     - gochecknoinits
+#    - gocognit          # too many findings, will take time to evaluate
     - goconst
     - gocritic
 ##    - gocyclo             # checks cyclomatic complexity.  don't care
-##    - godox               # checks for TODO comments.  not standardized
+#    - godot               # too many false positives
+#    - godox               # doesn't allow TODO comments.  We allow those to be committed.
+#    - goerr113             # good practice, but it doesn't recognize that we're already wrapping errors with merry
 ##    - gofmt               # checks code is formatted, handled by make prep
+    - gofumpt
+    - goheader
 ##    - goimports           # checks import order.  We're not using goimports
-    - golint
+#    - gomnd                # too aggressive
+    - gomoddirectives
+#    - gomodguard
+    - goprintffuncname
     - gosec
-    - interfacer
+    - grouper
+    - ifshort
+    - importas
+#    - ireturn              # there are valid use cases for this pattern.  too strict.
 ##    - lll                 # checks line length.  not enforced
+#    - maintidx             # look at this later
+    - makezero
 ##    - maligned            # optimizies struct field order, but structs are usually ordered for legibility
     - misspell
     - nakedret
+#    - nestif               # need to evaluate the findings
+    - nilerr
+    - nilnil
+#    - nlreturn             # a little too aggressive.  wsl covers the same ground.
+    - noctx
+    - nolintlint
+#    - paralleltest        # look at this later
 #    - prealloc            # slice optimizations, but promotes too much premature optimization
-    - scopelint
+    - predeclared
+    - promlinter
+    - revive
+    - rowserrcheck
+    - sqlclosecheck
     - stylecheck
+    - tagliatelle
+    - thelper
+    - tparallel
     - unconvert
+    - unparam
+#    - varnamelen        # take a look later
+    - wastedassign
+    - whitespace
+#    - wrapcheck           # way too aggressive
+    - wsl
 ##    - unparam            # too many false positives
 ##    - whitespace         # not enforced
   disable-all: true
@@ -240,21 +172,28 @@ issues:
 
   # Excluding configuration per-path, per-linter, per-text and per-source
   exclude-rules:
+    # Explicitly exclude the typecheck plugin.  There is some bug in golangci which is
+    # enabling this checker, even though it isn't listed above.
     # Exclude some linters from running on tests files.
     - path: _test\.go
       linters:
         - gocyclo
         - errcheck
         - dupl
         - gosec
-        - scopelint
+        - exportloopref
         - gochecknoinits
         - gochecknoglobals
+        - wsl
+        - nlreturn
+        - errchkjson
+        - forcetypeassert
     - path: cmd
       linters:
-        # init() functions are pretty common in main packages
+        # init(), globals, and prints are pretty common in main packages
         - gochecknoinits
         - gochecknoglobals
+        - forbidigo
 
     # Exclude known linters from partially hard-vendored code,
     # which is impossible to exclude via "nolint" comments.
@@ -268,10 +207,6 @@ issues:
 #        - staticcheck
 #      text: "SA9003:"
 
-    # Exclude lll issues for long lines with go:generate
-    - linters:
-        - lll
-      source: "^//go:generate "
 
   # Independently from option `exclude` we use default exclude patterns,
   # it can be disabled by this option. To list all

diff --git a/Makefile b/Makefile
@@ -30,7 +30,7 @@ clean:
 	rm -rf build/*
 
 fmt:
-	go fmt ./...
+	gofumpt -w -l .
 
 # generates go code structures representing all the enums, mask, and tags defined
 # in the KMIP spec.  The source specifications are stored in kmip14/kmip_1_4.json
@@ -90,7 +90,8 @@ update:
 # install tools used by the build.  typically only needs to be run once
 # to initialize a workspace.
 tools: kmipgen
-	go get -u golang.org/x/tools/cmd/cover
+	go install mvdan.cc/gofumpt@latest
+	go install golang.org/x/tools/cmd/cover@latest
 	sh -c "$$(wget -O - -q https://install.goreleaser.com/github.com/golangci/golangci-lint.sh || echo exit 2)" -- -b $(shell go env GOPATH)/bin $(GOLANGCI_LINT_VERSION)
 
 pykmip-server: up