feat: formatting some error messages

eloycoto · eloycoto · commit 2511d1f14f32 · 2022-11-28T16:54:46.000+01:00
This commits adds some clarity to the end users about what it is failing
on their end, adding values does not match, value X is not part of the
enum, etc.. So for end-users it's a bit easier to understand.

Signed-off-by: Eloy Coto &lt;eloy.coto@acalustra.com&gt;
diff --git a/openapi3/schema.go b/openapi3/schema.go
@@ -883,7 +883,7 @@ func (schema *Schema) visitSetOperations(settings *schemaValidationSettings, val
 			Value:                 value,
 			Schema:                schema,
 			SchemaField:           "enum",
-			Reason:                "value is not one of the allowed values",
+			Reason:                fmt.Sprintf("value %q is not one of the allowed values", value),
 			customizeMessageError: settings.customizeMessageError,
 		}
 	}
@@ -1085,7 +1085,7 @@ func (schema *Schema) visitJSONNumber(settings *schemaValidationSettings, value
 				Value:                 value,
 				Schema:                schema,
 				SchemaField:           "type",
-				Reason:                "Value must be an integer",
+				Reason:                fmt.Sprintf("Value \"%g\" must be an integer", value),
 				customizeMessageError: settings.customizeMessageError,
 			}
 			if !settings.multiError {
@@ -1305,7 +1305,7 @@ func (schema *Schema) visitJSONString(settings *schemaValidationSettings, value
 			Value:                 value,
 			Schema:                schema,
 			SchemaField:           "pattern",
-			Reason:                fmt.Sprintf(`string doesn't match the regular expression "%s"`, schema.Pattern),
+			Reason:                fmt.Sprintf(`string %q doesn't match the regular expression "%s"`, value, schema.Pattern),
 			customizeMessageError: settings.customizeMessageError,
 		}
 		if !settings.multiError {
@@ -1650,7 +1650,7 @@ func (schema *Schema) expectedType(settings *schemaValidationSettings, typ strin
 		Value:                 typ,
 		Schema:                schema,
 		SchemaField:           "type",
-		Reason:                "Field must be set to " + schema.Type + " or not be present",
+		Reason:                fmt.Sprintf("Field must be set to %s or not be present", schema.Type),
 		customizeMessageError: settings.customizeMessageError,
 	}
 }
diff --git a/openapi3filter/issue201_test.go b/openapi3filter/issue201_test.go
@@ -94,7 +94,7 @@ paths:
 		},
 
 		"invalid required header": {
-			err: `response header "X-Blup" doesn't match the schema: string doesn't match the regular expression "^blup$"`,
+			err: `response header "X-Blup" doesn't match the schema: string "bluuuuuup" doesn't match the regular expression "^blup$"`,
 			headers: map[string]string{
 				"X-Blip": "blip",
 				"x-blop": "blop",
diff --git a/openapi3filter/issue625_test.go b/openapi3filter/issue625_test.go
@@ -72,7 +72,7 @@ paths:
 			name:   "failed allof object array",
 			spec:   allOfArraySpec,
 			req:    `/items?test=1.2,3.1`,
-			errStr: `parameter "test" in query has an error: Error at "/0": Value must be an integer`,
+			errStr: `parameter "test" in query has an error: Error at "/0": Value "1.2" must be an integer`,
 		},
 		{
 			name: "success oneof object array",
diff --git a/openapi3filter/unpack_errors_test.go b/openapi3filter/unpack_errors_test.go
@@ -93,7 +93,7 @@ func Example() {
 	//
 	// ===== Start New Error =====
 	// @body.status:
-	// 	Error at "/status": value is not one of the allowed values
+	// 	Error at "/status": value "invalidStatus" is not one of the allowed values
 	// Schema:
 	//   {
 	//     "description": "pet status in the store",
diff --git a/openapi3filter/validation_error_test.go b/openapi3filter/validation_error_test.go
@@ -244,11 +244,11 @@ func getValidationTests(t *testing.T) []*validationTest {
 			},
 			wantErrParam:        "status",
 			wantErrParamIn:      "query",
-			wantErrSchemaReason: "value is not one of the allowed values",
+			wantErrSchemaReason: "value \"available,sold\" is not one of the allowed values",
 			wantErrSchemaPath:   "/0",
 			wantErrSchemaValue:  "available,sold",
 			wantErrResponse: &ValidationError{Status: http.StatusBadRequest,
-				Title: "value is not one of the allowed values",
+				Title: "value \"available,sold\" is not one of the allowed values",
 				Detail: "value available,sold at /0 must be one of: available, pending, sold; " +
 					// TODO: do we really want to use this heuristic to guess
 					//  that they're using the wrong serialization?
@@ -262,11 +262,11 @@ func getValidationTests(t *testing.T) []*validationTest {
 			},
 			wantErrParam:        "status",
 			wantErrParamIn:      "query",
-			wantErrSchemaReason: "value is not one of the allowed values",
+			wantErrSchemaReason: "value \"watdis\" is not one of the allowed values",
 			wantErrSchemaPath:   "/1",
 			wantErrSchemaValue:  "watdis",
 			wantErrResponse: &ValidationError{Status: http.StatusBadRequest,
-				Title:  "value is not one of the allowed values",
+				Title:  "value \"watdis\" is not one of the allowed values",
 				Detail: "value watdis at /1 must be one of: available, pending, sold",
 				Source: &ValidationErrorSource{Parameter: "status"}},
 		},
@@ -278,11 +278,11 @@ func getValidationTests(t *testing.T) []*validationTest {
 			},
 			wantErrParam:        "kind",
 			wantErrParamIn:      "query",
-			wantErrSchemaReason: "value is not one of the allowed values",
+			wantErrSchemaReason: "value \"fish,with,commas\" is not one of the allowed values",
 			wantErrSchemaPath:   "/1",
 			wantErrSchemaValue:  "fish,with,commas",
 			wantErrResponse: &ValidationError{Status: http.StatusBadRequest,
-				Title:  "value is not one of the allowed values",
+				Title:  "value \"fish,with,commas\" is not one of the allowed values",
 				Detail: "value fish,with,commas at /1 must be one of: dog, cat, turtle, bird,with,commas",
 				// No 'perhaps you intended' because its the right serialization format
 				Source: &ValidationErrorSource{Parameter: "kind"}},
@@ -304,11 +304,11 @@ func getValidationTests(t *testing.T) []*validationTest {
 			},
 			wantErrParam:        "x-environment",
 			wantErrParamIn:      "header",
-			wantErrSchemaReason: "value is not one of the allowed values",
+			wantErrSchemaReason: "value \"watdis\" is not one of the allowed values",
 			wantErrSchemaPath:   "/",
 			wantErrSchemaValue:  "watdis",
 			wantErrResponse: &ValidationError{Status: http.StatusBadRequest,
-				Title:  "value is not one of the allowed values",
+				Title:  "value \"watdis\" is not one of the allowed values",
 				Detail: "value watdis at / must be one of: demo, prod",
 				Source: &ValidationErrorSource{Parameter: "x-environment"}},
 		},
@@ -323,11 +323,11 @@ func getValidationTests(t *testing.T) []*validationTest {
 				r: newPetstoreRequest(t, http.MethodPost, "/pet", bytes.NewBufferString(`{"status":"watdis"}`)),
 			},
 			wantErrReason:       "doesn't match the schema",
-			wantErrSchemaReason: "value is not one of the allowed values",
+			wantErrSchemaReason: "value \"watdis\" is not one of the allowed values",
 			wantErrSchemaValue:  "watdis",
 			wantErrSchemaPath:   "/status",
 			wantErrResponse: &ValidationError{Status: http.StatusUnprocessableEntity,
-				Title:  "value is not one of the allowed values",
+				Title:  "value \"watdis\" is not one of the allowed values",
 				Detail: "value watdis at /status must be one of: available, pending, sold",
 				Source: &ValidationErrorSource{Pointer: "/status"}},
 		},

Original file line number	Diff line number	Diff line change
`@@ -883,7 +883,7 @@ func (schema Schema) visitSetOperations(settings schemaValidationSettings, val`
`883`	`883`	`Value: value,`
`884`	`884`	`Schema: schema,`
`885`	`885`	`SchemaField: "enum",`
`886`		`- Reason: "value is not one of the allowed values",`
	`886`	`+ Reason: fmt.Sprintf("value %q is not one of the allowed values", value),`
`887`	`887`	`customizeMessageError: settings.customizeMessageError,`
`888`	`888`	`}`
`889`	`889`	`}`
`@@ -1085,7 +1085,7 @@ func (schema Schema) visitJSONNumber(settings schemaValidationSettings, value`
`1085`	`1085`	`Value: value,`
`1086`	`1086`	`Schema: schema,`
`1087`	`1087`	`SchemaField: "type",`
`1088`		`- Reason: "Value must be an integer",`
	`1088`	`+ Reason: fmt.Sprintf("Value \"%g\" must be an integer", value),`
`1089`	`1089`	`customizeMessageError: settings.customizeMessageError,`
`1090`	`1090`	`}`
`1091`	`1091`	`if !settings.multiError {`
`@@ -1305,7 +1305,7 @@ func (schema Schema) visitJSONString(settings schemaValidationSettings, value`
`1305`	`1305`	`Value: value,`
`1306`	`1306`	`Schema: schema,`
`1307`	`1307`	`SchemaField: "pattern",`
`1308`		- Reason: fmt.Sprintf(`string doesn't match the regular expression "%s"`, schema.Pattern),
	`1308`	+ Reason: fmt.Sprintf(`string %q doesn't match the regular expression "%s"`, value, schema.Pattern),
`1309`	`1309`	`customizeMessageError: settings.customizeMessageError,`
`1310`	`1310`	`}`
`1311`	`1311`	`if !settings.multiError {`
`@@ -1650,7 +1650,7 @@ func (schema Schema) expectedType(settings schemaValidationSettings, typ strin`
`1650`	`1650`	`Value: typ,`
`1651`	`1651`	`Schema: schema,`
`1652`	`1652`	`SchemaField: "type",`
`1653`		`- Reason: "Field must be set to " + schema.Type + " or not be present",`
	`1653`	`+ Reason: fmt.Sprintf("Field must be set to %s or not be present", schema.Type),`
`1654`	`1654`	`customizeMessageError: settings.customizeMessageError,`
`1655`	`1655`	`}`
`1656`	`1656`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ paths:`
`72`	`72`	`name: "failed allof object array",`
`73`	`73`	`spec: allOfArraySpec,`
`74`	`74`	req: `/items?test=1.2,3.1`,
`75`		- errStr: `parameter "test" in query has an error: Error at "/0": Value must be an integer`,
	`75`	+ errStr: `parameter "test" in query has an error: Error at "/0": Value "1.2" must be an integer`,
`76`	`76`	`},`
`77`	`77`	`{`
`78`	`78`	`name: "success oneof object array",`