Merge pull request #200 from mjbonifacio/unify-context-and-centralize

Improved Error Reporting Consistency - SchemaValidationFailures are consistently returned, and error mapping information is consistently mapped

Author: daveshanley

errors/parameter_errors.go

@@ -122,7 +122,7 @@ func TestQueryParameterMissing(t *testing.T) {
 	param := createMockParameterWithSchema()
 
 	// Call the function
-	err := QueryParameterMissing(param)
+	err := QueryParameterMissing(param, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -138,7 +138,7 @@ func TestHeaderParameterMissing(t *testing.T) {
 	param := createMockParameterWithSchema()
 
 	// Call the function
-	err := HeaderParameterMissing(param)
+	err := HeaderParameterMissing(param, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -154,7 +154,7 @@ func TestCookieParameterMissing(t *testing.T) {
 	param := createMockParameterWithSchema()
 
 	// Call the function
-	err := CookieParameterMissing(param)
+	err := CookieParameterMissing(param, "/test", "get", "")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -171,7 +171,7 @@ func TestHeaderParameterCannotBeDecoded(t *testing.T) {
 	val := "malformed_header_value"
 
 	// Call the function
-	err := HeaderParameterCannotBeDecoded(param, val)
+	err := HeaderParameterCannotBeDecoded(param, val, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -209,7 +209,7 @@ func TestIncorrectHeaderParamEnum(t *testing.T) {
 	schema := base.NewSchema(s)
 
 	// Call the function with an invalid enum value
-	err := IncorrectHeaderParamEnum(param, "invalidEnum", schema)
+	err := IncorrectHeaderParamEnum(param, "invalidEnum", schema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -246,7 +246,7 @@ func TestIncorrectQueryParamArrayBoolean(t *testing.T) {
 	schema := base.NewSchema(s)
 
 	// Call the function with an invalid boolean value in the array
-	err := IncorrectQueryParamArrayBoolean(param, "notBoolean", schema, schema.Items.A.Schema())
+	err := IncorrectQueryParamArrayBoolean(param, "notBoolean", schema, schema.Items.A.Schema(), "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -339,7 +339,7 @@ func TestIncorrectCookieParamArrayBoolean(t *testing.T) {
 	itemsSchema := base.NewSchema(baseSchema.Items.Value.A.Schema())
 
 	// Call the function with an invalid boolean value in the array
-	err := IncorrectCookieParamArrayBoolean(param, "notBoolean", s, itemsSchema)
+	err := IncorrectCookieParamArrayBoolean(param, "notBoolean", s, itemsSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -401,7 +401,7 @@ func TestIncorrectQueryParamArrayInteger(t *testing.T) {
 	itemsSchema := base.NewSchema(baseSchema.Items.Value.A.Schema())
 
 	// Call the function with an invalid number value in the array
-	err := IncorrectQueryParamArrayInteger(param, "notNumber", s, itemsSchema)
+	err := IncorrectQueryParamArrayInteger(param, "notNumber", s, itemsSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -421,7 +421,7 @@ func TestIncorrectQueryParamArrayNumber(t *testing.T) {
 	itemsSchema := base.NewSchema(baseSchema.Items.Value.A.Schema())
 
 	// Call the function with an invalid number value in the array
-	err := IncorrectQueryParamArrayNumber(param, "notNumber", s, itemsSchema)
+	err := IncorrectQueryParamArrayNumber(param, "notNumber", s, itemsSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -483,7 +483,7 @@ func TestIncorrectCookieParamArrayNumber(t *testing.T) {
 	itemsSchema := base.NewSchema(baseSchema.Items.Value.A.Schema())
 
 	// Call the function with an invalid number value in the cookie array
-	err := IncorrectCookieParamArrayNumber(param, "notNumber", s, itemsSchema)
+	err := IncorrectCookieParamArrayNumber(param, "notNumber", s, itemsSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -560,7 +560,7 @@ func TestIncorrectParamEncodingJSON(t *testing.T) {
 	baseSchema := createMockLowBaseSchema()
 
 	// Call the function with an invalid JSON value
-	err := IncorrectParamEncodingJSON(param, "invalidJSON", base.NewSchema(baseSchema))
+	err := IncorrectParamEncodingJSON(param, "invalidJSON", base.NewSchema(baseSchema), "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -590,7 +590,7 @@ func TestIncorrectQueryParamBool(t *testing.T) {
 	})
 
 	// Call the function with an invalid boolean value
-	err := IncorrectQueryParamBool(param, "notBoolean", base.NewSchema(baseSchema))
+	err := IncorrectQueryParamBool(param, "notBoolean", base.NewSchema(baseSchema), "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -607,7 +607,7 @@ func TestInvalidQueryParamNumber(t *testing.T) {
 	baseSchema := createMockLowBaseSchema()
 
 	// Call the function with an invalid number value
-	err := InvalidQueryParamNumber(param, "notNumber", base.NewSchema(baseSchema))
+	err := InvalidQueryParamNumber(param, "notNumber", base.NewSchema(baseSchema), "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -624,7 +624,7 @@ func TestInvalidQueryParamInteger(t *testing.T) {
 	baseSchema := createMockLowBaseSchema()
 
 	// Call the function with an invalid number value
-	err := InvalidQueryParamInteger(param, "notNumber", base.NewSchema(baseSchema))
+	err := InvalidQueryParamInteger(param, "notNumber", base.NewSchema(baseSchema), "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -650,7 +650,7 @@ func TestIncorrectQueryParamEnum(t *testing.T) {
 	param.GoLow().Schema.Value.Schema().Enum.KeyNode = &yaml.Node{}
 
 	// Call the function with an invalid enum value
-	err := IncorrectQueryParamEnum(param, "invalidEnum", highSchema)
+	err := IncorrectQueryParamEnum(param, "invalidEnum", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -680,7 +680,7 @@ func TestIncorrectQueryParamEnumArray(t *testing.T) {
 	}
 
 	// Call the function with an invalid enum value
-	err := IncorrectQueryParamEnumArray(param, "invalidEnum", highSchema)
+	err := IncorrectQueryParamEnumArray(param, "invalidEnum", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -704,7 +704,7 @@ func TestIncorrectReservedValues(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "borked::?^&*"
 
-	err := IncorrectReservedValues(param, "borked::?^&*", highSchema)
+	err := IncorrectReservedValues(param, "borked::?^&*", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -728,7 +728,7 @@ func TestInvalidHeaderParamInteger(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bunny"
 
-	err := InvalidHeaderParamInteger(param, "bunmy", highSchema)
+	err := InvalidHeaderParamInteger(param, "bunmy", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -752,7 +752,7 @@ func TestInvalidHeaderParamNumber(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bunny"
 
-	err := InvalidHeaderParamNumber(param, "bunmy", highSchema)
+	err := InvalidHeaderParamNumber(param, "bunmy", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -776,7 +776,7 @@ func TestInvalidCookieParamNumber(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "cookies"
 
-	err := InvalidCookieParamNumber(param, "milky", highSchema)
+	err := InvalidCookieParamNumber(param, "milky", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -800,7 +800,7 @@ func TestInvalidCookieParamInteger(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "cookies"
 
-	err := InvalidCookieParamInteger(param, "milky", highSchema)
+	err := InvalidCookieParamInteger(param, "milky", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -824,7 +824,7 @@ func TestIncorrectHeaderParamBool(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "cookies"
 
-	err := IncorrectHeaderParamBool(param, "milky", highSchema)
+	err := IncorrectHeaderParamBool(param, "milky", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -848,7 +848,7 @@ func TestIncorrectCookieParamBool(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "cookies"
 
-	err := IncorrectCookieParamBool(param, "milky", highSchema)
+	err := IncorrectCookieParamBool(param, "milky", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -879,7 +879,7 @@ items:
 	}
 	param.GoLow().Schema.Value.Schema().Enum.KeyNode = &yaml.Node{}
 
-	err := IncorrectCookieParamEnum(param, "milky", highSchema)
+	err := IncorrectCookieParamEnum(param, "milky", highSchema, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -906,7 +906,7 @@ func TestIncorrectHeaderParamArrayBoolean(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bubbles"
 
-	err := IncorrectHeaderParamArrayBoolean(param, "milky", highSchema, nil)
+	err := IncorrectHeaderParamArrayBoolean(param, "milky", highSchema, nil, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -933,7 +933,7 @@ func TestIncorrectHeaderParamArrayNumber(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bubbles"
 
-	err := IncorrectHeaderParamArrayNumber(param, "milky", highSchema, nil)
+	err := IncorrectHeaderParamArrayNumber(param, "milky", highSchema, nil, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -959,7 +959,7 @@ func TestIncorrectPathParamBool(t *testing.T) {
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := IncorrectPathParamBool(param, "milky", highSchema)
+	err := IncorrectPathParamBool(param, "milky", highSchema, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -991,7 +991,7 @@ items:
 	}
 	param.GoLow().Schema.Value.Schema().Enum.KeyNode = &yaml.Node{}
 
-	err := IncorrectPathParamEnum(param, "milky", highSchema)
+	err := IncorrectPathParamEnum(param, "milky", highSchema, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1017,7 +1017,7 @@ func TestIncorrectPathParamNumber(t *testing.T) {
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := IncorrectPathParamNumber(param, "milky", highSchema)
+	err := IncorrectPathParamNumber(param, "milky", highSchema, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1043,7 +1043,7 @@ func TestIncorrectPathParamInteger(t *testing.T) {
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := IncorrectPathParamInteger(param, "milky", highSchema)
+	err := IncorrectPathParamInteger(param, "milky", highSchema, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1070,7 +1070,7 @@ func TestIncorrectPathParamArrayNumber(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bubbles"
 
-	err := IncorrectPathParamArrayNumber(param, "milky", highSchema, nil)
+	err := IncorrectPathParamArrayNumber(param, "milky", highSchema, nil, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1097,7 +1097,7 @@ func TestIncorrectPathParamArrayInteger(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bubbles"
 
-	err := IncorrectPathParamArrayInteger(param, "milky", highSchema, nil)
+	err := IncorrectPathParamArrayInteger(param, "milky", highSchema, nil, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1124,7 +1124,7 @@ func TestIncorrectPathParamArrayBoolean(t *testing.T) {
 	param := createMockParameter()
 	param.Name = "bubbles"
 
-	err := IncorrectPathParamArrayBoolean(param, "milky", highSchema, nil)
+	err := IncorrectPathParamArrayBoolean(param, "milky", highSchema, nil, "/test-path", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1150,7 +1150,7 @@ func TestPathParameterMissing(t *testing.T) {
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := PathParameterMissing(param)
+	err := PathParameterMissing(param, "/test/{testQueryParam}", "/test/")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1177,7 +1177,7 @@ items:
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := IncorrectParamArrayMaxNumItems(param, param.Schema.Schema(), 10, 25)
+	err := IncorrectParamArrayMaxNumItems(param, param.Schema.Schema(), 10, 25, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1204,7 +1204,7 @@ items:
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := IncorrectParamArrayMinNumItems(param, param.Schema.Schema(), 10, 5)
+	err := IncorrectParamArrayMinNumItems(param, param.Schema.Schema(), 10, 5, "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)
@@ -1231,7 +1231,7 @@ items:
 	param.Schema = base.CreateSchemaProxy(highSchema)
 	param.GoLow().Schema.KeyNode = &yaml.Node{}
 
-	err := IncorrectParamArrayUniqueItems(param, param.Schema.Schema(), "fish, cake")
+	err := IncorrectParamArrayUniqueItems(param, param.Schema.Schema(), "fish, cake", "/test-path", "get", "{}")
 
 	// Validate the error
 	require.NotNil(t, err)

errors/parameter_errors_test.go

@@ -15,7 +15,6 @@ func InvalidURLEncodedParsing(reason, referenceObject string) *ValidationError {
 		Reason:            fmt.Sprintf("failed to parse form-urlencoded: %s", reason),
 		SchemaValidationErrors: []*SchemaValidationFailure{{
 			Reason:          reason,
-			Location:        "url encoded parsing",
 			ReferenceSchema: "",
 			ReferenceObject: referenceObject,
 		}},

errors/urlencoded_errors.go

@@ -38,7 +38,8 @@ func TestInvalidURLEncodedParsing(t *testing.T) {
 	err := InvalidURLEncodedParsing("no data sent", "invalid-formdata")
 
 	assert.NotNil(t, (*err))
-	assert.Equal(t, (*err).SchemaValidationErrors[0].Location, "url encoded parsing")
+	assert.Equal(t, (*err).SchemaValidationErrors[0].Reason, "no data sent")
+	assert.Equal(t, (*err).SchemaValidationErrors[0].ReferenceObject, "invalid-formdata")
 	assert.Equal(t, helpers.Schema, (*err).ValidationSubType)
 }