-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathtest_exceptions.py
More file actions
182 lines (146 loc) · 7.47 KB
/
Copy pathtest_exceptions.py
File metadata and controls
182 lines (146 loc) · 7.47 KB
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
"""
Unit tests for the SDK exception hierarchy and transient-error classification.
`APIFailure.is_transient_error()` tells consumers whether retrying the same request may
succeed (gateway/connection-level failures: HTTP 408/502/503/504, dropped or reset
connections, client-side timeouts) or whether the failure is deterministic (400/401/403/
404/429 and similar). Classification is based on the `status_code` recorded at raise time
inside `API.do_request`, so these tests cover both the exception classes themselves and
the status codes `do_request` attaches when raising them.
Run with: python -m pytest tests/unit/ -v
"""
import unittest
from unittest.mock import MagicMock, patch
import requests
from socketdev.core.api import API
from socketdev.exceptions import (
APIAccessDenied,
APIBadGateway,
APIConnectionError,
APIFailure,
APIInsufficientPermissions,
APIInsufficientQuota,
APIOrganizationNotAllowed,
APIPartialResponse,
APIResourceNotFound,
APITimeout,
)
class TestIsTransientError(unittest.TestCase):
"""Classification of exceptions constructed directly."""
def test_transient_statuses_on_catch_all_failure(self):
for status in (408, 502, 503, 504):
self.assertTrue(APIFailure("boom", status_code=status).is_transient_error())
def test_deterministic_statuses_on_catch_all_failure(self):
for status in (400, 401, 403, 404, 422, 429, 500):
self.assertFalse(APIFailure("boom", status_code=status).is_transient_error())
def test_no_status_code_is_not_transient(self):
# The wrapped-unexpected-error case: do_request raises a bare APIFailure().
self.assertFalse(APIFailure().is_transient_error())
self.assertFalse(APIFailure("boom").is_transient_error())
def test_connection_level_classes_are_transient(self):
self.assertTrue(APITimeout().is_transient_error())
self.assertTrue(APIConnectionError().is_transient_error())
self.assertTrue(APIBadGateway().is_transient_error())
def test_partial_response_is_not_transient(self):
error = APIPartialResponse("incomplete", missing=["pkg:npm/missing@1.0.0"])
self.assertFalse(error.is_transient_error())
self.assertEqual(error.missing, ["pkg:npm/missing@1.0.0"])
def test_bad_gateway_carries_502_by_default(self):
self.assertEqual(APIBadGateway().status_code, 502)
def test_dedicated_4xx_classes_are_not_transient(self):
self.assertFalse(APIAccessDenied("denied", status_code=401).is_transient_error())
self.assertFalse(APIInsufficientPermissions(status_code=403).is_transient_error())
self.assertFalse(APIOrganizationNotAllowed(status_code=403).is_transient_error())
self.assertFalse(APIInsufficientQuota(status_code=429).is_transient_error())
self.assertFalse(APIResourceNotFound(status_code=404).is_transient_error())
def test_subclass_with_transient_status_follows_the_status(self):
# Classification is by recorded status, not class identity: if a transient status
# ever gains a dedicated subclass, is_transient_error() keeps working unchanged.
class APIServiceUnavailable(APIFailure):
pass
self.assertTrue(APIServiceUnavailable(status_code=503).is_transient_error())
def test_message_text_does_not_affect_classification(self):
self.assertFalse(
APIFailure("original_status_code:503 lookalike").is_transient_error()
)
def test_single_message_arg_is_preserved(self):
error = APIFailure("something broke", status_code=503)
self.assertEqual(str(error), "something broke")
def _mock_response(status_code, json_data=None, headers=None, text=""):
response = MagicMock()
response.status_code = status_code
response.headers = headers if headers is not None else {}
response.text = text
if json_data is None:
response.json.side_effect = ValueError("no json")
else:
response.json.return_value = json_data
return response
class TestDoRequestStatusCodes(unittest.TestCase):
"""do_request attaches the HTTP status to the exceptions it raises."""
def setUp(self):
self.api = API()
self.api.encode_key("test-token")
def _do_request_raising(self, expected_class, response=None, side_effect=None):
with patch("socketdev.core.api.requests.request") as mock_request:
if side_effect is not None:
mock_request.side_effect = side_effect
else:
mock_request.return_value = response
with self.assertRaises(expected_class) as ctx:
self.api.do_request("orgs/test/full-scans", method="POST")
return ctx.exception
def test_401_access_denied_is_not_transient(self):
error = self._do_request_raising(APIAccessDenied, _mock_response(401))
self.assertEqual(error.status_code, 401)
self.assertFalse(error.is_transient_error())
def test_403_insufficient_permissions_is_not_transient(self):
response = _mock_response(
403,
json_data={"error": {"message": "Insufficient permissions for API method"}},
)
error = self._do_request_raising(APIInsufficientPermissions, response)
self.assertEqual(error.status_code, 403)
self.assertFalse(error.is_transient_error())
def test_404_not_found_is_not_transient(self):
error = self._do_request_raising(APIResourceNotFound, _mock_response(404))
self.assertEqual(error.status_code, 404)
self.assertFalse(error.is_transient_error())
def test_429_quota_is_not_transient(self):
error = self._do_request_raising(APIInsufficientQuota, _mock_response(429))
self.assertEqual(error.status_code, 429)
self.assertFalse(error.is_transient_error())
def test_502_bad_gateway_is_transient(self):
error = self._do_request_raising(APIBadGateway, _mock_response(502))
self.assertEqual(error.status_code, 502)
self.assertTrue(error.is_transient_error())
def test_catch_all_transient_statuses(self):
for status in (408, 503, 504):
error = self._do_request_raising(APIFailure, _mock_response(status))
self.assertIs(type(error), APIFailure)
self.assertEqual(error.status_code, status)
self.assertTrue(error.is_transient_error())
def test_catch_all_deterministic_statuses(self):
for status in (400, 500):
error = self._do_request_raising(APIFailure, _mock_response(status))
self.assertIs(type(error), APIFailure)
self.assertEqual(error.status_code, status)
self.assertFalse(error.is_transient_error())
def test_timeout_is_transient(self):
error = self._do_request_raising(
APITimeout, side_effect=requests.exceptions.Timeout("timed out")
)
self.assertIsNone(error.status_code)
self.assertTrue(error.is_transient_error())
def test_connection_error_is_transient(self):
error = self._do_request_raising(
APIConnectionError,
side_effect=requests.exceptions.ConnectionError("reset"),
)
self.assertIsNone(error.status_code)
self.assertTrue(error.is_transient_error())
def test_unexpected_error_wrapped_without_status_is_not_transient(self):
error = self._do_request_raising(APIFailure, side_effect=RuntimeError("boom"))
self.assertIsNone(error.status_code)
self.assertFalse(error.is_transient_error())
if __name__ == "__main__":
unittest.main()