update go version to 1.18. Fix lint

youyuanwu · youyuanwu · commit 82e6077f5c37 · 2023-07-22T11:40:16.000-07:00
Signed-off-by: Youyuan Wu &lt;youyuanwu@outlook.com&gt;
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -41,6 +41,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - uses: golangci/golangci-lint-action@v2
+    - uses: golangci/golangci-lint-action@v3
       with:
+        version: v1.53
         args: --timeout=5m
diff --git a/.golangci.yml b/.golangci.yml
@@ -39,7 +39,12 @@ linters:
     - tparallel
     - paralleltest
     - cyclop # because we have gocyclo already
+    - depguard # we do not add a config for this
     # TODO: review the linters below. We disabled them to make the CI pass first.
+    - nonamedreturns
+    - exhaustruct
+    - nosnakecase
+    - nolintlint
     - ireturn
     - varnamelen
     - forcetypeassert
diff --git a/default_validator.go b/default_validator.go
@@ -170,7 +170,7 @@ func (d *defaultValidator) validateDefaultInResponse(resp *spec.Response, respon
 
 	responseName, responseCodeAsStr := responseHelp.responseMsgVariants(responseType, responseCode)
 
-	// nolint: dupl
+	//nolint: dupl
 	if response.Headers != nil { // Safeguard
 		for nm, h := range response.Headers {
 			// reset explored schemas to get depth-first recursive-proof exploration
@@ -262,6 +262,7 @@ func (d *defaultValidator) validateDefaultValueSchemaAgainstSchema(path, in stri
 }
 
 // TODO: Temporary duplicated code. Need to refactor with examples
+
 // nolint: dupl
 func (d *defaultValidator) validateDefaultValueItemsAgainstSchema(path, in string, root interface{}, items *spec.Items) *Result {
 	res := new(Result)
diff --git a/doc.go b/doc.go
@@ -19,7 +19,7 @@ as well as tools to validate data against their schema.
 This package follows Swagger 2.0. specification (aka OpenAPI 2.0). Reference
 can be found here: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md.
 
-Validating a specification
+# Validating a specification
 
 Validates a spec document (from JSON or YAML) against the JSON schema for swagger,
 then checks a number of extra rules that can't be expressed in JSON schema.
@@ -30,34 +30,36 @@ Entry points:
   - SpecValidator.Validate()
 
 Reported as errors:
-  [x] definition can't declare a property that's already defined by one of its ancestors
-  [x] definition's ancestor can't be a descendant of the same model
-  [x] path uniqueness: each api path should be non-verbatim (account for path param names) unique per method
-  [x] each security reference should contain only unique scopes
-  [x] each security scope in a security definition should be unique
-  [x] parameters in path must be unique
-  [x] each path parameter must correspond to a parameter placeholder and vice versa
-  [x] each referenceable definition must have references
-  [x] each definition property listed in the required array must be defined in the properties of the model
-  [x] each parameter should have a unique `name` and `type` combination
-  [x] each operation should have only 1 parameter of type body
-  [x] each reference must point to a valid object
-  [x] every default value that is specified must validate against the schema for that property
-  [x] items property is required for all schemas/definitions of type `array`
-  [x] path parameters must be declared a required
-  [x] headers must not contain $ref
-  [x] schema and property examples provided must validate against their respective object's schema
-  [x] examples provided must validate their schema
+
+	[x] definition can't declare a property that's already defined by one of its ancestors
+	[x] definition's ancestor can't be a descendant of the same model
+	[x] path uniqueness: each api path should be non-verbatim (account for path param names) unique per method
+	[x] each security reference should contain only unique scopes
+	[x] each security scope in a security definition should be unique
+	[x] parameters in path must be unique
+	[x] each path parameter must correspond to a parameter placeholder and vice versa
+	[x] each referenceable definition must have references
+	[x] each definition property listed in the required array must be defined in the properties of the model
+	[x] each parameter should have a unique `name` and `type` combination
+	[x] each operation should have only 1 parameter of type body
+	[x] each reference must point to a valid object
+	[x] every default value that is specified must validate against the schema for that property
+	[x] items property is required for all schemas/definitions of type `array`
+	[x] path parameters must be declared a required
+	[x] headers must not contain $ref
+	[x] schema and property examples provided must validate against their respective object's schema
+	[x] examples provided must validate their schema
 
 Reported as warnings:
-  [x] path parameters should not contain any of [{,},\w]
-  [x] empty path
-  [x] unused definitions
-  [x] unsupported validation of examples on non-JSON media types
-  [x] examples in response without schema
-  [x] readOnly properties should not be required
 
-Validating a schema
+	[x] path parameters should not contain any of [{,},\w]
+	[x] empty path
+	[x] unused definitions
+	[x] unsupported validation of examples on non-JSON media types
+	[x] examples in response without schema
+	[x] readOnly properties should not be required
+
+# Validating a schema
 
 The schema validation toolkit validates data against JSON-schema-draft 04 schema.
 
@@ -70,16 +72,16 @@ Entry points:
   - AgainstSchema()
   - ...
 
-Known limitations
+# Known limitations
 
 With the current version of this package, the following aspects of swagger are not yet supported:
-  [ ] errors and warnings are not reported with key/line number in spec
-  [ ] default values and examples on responses only support application/json producer type
-  [ ] invalid numeric constraints (such as Minimum, etc..) are not checked except for default and example values
-  [ ] rules for collectionFormat are not implemented
-  [ ] no validation rule for polymorphism support (discriminator) [not done here]
-  [ ] valid js ECMA regexp not supported by Go regexp engine are considered invalid
-  [ ] arbitrary large numbers are not supported: max is math.MaxFloat64
 
+	[ ] errors and warnings are not reported with key/line number in spec
+	[ ] default values and examples on responses only support application/json producer type
+	[ ] invalid numeric constraints (such as Minimum, etc..) are not checked except for default and example values
+	[ ] rules for collectionFormat are not implemented
+	[ ] no validation rule for polymorphism support (discriminator) [not done here]
+	[ ] valid js ECMA regexp not supported by Go regexp engine are considered invalid
+	[ ] arbitrary large numbers are not supported: max is math.MaxFloat64
 */
 package validate
diff --git a/doc_test.go b/doc_test.go
@@ -49,7 +49,7 @@ func ExampleSpec() {
 	// Output: This spec is valid
 }
 
-func ExampleSpec_url() {
+func ExampleSpec_second() {
 	// Example with high level spec validation call, without showing warnings
 
 	// Example with online spec URL:
@@ -67,6 +67,9 @@ func ExampleSpec_url() {
 	} else {
 		fmt.Println("Could not load this spec")
 	}
+
+	// Output:
+	// This spec is valid
 }
 
 func ExampleSpecValidator_Validate() {
@@ -116,6 +119,9 @@ func ExampleSpecValidator_Validate_url() {
 			fmt.Println("This spec has some validation warnings")
 		}
 	}
+
+	// Output:
+	// This spec is valid
 }
 
 func ExampleAgainstSchema() {
diff --git a/example_validator.go b/example_validator.go
@@ -48,7 +48,6 @@ func (ex *exampleValidator) isVisited(path string) bool {
 //   - schemas
 //   - individual property
 //   - responses
-//
 func (ex *exampleValidator) Validate() (errs *Result) {
 	errs = new(Result)
 	if ex == nil || ex.SpecValidator == nil {
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/go-openapi/validate
 
-go 1.14
+go 1.18
 
 require (
 	github.com/go-openapi/analysis v0.21.2
@@ -13,3 +13,21 @@ require (
 	github.com/stretchr/testify v1.7.0
 	gopkg.in/yaml.v2 v2.4.0
 )
+
+require (
+	github.com/PuerkitoBio/purell v1.1.1 // indirect
+	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
+	github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/go-openapi/jsonreference v0.19.6 // indirect
+	github.com/go-stack/stack v1.8.0 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/mailru/easyjson v0.7.6 // indirect
+	github.com/mitchellh/mapstructure v1.4.1 // indirect
+	github.com/oklog/ulid v1.3.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	go.mongodb.org/mongo-driver v1.7.5 // indirect
+	golang.org/x/net v0.0.0-20210421230115-4e50805a0758 // indirect
+	golang.org/x/text v0.3.7 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+)
diff --git a/go.sum b/go.sum
@@ -151,7 +151,6 @@ golang.org/x/tools v0.0.0-20190329151228-23e29df326fe/go.mod h1:LCzVGOaR6xXOjkQ3
 golang.org/x/tools v0.0.0-20190416151739-9c9e1878f421/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20190420181800-aa740d480789/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20190531172133-b3315ee88b7d/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
diff --git a/helpers.go b/helpers.go
@@ -250,7 +250,7 @@ func (h *paramHelper) resolveParam(path, method, operationID string, param *spec
 
 	}
 	if err != nil { // Safeguard
-		// NOTE: we may enter enter here when the whole parameter is an unresolved $ref
+		// NOTE: we may enter here when the whole parameter is an unresolved $ref
 		refPath := strings.Join([]string{"\"" + path + "\"", method}, ".")
 		errorHelp.addPointerError(res, err, param.Ref.String(), refPath)
 		return nil, res
diff --git a/jsonschema_test.go b/jsonschema_test.go
@@ -22,6 +22,7 @@ import (
 	"path/filepath"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/go-openapi/spec"
 	"github.com/go-openapi/strfmt"
@@ -107,7 +108,13 @@ func isExtendedEnabled(nm string) bool {
 func TestJSONSchemaSuite(t *testing.T) {
 	// Internal local server to serve remote $ref
 	go func() {
-		err := http.ListenAndServe("localhost:1234", http.FileServer(http.Dir(jsonSchemaFixturesPath+"/remotes")))
+		svr := &http.Server{
+			ReadTimeout:  5 * time.Second,
+			WriteTimeout: 10 * time.Second,
+			Addr:         "localhost:1234",
+			Handler:      http.FileServer(http.Dir(jsonSchemaFixturesPath + "/remotes")),
+		}
+		err := svr.ListenAndServe()
 		if err != nil {
 			panic(err.Error())
 		}
diff --git a/options_test.go b/options_test.go
@@ -6,5 +6,5 @@ import (
 
 // This test must be synchronized to avoid issues with -race
 // TODO(TEST)
-func TestOptions_SetContinueOnErrors(t *testing.T) {
+func TestOptions_SetContinueOnErrors(_ *testing.T) {
 }
diff --git a/rexp_test.go b/rexp_test.go
@@ -75,9 +75,10 @@ func TestRace_compileRegexp(t *testing.T) {
 	}
 
 	for i := 0; i < 20; i++ {
-		t.Run(patterns[i%3], func(t *testing.T) {
+		ii := i
+		t.Run(patterns[ii%3], func(t *testing.T) {
 			t.Parallel()
-			comp(patterns[i%3])
+			comp(patterns[ii%3])
 		})
 	}
 }
@@ -98,9 +99,10 @@ func TestRace_mustCompileRegexp(t *testing.T) {
 	}
 
 	for i := 0; i < 20; i++ {
-		t.Run(patterns[i%3], func(t *testing.T) {
+		ii := i
+		t.Run(patterns[ii%3], func(t *testing.T) {
 			t.Parallel()
-			comp(patterns[i%3])
+			comp(patterns[ii%3])
 		})
 	}
 }
diff --git a/schema.go b/schema.go
@@ -101,7 +101,7 @@ func (s *SchemaValidator) SetPath(path string) {
 }
 
 // Applies returns true when this schema validator applies
-func (s *SchemaValidator) Applies(source interface{}, kind reflect.Kind) bool {
+func (s *SchemaValidator) Applies(source interface{}, _ reflect.Kind) bool {
 	_, ok := source.(*spec.Schema)
 	return ok
 }
diff --git a/spec.go b/spec.go
@@ -32,17 +32,16 @@ import (
 //
 // Returns an error flattening in a single standard error, all validation messages.
 //
-//  - TODO: $ref should not have siblings
-//  - TODO: make sure documentation reflects all checks and warnings
-//  - TODO: check on discriminators
-//  - TODO: explicit message on unsupported keywords (better than "forbidden property"...)
-//  - TODO: full list of unresolved refs
-//  - TODO: validate numeric constraints (issue#581): this should be handled like defaults and examples
-//  - TODO: option to determine if we validate for go-swagger or in a more general context
-//  - TODO: check on required properties to support anyOf, allOf, oneOf
+//   - TODO: $ref should not have siblings
+//   - TODO: make sure documentation reflects all checks and warnings
+//   - TODO: check on discriminators
+//   - TODO: explicit message on unsupported keywords (better than "forbidden property"...)
+//   - TODO: full list of unresolved refs
+//   - TODO: validate numeric constraints (issue#581): this should be handled like defaults and examples
+//   - TODO: option to determine if we validate for go-swagger or in a more general context
+//   - TODO: check on required properties to support anyOf, allOf, oneOf
 //
 // NOTE: SecurityScopes are maps: no need to check uniqueness
-//
 func Spec(doc *loads.Document, formats strfmt.Registry) error {
 	errs, _ /*warns*/ := NewSpecValidator(doc.Schema(), formats).Validate(doc)
 	if errs.HasErrors() {
diff --git a/spec_messages.go b/spec_messages.go
@@ -349,9 +349,10 @@ func parameterValidationTypeMismatchMsg(param, path, typ string) errors.Error {
 }
 
 // disabled
-// func invalidResponseDefinitionAsSchemaMsg(path, method string) errors.Error {
-//	return errors.New(errors.CompositeErrorCode, InvalidResponseDefinitionAsSchemaError, path, method)
-// }
+//
+//	func invalidResponseDefinitionAsSchemaMsg(path, method string) errors.Error {
+//		return errors.New(errors.CompositeErrorCode, InvalidResponseDefinitionAsSchemaError, path, method)
+//	}
 func someParametersBrokenMsg(path, method, operationID string) errors.Error {
 	return errors.New(errors.CompositeErrorCode, SomeParametersBrokenError, path, method, operationID)
 }
diff --git a/spec_test.go b/spec_test.go
@@ -35,11 +35,9 @@ import (
 // Usage: go test ... -args [-enable-long|-enable-go-swagger]
 //
 // -enable-long:       enable spec_test.go:TestIssue18 and messages_test.go:Test_Quality*
-// -enable-go-swagger: enable non-regression tests against go-swagger fixtures (validation status)
-//                     in swagger_test.go:Test_GoSwagger  (running about 110 specs...)
+// -enable-go-swagger: enable non-regression tests against go-swagger fixtures (validation status) in swagger_test.go:Test_GoSwagger  (running about 110 specs...)
 //
 // If none enabled, these tests are skipped
-//
 // NOTE: replacing with go test -short and testing.Short() means that
 // by default, every test is launched. With -enable-long, we just get the
 // opposite...
diff --git a/swagger_test.go b/swagger_test.go
@@ -36,7 +36,7 @@ func skipNotifyGoSwagger(t *testing.T) {
 }
 
 // Exercise validate will all tests cases from package go-swagger
-// A copy of all fixtures available in in go-swagger/go-swagger
+// A copy of all fixtures available in go-swagger/go-swagger
 // is maintained in fixtures/go-swagger
 //
 // TODO: move this list to a YAML fixture config file
diff --git a/validator.go b/validator.go
@@ -148,7 +148,7 @@ func (b *basicCommonValidator) SetPath(path string) {
 	b.Path = path
 }
 
-func (b *basicCommonValidator) Applies(source interface{}, kind reflect.Kind) bool {
+func (b *basicCommonValidator) Applies(source interface{}, _ reflect.Kind) bool {
 	switch source.(type) {
 	case *spec.Parameter, *spec.Schema, *spec.Header:
 		return true
diff --git a/values.go b/values.go
@@ -120,7 +120,7 @@ func UniqueItems(path, in string, data interface{}) *errors.Validation {
 
 // MinLength validates a string for minimum length
 func MinLength(path, in, data string, minLength int64) *errors.Validation {
-	strLen := int64(utf8.RuneCount([]byte(data)))
+	strLen := int64(utf8.RuneCountInString(data))
 	if strLen < minLength {
 		return errors.TooShort(path, in, minLength, data)
 	}
@@ -129,7 +129,7 @@ func MinLength(path, in, data string, minLength int64) *errors.Validation {
 
 // MaxLength validates a string for maximum length
 func MaxLength(path, in, data string, maxLength int64) *errors.Validation {
-	strLen := int64(utf8.RuneCount([]byte(data)))
+	strLen := int64(utf8.RuneCountInString(data))
 	if strLen > maxLength {
 		return errors.TooLong(path, in, maxLength, data)
 	}

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func ExampleSpec() {`
`49`	`49`	`// Output: This spec is valid`
`50`	`50`	`}`
`51`	`51`
`52`		`-func ExampleSpec_url() {`
	`52`	`+func ExampleSpec_second() {`
`53`	`53`	`// Example with high level spec validation call, without showing warnings`
`54`	`54`
`55`	`55`	`// Example with online spec URL:`
`@@ -67,6 +67,9 @@ func ExampleSpec_url() {`
`67`	`67`	`} else {`
`68`	`68`	`fmt.Println("Could not load this spec")`
`69`	`69`	`}`
	`70`	`+`
	`71`	`+ // Output:`
	`72`	`+ // This spec is valid`
`70`	`73`	`}`
`71`	`74`
`72`	`75`	`func ExampleSpecValidator_Validate() {`
`@@ -116,6 +119,9 @@ func ExampleSpecValidator_Validate_url() {`
`116`	`119`	`fmt.Println("This spec has some validation warnings")`
`117`	`120`	`}`
`118`	`121`	`}`
	`122`	`+`
	`123`	`+ // Output:`
	`124`	`+ // This spec is valid`
`119`	`125`	`}`
`120`	`126`
`121`	`127`	`func ExampleAgainstSchema() {`
Original file line number	Diff line number	Diff line change
`@@ -250,7 +250,7 @@ func (h paramHelper) resolveParam(path, method, operationID string, param spec`
`250`	`250`
`251`	`251`	`}`
`252`	`252`	`if err != nil { // Safeguard`
`253`		`- // NOTE: we may enter enter here when the whole parameter is an unresolved $ref`
	`253`	`+ // NOTE: we may enter here when the whole parameter is an unresolved $ref`
`254`	`254`	`refPath := strings.Join([]string{"\"" + path + "\"", method}, ".")`
`255`	`255`	`errorHelp.addPointerError(res, err, param.Ref.String(), refPath)`
`256`	`256`	`return nil, res`