File: test_rest_headers.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (253 lines) | stat: -rw-r--r-- 10,772 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE.txt in the project root for
# license information.
# -------------------------------------------------------------------------
import sys
import pytest
from itertools import product

# NOTE: These tests are heavily inspired from the httpx test suite: https://github.com/encode/httpx/tree/master/tests
# Thank you httpx for your wonderful tests!
from azure.core.rest import HttpRequest

from rest_client import MockRestClient
from utils import SYNC_TRANSPORTS, HTTP_REQUESTS, create_http_request

# flask returns these response headers, which we don't really need for these following tests
RESPONSE_HEADERS_TO_IGNORE = [
    "Connection",
    "Content-Type",
    "Content-Length",
    "Server",
    "Date",
]


@pytest.fixture
def get_response_headers(port):
    def _get_response_headers(request, transport):
        client = MockRestClient(port, transport=transport)
        response = client.send_request(request)
        response.raise_for_status
        for header in RESPONSE_HEADERS_TO_IGNORE:
            response.headers.pop(header, None)
        return response.headers

    return _get_response_headers


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    assert "a" in h
    assert "A" in h
    assert "b" in h
    assert "B" in h
    assert "c" not in h
    assert h["a"] == "123, 456"
    assert h["A"] == "123, 456"
    assert h.get("a") == "123, 456"
    assert h.get("A") == "123, 456"
    assert h.get("nope") is None
    assert h.get("nope", default="default") is "default"
    assert h.get("nope", default=None) is None
    assert h.get("nope", default=[]) == []
    assert list(h) == ["a", "b"]

    assert set(h.keys()) == set(["a", "b"])
    assert list(h.values()) == ["123, 456", "789"]
    assert list(h.items()) == [("a", "123, 456"), ("b", "789")]
    assert list(h) == ["a", "b"]
    assert dict(h) == {"a": "123, 456", "b": "789"}


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response_keys(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    # basically want to make sure this behaves like dict {"a": "123, 456", "b": "789"}
    ref_dict = {"a": "123, 456", "b": "789"}
    assert set(h.keys()) == set(ref_dict.keys())
    assert repr(h.keys()) == repr(ref_dict.keys())
    assert "a" in h.keys()
    assert "b" in h.keys()
    assert set(h.keys()) == set(ref_dict.keys())


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response_keys_mutability(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    # test mutability
    before_mutation_keys = h.keys()
    h["c"] = "000"
    assert "c" in before_mutation_keys


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response_values(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    # basically want to make sure this behaves like dict {"a": "123, 456", "b": "789"}
    ref_dict = {"a": "123, 456", "b": "789"}
    assert set(h.values()) == set(ref_dict.values())
    assert repr(h.values()) == repr(ref_dict.values())
    assert "123, 456" in h.values()
    assert "789" in h.values()
    assert set(h.values()) == set(ref_dict.values())


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response_values_mutability(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    # test mutability
    before_mutation_values = h.values()
    h["c"] = "000"
    assert "000" in before_mutation_values


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response_items(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    # basically want to make sure this behaves like dict {"a": "123, 456", "b": "789"}
    ref_dict = {"a": "123, 456", "b": "789"}
    assert set(h.items()) == set(ref_dict.items())
    assert repr(h.items()) == repr(ref_dict.items())
    assert ("a", "123, 456") in h.items()
    assert not ("a", "123, 456", "123, 456") in h.items()
    assert not {"a": "blah", "123, 456": "blah"} in h.items()
    assert ("A", "123, 456") in h.items()
    assert ("b", "789") in h.items()
    assert ("B", "789") in h.items()
    assert set(h.items()) == set(ref_dict.items())


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_response_items_mutability(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    h = get_response_headers(request, transport())
    # test mutability
    before_mutation_items = h.items()
    h["c"] = "000"
    assert ("c", "000") in before_mutation_items


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_header_mutations(get_response_headers, transport, requesttype):
    def _headers_check(h):
        assert dict(h) == {}
        h["a"] = "1"
        assert dict(h) == {"a": "1"}
        h["a"] = "2"
        assert dict(h) == {"a": "2"}
        h.setdefault("a", "3")
        assert dict(h) == {"a": "2"}
        h.setdefault("b", "4")
        assert dict(h) == {"a": "2", "b": "4"}
        del h["a"]
        assert dict(h) == {"b": "4"}

    request = create_http_request(requesttype, "GET", "/headers/empty")
    _headers_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_copy_headers_method(get_response_headers, transport, requesttype):
    def _header_check(h):
        headers_copy = h.copy()
        assert h == headers_copy
        assert h is not headers_copy

    request = create_http_request(requesttype, "GET", "/headers/case-insensitive")
    _header_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_insert_retains_ordering(get_response_headers, transport, requesttype):
    def _header_check(h):
        h["b"] = "123"
        assert list(h.values()) == ["a", "123", "c"]

    request = create_http_request(requesttype, "GET", "/headers/ordered")
    _header_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_insert_appends_if_new(get_response_headers, transport, requesttype):
    def _headers_check(h):
        h["d"] = "123"
        assert list(h.values()) == ["lowercase", "ALLCAPS", "camelCase", "123"]

    request = create_http_request(requesttype, "GET", "/headers/case-insensitive")
    _headers_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_insert_removes_all_existing(get_response_headers, transport, requesttype):
    def _headers_check(h):
        h["a"] = "789"
        assert dict(h) == {"a": "789", "b": "789"}

    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    _headers_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_delete_removes_all_existing(get_response_headers, transport, requesttype):
    def _headers_check(h):
        del h["a"]
        assert dict(h) == {"b": "789"}

    request = create_http_request(requesttype, "GET", "/headers/duplicate/numbers")
    _headers_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_headers_case_insensitive(get_response_headers, transport, requesttype):
    def _headers_check(h):
        assert (
            h["lowercase-header"]
            == h["LOWERCASE-HEADER"]
            == h["Lowercase-Header"]
            == h["lOwErCasE-HeADer"]
            == "lowercase"
        )
        assert h["allcaps-header"] == h["ALLCAPS-HEADER"] == h["Allcaps-Header"] == h["AlLCapS-HeADer"] == "ALLCAPS"
        assert (
            h["camelcase-header"]
            == h["CAMELCASE-HEADER"]
            == h["CamelCase-Header"]
            == h["cAMeLCaSE-hEadER"]
            == "camelCase"
        )

    request = create_http_request(requesttype, "GET", "/headers/case-insensitive")
    _headers_check(get_response_headers(request, transport()))


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_multiple_headers_duplicate_case_insensitive(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/case-insensitive")
    h = get_response_headers(request, transport())
    assert h["Duplicate-Header"] == h["duplicate-header"] == h["DupLicAte-HeaDER"] == "one, two, three"


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_multiple_headers_commas(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/commas")
    h = get_response_headers(request, transport())
    assert h["Set-Cookie"] == "a,  b, c"


@pytest.mark.parametrize("transport,requesttype", product(SYNC_TRANSPORTS, HTTP_REQUESTS))
def test_update(get_response_headers, transport, requesttype):
    request = create_http_request(requesttype, "GET", "/headers/duplicate/commas")
    h = get_response_headers(request, transport())
    assert h["Set-Cookie"] == "a,  b, c"
    h.update({"Set-Cookie": "override", "new-key": "new-value"})
    assert h["Set-Cookie"] == "override"
    assert h["new-key"] == "new-value"