Skip to content
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.

Sign up for GitHub

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

Add tags and appliesTo to protocol tests #696

Merged
merged 1 commit into from
Jan 28, 2021
Merged

Add tags and appliesTo to protocol tests #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/source/1.0/spec/http-protocol-compliance-tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,21 @@ that support the following members:
- ``string``
- A description of the test and what is being asserted defined in
CommonMark_.
* - tags
- ``[string]``
- Attaches a list of tags that allow test cases to be categorized and
grouped.
* - appliesTo
- ``string``, one of "client" or "server"
- Indicates that the test case is only to be implemented by "client" or
"server" implementations. This property is useful for identifying and
testing edge cases of clients and servers that are impossible or
undesirable to test in *both* client and server implementations. For
example, a "server" test might be useful to ensure a service can
gracefully receive a request that optionally contains a payload.

Is is assumed that test cases that do not define an ``appliesTo``
member are implemented by both client and server implementations.


HTTP request example
Expand Down Expand Up @@ -410,6 +425,21 @@ structures that support the following members:
- ``string``
- A description of the test and what is being asserted defined in
CommonMark_.
* - tags
- ``[string]``
- Attaches a list of tags that allow test cases to be categorized and
grouped.
* - appliesTo
- ``string``, one of "client" or "server"
- Indicates that the test case is only to be implemented by "client" or
"server" implementations. This property is useful for identifying and
testing edge cases of clients and servers that are impossible or
undesirable to test in *both* client and server implementations. For
example, a "client" test might be useful to ensure a client can
gracefully receive a response that optionally contains a payload.

Is is assumed that test cases that do not define an ``appliesTo``
member are implemented by both client and server implementations.


HTTP response example
Expand Down
9 changes: 9 additions & 0 deletions smithy-aws-protocol-tests/model/awsJson1_0/errors.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "FooError",
},
appliesTo: "client",
},
{
id: "AwsJson10FooErrorUsingXAmznErrorTypeWithUri",
Expand All @@ -135,6 +136,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/",
},
appliesTo: "client",
},
{
id: "AwsJson10FooErrorUsingXAmznErrorTypeWithUriAndNamespace",
Expand All @@ -146,6 +148,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "aws.protocoltests.json10#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/",
},
appliesTo: "client",
},
{
id: "AwsJson10FooErrorUsingCode",
Expand All @@ -165,6 +168,7 @@ apply FooError @httpResponseTests([
"code": "FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson10FooErrorUsingCodeAndNamespace",
Expand All @@ -181,6 +185,7 @@ apply FooError @httpResponseTests([
"code": "aws.protocoltests.json10#FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson10FooErrorUsingCodeUriAndNamespace",
Expand All @@ -198,6 +203,7 @@ apply FooError @httpResponseTests([
"code": "aws.protocoltests.json10#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson10FooErrorWithDunderType",
Expand All @@ -212,6 +218,7 @@ apply FooError @httpResponseTests([
"__type": "FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson10FooErrorWithDunderTypeAndNamespace",
Expand All @@ -228,6 +235,7 @@ apply FooError @httpResponseTests([
"__type": "aws.protocoltests.json10#FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson10FooErrorWithDunderTypeUriAndNamespace",
Expand All @@ -245,5 +253,6 @@ apply FooError @httpResponseTests([
"__type": "aws.protocoltests.json10#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
}
])
9 changes: 9 additions & 0 deletions smithy-aws-protocol-tests/model/awsJson1_1/errors.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "FooError",
},
appliesTo: "client",
},
{
id: "AwsJson11FooErrorUsingXAmznErrorTypeWithUri",
Expand All @@ -134,6 +135,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/",
},
appliesTo: "client",
},
{
id: "AwsJson11FooErrorUsingXAmznErrorTypeWithUriAndNamespace",
Expand All @@ -145,6 +147,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "aws.protocoltests.restjson#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/",
},
appliesTo: "client",
},
{
id: "AwsJson11FooErrorUsingCode",
Expand All @@ -164,6 +167,7 @@ apply FooError @httpResponseTests([
"code": "FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson11FooErrorUsingCodeAndNamespace",
Expand All @@ -180,6 +184,7 @@ apply FooError @httpResponseTests([
"code": "aws.protocoltests.restjson#FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson11FooErrorUsingCodeUriAndNamespace",
Expand All @@ -197,6 +202,7 @@ apply FooError @httpResponseTests([
"code": "aws.protocoltests.restjson#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson11FooErrorWithDunderType",
Expand All @@ -211,6 +217,7 @@ apply FooError @httpResponseTests([
"__type": "FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson11FooErrorWithDunderTypeAndNamespace",
Expand All @@ -227,6 +234,7 @@ apply FooError @httpResponseTests([
"__type": "aws.protocoltests.restjson#FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "AwsJson11FooErrorWithDunderTypeUriAndNamespace",
Expand All @@ -244,5 +252,6 @@ apply FooError @httpResponseTests([
"__type": "aws.protocoltests.restjson#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
}
])
4 changes: 3 additions & 1 deletion smithy-aws-protocol-tests/model/awsQuery/input.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ apply QueryIdempotencyTokenAutoFill @httpRequestTests([
&Version=2020-01-08
&token=00000000-0000-4000-8000-000000000000""",
bodyMediaType: "application/x-www-form-urlencoded",
appliesTo: "client",
},
{
id: "QueryProtocolIdempotencyTokenAutoFillIsSet",
Expand All @@ -320,7 +321,8 @@ apply QueryIdempotencyTokenAutoFill @httpRequestTests([
bodyMediaType: "application/x-www-form-urlencoded",
params: {
token: "00000000-0000-4000-8000-000000000123"
}
},
appliesTo: "client",
}
])

Expand Down
3 changes: 2 additions & 1 deletion smithy-aws-protocol-tests/model/awsQuery/xml-lists.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,8 @@ apply XmlEmptyLists @httpResponseTests([
params: {
stringList: [],
stringSet: [],
}
},
appliesTo: "client",
}
])

Expand Down
6 changes: 4 additions & 2 deletions smithy-aws-protocol-tests/model/awsQuery/xml-maps.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ apply XmlEmptyMaps @httpResponseTests([
},
params: {
myMap: {}
}
},
appliesTo: "client",
},
{
id: "QueryXmlEmptySelfClosedMaps",
Expand All @@ -103,7 +104,8 @@ apply XmlEmptyMaps @httpResponseTests([
},
params: {
myMap: {}
}
},
appliesTo: "client",
}
])

Expand Down
6 changes: 4 additions & 2 deletions smithy-aws-protocol-tests/model/awsQuery/xml-structs.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ apply XmlEmptyBlobs @httpResponseTests([
},
params: {
data: ""
}
},
appliesTo: "client",
},
{
id: "QueryXmlEmptySelfClosedBlobs",
Expand All @@ -146,7 +147,8 @@ apply XmlEmptyBlobs @httpResponseTests([
},
params: {
data: ""
}
},
appliesTo: "client",
}
])

Expand Down
4 changes: 3 additions & 1 deletion smithy-aws-protocol-tests/model/ec2Query/input.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,7 @@ apply QueryIdempotencyTokenAutoFill @httpRequestTests([
&Version=2020-01-08
&Token=00000000-0000-4000-8000-000000000000""",
bodyMediaType: "application/x-www-form-urlencoded",
appliesTo: "client",
},
{
id: "Ec2ProtocolIdempotencyTokenAutoFillIsSet",
Expand All @@ -394,7 +395,8 @@ apply QueryIdempotencyTokenAutoFill @httpRequestTests([
bodyMediaType: "application/x-www-form-urlencoded",
params: {
token: "00000000-0000-4000-8000-000000000123"
}
},
appliesTo: "client",
}
])

Expand Down
3 changes: 2 additions & 1 deletion smithy-aws-protocol-tests/model/ec2Query/xml-lists.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ apply XmlEmptyLists @httpResponseTests([
params: {
stringList: [],
stringSet: [],
}
},
appliesTo: "client",
}
])

Expand Down
6 changes: 4 additions & 2 deletions smithy-aws-protocol-tests/model/ec2Query/xml-structs.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,8 @@ apply XmlEmptyBlobs @httpResponseTests([
},
params: {
data: ""
}
},
appliesTo: "client",
},
{
id: "Ec2XmlEmptySelfClosedBlobs",
Expand All @@ -146,7 +147,8 @@ apply XmlEmptyBlobs @httpResponseTests([
},
params: {
data: ""
}
},
appliesTo: "client",
}
])

Expand Down
9 changes: 9 additions & 0 deletions smithy-aws-protocol-tests/model/restJson1/errors.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "FooError",
},
appliesTo: "client",
},
{
id: "RestJsonFooErrorUsingXAmznErrorTypeWithUri",
Expand All @@ -169,6 +170,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/",
},
appliesTo: "client",
},
{
id: "RestJsonFooErrorUsingXAmznErrorTypeWithUriAndNamespace",
Expand All @@ -180,6 +182,7 @@ apply FooError @httpResponseTests([
headers: {
"X-Amzn-Errortype": "aws.protocoltests.restjson#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/",
},
appliesTo: "client",
},
{
id: "RestJsonFooErrorUsingCode",
Expand All @@ -199,6 +202,7 @@ apply FooError @httpResponseTests([
"code": "FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "RestJsonFooErrorUsingCodeAndNamespace",
Expand All @@ -215,6 +219,7 @@ apply FooError @httpResponseTests([
"code": "aws.protocoltests.restjson#FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "RestJsonFooErrorUsingCodeUriAndNamespace",
Expand All @@ -232,6 +237,7 @@ apply FooError @httpResponseTests([
"code": "aws.protocoltests.restjson#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "RestJsonFooErrorWithDunderType",
Expand All @@ -246,6 +252,7 @@ apply FooError @httpResponseTests([
"__type": "FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "RestJsonFooErrorWithDunderTypeAndNamespace",
Expand All @@ -262,6 +269,7 @@ apply FooError @httpResponseTests([
"__type": "aws.protocoltests.restjson#FooError"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
},
{
id: "RestJsonFooErrorWithDunderTypeUriAndNamespace",
Expand All @@ -279,5 +287,6 @@ apply FooError @httpResponseTests([
"__type": "aws.protocoltests.restjson#FooError:http://internal.amazon.com/coral/com.amazon.coral.validate/"
}""",
bodyMediaType: "application/json",
appliesTo: "client",
}
])
6 changes: 4 additions & 2 deletions smithy-aws-protocol-tests/model/restJson1/http-headers.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,8 @@ apply NullAndEmptyHeadersClient @httpRequestTests([
a: null,
b: "",
c: [],
}
},
appliesTo: "client",
},
])

Expand All @@ -309,7 +310,8 @@ apply NullAndEmptyHeadersServer @httpResponseTests([
a: null,
b: "",
c: [],
}
},
appliesTo: "server",
},
])

Expand Down
Loading