-
-
Notifications
You must be signed in to change notification settings - Fork 426
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feature: Add more discriminator error messages and return specific er… #394
Merged
fenollp
merged 4 commits into
getkin:master
from
rtfpessoa:improve-visitSetOperations-messages
Aug 16, 2021
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| package openapi3 | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| var oneofSpec = []byte(`components: | ||
| schemas: | ||
| Cat: | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| scratches: | ||
| type: boolean | ||
| $type: | ||
| type: string | ||
| enum: | ||
| - cat | ||
| required: | ||
| - name | ||
| - scratches | ||
| - $type | ||
| Dog: | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| barks: | ||
| type: boolean | ||
| $type: | ||
| type: string | ||
| enum: | ||
| - dog | ||
| required: | ||
| - name | ||
| - barks | ||
| - $type | ||
| Animal: | ||
| type: object | ||
| oneOf: | ||
| - $ref: "#/components/schemas/Cat" | ||
| - $ref: "#/components/schemas/Dog" | ||
| discriminator: | ||
| propertyName: $type | ||
| mapping: | ||
| cat: "#/components/schemas/Cat" | ||
| dog: "#/components/schemas/Dog" | ||
| `) | ||
|
|
||
| var oneofNoDiscriminatorSpec = []byte(`components: | ||
| schemas: | ||
| Cat: | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| scratches: | ||
| type: boolean | ||
| required: | ||
| - name | ||
| - scratches | ||
| Dog: | ||
| type: object | ||
| properties: | ||
| name: | ||
| type: string | ||
| barks: | ||
| type: boolean | ||
| required: | ||
| - name | ||
| - barks | ||
| Animal: | ||
| type: object | ||
| oneOf: | ||
| - $ref: "#/components/schemas/Cat" | ||
| - $ref: "#/components/schemas/Dog" | ||
| `) | ||
|
|
||
| func TestVisitJSON_OneOf_MissingDiscriptorProperty(t *testing.T) { | ||
| s, err := NewLoader().LoadFromData(oneofSpec) | ||
| require.NoError(t, err) | ||
| err = s.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{ | ||
| "name": "snoopy", | ||
| }) | ||
| require.EqualError(t, err, "input does not contain the discriminator property") | ||
| } | ||
|
|
||
| func TestVisitJSON_OneOf_MissingDiscriptorValue(t *testing.T) { | ||
| s, err := NewLoader().LoadFromData(oneofSpec) | ||
| require.NoError(t, err) | ||
| err = s.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{ | ||
| "name": "snoopy", | ||
| "$type": "snake", | ||
| }) | ||
| require.EqualError(t, err, "input does not contain a valid discriminator value") | ||
| } | ||
|
|
||
| func TestVisitJSON_OneOf_MissingField(t *testing.T) { | ||
| s, err := NewLoader().LoadFromData(oneofSpec) | ||
| require.NoError(t, err) | ||
| err = s.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{ | ||
| "name": "snoopy", | ||
| "$type": "dog", | ||
| }) | ||
| require.EqualError(t, err, "Error at \"/barks\": property \"barks\" is missing\nSchema:\n {\n \"properties\": {\n \"$type\": {\n \"enum\": [\n \"dog\"\n ],\n \"type\": \"string\"\n },\n \"barks\": {\n \"type\": \"boolean\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"barks\",\n \"$type\"\n ],\n \"type\": \"object\"\n }\n\nValue:\n {\n \"$type\": \"dog\",\n \"name\": \"snoopy\"\n }\n") | ||
| } | ||
|
|
||
| func TestVisitJSON_OneOf_NoDiscriptor_MissingField(t *testing.T) { | ||
| s, err := NewLoader().LoadFromData(oneofNoDiscriminatorSpec) | ||
| require.NoError(t, err) | ||
| err = s.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{ | ||
| "name": "snoopy", | ||
| }) | ||
| require.EqualError(t, err, "doesn't match schema due to: Error at \"/scratches\": property \"scratches\" is missing\nSchema:\n {\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"scratches\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"name\",\n \"scratches\"\n ],\n \"type\": \"object\"\n }\n\nValue:\n {\n \"name\": \"snoopy\"\n }\n Or Error at \"/barks\": property \"barks\" is missing\nSchema:\n {\n \"properties\": {\n \"barks\": {\n \"type\": \"boolean\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"barks\"\n ],\n \"type\": \"object\"\n }\n\nValue:\n {\n \"name\": \"snoopy\"\n }\n") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fenollp to bring the details back we would have to change this. But this will also add extra details to other errors. And would probably never use the Schema error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well the loss of context isn't that huge, also this should all be replaced by a dedicated lib anyway so let's get on with this.