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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
import base64
import json
import sys
import unittest
from unittest import mock
import requests
from ...authentication.base import AuthenticationBase
from ...exceptions import Auth0Error, RateLimitError
class TestBase(unittest.TestCase):
def test_telemetry_enabled_by_default(self):
ab = AuthenticationBase("auth0.com", "cid")
base_headers = ab.client.base_headers
user_agent = base_headers["User-Agent"]
auth0_client_bytes = base64.b64decode(base_headers["Auth0-Client"])
auth0_client_json = auth0_client_bytes.decode("utf-8")
auth0_client = json.loads(auth0_client_json)
content_type = base_headers["Content-Type"]
from auth0 import __version__ as auth0_version
python_version = "{}.{}.{}".format(
sys.version_info.major, sys.version_info.minor, sys.version_info.micro
)
client_info = {
"name": "auth0-python",
"version": auth0_version,
"env": {"python": python_version},
}
self.assertEqual(user_agent, f"Python/{python_version}")
self.assertEqual(auth0_client, client_info)
self.assertEqual(content_type, "application/json")
def test_telemetry_disabled(self):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
self.assertEqual(ab.client.base_headers, {"Content-Type": "application/json"})
@mock.patch("requests.request")
def test_post(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False, timeout=(10, 2))
mock_request.return_value.status_code = 200
mock_request.return_value.text = '{"x": "y"}'
data = ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
mock_request.assert_called_with(
"POST",
"the-url",
json={"a": "b"},
headers={"c": "d", "Content-Type": "application/json"},
timeout=(10, 2),
)
self.assertEqual(data, {"x": "y"})
@mock.patch("requests.request")
def test_post_with_defaults(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
mock_request.return_value.status_code = 200
mock_request.return_value.text = '{"x": "y"}'
# Only required params are passed
data = ab.post("the-url")
mock_request.assert_called_with(
"POST",
"the-url",
headers={"Content-Type": "application/json"},
timeout=5.0,
)
self.assertEqual(data, {"x": "y"})
@mock.patch("requests.request")
def test_post_includes_telemetry(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid")
mock_request.return_value.status_code = 200
mock_request.return_value.text = '{"x": "y"}'
data = ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(mock_request.call_count, 1)
call_args, call_kwargs = mock_request.call_args
self.assertEqual(call_args[0], "POST")
self.assertEqual(call_args[1], "the-url")
self.assertEqual(call_kwargs["json"], {"a": "b"})
headers = call_kwargs["headers"]
self.assertEqual(headers["c"], "d")
self.assertEqual(headers["Content-Type"], "application/json")
self.assertIn("User-Agent", headers)
self.assertIn("Auth0-Client", headers)
self.assertEqual(data, {"x": "y"})
@mock.patch("requests.request")
def test_post_error(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
for error_status in [400, 500, None]:
mock_request.return_value.status_code = error_status
mock_request.return_value.text = (
'{"error": "e0","error_description": "desc"}'
)
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, error_status)
self.assertEqual(context.exception.error_code, "e0")
self.assertEqual(context.exception.message, "desc")
@mock.patch("requests.request")
def test_post_error_mfa_required(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
mock_request.return_value.status_code = 403
mock_request.return_value.text = '{"error": "mfa_required", "error_description": "Multifactor authentication required", "mfa_token": "Fe26...Ha"}'
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, 403)
self.assertEqual(context.exception.error_code, "mfa_required")
self.assertEqual(
context.exception.message, "Multifactor authentication required"
)
self.assertEqual(context.exception.content.get("mfa_token"), "Fe26...Ha")
@mock.patch("requests.request")
def test_post_rate_limit_error(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
mock_request.return_value.text = (
'{"statusCode": 429, "error": "e0", "error_description": "desc"}'
)
mock_request.return_value.status_code = 429
mock_request.return_value.headers = {
"x-ratelimit-limit": "3",
"x-ratelimit-remaining": "6",
"x-ratelimit-reset": "9",
}
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, 429)
self.assertEqual(context.exception.error_code, "e0")
self.assertEqual(context.exception.message, "desc")
self.assertIsInstance(context.exception, RateLimitError)
self.assertEqual(context.exception.reset_at, 9)
self.assertIsNotNone(context.exception.headers)
self.assertEqual(context.exception.headers["x-ratelimit-limit"], "3")
self.assertEqual(context.exception.headers["x-ratelimit-remaining"], "6")
self.assertEqual(context.exception.headers["x-ratelimit-reset"], "9")
@mock.patch("requests.request")
def test_post_rate_limit_error_without_headers(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
mock_request.return_value.text = (
'{"statusCode": 429, "error": "e0", "error_description": "desc"}'
)
mock_request.return_value.status_code = 429
mock_request.return_value.headers = {}
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, 429)
self.assertEqual(context.exception.error_code, "e0")
self.assertEqual(context.exception.message, "desc")
self.assertIsInstance(context.exception, RateLimitError)
self.assertEqual(context.exception.reset_at, -1)
self.assertIsNotNone(context.exception.headers)
self.assertEqual(context.exception.headers, {})
@mock.patch("requests.request")
def test_post_error_with_code_property(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
for error_status in [400, 500, None]:
mock_request.return_value.status_code = error_status
mock_request.return_value.text = (
'{"code": "e0","error_description": "desc"}'
)
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, error_status)
self.assertEqual(context.exception.error_code, "e0")
self.assertEqual(context.exception.message, "desc")
@mock.patch("requests.request")
def test_post_error_with_no_error_code(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
for error_status in [400, 500, None]:
mock_request.return_value.status_code = error_status
mock_request.return_value.text = '{"error_description": "desc"}'
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, error_status)
self.assertEqual(context.exception.error_code, "a0.sdk.internal.unknown")
self.assertEqual(context.exception.message, "desc")
@mock.patch("requests.request")
def test_post_error_with_text_response(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
for error_status in [400, 500, None]:
mock_request.return_value.status_code = error_status
mock_request.return_value.text = "there has been a terrible error"
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, error_status)
self.assertEqual(context.exception.error_code, "a0.sdk.internal.unknown")
self.assertEqual(
context.exception.message, "there has been a terrible error"
)
@mock.patch("requests.request")
def test_post_error_with_no_response_text(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
for error_status in [400, 500, None]:
mock_request.return_value.status_code = error_status
mock_request.return_value.text = None
with self.assertRaises(Auth0Error) as context:
ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
self.assertEqual(context.exception.status_code, error_status)
self.assertEqual(context.exception.error_code, "a0.sdk.internal.unknown")
self.assertEqual(context.exception.message, "")
@mock.patch("requests.request")
def test_get(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False, timeout=(10, 2))
mock_request.return_value.status_code = 200
mock_request.return_value.text = '{"x": "y"}'
data = ab.get("the-url", params={"a": "b"}, headers={"c": "d"})
mock_request.assert_called_with(
"GET",
"the-url",
params={"a": "b"},
headers={"c": "d", "Content-Type": "application/json"},
timeout=(10, 2),
)
self.assertEqual(data, {"x": "y"})
@mock.patch("requests.request")
def test_get_with_defaults(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid", telemetry=False)
mock_request.return_value.status_code = 200
mock_request.return_value.text = '{"x": "y"}'
# Only required params are passed
data = ab.get("the-url")
mock_request.assert_called_with(
"GET",
"the-url",
headers={"Content-Type": "application/json"},
timeout=5.0,
)
self.assertEqual(data, {"x": "y"})
@mock.patch("requests.request")
def test_get_includes_telemetry(self, mock_request):
ab = AuthenticationBase("auth0.com", "cid")
mock_request.return_value.status_code = 200
mock_request.return_value.text = '{"x": "y"}'
data = ab.get("the-url", params={"a": "b"}, headers={"c": "d"})
self.assertEqual(mock_request.call_count, 1)
call_args, call_kwargs = mock_request.call_args
self.assertEqual(call_args[0], "GET")
self.assertEqual(call_args[1], "the-url")
self.assertEqual(call_kwargs["params"], {"a": "b"})
headers = call_kwargs["headers"]
self.assertEqual(headers["c"], "d")
self.assertEqual(headers["Content-Type"], "application/json")
self.assertIn("User-Agent", headers)
self.assertIn("Auth0-Client", headers)
self.assertEqual(data, {"x": "y"})
# TODO: Replace the following with more reliable tests. Failing on GitHub Actions.
# def test_get_can_timeout(self):
# ab = AuthenticationBase("auth0.com", "cid", timeout=0.00002)
# with self.assertRaises(requests.exceptions.Timeout):
# ab.get("https://google.com", params={"a": "b"}, headers={"c": "d"})
# def test_post_can_timeout(self):
# ab = AuthenticationBase("auth0.com", "cid", timeout=0.00002)
# with self.assertRaises(requests.exceptions.Timeout):
# ab.post("https://google.com", data={"a": "b"}, headers={"c": "d"})
|
