-
Notifications
You must be signed in to change notification settings - Fork 244
Add protocol tests for Aws Json 1.0 #496
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 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
126 changes: 126 additions & 0 deletions
126
smithy-aws-protocol-tests/model/awsJson1_0/empty-input-output.smithy
This file contains hidden or 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,126 @@ | ||
| // This file defines test cases that test the basics of empty input and | ||
| // output shape serialization. | ||
|
|
||
| $version: "1.0" | ||
|
|
||
| namespace aws.protocoltests.json10 | ||
|
|
||
| use aws.protocols#awsJson1_0 | ||
| use smithy.test#httpRequestTests | ||
| use smithy.test#httpResponseTests | ||
|
|
||
| /// The example tests how requests and responses are serialized when there's | ||
| /// no request or response payload because the operation has no input or output. | ||
| /// While this should be rare, code generators must support this. | ||
| operation NoInputAndNoOutput {} | ||
|
|
||
| apply NoInputAndNoOutput @httpRequestTests([ | ||
| { | ||
| id: "AwsJson10NoInputAndNoOutput", | ||
| documentation: "No input serializes no payload", | ||
| protocol: awsJson1_0, | ||
| method: "POST", | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0", | ||
| "X-Amz-Target": "JsonRpc10.NoInputAndNoOutput", | ||
| }, | ||
| uri: "/", | ||
| } | ||
| ]) | ||
|
|
||
| apply NoInputAndNoOutput @httpResponseTests([ | ||
| { | ||
| id: "AwsJson10NoInputAndNoOutput", | ||
| documentation: "No output serializes no payload", | ||
| protocol: awsJson1_0, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0", | ||
| }, | ||
| code: 200, | ||
| } | ||
| ]) | ||
|
|
||
| /// The example tests how requests and responses are serialized when there's | ||
| /// no request or response payload because the operation has no input and the | ||
| /// output is empty. While this should be rare, code generators must support | ||
| /// this. | ||
| operation NoInputAndOutput { | ||
| output: NoInputAndOutputOutput | ||
| } | ||
|
|
||
| apply NoInputAndOutput @httpRequestTests([ | ||
| { | ||
| id: "AwsJson10NoInputAndOutput", | ||
| documentation: "No input serializes no payload", | ||
| protocol: awsJson1_0, | ||
| method: "POST", | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0", | ||
| "X-Amz-Target": "JsonRpc10.NoInputAndOutput", | ||
| }, | ||
| uri: "/" | ||
| } | ||
| ]) | ||
|
|
||
| apply NoInputAndOutput @httpResponseTests([ | ||
| { | ||
| id: "AwsJson10NoInputAndOutput", | ||
| documentation: "Empty output serializes no payload", | ||
| protocol: awsJson1_0, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| code: 200 | ||
| } | ||
| ]) | ||
|
|
||
| structure NoInputAndOutputOutput {} | ||
|
|
||
| /// The example tests how requests and responses are serialized when there's | ||
| /// no request or response payload because the operation has an empty input | ||
| /// and empty output structure that reuses the same shape. While this should | ||
| /// be rare, code generators must support this. | ||
| operation EmptyInputAndEmptyOutput { | ||
| input: EmptyInputAndEmptyOutputInput, | ||
| output: EmptyInputAndEmptyOutputInput | ||
| } | ||
|
|
||
| apply EmptyInputAndEmptyOutput @httpRequestTests([ | ||
| { | ||
| id: "AwsJson10EmptyInputAndEmptyOutput", | ||
| documentation: "Empty input serializes no payload", | ||
| protocol: awsJson1_0, | ||
| method: "POST", | ||
| uri: "/", | ||
| body: "", | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0", | ||
| "X-Amz-Target": "JsonRpc10.EmptyInputAndEmptyOutput", | ||
| }, | ||
| bodyMediaType: "application/json" | ||
| }, | ||
| ]) | ||
|
|
||
| apply EmptyInputAndEmptyOutput @httpResponseTests([ | ||
| { | ||
| id: "AwsJson10EmptyInputAndEmptyOutput", | ||
| documentation: "Empty output serializes no payload", | ||
| protocol: awsJson1_0, | ||
| code: 200, | ||
| body: "", | ||
| headers: {"Content-Type": "application/x-amz-json-1.0"}, | ||
| bodyMediaType: "application/json" | ||
| }, | ||
| { | ||
| id: "AwsJson10EmptyInputAndEmptyJsonObjectOutput", | ||
| documentation: "Empty output serializes no payload", | ||
| protocol: awsJson1_0, | ||
| code: 200, | ||
| body: "{}", | ||
| headers: {"Content-Type": "application/x-amz-json-1.0"}, | ||
| bodyMediaType: "application/json" | ||
| }, | ||
| ]) | ||
|
|
||
| structure EmptyInputAndEmptyOutputInput {} | ||
| structure EmptyInputAndEmptyOutputOutput {} |
249 changes: 249 additions & 0 deletions
249
smithy-aws-protocol-tests/model/awsJson1_0/errors.smithy
This file contains hidden or 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,249 @@ | ||
| // This file defines test cases that test error serialization. | ||
|
|
||
| $version: "1.0" | ||
|
|
||
| namespace aws.protocoltests.json10 | ||
|
|
||
| use aws.protocols#awsJson1_0 | ||
| use smithy.test#httpRequestTests | ||
| use smithy.test#httpResponseTests | ||
|
|
||
| /// This operation has three possible return values: | ||
| /// | ||
| /// 1. A successful response in the form of GreetingWithErrorsOutput | ||
| /// 2. An InvalidGreeting error. | ||
| /// 3. A ComplexError error. | ||
| /// | ||
| /// Implementations must be able to successfully take a response and | ||
| /// properly deserialize successful and error responses. | ||
| @idempotent | ||
| operation GreetingWithErrors { | ||
| output: GreetingWithErrorsOutput, | ||
| errors: [InvalidGreeting, ComplexError, FooError] | ||
| } | ||
|
|
||
| structure GreetingWithErrorsOutput { | ||
| greeting: String, | ||
| } | ||
|
|
||
| /// This error is thrown when an invalid greeting value is provided. | ||
| @error("client") | ||
| structure InvalidGreeting { | ||
| Message: String, | ||
| } | ||
|
|
||
| apply InvalidGreeting @httpResponseTests([ | ||
| { | ||
| id: "AwsJson10InvalidGreetingError", | ||
| documentation: "Parses simple JSON errors", | ||
| protocol: awsJson1_0, | ||
| params: { | ||
| Message: "Hi" | ||
| }, | ||
| code: 400, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "__type": "aws.protocoltests.json10#InvalidGreeting", | ||
| "Message": "Hi" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| ]) | ||
|
|
||
| /// This error is thrown when a request is invalid. | ||
| @error("client") | ||
| structure ComplexError { | ||
| TopLevel: String, | ||
| Nested: ComplexNestedErrorData, | ||
| } | ||
|
|
||
| structure ComplexNestedErrorData { | ||
| @jsonName("Fooooo") | ||
| Foo: String, | ||
| } | ||
|
|
||
| apply ComplexError @httpResponseTests([ | ||
| { | ||
| id: "AwsJson10ComplexError", | ||
| documentation: "Parses a complex error with no message member", | ||
| protocol: awsJson1_0, | ||
| params: { | ||
| TopLevel: "Top level", | ||
| Nested: { | ||
| Foo: "bar" | ||
| } | ||
| }, | ||
| code: 400, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "__type": "aws.protocoltests.json10#ComplexError", | ||
| "TopLevel": "Top level", | ||
| "Nested": { | ||
| "Fooooo": "bar" | ||
| } | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| { | ||
| id: "AwsJson10EmptyComplexError", | ||
| documentation: "Parses a complex error with an empty body", | ||
| protocol: awsJson1_0, | ||
| code: 400, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "__type": "aws.protocoltests.json10#ComplexError" | ||
| }""", | ||
| bodyMediaType: "application/json" | ||
| }, | ||
| ]) | ||
|
|
||
| /// This error has test cases that test some of the dark corners of Amazon service | ||
| /// framework history. It should only be implemented by clients. | ||
| @error("server") | ||
| @tags(["client-only"]) | ||
| structure FooError {} | ||
|
|
||
| apply FooError @httpResponseTests([ | ||
| { | ||
| id: "AwsJson10FooErrorUsingXAmznErrorType", | ||
| documentation: "Serializes the X-Amzn-ErrorType header. For an example service, see Amazon EKS.", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "X-Amzn-Errortype": "FooError", | ||
| }, | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorUsingXAmznErrorTypeWithUri", | ||
| documentation: """ | ||
| Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on ':' and take \ | ||
| only the first half of the string. For example, 'ValidationException:http://internal.amazon.com/coral/com.amazon.coral.validate/' | ||
| is to be interpreted as 'ValidationException'. | ||
|
|
||
| For an example service see Amazon Polly.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "X-Amzn-Errortype": "FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/", | ||
| }, | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorUsingXAmznErrorTypeWithUriAndNamespace", | ||
| documentation: """ | ||
| X-Amzn-Errortype might contain a URL and a namespace. Client should extract only the shape \ | ||
| name. This is a pathalogical case that might not actually happen in any deployed AWS service.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "X-Amzn-Errortype": "aws.protocoltests.json10#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/", | ||
| }, | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorUsingCode", | ||
| documentation: """ | ||
| This example uses the 'code' property in the output rather than X-Amzn-Errortype. Some \ | ||
| services do this though it's preferable to send the X-Amzn-Errortype. Client implementations \ | ||
| must first check for the X-Amzn-Errortype and then check for a top-level 'code' property. | ||
|
|
||
| For example service see Amazon S3 Glacier.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "code": "FooError" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorUsingCodeAndNamespace", | ||
| documentation: """ | ||
| Some services serialize errors using code, and it might contain a namespace. \ | ||
| Clients should just take the last part of the string after '#'.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "code": "aws.protocoltests.json10#FooError" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorUsingCodeUriAndNamespace", | ||
| documentation: """ | ||
| Some services serialize errors using code, and it might contain a namespace. It also might \ | ||
| contain a URI. Clients should just take the last part of the string after '#' and before ":". \ | ||
| This is a pathalogical case that might not occur in any deployed AWS service.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "code": "aws.protocoltests.json10#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorWithDunderType", | ||
| documentation: "Some services serialize errors using __type.", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "__type": "FooError" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorWithDunderTypeAndNamespace", | ||
| documentation: """ | ||
| Some services serialize errors using __type, and it might contain a namespace. \ | ||
| Clients should just take the last part of the string after '#'.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "__type": "aws.protocoltests.json10#FooError" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| }, | ||
| { | ||
| id: "AwsJson10FooErrorWithDunderTypeUriAndNamespace", | ||
| documentation: """ | ||
| Some services serialize errors using __type, and it might contain a namespace. It also might \ | ||
| contain a URI. Clients should just take the last part of the string after '#' and before ":". \ | ||
| This is a pathalogical case that might not occur in any deployed AWS service.""", | ||
| protocol: awsJson1_0, | ||
| code: 500, | ||
| headers: { | ||
| "Content-Type": "application/x-amz-json-1.0" | ||
| }, | ||
| body: """ | ||
| { | ||
| "__type": "aws.protocoltests.json10#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/" | ||
| }""", | ||
| bodyMediaType: "application/json", | ||
| } | ||
| ]) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.