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
396
|
import pytest
from collections import namedtuple
import jenkinsapi
from jenkinsapi.plugins import Plugins
from jenkinsapi.utils.requester import Requester
from jenkinsapi.jenkins import Jenkins
from jenkinsapi.jenkinsbase import JenkinsBase
from jenkinsapi.job import Job
from jenkinsapi.custom_exceptions import JenkinsAPIException
DATA = {}
TWO_JOBS_DATA = {
"jobs": [
{
"name": "job_one",
"url": "http://localhost:8080/job/job_one",
"color": "blue",
},
{
"name": "job_two",
"url": "http://localhost:8080/job/job_two",
"color": "blue",
},
]
}
MULTIBRANCH_JOBS_DATA = {
"jobs": [
{
"name": "multibranch-repo/master",
"url": "http://localhost:8080/job/multibranch-repo/job/master",
"color": "blue",
},
{
"name": "multibranch-repo/develop",
"url": "http://localhost:8080/job/multibranch-repo/job/develop",
"color": "blue",
},
]
}
SCAN_MULTIBRANCH_PIPELINE_LOG = """
Started by timer
[Fri Jul 05 06:46:00 CEST 2019] Starting branch indexing...
Connecting to https://stash.macq.eu using Jenkins/****** (jenkins-ldap)
Repository type: Git
Looking up internal/base for branches
Checking branch master from internal/base
'Jenkinsfile' found
Met criteria
No changes detected: master (still at 26d4d8a673f57a957fd5a23f5adfe0be02089294)
1 branches were processed
Looking up internal/base for pull requests
0 pull requests were processed
[Fri Jul 05 06:46:01 CEST 2019] Finished branch indexing. Indexing took 1.1 sec
Finished: SUCCESS
"""
@pytest.fixture(scope="function")
def jenkins(monkeypatch):
def fake_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(Jenkins, "_poll", fake_poll)
return Jenkins(
"http://localhost:8080", username="foouser", password="foopassword"
)
def test__clone(jenkins):
cloned = jenkins._clone()
assert id(cloned) != id(jenkins)
assert cloned == jenkins
def test_stored_passwords(jenkins):
assert jenkins.requester.password == "foopassword"
assert jenkins.requester.username == "foouser"
def test_reload(monkeypatch):
class FakeResponse(object):
status_code = 200
text = "{}"
def fake_get_url(
url, # pylint: disable=unused-argument
params=None, # pylint: disable=unused-argument
headers=None, # pylint: disable=unused-argument
allow_redirects=True, # pylint: disable=unused-argument
stream=False,
): # pylint: disable=unused-argument
return FakeResponse()
monkeypatch.setattr(Requester, "get_url", fake_get_url)
mock_requester = Requester(username="foouser", password="foopassword")
jenkins = Jenkins(
"http://localhost:8080/",
username="foouser",
password="foopassword",
requester=mock_requester,
)
jenkins.poll()
def test_get_jobs_list(monkeypatch):
def fake_jenkins_poll(cls, tree=None): # pylint: disable=unused-argument
return TWO_JOBS_DATA
def fake_job_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(JenkinsBase, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Jenkins, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Job, "_poll", fake_job_poll)
jenkins = Jenkins(
"http://localhost:8080/", username="foouser", password="foopassword"
)
for idx, job_name in enumerate(jenkins.get_jobs_list()):
assert job_name == TWO_JOBS_DATA["jobs"][idx]["name"]
for idx, job_name in enumerate(jenkins.jobs.keys()):
assert job_name == TWO_JOBS_DATA["jobs"][idx]["name"]
def test_create_new_job_fail(mocker, monkeypatch):
def fake_jenkins_poll(cls, tree=None): # pylint: disable=unused-argument
return TWO_JOBS_DATA
def fake_job_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(JenkinsBase, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Jenkins, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Job, "_poll", fake_job_poll)
mock_requester = Requester(username="foouser", password="foopassword")
mock_requester.post_xml_and_confirm_status = mocker.MagicMock(
return_value=""
)
jenkins = Jenkins(
"http://localhost:8080/",
username="foouser",
password="foopassword",
requester=mock_requester,
)
with pytest.raises(JenkinsAPIException) as ar:
jenkins.create_job("job_new", None)
assert "Job XML config cannot be empty" in str(ar.value)
def test_create_multibranch_pipeline_job(mocker, monkeypatch):
def fake_jenkins_poll(cls, tree=None): # pylint: disable=unused-argument
# return multibranch jobs and other jobs.
# create_multibranch_pipeline_job is supposed to filter out
# the MULTIBRANCH jobs
return {"jobs": TWO_JOBS_DATA["jobs"] + MULTIBRANCH_JOBS_DATA["jobs"]}
def fake_job_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(JenkinsBase, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Jenkins, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Job, "_poll", fake_job_poll)
mock_requester = Requester(username="foouser", password="foopassword")
mock_requester.post_xml_and_confirm_status = mocker.MagicMock(
return_value=""
)
mock_requester.post_and_confirm_status = mocker.MagicMock(return_value="")
get_response = namedtuple("get_response", "text")
mock_requester.get_url = mocker.MagicMock(
return_value=get_response(text=SCAN_MULTIBRANCH_PIPELINE_LOG)
)
jenkins = Jenkins(
"http://localhost:8080/",
username="foouser",
password="foopassword",
requester=mock_requester,
)
jobs = jenkins.create_multibranch_pipeline_job(
"multibranch-repo", "multibranch-xml-content"
)
for idx, job_instance in enumerate(jobs):
assert job_instance.name == MULTIBRANCH_JOBS_DATA["jobs"][idx]["name"]
# make sure we didn't get more jobs.
assert len(MULTIBRANCH_JOBS_DATA["jobs"]) == len(jobs)
def test_get_jenkins_obj_from_url(mocker, monkeypatch):
def fake_jenkins_poll(cls, tree=None): # pylint: disable=unused-argument
return TWO_JOBS_DATA
def fake_job_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(JenkinsBase, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Jenkins, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Job, "_poll", fake_job_poll)
mock_requester = Requester(username="foouser", password="foopassword")
mock_requester.post_xml_and_confirm_status = mocker.MagicMock(
return_value=""
)
jenkins = Jenkins(
"http://localhost:8080/",
username="foouser",
password="foopassword",
requester=mock_requester,
)
new_jenkins = jenkins.get_jenkins_obj_from_url("http://localhost:8080/")
assert new_jenkins == jenkins
new_jenkins = jenkins.get_jenkins_obj_from_url("http://localhost:8080/foo")
assert new_jenkins != jenkins
def test_get_jenkins_obj(mocker, monkeypatch):
def fake_jenkins_poll(cls, tree=None): # pylint: disable=unused-argument
return TWO_JOBS_DATA
def fake_job_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(JenkinsBase, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Jenkins, "_poll", fake_jenkins_poll)
monkeypatch.setattr(Job, "_poll", fake_job_poll)
mock_requester = Requester(username="foouser", password="foopassword")
mock_requester.post_xml_and_confirm_status = mocker.MagicMock(
return_value=""
)
jenkins = Jenkins(
"http://localhost:8080/",
username="foouser",
password="foopassword",
requester=mock_requester,
)
new_jenkins = jenkins.get_jenkins_obj()
assert new_jenkins == jenkins
def test_get_version(monkeypatch):
class MockResponse(object):
def __init__(self):
self.headers = {}
self.headers["X-Jenkins"] = "1.542"
def fake_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(Jenkins, "_poll", fake_poll)
def fake_get(cls, *arga, **kwargs): # pylint: disable=unused-argument
return MockResponse()
monkeypatch.setattr(Requester, "get_and_confirm_status", fake_get)
jenkins = Jenkins(
"http://foobar:8080/", username="foouser", password="foopassword"
)
assert jenkins.version == "1.542"
def test_get_version_nonexistent(mocker):
class MockResponse(object):
status_code = 200
headers = {}
text = "{}"
mock_requester = Requester(username="foouser", password="foopassword")
mock_requester.get_url = mocker.MagicMock(return_value=MockResponse())
jenkins = Jenkins(
"http://localhost:8080",
username="foouser",
password="foopassword",
requester=mock_requester,
)
assert jenkins.version == "0.0"
def test_get_master_data(mocker):
class MockResponse(object):
status_code = 200
headers = {}
text = "{}"
mock_requester = Requester(username="foouser", password="foopassword")
mock_requester.get_url = mocker.MagicMock(return_value=MockResponse())
jenkins = Jenkins(
"http://localhost:808",
username="foouser",
password="foopassword",
requester=mock_requester,
)
jenkins.get_data = mocker.MagicMock(
return_value={"busyExecutors": 59, "totalExecutors": 75}
)
data = jenkins.get_master_data()
assert data["busyExecutors"] == 59
assert data["totalExecutors"] == 75
def test_get_create_url(monkeypatch):
def fake_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(Jenkins, "_poll", fake_poll)
# Jenkins URL w/o slash
jenkins = Jenkins(
"http://localhost:8080", username="foouser", password="foopassword"
)
assert jenkins.get_create_url() == "http://localhost:8080/createItem"
# Jenkins URL w/ slash
jenkins = Jenkins(
"http://localhost:8080/", username="foouser", password="foopassword"
)
assert jenkins.get_create_url() == "http://localhost:8080/createItem"
def test_has_plugin(monkeypatch):
def fake_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(Jenkins, "_poll", fake_poll)
def fake_plugin_poll(cls, tree=None): # pylint: disable=unused-argument
return {
"plugins": [
{
"deleted": False,
"hasUpdate": True,
"downgradable": False,
"dependencies": [{}, {}, {}, {}],
"longName": "Jenkins Subversion Plug-in",
"active": True,
"shortName": "subversion",
"backupVersion": None,
"url": "http://wiki.jenkins-ci.org/"
"display/JENKINS/Subversion+Plugin",
"enabled": True,
"pinned": False,
"version": "1.45",
"supportsDynamicLoad": "MAYBE",
"bundled": True,
}
]
}
monkeypatch.setattr(Plugins, "_poll", fake_plugin_poll)
jenkins = Jenkins(
"http://localhost:8080/", username="foouser", password="foopassword"
)
assert jenkins.has_plugin("subversion") is True
def test_get_use_auth_cookie(mocker, monkeypatch):
COOKIE_VALUE = "FAKE_COOKIE"
def fake_opener(redirect_handler): # pylint: disable=unused-argument
mock_response = mocker.MagicMock()
mock_response.cookie = COOKIE_VALUE
mock_opener = mocker.MagicMock()
mock_opener.open.return_value = mock_response
return mock_opener
def fake_poll(cls, tree=None): # pylint: disable=unused-argument
return {}
monkeypatch.setattr(Jenkins, "_poll", fake_poll)
monkeypatch.setattr(Requester, "AUTH_COOKIE", None)
monkeypatch.setattr(jenkinsapi.jenkins, "build_opener", fake_opener)
jenkins = Jenkins(
"http://localhost:8080", username="foouser", password="foopassword"
)
jenkins.use_auth_cookie()
assert Requester.AUTH_COOKIE == COOKIE_VALUE
|
