File: headers_test.py

package info (click to toggle)
python-pook 2.1.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 672 kB
  • sloc: python: 3,558; makefile: 13
file content (242 lines) | stat: -rw-r--r-- 7,544 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
import re

import pytest

import pook


@pytest.mark.parametrize(
    ("expected", "requested"),
    (
        pytest.param(
            {"Content-Type": b"application/pdf"},
            {"Content-Type": b"application/pdf"},
            id="Matching binary headers",
        ),
        pytest.param(
            {
                "Content-Type": b"application/pdf",
                "Authentication": "Bearer 123abc",
            },
            {
                "Content-Type": b"application/pdf",
                "Authentication": "Bearer 123abc",
            },
            id="Matching mixed headers",
        ),
        pytest.param(
            {"Authentication": "Bearer 123abc"},
            {"Authentication": "Bearer 123abc"},
            id="Matching string headers",
        ),
        pytest.param(
            {"Content-Type": b"application/pdf"},
            {
                "Content-Type": b"application/pdf",
                "Authentication": "Bearer 123abc",
            },
            id="Non-matching asymetric mixed headers",
        ),
        pytest.param(
            {"Content-Type": b"application/pdf"},
            {"Content-Type": "application/pdf"},
            id="Non-matching header types (matcher binary, request string)",
        ),
        pytest.param(
            {"Content-Type": "application/pdf"},
            {"Content-Type": b"application/pdf"},
            id="Non-matching header types (matcher string, request binary)",
        ),
        pytest.param(
            {"content-type": "application/pdf"},
            {"Content-Type": "application/pdf"},
            id="Non-matching field name casing",
        ),
        pytest.param(
            {}, {"Content-Type": "application/pdf"}, id="Missing matcher header"
        ),
        pytest.param(
            {"Content-Type": "application/pdf".encode("utf-16")},
            {"Content-Type": "application/pdf".encode("utf-16")},
            id="Arbitrary field value encoding",
        ),
        pytest.param(
            {"Content-Type": "re/json/"},
            {"Content-Type": "application/json"},
            id="Regex-format str expectation",
        ),
        pytest.param(
            {"Content-Type": re.compile("json", re.I)},
            {"Content-Type": "APPLICATION/JSON"},
            id="Regex pattern expectation",
        ),
    ),
)
def test_headers_matcher_matching(expected, requested):
    mock = pook.get("https://example.com")
    if expected:
        mock.headers(expected)

    request = pook.Request()
    request.url = "https://example.com"
    if requested:
        request.headers = requested

    matched, explanation = mock.match(request)
    assert matched, explanation


@pytest.mark.parametrize(
    ("expected", "requested", "explanation"),
    (
        pytest.param(
            {"Content-Type": "application/pdf"},
            {},
            ["HeadersMatcher: Header 'Content-Type' not present"],
            id="Missing request header str expectation",
        ),
        pytest.param(
            {"Content-Type": b"application/pdf"},
            {},
            ["HeadersMatcher: Header 'Content-Type' not present"],
            id="Missing request header bytes expectation",
        ),
        pytest.param(
            {"Content-Type": "application/pdf"},
            {"Content-Type": "application/xml"},
            [
                (
                    "HeadersMatcher: 'application/pdf' != 'application/xml'\n"
                    "- application/pdf\n"
                    "?             ^^^\n"
                    "+ application/xml\n"
                    "?             ^^^\n"
                )
            ],
            id="Non-matching values, matching types",
        ),
        pytest.param(
            {"Content-Type": "application/pdf"},
            {"Content-Type": b"application/xml"},
            [
                (
                    "HeadersMatcher: 'application/pdf' != 'application/xml'\n"
                    "- application/pdf\n"
                    "?             ^^^\n"
                    "+ application/xml\n"
                    "?             ^^^\n"
                )
            ],
            id="Non-matching values, str expectation byte actual",
        ),
        pytest.param(
            {"Content-Type": b"application/pdf"},
            {"Content-Type": "application/xml"},
            [
                (
                    "HeadersMatcher: 'application/pdf' != 'application/xml'\n"
                    "- application/pdf\n"
                    "?             ^^^\n"
                    "+ application/xml\n"
                    "?             ^^^\n"
                )
            ],
            id="Non-matching values, bytes expectation str actual",
        ),
        pytest.param(
            {"Content-Type": "re/json/"},
            {"Content-Type": b"application/xml"},
            [
                (
                    "HeadersMatcher: Regex didn't match: 'json' not found in "
                    "'application/xml'"
                )
            ],
            id="Non-matching values, re-format str expectation",
        ),
    ),
)
def test_headers_not_matching(expected, requested, explanation):
    mock = pook.get("https://example.com")
    if expected:
        mock.headers(expected)

    request = pook.Request()
    request.url = "https://example.com"
    if requested:
        request.headers = requested

    matched, actual_explanation = mock.match(request)
    assert not matched
    assert explanation == actual_explanation


@pytest.mark.parametrize(
    ("required_headers", "requested_headers", "should_match"),
    (
        pytest.param(
            ["content-type", "Authorization"],
            {
                "Content-Type": "",
                "authorization": "Bearer NOT A TOKEN",
            },
            True,
            id="case-insensitive-match-with-empty-value",
        ),
        pytest.param(
            ["content-type", "Authorization"],
            {
                "Content-Type": "application/json",
                "authorization": "Bearer NOT A TOKEN",
            },
            True,
            id="case-insensitive-match-with-non-empty-values",
        ),
        pytest.param(
            ["x-requested-with"],
            {
                "content-type": "application/json",
            },
            False,
            id="x-header-missing-with-other-headers",
        ),
        pytest.param(
            ["x-requested-with"],
            {},
            False,
            id="x-header-no-headers",
        ),
        pytest.param(
            ["content-type"],
            {},
            False,
            id="no-headers",
        ),
        pytest.param(
            ["x-requested-with"],
            {"x-requested-with": "com.example.app"},
            True,
            id="x-header-with-value",
        ),
        pytest.param(
            ["x-requested-with"],
            {"x-requested-with": ""},
            True,
            id="x-header-with-empty-value",
        ),
    ),
)
def test_headers_present(required_headers, requested_headers, should_match):
    mock = pook.get("https://example.com").headers_present(required_headers)

    request = pook.Request()
    request.url = "https://example.com"
    request.headers = requested_headers

    matched, explanation = mock.match(request)
    assert matched == should_match, explanation


def test_headers_present_empty_argument():
    with pytest.raises(ValueError):
        pook.get("https://example.com").headers_present([])