File: test_query_compatibility.py

package info (click to toggle)
python-botocore 1.40.72%2Brepack-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 128,088 kB
  • sloc: python: 76,667; xml: 14,037; javascript: 181; makefile: 157
file content (138 lines) | stat: -rw-r--r-- 4,808 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.


from tests import ClientHTTPStubber, patch_load_service_model

TEST_QUERY_COMPAT_SERVICE_MODEL = {
    "version": "2.0",
    "documentation": "This is a test service.",
    "metadata": {
        "apiVersion": "2023-01-01",
        "endpointPrefix": "test",
        "protocol": "json",
        "protocols": ["json", "query"],
        "jsonVersion": "1.0",
        "serviceFullName": "Test Service",
        "serviceId": "Test Service",
        "signatureVersion": "v4",
        "signingName": "testservice",
        "targetPrefix": "testservice",
        "uid": "testservice-2025-01-01",
    },
    "operations": {
        "QueryCompatOperation": {
            "name": "QueryCompatOperation",
            "http": {"method": "POST", "requestUri": "/QueryCompatOperation"},
            "input": {"shape": "SomeInput"},
            "output": {"shape": "SomeOutput"},
            "errors": [{"shape": "QueryErrorType"}],
        }
    },
    "shapes": {
        "SomeInput": {
            "type": "structure",
        },
        "SomeOutput": {
            "type": "structure",
        },
        "QueryErrorType": {
            "type": "structure",
            "members": {
                "message": {
                    "shape": "ErrorMessage",
                }
            },
            "error": {
                "code": "QueryErrorCode",
                "httpStatusCode": 404,
                "senderFault": True,
            },
            "exception": True,
        },
        "ErrorMessage": {"type": "string"},
    },
}

TEST_QUERY_COMPAT_RULESET = {
    "version": "1.0",
    "parameters": {},
    "rules": [
        {
            "conditions": [],
            "type": "endpoint",
            "endpoint": {
                "url": "https://foo.bar",
                "properties": {},
                "headers": {},
            },
        }
    ],
}


def test_generic_query_compatibility(
    patched_session,
    monkeypatch,
):
    patch_load_service_model(
        patched_session,
        monkeypatch,
        TEST_QUERY_COMPAT_SERVICE_MODEL,
        TEST_QUERY_COMPAT_RULESET,
    )
    client = patched_session.create_client(
        "testservice", region_name="us-west-2"
    )
    with ClientHTTPStubber(client, strict=True) as http_stubber:
        http_stubber.add_response(
            status=400,
            body=b'{"__type":"com.amazonaws.testService#QueryErrorType","message":"Message for query compatible error"}',
            headers={'x-amzn-query-error': 'QueryErrorCode;Sender'},
        )
        try:
            client.query_compat_operation()
            assert False, "Expected a QueryError, but wasn't thrown"
        except client.exceptions.QueryErrorType as e:
            assert e.response['Error']['Code'] == 'QueryErrorCode'
            assert e.response['Error']['QueryErrorCode'] == 'QueryErrorType'
            assert e.response['Error']['Type'] == 'Sender'
            assert e.response['ResponseMetadata']['HTTPStatusCode'] == 400


# SQS was the first service to migrate protocols, and has some unique behavior.
# We need to check that we are maintaining backwards compatibility with the error code,
# type, and query error code
def test_sqs_query_compatibility(
    patched_session,
):
    client = patched_session.create_client('sqs', region_name='us-east-1')
    with ClientHTTPStubber(client, strict=True) as http_stubber:
        http_stubber.add_response(
            status=400,
            body=b'{"__type":"com.amazonaws.sqs#QueueDoesNotExist","message":"The specified queue does not exist."}',
            headers={
                'x-amzn-query-error': 'AWS.SimpleQueueService.NonExistentQueue;Sender'
            },
        )
        try:
            client.delete_queue(QueueUrl="not-a-real-queue")
            assert False, "Expected a QueueDoesNotExist, but wasn't thrown"
        except client.exceptions.QueueDoesNotExist as e:
            assert (
                e.response['Error']['Code']
                == 'AWS.SimpleQueueService.NonExistentQueue'
            )
            assert e.response['Error']['QueryErrorCode'] == 'QueueDoesNotExist'
            assert e.response['Error']['Type'] == 'Sender'
            assert e.response['ResponseMetadata']['HTTPStatusCode'] == 400