defaulting: implement orthogonally to validation

Author: sttts

helpers.go

@@ -159,7 +159,7 @@ func (h *paramHelper) safeExpandedParamsFor(path, method, operationID string, re
 				resolvedParams = append(resolvedParams, *resolvedParam)
 			}
 		}
-		// remove params with invalid expansion from slice
+		// remove params with invalid expansion from Slice
 		operation.Parameters = resolvedParams
 
 		for _, ppr := range s.analyzer.SafeParamsFor(method, path,

object_validator.go

@@ -102,6 +102,7 @@ func (o *objectValidator) Validate(data interface{}) *Result {
 
 	o.precheck(res, val)
 
+	// check validity of field names
 	if o.AdditionalProperties != nil && !o.AdditionalProperties.Allows {
 		// Case: additionalProperties: false
 		for k := range val {
@@ -175,7 +176,8 @@ func (o *objectValidator) Validate(data interface{}) *Result {
 				// Cases: properties which are not regular properties and have not been matched by the PatternProperties validator
 				if o.AdditionalProperties != nil && o.AdditionalProperties.Schema != nil {
 					// AdditionalProperties as Schema
-					res.Merge(NewSchemaValidator(o.AdditionalProperties.Schema, o.Root, o.Path+"."+key, o.KnownFormats).Validate(value))
+					r := NewSchemaValidator(o.AdditionalProperties.Schema, o.Root, o.Path+"."+key, o.KnownFormats).Validate(value)
+					res.mergeForField(data.(map[string]interface{}), key, r)
 				} else if regularProperty && !(matched || succeededOnce) {
 					// TODO: this is dead code since regularProperty=false here
 					res.AddErrors(errors.FailedAllPatternProperties(o.Path, o.In, key))
@@ -189,7 +191,8 @@ func (o *objectValidator) Validate(data interface{}) *Result {
 
 	// Property types:
 	// - regular Property
-	for pName, pSchema := range o.Properties {
+	for pName := range o.Properties {
+		pSchema := o.Properties[pName] // one instance per iteration
 		rName := pName
 		if o.Path != "" {
 			rName = o.Path + "." + pName
@@ -198,17 +201,12 @@ func (o *objectValidator) Validate(data interface{}) *Result {
 		// Recursively validates each property against its schema
 		if v, ok := val[pName]; ok {
 			r := NewSchemaValidator(&pSchema, o.Root, rName, o.KnownFormats).Validate(v)
-			res.Merge(r)
+			res.mergeForField(data.(map[string]interface{}), pName, r)
 		} else if pSchema.Default != nil {
 			// If a default value is defined, creates the property from defaults
 			// NOTE: JSON schema does not enforce default values to be valid against schema. Swagger does.
 			createdFromDefaults[pName] = true
-			pName := pName // shadow
-			// TODO: should validate the default first and ignore the value if invalid
-			def := pSchema.Default
-			res.Defaulters = append(res.Defaulters, DefaulterFunc(func() {
-				val[pName] = def
-			}))
+			res.addPropertySchemata(data.(map[string]interface{}), pName, &pSchema)
 		}
 	}
 
@@ -230,7 +228,8 @@ func (o *objectValidator) Validate(data interface{}) *Result {
 		if !regularProperty && (matched /*|| succeededOnce*/) {
 			for _, pName := range patterns {
 				if v, ok := o.PatternProperties[pName]; ok {
-					res.Merge(NewSchemaValidator(&v, o.Root, o.Path+"."+key, o.KnownFormats).Validate(value))
+					r := NewSchemaValidator(&v, o.Root, o.Path+"."+key, o.KnownFormats).Validate(value)
+					res.mergeForField(data.(map[string]interface{}), key, r)
 				}
 			}
 		}

defaulter.go renamed to post/defaulter.go

@@ -1,4 +1,4 @@
-// Copyright 2015 go-swagger maintainers
+// Copyright 2018 go-swagger maintainers
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,18 +12,22 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package validate
+package post
 
-// Defaulter defines an interface to define values from default values
-// provided in a schema.
-type Defaulter interface {
-	Apply()
-}
-
-// DefaulterFunc is a function to be called to apply default values to an object.
-type DefaulterFunc func()
+import (
+	"github.com/go-openapi/validate"
+)
 
-// Apply runs the defaulter function, thus applying default values to an object.
-func (f DefaulterFunc) Apply() {
-	f()
+// ApplyDefaults applies defaults to data.
+func ApplyDefaults(r *validate.Result) {
+	fieldSchemata := r.FieldSchemata()
+	for key, schemata := range fieldSchemata {
+	LookForDefaultingScheme:
+		for _, s := range schemata {
+			if s.Default != nil {
+				key.Object()[key.Field()] = s.Default
+				break LookForDefaultingScheme
+			}
+		}
+	}
 }

defaulter_test.go renamed to post/defaulter_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package validate
+package post
 
 import (
 	"encoding/json"
@@ -25,22 +25,23 @@ import (
 
 	"github.com/go-openapi/spec"
 	"github.com/go-openapi/strfmt"
+	"github.com/go-openapi/validate"
 )
 
-var defaulterFixturesPath = filepath.Join("fixtures", "defaulting")
+var defaulterFixturesPath = filepath.Join("..", "fixtures", "defaulting")
 
 func TestDefaulter(t *testing.T) {
 	schema, err := defaulterFixture()
 	assert.NoError(t, err)
 
-	validator := NewSchemaValidator(schema, nil, "", strfmt.Default)
+	validator := validate.NewSchemaValidator(schema, nil, "", strfmt.Default)
 	x := defaulterFixtureInput()
 	t.Logf("Before: %v", x)
 
 	r := validator.Validate(x)
 	assert.False(t, r.HasErrors(), fmt.Sprintf("unexpected validation error: %v", r.AsError()))
 
-	r.ApplyDefaults()
+	ApplyDefaults(r)
 	t.Logf("After: %v", x)
 	var expected interface{}
 	err = json.Unmarshal([]byte(`{
@@ -60,26 +61,26 @@ func TestDefaulterSimple(t *testing.T) {
 	schema := spec.Schema{
 		SchemaProps: spec.SchemaProps{
 			Properties: map[string]spec.Schema{
-				"int": spec.Schema{
+				"int": {
 					SchemaProps: spec.SchemaProps{
 						Default: float64(42),
 					},
 				},
-				"str": spec.Schema{
+				"str": {
 					SchemaProps: spec.SchemaProps{
 						Default: "Hello",
 					},
 				},
 			},
 		},
 	}
-	validator := NewSchemaValidator(&schema, nil, "", strfmt.Default)
+	validator := validate.NewSchemaValidator(&schema, nil, "", strfmt.Default)
 	x := map[string]interface{}{}
 	t.Logf("Before: %v", x)
 	r := validator.Validate(x)
 	assert.False(t, r.HasErrors(), fmt.Sprintf("unexpected validation error: %v", r.AsError()))
 
-	r.ApplyDefaults()
+	ApplyDefaults(r)
 	t.Logf("After: %v", x)
 	var expected interface{}
 	err := json.Unmarshal([]byte(`{
@@ -92,16 +93,16 @@ func TestDefaulterSimple(t *testing.T) {
 
 func BenchmarkDefaulting(b *testing.B) {
 	b.ReportAllocs()
-	
+
 	schema, err := defaulterFixture()
 	assert.NoError(b, err)
 
 	for n := 0; n < b.N; n++ {
-		validator := NewSchemaValidator(schema, nil, "", strfmt.Default)
+		validator := validate.NewSchemaValidator(schema, nil, "", strfmt.Default)
 		x := defaulterFixtureInput()
 		r := validator.Validate(x)
 		assert.False(b, r.HasErrors(), fmt.Sprintf("unexpected validation error: %v", r.AsError()))
-		r.ApplyDefaults()
+		ApplyDefaults(r)
 	}
 }