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
|
from __future__ import annotations
import json
from unittest.mock import MagicMock
import pytest
import requests
from hcloud import (
APIException,
Client,
constant_backoff_function,
exponential_backoff_function,
)
class TestHetznerClient:
@pytest.fixture()
def client(self):
Client._version = "0.0.0"
client = Client(token="project_token")
client._requests_session = MagicMock()
return client
@pytest.fixture()
def response(self):
response = requests.Response()
response.status_code = 200
response._content = json.dumps({"result": "data"}).encode("utf-8")
return response
@pytest.fixture()
def fail_response(self, response):
response.status_code = 422
error = {
"code": "invalid_input",
"message": "invalid input in field 'broken_field': is too long",
"details": {
"fields": [{"name": "broken_field", "messages": ["is too long"]}]
},
}
response._content = json.dumps({"error": error}).encode("utf-8")
return response
@pytest.fixture()
def rate_limit_response(self, response):
response.status_code = 422
error = {
"code": "rate_limit_exceeded",
"message": "limit of 10 requests per hour reached",
"details": {},
}
response._content = json.dumps({"error": error}).encode("utf-8")
return response
def test__get_user_agent(self, client):
user_agent = client._get_user_agent()
assert user_agent == "hcloud-python/0.0.0"
def test__get_user_agent_with_application_name(self, client):
client = Client(token="project_token", application_name="my-app")
user_agent = client._get_user_agent()
assert user_agent == "my-app hcloud-python/0.0.0"
def test__get_user_agent_with_application_name_and_version(self, client):
client = Client(
token="project_token",
application_name="my-app",
application_version="1.0.0",
)
user_agent = client._get_user_agent()
assert user_agent == "my-app/1.0.0 hcloud-python/0.0.0"
def test__get_headers(self, client):
headers = client._get_headers()
assert headers == {
"User-Agent": "hcloud-python/0.0.0",
"Authorization": "Bearer project_token",
}
def test_request_ok(self, client, response):
client._requests_session.request.return_value = response
response = client.request(
"POST", "/servers", params={"argument": "value"}, timeout=2
)
client._requests_session.request.assert_called_once_with(
method="POST",
url="https://api.hetzner.cloud/v1/servers",
headers={
"User-Agent": "hcloud-python/0.0.0",
"Authorization": "Bearer project_token",
},
params={"argument": "value"},
timeout=2,
)
assert response == {"result": "data"}
def test_request_fails(self, client, fail_response):
client._requests_session.request.return_value = fail_response
with pytest.raises(APIException) as exception_info:
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
error = exception_info.value
assert error.code == "invalid_input"
assert error.message == "invalid input in field 'broken_field': is too long"
assert error.details["fields"][0]["name"] == "broken_field"
def test_request_fails_correlation_id(self, client, response):
response.headers["X-Correlation-Id"] = "67ed842dc8bc8673"
response.status_code = 422
response._content = json.dumps(
{
"error": {
"code": "service_error",
"message": "Something crashed",
}
}
).encode("utf-8")
client._requests_session.request.return_value = response
with pytest.raises(APIException) as exception_info:
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
error = exception_info.value
assert error.code == "service_error"
assert error.message == "Something crashed"
assert error.details is None
assert error.correlation_id == "67ed842dc8bc8673"
assert str(error) == "Something crashed (service_error, 67ed842dc8bc8673)"
def test_request_500(self, client, fail_response):
fail_response.status_code = 500
fail_response.reason = "Internal Server Error"
fail_response._content = "Internal Server Error"
client._requests_session.request.return_value = fail_response
with pytest.raises(APIException) as exception_info:
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
error = exception_info.value
assert error.code == 500
assert error.message == "Internal Server Error"
assert error.details["content"] == "Internal Server Error"
def test_request_broken_json_200(self, client, response):
content = b"{'key': 'value'"
response.reason = "OK"
response._content = content
client._requests_session.request.return_value = response
with pytest.raises(APIException) as exception_info:
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
error = exception_info.value
assert error.code == 200
assert error.message == "OK"
assert error.details["content"] == content
def test_request_empty_content_200(self, client, response):
content = ""
response.reason = "OK"
response._content = content
client._requests_session.request.return_value = response
response = client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
assert response == {}
def test_request_500_empty_content(self, client, fail_response):
fail_response.status_code = 500
fail_response.reason = "Internal Server Error"
fail_response._content = ""
client._requests_session.request.return_value = fail_response
with pytest.raises(APIException) as exception_info:
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
error = exception_info.value
assert error.code == 500
assert error.message == "Internal Server Error"
assert error.details["content"] == ""
assert str(error) == "Internal Server Error (500)"
def test_request_limit(self, client, rate_limit_response):
client._retry_interval = constant_backoff_function(0.0)
client._requests_session.request.return_value = rate_limit_response
with pytest.raises(APIException) as exception_info:
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
error = exception_info.value
assert client._requests_session.request.call_count == 6
assert error.code == "rate_limit_exceeded"
assert error.message == "limit of 10 requests per hour reached"
def test_request_limit_then_success(self, client, rate_limit_response):
client._retry_interval = constant_backoff_function(0.0)
response = requests.Response()
response.status_code = 200
response._content = json.dumps({"result": "data"}).encode("utf-8")
client._requests_session.request.side_effect = [rate_limit_response, response]
client.request(
"POST", "http://url.com", params={"argument": "value"}, timeout=2
)
assert client._requests_session.request.call_count == 2
@pytest.mark.parametrize(
("exception", "expected"),
[
(
APIException(code="rate_limit_exceeded", message="Error", details=None),
True,
),
(
APIException(code="conflict", message="Error", details=None),
True,
),
(
APIException(code=409, message="Conflict", details=None),
False,
),
(
APIException(code=429, message="Too Many Requests", details=None),
False,
),
(
APIException(code=502, message="Bad Gateway", details=None),
True,
),
(
APIException(code=503, message="Service Unavailable", details=None),
False,
),
(
APIException(code=504, message="Gateway Timeout", details=None),
True,
),
],
)
def test_retry_policy(self, client, exception, expected):
assert client._retry_policy(exception) == expected
def test_constant_backoff_function():
backoff = constant_backoff_function(interval=1.0)
max_retries = 5
for i in range(max_retries):
assert backoff(i) == 1.0
def test_exponential_backoff_function():
backoff = exponential_backoff_function(
base=1.0,
multiplier=2,
cap=60.0,
)
max_retries = 5
results = [backoff(i) for i in range(max_retries)]
assert sum(results) == 31.0
assert results == [1.0, 2.0, 4.0, 8.0, 16.0]
|
