chore: relint & update

* updated go version requirement to go1.19 * updated dependencies, excepted: * yaml (upgrade to v3 deferred to another PR) * otel (upgrade is breaking: deferred to another PR) * ci: updated linting rules, in line with other go-openapi repos * exception: disabled the "nilerr" linter, which currently crashes for this repo * ci:updated github actions, in line with other go-openapi repos * doc: updated README links and badges * major relinting of all test code * relinting non-test code is deferred to another PR (hopefully with less changes) * changes to non-test code are limited to: * addition of (temporary) nolint directives * gofmt/typos in comments * unused params TODO in forthcoming PRs: * [ ] upgrade to yaml/v3 * [ ] upgrade OTEL packages * [ ] gradually remove most "nolint" directives in non-test code * [ ] complete test refactoring: some nolint directives have been added to skip more complex refacoring (e.g. duplicate code) Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
go-openapi · Dec 7, 2023 · e4cc157 · e4cc157
1 parent 1ade6d4
commit e4cc157
Show file tree

Hide file tree

Showing 72 changed files with 2,145 additions and 1,897 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
diff --git a/.github/workflows/go-test.yml b/.github/workflows/go-test.yml
@@ -0,0 +1,50 @@
+name: go test
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+          check-latest: true
+          cache: true
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          only-new-issues: true
+
+  test:
+    name: Unit tests
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        go_version: ['oldstable', 'stable' ]
+
+    steps:
+    - name: Run unit tests
+      uses: actions/setup-go@v4
+      with:
+        go-version: '${{ matrix.go_version }}'
+        check-latest: true
+        cache: true
+
+    - uses: actions/checkout@v3
+
+    - run: go test -v -race -coverprofile="coverage-${{ matrix.os }}.${{ matrix.go_version }}.out" -covermode=atomic ./...
+
+    - name: Upload coverage to codecov
+      uses: codecov/codecov-action@v3
+      with:
+        files: './coverage-${{ matrix.os }}.${{ matrix.go_version }}.out'
+        flags: '${{ matrix.go_version }}'
+        os: '${{ matrix.os }}'
+        fail_ci_if_error: false
+        verbose: true
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
diff --git a/.golangci.yml b/.golangci.yml
@@ -1,44 +1,62 @@
 linters-settings:
   govet:
-    # Using err repeatedly considered as shadowing.
-    check-shadowing: false
+    check-shadowing: true
   golint:
     min-confidence: 0
   gocyclo:
-    min-complexity: 30
+    min-complexity: 45
   maligned:
     suggest-new: true
   dupl:
-    threshold: 100
+    threshold: 200
   goconst:
     min-len: 2
-    min-occurrences: 4
+    min-occurrences: 3
+
 linters:
+  enable-all: true
   disable:
+    - nilerr # nilerr crashes on this repo
     - maligned
+    - unparam
     - lll
+    - gochecknoinits
     - gochecknoglobals
+    - funlen
     - godox
     - gocognit
     - whitespace
     - wsl
-    - funlen
-    - gochecknoglobals
-    - gochecknoinits
-    - scopelint
     - wrapcheck
-    - exhaustivestruct
-    - exhaustive
-    - nlreturn
     - testpackage
-    - gci
-    - gofumpt
-    - goerr113
+    - nlreturn
     - gomnd
-    - tparallel
+    - exhaustivestruct
+    - goerr113
+    - errorlint
     - nestif
     - godot
-    - errorlint
-    - noctx
+    - gofumpt
+    - paralleltest
+    - tparallel
+    - thelper
+    - ifshort
+    - exhaustruct
+    - varnamelen
+    - gci
+    - depguard
+    - errchkjson
+    - inamedparam
+    - nonamedreturns
+    - musttag
+    - ireturn
+    - forcetypeassert
+    - cyclop
+    # deprecated linters
+    - deadcode
     - interfacer
-    - nilerr
+    - scopelint
+    - varcheck
+    - structcheck
+    - golint
+    - nosnakecase
diff --git a/README.md b/README.md
@@ -1,7 +1,10 @@
-# runtime [![Build Status](https://travis-ci.org/go-openapi/runtime.svg?branch=client-context)](https://travis-ci.org/go-openapi/runtime) [![codecov](https://codecov.io/gh/go-openapi/runtime/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/runtime) [![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
+# runtime [![Build Status](https://github.com/go-openapi/runtime/actions/workflows/go-test.yml/badge.svg)](https://github.com/go-openapi/runtime/actions?query=workflow%3A"go+test") [![codecov](https://codecov.io/gh/go-openapi/runtime/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/runtime)
 
-[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/runtime/master/LICENSE) [![GoDoc](https://godoc.org/github.com/go-openapi/runtime?status.svg)](http://godoc.org/github.com/go-openapi/runtime)
+[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
+[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/runtime/master/LICENSE) 
+[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/runtime.svg)](https://pkg.go.dev/github.com/go-openapi/runtime)
+[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/runtime)](https://goreportcard.com/report/github.com/go-openapi/runtime)
 
-# golang Open-API toolkit - runtime
+# go OpenAPI toolkit runtime
 
-The runtime component for use in codegeneration or as untyped usage.
+The runtime component for use in code generation or as untyped usage.
diff --git a/authinfo_test.go b/authinfo_test.go
@@ -19,15 +19,17 @@ import (
 
 	"github.com/go-openapi/strfmt"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestAuthInfoWriter(t *testing.T) {
+	const bearerToken = "Bearer the-token-goes-here"
+
 	hand := ClientAuthInfoWriterFunc(func(r ClientRequest, _ strfmt.Registry) error {
-		return r.SetHeaderParam(HeaderAuthorization, "Bearer the-token-goes-here")
+		return r.SetHeaderParam(HeaderAuthorization, bearerToken)
 	})
 
 	tr := new(TestClientRequest)
-	err := hand.AuthenticateRequest(tr, nil)
-	assert.NoError(t, err)
-	assert.Equal(t, "Bearer the-token-goes-here", tr.Headers.Get(HeaderAuthorization))
+	require.NoError(t, hand.AuthenticateRequest(tr, nil))
+	assert.Equal(t, bearerToken, tr.Headers.Get(HeaderAuthorization))
 }
diff --git a/bytestream.go b/bytestream.go
@@ -52,10 +52,10 @@ func ByteStreamConsumer(opts ...byteStreamOpt) Consumer {
 			return errors.New("ByteStreamConsumer requires a reader") // early exit
 		}
 
-		close := defaultCloser
+		close := defaultCloser //nolint:revive,predeclared
 		if vals.Close {
 			if cl, ok := reader.(io.Closer); ok {
-				close = cl.Close
+				close = cl.Close //nolint:revive
 			}
 		}
 		//nolint:errcheck // closing a reader wouldn't fail.
@@ -109,10 +109,10 @@ func ByteStreamProducer(opts ...byteStreamOpt) Producer {
 		if writer == nil {
 			return errors.New("ByteStreamProducer requires a writer") // early exit
 		}
-		close := defaultCloser
+		close := defaultCloser //nolint:revive,predeclared
 		if vals.Close {
 			if cl, ok := writer.(io.Closer); ok {
-				close = cl.Close
+				close = cl.Close //nolint:revive
 			}
 		}
 		//nolint:errcheck // TODO: closing a writer would fail.