Relint

* updated linter config
* fixed linter issues (esp. errors wrapping)

Signed-off-by: Frederic BIDON <[email protected]>

Author: fredbi

.golangci.yml

@@ -1,12 +1,6 @@
 linters-settings:
-  govet:
-    check-shadowing: true
-  golint:
-    min-confidence: 0
   gocyclo:
     min-complexity: 45
-  maligned:
-    suggest-new: true
   dupl:
     threshold: 200
   goconst:
@@ -16,7 +10,6 @@ linters-settings:
 linters:
   enable-all: true
   disable:
-    - maligned
     - unparam
     - lll
     - gochecknoinits
@@ -29,17 +22,13 @@ linters:
     - wrapcheck
     - testpackage
     - nlreturn
-    - gomnd
-    - exhaustivestruct
-    - goerr113
     - errorlint
     - nestif
     - godot
     - gofumpt
     - paralleltest
     - tparallel
     - thelper
-    - ifshort
     - exhaustruct
     - varnamelen
     - gci
@@ -52,10 +41,15 @@ linters:
     - forcetypeassert
     - cyclop
     # deprecated linters
-    - deadcode
-    - interfacer
-    - scopelint
-    - varcheck
-    - structcheck
-    - golint
-    - nosnakecase
+    #- deadcode
+    #- interfacer
+    #- scopelint
+    #- varcheck
+    #- structcheck
+    #- golint
+    #- nosnakecase
+    #- maligned
+    #- goerr113
+    #- ifshort
+    #- gomnd
+    #- exhaustivestruct

errors.go

@@ -0,0 +1,15 @@
+package loads
+
+type loaderError string
+
+func (e loaderError) Error() string {
+	return string(e)
+}
+
+const (
+	// ErrLoads is an error returned by the loads package
+	ErrLoads loaderError = "loaderrs error"
+
+	// ErrNoLoader indicates that no configured loader matched the input
+	ErrNoLoader loaderError = "no loader matched"
+)

fmts/yaml_test.go

@@ -28,11 +28,13 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+var errTest = errors.New("expected")
+
 type failJSONMarshal struct {
 }
 
 func (f failJSONMarshal) MarshalJSON() ([]byte, error) {
-	return nil, errors.New("expected")
+	return nil, errTest
 }
 
 func TestLoadHTTPBytes(t *testing.T) {
@@ -124,7 +126,7 @@ name: a string value
 
 		d, err := YAMLToJSON(dd)
 		require.NoError(t, err)
-		assert.Equal(t, json.RawMessage(`{"description":"object created"}`), d)
+		assert.YAMLEq(t, `{"description":"object created"}`, string(d))
 	})
 }
 
@@ -138,7 +140,7 @@ func TestLoadStrategy(t *testing.T) {
 
 	ld := swag.LoadStrategy("blah", loader, remLoader)
 	b, _ := ld("")
-	assert.Equal(t, []byte(yamlPetStore), b)
+	assert.YAMLEq(t, yamlPetStore, string(b))
 
 	serv := httptest.NewServer(http.HandlerFunc(yamlPestoreServer))
 	defer serv.Close()

loaders.go

@@ -83,10 +83,10 @@ func (l *loader) WithNext(next *loader) *loader {
 func (l *loader) Load(path string) (json.RawMessage, error) {
 	_, erp := url.Parse(path)
 	if erp != nil {
-		return nil, erp
+		return nil, errors.Join(erp, ErrLoads)
 	}
 
-	lastErr := errors.New("no loader matched") // default error if no match was found
+	var lastErr error = ErrNoLoader // default error if no match was found
 	for ldr := l; ldr != nil; ldr = ldr.Next {
 		if ldr.Match != nil && !ldr.Match(path) {
 			continue
@@ -101,14 +101,14 @@ func (l *loader) Load(path string) (json.RawMessage, error) {
 		lastErr = err
 	}
 
-	return nil, lastErr
+	return nil, errors.Join(lastErr, ErrLoads)
 }
 
 // JSONDoc loads a json document from either a file or a remote url
 func JSONDoc(path string) (json.RawMessage, error) {
 	data, err := swag.LoadFromFileOrHTTP(path)
 	if err != nil {
-		return nil, err
+		return nil, errors.Join(err, ErrLoads)
 	}
 	return json.RawMessage(data), nil
 }

options_test.go

@@ -14,6 +14,8 @@ import (
 
 const optionFixture = "fixtures/json/resources/pathLoaderIssue.json"
 
+var errTest = errors.New("test")
+
 func TestOptionsWithDocLoader(t *testing.T) {
 	document, err := Spec(optionFixture, WithDocLoader(func(pth string) (json.RawMessage, error) {
 		buf, err := os.ReadFile(pth)
@@ -105,11 +107,11 @@ func TestOptionsWithDocLoaderMatches(t *testing.T) {
 
 	// the nil matcher always matches
 	nilMatcher := NewDocLoaderWithMatch(func(_ string) (json.RawMessage, error) {
-		return nil, errors.New("test")
+		return nil, errTest
 	}, nil)
 	_, err = Spec(optionFixture, WithDocLoaderMatches(nilMatcher))
 	require.Error(t, err)
-	require.Equal(t, "test", err.Error())
+	require.ErrorIs(t, err, errTest)
 
 	// when a matcher returns an errors, the next one is tried
 	document, err = Spec(optionFixture, WithDocLoaderMatches(nilMatcher, jsonLoader, yamlLoader))

spec.go

@@ -18,6 +18,7 @@ import (
 	"bytes"
 	"encoding/gob"
 	"encoding/json"
+	"errors"
 	"fmt"
 
 	"github.com/go-openapi/analysis"
@@ -102,7 +103,7 @@ func Analyzed(data json.RawMessage, version string, options ...LoaderOption) (*D
 		version = "2.0"
 	}
 	if version != "2.0" {
-		return nil, fmt.Errorf("spec version %q is not supported", version)
+		return nil, fmt.Errorf("spec version %q is not supported: %w", version, ErrLoads)
 	}
 
 	raw, err := trimData(data) // trim blanks, then convert yaml docs into json
@@ -112,12 +113,12 @@ func Analyzed(data json.RawMessage, version string, options ...LoaderOption) (*D
 
 	swspec := new(spec.Swagger)
 	if err = json.Unmarshal(raw, swspec); err != nil {
-		return nil, err
+		return nil, errors.Join(err, ErrLoads)
 	}
 
 	origsqspec, err := cloneSpec(swspec)
 	if err != nil {
-		return nil, err
+		return nil, errors.Join(err, ErrLoads)
 	}
 
 	d := &Document{
@@ -145,12 +146,12 @@ func trimData(in json.RawMessage) (json.RawMessage, error) {
 	// assume yaml doc: convert it to json
 	yml, err := swag.BytesToYAMLDoc(trimmed)
 	if err != nil {
-		return nil, fmt.Errorf("analyzed: %v", err)
+		return nil, fmt.Errorf("analyzed: %v: %w", err, ErrLoads)
 	}
 
 	d, err := swag.YAMLToJSON(yml)
 	if err != nil {
-		return nil, fmt.Errorf("analyzed: %v", err)
+		return nil, fmt.Errorf("analyzed: %v: %w", err, ErrLoads)
 	}
 
 	return d, nil
@@ -271,5 +272,6 @@ func cloneSpec(src *spec.Swagger) (*spec.Swagger, error) {
 	if err := gob.NewDecoder(&b).Decode(&dst); err != nil {
 		return nil, err
 	}
+
 	return &dst, nil
 }