Adding new schema violation data, will be super useful downstream.

Signed-off-by: Dave Shanley <[email protected]>

Author: daveshanley

errors/validation_error.go

@@ -4,89 +4,95 @@
 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"`
 
-	// DeepLocation is the path to the validation failure as exposed by the jsonschema library.
-	DeepLocation string `json:"deepLocation,omitempty" yaml:"deepLocation,omitempty"`
+    // DeepLocation is the path to the validation failure as exposed by the jsonschema library.
+    DeepLocation string `json:"deepLocation,omitempty" yaml:"deepLocation,omitempty"`
 
-	// AbsoluteLocation is the absolute path to the validation failure as exposed by the jsonschema library.
-	AbsoluteLocation string `json:"absoluteLocation,omitempty" yaml:"absoluteLocation,omitempty"`
+    // AbsoluteLocation is the absolute path to the validation failure as exposed by the jsonschema library.
+    AbsoluteLocation string `json:"absoluteLocation,omitempty" yaml:"absoluteLocation,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:"-"`
+    // ReferenceSchema is the schema that was referenced in the validation failure.
+    ReferenceSchema string `json:"referenceSchema,omitempty" yaml:"referenceSchema,omitempty"`
+
+    // ReferenceObject is the object that was referenced in the validation failure.
+    ReferenceObject string `json:"referenceObject,omitempty" yaml:"referenceObject,omitempty"`
+
+    // 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"
+    return v.ValidationType == "path" && v.ValidationSubType == "missing"
 }

requests/validate_request.go

@@ -15,9 +15,14 @@ import (
 	"gopkg.in/yaml.v3"
 	"io"
 	"net/http"
+	"reflect"
+	"regexp"
+	"strconv"
 	"strings"
 )
 
+var instanceLocationRegex = regexp.MustCompile(`^/(\d+)`)
+
 // ValidateRequestSchema will validate an http.Request pointer against a schema.
 // If validation fails, it will return a list of validation errors as the second return value.
 func ValidateRequestSchema(
@@ -67,10 +72,29 @@ func ValidateRequestSchema(
 
 				// locate the violated property in the schema
 				located := schema_validation.LocateSchemaPropertyNodeByJSONPath(renderedNode.Content[0], er.KeywordLocation)
+
+				// extract the element specified by the instance
+				val := instanceLocationRegex.FindStringSubmatch(er.InstanceLocation)
+				var referenceObject string
+
+				if len(val) > 0 {
+					referenceIndex, _ := strconv.Atoi(val[1])
+					if reflect.ValueOf(decodedObj).Type().Kind() == reflect.Slice {
+						found := decodedObj.([]any)[referenceIndex]
+						recoded, _ := json.MarshalIndent(found, "", "  ")
+						referenceObject = string(recoded)
+					}
+				}
+				if referenceObject == "" {
+					referenceObject = string(requestBody)
+				}
+
 				violation := &errors.SchemaValidationFailure{
-					Reason:        er.Error,
-					Location:      er.KeywordLocation,
-					OriginalError: jk,
+					Reason:          er.Error,
+					Location:        er.KeywordLocation,
+					ReferenceSchema: string(renderedSchema),
+					ReferenceObject: referenceObject,
+					OriginalError:   jk,
 				}
 				// if we have a location within the schema, add it to the error
 				if located != nil {

responses/validate_response.go

@@ -15,9 +15,14 @@ import (
 	"gopkg.in/yaml.v3"
 	"io"
 	"net/http"
+	"reflect"
+	"regexp"
+	"strconv"
 	"strings"
 )
 
+var instanceLocationRegex = regexp.MustCompile(`^/(\d+)`)
+
 // ValidateResponseSchema will validate the response body for a http.Response pointer. The request is used to
 // locate the operation in the specification, the response is used to ensure the response code, media type and the
 // schema of the response body are valid.
@@ -74,10 +79,29 @@ func ValidateResponseSchema(
 
 				// locate the violated property in the schema
 				located := schema_validation.LocateSchemaPropertyNodeByJSONPath(renderedNode.Content[0], er.KeywordLocation)
+
+				// extract the element specified by the instance
+				val := instanceLocationRegex.FindStringSubmatch(er.InstanceLocation)
+				var referenceObject string
+
+				if len(val) > 0 {
+					referenceIndex, _ := strconv.Atoi(val[1])
+					if reflect.ValueOf(decodedObj).Type().Kind() == reflect.Slice {
+						found := decodedObj.([]any)[referenceIndex]
+						recoded, _ := json.MarshalIndent(found, "", "  ")
+						referenceObject = string(recoded)
+					}
+				}
+				if referenceObject == "" {
+					referenceObject = string(responseBody)
+				}
+
 				violation := &errors.SchemaValidationFailure{
-					Reason:        er.Error,
-					Location:      er.KeywordLocation,
-					OriginalError: jk,
+					Reason:          er.Error,
+					Location:        er.KeywordLocation,
+					ReferenceSchema: string(renderedSchema),
+					ReferenceObject: referenceObject,
+					OriginalError:   jk,
 				}
 				// if we have a location within the schema, add it to the error
 				if located != nil {

schema_validation/validate_schema.go

@@ -13,6 +13,9 @@ import (
 	_ "github.com/santhosh-tekuri/jsonschema/v5/httploader"
 	"go.uber.org/zap"
 	"gopkg.in/yaml.v3"
+	"reflect"
+	"regexp"
+	"strconv"
 	"strings"
 )
 
@@ -36,6 +39,8 @@ type SchemaValidator interface {
 	ValidateSchemaBytes(schema *base.Schema, payload []byte) (bool, []*errors.ValidationError)
 }
 
+var instanceLocationRegex = regexp.MustCompile(`^/(\d+)`)
+
 type schemaValidator struct {
 	logger *zap.SugaredLogger
 }
@@ -110,11 +115,30 @@ func validateSchema(schema *base.Schema, payload []byte, decodedObject interface
 
 					// locate the violated property in the schema
 					located := LocateSchemaPropertyNodeByJSONPath(renderedNode.Content[0], er.KeywordLocation)
+
+					// extract the element specified by the instance
+					val := instanceLocationRegex.FindStringSubmatch(er.InstanceLocation)
+					var referenceObject string
+
+					if len(val) > 0 {
+						referenceIndex, _ := strconv.Atoi(val[1])
+						if reflect.ValueOf(decodedObject).Type().Kind() == reflect.Slice {
+							found := decodedObject.([]any)[referenceIndex]
+							recoded, _ := json.MarshalIndent(found, "", "  ")
+							referenceObject = string(recoded)
+						}
+					}
+					if referenceObject == "" {
+						referenceObject = string(payload)
+					}
+
 					violation := &errors.SchemaValidationFailure{
 						Reason:           er.Error,
 						Location:         er.InstanceLocation,
 						DeepLocation:     er.KeywordLocation,
 						AbsoluteLocation: er.AbsoluteKeywordLocation,
+						ReferenceSchema:  string(renderedSchema),
+						ReferenceObject:  referenceObject,
 						OriginalError:    jk,
 					}
 					// if we have a location within the schema, add it to the error