Merge pull request #5 from pb33f/0.0.2

v0.0.2

Author: daveshanley

errors/parameter_errors.go

@@ -5,7 +5,6 @@ import (
     "github.com/pb33f/libopenapi-validator/helpers"
     "github.com/pb33f/libopenapi/datamodel/high/base"
     "github.com/pb33f/libopenapi/datamodel/high/v3"
-    "gopkg.in/yaml.v3"
     "net/url"
     "strings"
 )
@@ -76,40 +75,40 @@ func InvalidDeepObject(param *v3.Parameter, qp *helpers.QueryParam) *ValidationE
 
 func QueryParameterMissing(param *v3.Parameter) *ValidationError {
     return &ValidationError{
-        Message: fmt.Sprintf("Query parameter '%s' is missing", param.Name),
+        ValidationType:    helpers.ParameterValidation,
+        ValidationSubType: helpers.ParameterValidationQuery,
+        Message:           fmt.Sprintf("Query parameter '%s' is missing", param.Name),
         Reason: fmt.Sprintf("The query parameter '%s' is defined as being required, "+
             "however it's missing from the requests", param.Name),
         SpecLine: param.GoLow().Required.KeyNode.Line,
         SpecCol:  param.GoLow().Required.KeyNode.Column,
+        HowToFix: HowToFixMissingValue,
     }
 }
 
 func HeaderParameterMissing(param *v3.Parameter) *ValidationError {
     return &ValidationError{
-        Message: fmt.Sprintf("Header parameter '%s' is missing", param.Name),
+        ValidationType:    helpers.ParameterValidation,
+        ValidationSubType: helpers.ParameterValidationHeader,
+        Message:           fmt.Sprintf("Header parameter '%s' is missing", param.Name),
         Reason: fmt.Sprintf("The header parameter '%s' is defined as being required, "+
             "however it's missing from the requests", param.Name),
         SpecLine: param.GoLow().Required.KeyNode.Line,
         SpecCol:  param.GoLow().Required.KeyNode.Column,
-    }
-}
-
-func HeaderParameterNotDefined(paramName string, kn *yaml.Node) *ValidationError {
-    return &ValidationError{
-        Message:  fmt.Sprintf("Header parameter '%s' is not defined", paramName),
-        Reason:   fmt.Sprintf("The header parameter '%s' is not defined as part of the specification for the operation", paramName),
-        SpecLine: kn.Line,
-        SpecCol:  kn.Column,
+        HowToFix: HowToFixMissingValue,
     }
 }
 
 func HeaderParameterCannotBeDecoded(param *v3.Parameter, val string) *ValidationError {
     return &ValidationError{
-        Message: fmt.Sprintf("Header parameter '%s' cannot be decoded", param.Name),
+        ValidationType:    helpers.ParameterValidation,
+        ValidationSubType: helpers.ParameterValidationHeader,
+        Message:           fmt.Sprintf("Header parameter '%s' cannot be decoded", param.Name),
         Reason: fmt.Sprintf("The header parameter '%s' cannot be "+
             "extracted into an object, '%s' is malformed", param.Name, val),
         SpecLine: param.GoLow().Schema.Value.Schema().Type.KeyNode.Line,
         SpecCol:  param.GoLow().Schema.Value.Schema().Type.KeyNode.Line,
+        HowToFix: HowToFixInvalidEncoding,
     }
 }
 

errors/parameters_howtofix.go

@@ -4,22 +4,24 @@
 package errors
 
 const (
-	HowToFixReservedValues string = "parameter values need to URL Encoded to ensure reserved " +
-		"values are correctly encoded, for example: '%s'"
-	HowToFixParamInvalidNumber                      string = "Convert the value '%s' into a number"
-	HowToFixParamInvalidString                      string = "Convert the value '%s' into a string (cannot start with a number, or be a floating point)"
-	HowToFixParamInvalidBoolean                     string = "Convert the value '%s' into a true/false value"
-	HowToFixParamInvalidEnum                        string = "Instead of '%s', use one of the allowed values: '%s'"
-	HowToFixParamInvalidFormEncode                  string = "Use a form style encoding for parameter values, for example: '%s'"
-	HowToFixInvalidSchema                           string = "Ensure that the object being submitted, matches the schema correctly"
-	HowToFixParamInvalidSpaceDelimitedObjectExplode string = "When using 'explode' with space delimited parameters, " +
-		"they should be separated by spaces. For example: '%s'"
-	HowToFixParamInvalidPipeDelimitedObjectExplode string = "When using 'explode' with pipe delimited parameters, " +
-		"they should be separated by pipes '|'. For example: '%s'"
-	HowToFixParamInvalidDeepObjectMultipleValues string = "There can only be a single value per property name, " +
-		"deepObject parameters should contain the property key in square brackets next to the parameter name. For example: '%s'"
-	HowToFixInvalidJSON         string = "The JSON submitted is invalid, please check the syntax"
-	HowToFixDecodingError              = "The object can't be decoded, so make sure it's being encoded correctly according to the spec."
-	HowToFixInvalidContentType         = "The content type is invalid, Use one of the %d supported types for this operation: %s"
-	HowToFixInvalidResponseCode        = "The service is responding with a code that is not defined in the spec, fix the service!"
+    HowToFixReservedValues string = "parameter values need to URL Encoded to ensure reserved " +
+        "values are correctly encoded, for example: '%s'"
+    HowToFixParamInvalidNumber                      string = "Convert the value '%s' into a number"
+    HowToFixParamInvalidString                      string = "Convert the value '%s' into a string (cannot start with a number, or be a floating point)"
+    HowToFixParamInvalidBoolean                     string = "Convert the value '%s' into a true/false value"
+    HowToFixParamInvalidEnum                        string = "Instead of '%s', use one of the allowed values: '%s'"
+    HowToFixParamInvalidFormEncode                  string = "Use a form style encoding for parameter values, for example: '%s'"
+    HowToFixInvalidSchema                           string = "Ensure that the object being submitted, matches the schema correctly"
+    HowToFixParamInvalidSpaceDelimitedObjectExplode string = "When using 'explode' with space delimited parameters, " +
+        "they should be separated by spaces. For example: '%s'"
+    HowToFixParamInvalidPipeDelimitedObjectExplode string = "When using 'explode' with pipe delimited parameters, " +
+        "they should be separated by pipes '|'. For example: '%s'"
+    HowToFixParamInvalidDeepObjectMultipleValues string = "There can only be a single value per property name, " +
+        "deepObject parameters should contain the property key in square brackets next to the parameter name. For example: '%s'"
+    HowToFixInvalidJSON         string = "The JSON submitted is invalid, please check the syntax"
+    HowToFixDecodingError              = "The object can't be decoded, so make sure it's being encoded correctly according to the spec."
+    HowToFixInvalidContentType         = "The content type is invalid, Use one of the %d supported types for this operation: %s"
+    HowToFixInvalidResponseCode        = "The service is responding with a code that is not defined in the spec, fix the service!"
+    HowToFixInvalidEncoding            = "Ensure the correct encoding has been used on the object"
+    HowToFixMissingValue               = "Ensure the value has been set"
 )

errors/validation_error.go

@@ -4,78 +4,83 @@
 package errors
 
 import (
-	"fmt"
-	"github.com/santhosh-tekuri/jsonschema/v5"
+    "fmt"
+    "github.com/santhosh-tekuri/jsonschema/v5"
 )
 
 // SchemaValidationFailure is a wrapper around the jsonschema.ValidationError object, to provide a more
 // user-friendly way to break down what went wrong.
 type SchemaValidationFailure struct {
-	// Reason is a human-readable message describing the reason for the error.
-	Reason string `json:"reason,omitempty" yaml:"reason,omitempty"`
+    // Reason is a human-readable message describing the reason for the error.
+    Reason string `json:"reason,omitempty" yaml:"reason,omitempty"`
 
-	// Location is the XPath-like location of the validation failure
-	Location string `json:"location,omitempty" yaml:"location,omitempty"`
+    // Location is the XPath-like location of the validation failure
+    Location string `json:"location,omitempty" yaml:"location,omitempty"`
 
-	// Line is the line number where the violation occurred. This may a local line number
-	// if the validation is a schema (only schemas are validated locally, so the line number will be relative to
-	// the Context object held by the ValidationError object).
-	Line int `json:"line,omitempty" yaml:"line,omitempty"`
+    // Line is the line number where the violation occurred. This may a local line number
+    // if the validation is a schema (only schemas are validated locally, so the line number will be relative to
+    // the Context object held by the ValidationError object).
+    Line int `json:"line,omitempty" yaml:"line,omitempty"`
 
-	// Column is the column number where the violation occurred. This may a local column number
-	// if the validation is a schema (only schemas are validated locally, so the column number will be relative to
-	// the Context object held by the ValidationError object).
-	Column int `json:"column,omitempty" yaml:"column,omitempty"`
+    // Column is the column number where the violation occurred. This may a local column number
+    // if the validation is a schema (only schemas are validated locally, so the column number will be relative to
+    // the Context object held by the ValidationError object).
+    Column int `json:"column,omitempty" yaml:"column,omitempty"`
 
-	// The original error object, which is a jsonschema.ValidationError object.
-	OriginalError *jsonschema.ValidationError `json:"-" yaml:"-"`
+    // The original error object, which is a jsonschema.ValidationError object.
+    OriginalError *jsonschema.ValidationError `json:"-" yaml:"-"`
 }
 
 // Error returns a string representation of the error
 func (s *SchemaValidationFailure) Error() string {
-	return fmt.Sprintf("Reason: %s, Location: %s", s.Reason, s.Location)
+    return fmt.Sprintf("Reason: %s, Location: %s", s.Reason, s.Location)
 }
 
 // ValidationError is a struct that contains all the information about a validation error.
 type ValidationError struct {
 
-	// Message is a human-readable message describing the error.
-	Message string `json:"message" yaml:"message"`
+    // Message is a human-readable message describing the error.
+    Message string `json:"message" yaml:"message"`
 
-	// Reason is a human-readable message describing the reason for the error.
-	Reason string `json:"reason" yaml:"reason"`
+    // Reason is a human-readable message describing the reason for the error.
+    Reason string `json:"reason" yaml:"reason"`
 
-	// ValidationType is a string that describes the type of validation that failed.
-	ValidationType string `json:"validationType" yaml:"validationType"`
+    // ValidationType is a string that describes the type of validation that failed.
+    ValidationType string `json:"validationType" yaml:"validationType"`
 
-	// ValidationSubType is a string that describes the subtype of validation that failed.
-	ValidationSubType string `json:"validationSubType" yaml:"validationSubType"`
+    // ValidationSubType is a string that describes the subtype of validation that failed.
+    ValidationSubType string `json:"validationSubType" yaml:"validationSubType"`
 
-	// SpecLine is the line number in the spec where the error occurred.
-	SpecLine int `json:"specLine" yaml:"specLine"`
+    // SpecLine is the line number in the spec where the error occurred.
+    SpecLine int `json:"specLine" yaml:"specLine"`
 
-	// SpecCol is the column number in the spec where the error occurred.
-	SpecCol int `json:"specColumn" yaml:"specColumn"`
+    // SpecCol is the column number in the spec where the error occurred.
+    SpecCol int `json:"specColumn" yaml:"specColumn"`
 
-	// HowToFix is a human-readable message describing how to fix the error.
-	HowToFix string `json:"howToFix" yaml:"howToFix"`
+    // HowToFix is a human-readable message describing how to fix the error.
+    HowToFix string `json:"howToFix" yaml:"howToFix"`
 
-	// SchemaValidationErrors is a slice of SchemaValidationFailure objects that describe the validation errors
-	// This is only populated whe the validation type is against a schema.
-	SchemaValidationErrors []*SchemaValidationFailure `json:"validationErrors,omitempty" yaml:"validationErrors,omitempty"`
+    // SchemaValidationErrors is a slice of SchemaValidationFailure objects that describe the validation errors
+    // This is only populated whe the validation type is against a schema.
+    SchemaValidationErrors []*SchemaValidationFailure `json:"validationErrors,omitempty" yaml:"validationErrors,omitempty"`
 
-	// Context is the object that the validation error occurred on. This is usually a pointer to a schema
-	// or a parameter object.
-	Context interface{} `json:"-" yaml:"-"`
+    // Context is the object that the validation error occurred on. This is usually a pointer to a schema
+    // or a parameter object.
+    Context interface{} `json:"-" yaml:"-"`
 }
 
 // Error returns a string representation of the error
 func (v *ValidationError) Error() string {
-	if v.SchemaValidationErrors != nil {
-		return fmt.Sprintf("Error: %s, Reason: %s, Validation Errors: %s, Line: %d, Column: %d",
-			v.Message, v.Reason, v.SchemaValidationErrors, v.SpecLine, v.SpecCol)
-	} else {
-		return fmt.Sprintf("Error: %s, Reason: %s, Line: %d, Column: %d",
-			v.Message, v.Reason, v.SpecLine, v.SpecCol)
-	}
+    if v.SchemaValidationErrors != nil {
+        return fmt.Sprintf("Error: %s, Reason: %s, Validation Errors: %s, Line: %d, Column: %d",
+            v.Message, v.Reason, v.SchemaValidationErrors, v.SpecLine, v.SpecCol)
+    } else {
+        return fmt.Sprintf("Error: %s, Reason: %s, Line: %d, Column: %d",
+            v.Message, v.Reason, v.SpecLine, v.SpecCol)
+    }
+}
+
+// IsPathMissingError returns true if the error has a ValidationType of "path" and a ValidationSubType of "missing"
+func (v *ValidationError) IsPathMissingError() bool {
+    return v.ValidationType == "path" && v.ValidationSubType == "missing"
 }

requests/request_body.go

@@ -5,6 +5,7 @@ package requests
 
 import (
 	"github.com/pb33f/libopenapi-validator/errors"
+	"github.com/pb33f/libopenapi/datamodel/high/base"
 	"github.com/pb33f/libopenapi/datamodel/high/v3"
 	"net/http"
 )
@@ -28,17 +29,24 @@ type RequestBodyValidator interface {
 
 // NewRequestBodyValidator will create a new RequestBodyValidator from an OpenAPI 3+ document
 func NewRequestBodyValidator(document *v3.Document) RequestBodyValidator {
-	return &requestBodyValidator{document: document}
+	return &requestBodyValidator{document: document, schemaCache: make(map[[32]byte]*schemaCache)}
 }
 
 func (v *requestBodyValidator) SetPathItem(path *v3.PathItem, pathValue string) {
 	v.pathItem = path
 	v.pathValue = pathValue
 }
 
+type schemaCache struct {
+	schema         *base.Schema
+	renderedInline []byte
+	renderedJSON   []byte
+}
+
 type requestBodyValidator struct {
-	document  *v3.Document
-	pathItem  *v3.PathItem
-	pathValue string
-	errors    []*errors.ValidationError
+	document    *v3.Document
+	pathItem    *v3.PathItem
+	pathValue   string
+	errors      []*errors.ValidationError
+	schemaCache map[[32]byte]*schemaCache
 }