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
|
"""The cache_keys module is mostly covered indirectly via other tests.
This just contains tests for some extra edge cases not covered elsewhere.
"""
import json
import pytest
from requests import Request, Response
from requests_cache.cache_keys import (
MAX_NORM_BODY_SIZE,
create_key,
normalize_request,
redact_response,
)
CACHE_KEY = 'e25f7e6326966e82'
@pytest.mark.parametrize(
'url, params',
[
('https://example.com?foo=bar¶m=1', None),
('https://example.com?foo=bar¶m=1', {}),
('https://example.com/?foo=bar¶m=1', {}),
('https://example.com?foo=bar¶m=1&', {}),
('https://example.com?param=1&foo=bar', {}),
('https://example.com?param=1', {'foo': 'bar'}),
('https://example.com?foo=bar', {'param': '1'}),
('https://example.com', {'foo': 'bar', 'param': '1'}),
('https://example.com', {'foo': 'bar', 'param': 1}),
('https://example.com?', {'foo': 'bar', 'param': '1'}),
],
)
def test_create_key__normalize_url_params(url, params):
"""All of the above variations should produce the same cache key"""
request = Request(
method='GET',
url=url,
params=params,
)
assert create_key(request) == CACHE_KEY
def test_create_key__normalize_key_only_params():
request_1 = Request(method='GET', url='https://img.site.com/base/img.jpg?param_1')
request_2 = Request(method='GET', url='https://img.site.com/base/img.jpg?param_2')
assert create_key(request_1) != create_key(request_2)
request_1 = Request(method='GET', url='https://img.site.com/base/img.jpg?k=v¶m_1')
request_2 = Request(method='GET', url='https://img.site.com/base/img.jpg?param_1&k=v')
assert create_key(request_1) == create_key(request_2)
def test_create_key__normalize_duplicate_params():
request_1 = Request(method='GET', url='https://img.site.com/base/img.jpg?param_1=a¶m_1=b')
request_2 = Request(method='GET', url='https://img.site.com/base/img.jpg?param_1=a')
request_3 = Request(method='GET', url='https://img.site.com/base/img.jpg?param_1=b')
assert create_key(request_1) != create_key(request_2) != create_key(request_3)
request_1 = Request(
method='GET', url='https://img.site.com/base/img.jpg?param_1=a¶m_1=b&k=v'
)
request_2 = Request(
method='GET', url='https://img.site.com/base/img.jpg?param_1=b¶m_1=a', params={'k': 'v'}
)
assert create_key(request_1) == create_key(request_2)
def test_redact_response__escaped_params():
"""Test that redact_response() handles escaped request parameters"""
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg?ignored_param=value_1¶m_2=value_2',
)
response = Response()
response.url = 'https://img.site.com/base/img.jpg?where=code%3D123'
response.request = request
redacted_response = redact_response(response, [])
assert redacted_response.url == 'https://img.site.com/base/img.jpg?where=code%3D123'
def test_normalize_request__json_body():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
data=b'{"param_1": "value_1", "param_2": "value_2"}',
headers={'Content-Type': 'application/json'},
)
norm_request = normalize_request(request, ignored_parameters=['param_2'])
assert norm_request.body == b'{"param_1": "value_1", "param_2": "REDACTED"}'
def test_normalize_request__json_body_list():
"""Support request body with a list as a JSON root"""
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
data=b'["param_3", "param_2", "param_1"]',
headers={'Content-Type': 'application/json'},
)
norm_request = normalize_request(request)
assert norm_request.body == b'["param_1", "param_2", "param_3"]'
def test_normalize_request__json_body_list_filtered():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
data=b'["param_3", "param_2", "param_1"]',
headers={'Content-Type': 'application/json'},
)
norm_request = normalize_request(request, ignored_parameters=['param_2', 'param_1'])
assert norm_request.body == b'["param_3"]'
def test_normalize_request__json_body_invalid():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
data=b'invalid JSON!',
headers={'Content-Type': 'application/json'},
)
assert normalize_request(request, ignored_parameters=['param_2']).body == b'invalid JSON!'
def test_normalize_request__json_body_empty():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
data=b'{}',
headers={'Content-Type': 'application/json'},
)
assert normalize_request(request, ignored_parameters=['param_2']).body == b'{}'
def test_normalize_request__binary_body():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
data=b'some bytes',
headers={'Content-Type': 'application/octet-stream'},
)
assert normalize_request(request, ignored_parameters=['param']).body == request.data
def test_normalize_request__ovsersized_body():
body = {'param': '1', 'content': '0' * MAX_NORM_BODY_SIZE}
encoded_body = json.dumps(body).encode('utf-8')
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
json=body,
headers={'Content-Type': 'application/octet-stream'},
)
assert normalize_request(request, ignored_parameters=['param']).body == encoded_body
def test_normalize_request__headers():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
headers={'Accept': 'gzip, deflate,Venmo, PayPal, '},
)
norm_request = normalize_request(request.prepare())
assert norm_request.headers == {'Accept': 'deflate, gzip, paypal, venmo'}
def test_remove_ignored_headers__empty():
request = Request(
method='GET',
url='https://img.site.com/base/img.jpg',
headers={'foo': 'bar'},
)
assert normalize_request(request.prepare(), ignored_parameters=None).headers == request.headers
|
