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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
import pytest
import requests
from jenkinsapi.jenkins import Requester
from jenkinsapi.custom_exceptions import JenkinsAPIException
from mock import patch
def test_no_parameters_uses_default_values():
req = Requester()
assert isinstance(req, Requester)
assert req.username is None
assert req.password is None
assert req.ssl_verify
assert req.cert is None
assert req.base_scheme is None
assert req.timeout == 10
def test_all_named_parameters():
req = Requester(
username="foo",
password="bar",
ssl_verify=False,
cert="foobar",
baseurl="http://dummy",
timeout=5,
)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_mix_one_unnamed_named_parameters():
req = Requester(
"foo",
password="bar",
ssl_verify=False,
cert="foobar",
baseurl="http://dummy",
timeout=5,
)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_mix_two_unnamed_named_parameters():
req = Requester(
"foo",
"bar",
ssl_verify=False,
cert="foobar",
baseurl="http://dummy",
timeout=5,
)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_mix_three_unnamed_named_parameters():
req = Requester(
"foo", "bar", False, cert="foobar", baseurl="http://dummy", timeout=5
)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_mix_four_unnamed_named_parameters():
req = Requester(
"foo", "bar", False, "foobar", baseurl="http://dummy", timeout=5
)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_mix_five_unnamed_named_parameters():
req = Requester("foo", "bar", False, "foobar", "http://dummy", timeout=5)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_all_unnamed_parameters():
req = Requester("foo", "bar", False, "foobar", "http://dummy", 5)
assert isinstance(req, Requester)
assert req.username == "foo"
assert req.password == "bar"
assert not req.ssl_verify
assert req.cert == "foobar"
assert req.base_scheme == "http", "dummy"
assert req.timeout == 5
def test_to_much_unnamed_parameters_raises_error():
with pytest.raises(Exception):
Requester("foo", "bar", False, "foobar", "http://dummy", 5, "test")
def test_username_without_password_raises_error():
with pytest.raises(Exception):
Requester(username="foo")
Requester("foo")
def test_password_without_username_raises_error():
with pytest.raises(AssertionError):
Requester(password="bar")
def test_get_request_dict_auth():
req = Requester("foo", "bar")
req_return = req.get_request_dict(params={}, data=None, headers=None)
assert isinstance(req_return, dict)
assert req_return.get("auth")
assert req_return["auth"] == ("foo", "bar")
@patch("jenkinsapi.jenkins.Requester.AUTH_COOKIE", "FAKE")
def test_get_request_dict_cookie():
req = Requester("foo", "bar")
req_return = req.get_request_dict(params={}, data=None, headers=None)
assert isinstance(req_return, dict)
assert req_return.get("headers")
assert req_return.get("headers").get("Cookie")
assert req_return.get("headers").get("Cookie") == "FAKE"
@patch("jenkinsapi.jenkins.Requester.AUTH_COOKIE", "FAKE")
def test_get_request_dict_updatecookie():
req = Requester("foo", "bar")
req_return = req.get_request_dict(
params={}, data=None, headers={"key": "value"}
)
assert isinstance(req_return, dict)
assert req_return.get("headers")
assert req_return.get("headers").get("key")
assert req_return.get("headers").get("key") == "value"
assert req_return.get("headers").get("Cookie")
assert req_return.get("headers").get("Cookie") == "FAKE"
def test_get_request_dict_nocookie():
req = Requester("foo", "bar")
req_return = req.get_request_dict(params={}, data=None, headers=None)
assert isinstance(req_return, dict)
assert not req_return.get("headers")
def test_get_request_dict_wrong_params():
req = Requester("foo", "bar")
with pytest.raises(AssertionError) as na:
req.get_request_dict(params="wrong", data=None, headers=None)
assert "Params must be a dict, got 'wrong'" in str(na.value)
def test_get_request_dict_correct_params():
req = Requester("foo", "bar")
req_return = req.get_request_dict(
params={"param": "value"}, data=None, headers=None
)
assert isinstance(req_return, dict)
assert req_return.get("params")
assert req_return["params"] == {"param": "value"}
def test_get_request_dict_wrong_headers():
req = Requester("foo", "bar")
with pytest.raises(AssertionError) as na:
req.get_request_dict(params={}, data=None, headers="wrong")
assert "headers must be a dict, got 'wrong'" in str(na.value)
def test_get_request_dict_correct_headers():
req = Requester("foo", "bar")
req_return = req.get_request_dict(
params={"param": "value"}, data=None, headers={"header": "value"}
)
assert isinstance(req_return, dict)
assert req_return.get("headers")
assert req_return["headers"] == {"header": "value"}
def test_get_request_dict_data_passed():
req = Requester("foo", "bar")
req_return = req.get_request_dict(
params={"param": "value"},
data="some data",
headers={"header": "value"},
)
assert isinstance(req_return, dict)
assert req_return.get("data")
assert req_return["data"] == "some data"
def test_get_request_dict_data_not_passed():
req = Requester("foo", "bar")
req_return = req.get_request_dict(
params={"param": "value"}, data=None, headers={"header": "value"}
)
assert isinstance(req_return, dict)
assert req_return.get("data") is None
def test_get_url_get(monkeypatch):
def fake_get(*args, **kwargs): # pylint: disable=unused-argument
return "SUCCESS"
monkeypatch.setattr(requests.Session, "get", fake_get)
req = Requester("foo", "bar")
response = req.get_url(
"http://dummy", params={"param": "value"}, headers=None
)
assert response == "SUCCESS"
def test_get_url_post(monkeypatch):
def fake_post(*args, **kwargs): # pylint: disable=unused-argument
return "SUCCESS"
monkeypatch.setattr(requests.Session, "post", fake_post)
req = Requester("foo", "bar")
response = req.post_url(
"http://dummy", params={"param": "value"}, headers=None
)
assert response == "SUCCESS"
def test_post_xml_empty_xml(monkeypatch):
def fake_post(*args, **kwargs): # pylint: disable=unused-argument
return "SUCCESS"
monkeypatch.setattr(requests.Session, "post", fake_post)
req = Requester("foo", "bar")
with pytest.raises(AssertionError):
req.post_xml_and_confirm_status(
url="http://dummy", params={"param": "value"}, data=None
)
def test_post_xml_and_confirm_status_some_xml(monkeypatch):
class FakeResponse(requests.Response):
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument
self.status_code = 200
def fake_post(*args, **kwargs): # pylint: disable=unused-argument
return FakeResponse()
monkeypatch.setattr(requests.Session, "post", fake_post)
req = Requester("foo", "bar")
ret = req.post_xml_and_confirm_status(
url="http://dummy", params={"param": "value"}, data="<xml/>"
)
assert isinstance(ret, requests.Response)
def test_post_and_confirm_status_empty_data(monkeypatch):
def fake_post(*args, **kwargs): # pylint: disable=unused-argument
return "SUCCESS"
monkeypatch.setattr(requests.Session, "post", fake_post)
req = Requester("foo", "bar")
with pytest.raises(AssertionError):
req.post_and_confirm_status(
url="http://dummy", params={"param": "value"}, data=None
)
def test_post_and_confirm_status_some_data(monkeypatch):
class FakeResponse(requests.Response):
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument
self.status_code = 200
def fake_post(*args, **kwargs): # pylint: disable=unused-argument
return FakeResponse()
monkeypatch.setattr(requests.Session, "post", fake_post)
req = Requester("foo", "bar")
ret = req.post_and_confirm_status(
url="http://dummy", params={"param": "value"}, data="some data"
)
assert isinstance(ret, requests.Response)
def test_post_and_confirm_status_bad_result(monkeypatch):
class FakeResponse(object):
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument
self.status_code = 500
self.url = "http://dummy"
self.text = "something"
def fake_post(*args, **kwargs): # pylint: disable=unused-argument
return FakeResponse()
monkeypatch.setattr(requests.Session, "post", fake_post)
req = Requester("foo", "bar")
with pytest.raises(JenkinsAPIException) as error:
req.post_and_confirm_status(
url="http://dummy", params={"param": "value"}, data="some data"
)
assert "status=500" in str(error)
def test_get_and_confirm_status(monkeypatch):
class FakeResponse(requests.Response):
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument
self.status_code = 200
def fake_get(*args, **kwargs): # pylint: disable=unused-argument
return FakeResponse()
monkeypatch.setattr(requests.Session, "get", fake_get)
req = Requester("foo", "bar")
ret = req.get_and_confirm_status(
url="http://dummy", params={"param": "value"}
)
assert isinstance(ret, requests.Response)
def test_get_and_confirm_status_bad_result(monkeypatch):
class FakeResponse(object):
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument
self.status_code = 500
self.url = "http://dummy"
self.text = "something"
def fake_get(*args, **kwargs): # pylint: disable=unused-argument
return FakeResponse()
monkeypatch.setattr(requests.Session, "get", fake_get)
req = Requester("foo", "bar", baseurl="http://dummy")
with pytest.raises(JenkinsAPIException) as error:
req.get_and_confirm_status(
url="http://dummy", params={"param": "value"}
)
assert "status=500" in str(error)
def test_configure_max_retries():
req = Requester(
"username", "password", baseurl="http://dummy", max_retries=3
)
for adapter in req.session.adapters.values():
assert adapter.max_retries.total == 3
|
