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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import unittest
try:
# Attempt to load mock (works on Python 3.3 and above)
from unittest.mock import patch
except ImportError:
# Attempt to load mock (works on Python version below 3.3)
from mock import patch
from azext_devops.devops_sdk.v5_0.git.models import GitCommit, GitCommitRef, GitPullRequest, GitRepository, TeamProjectReference
from azext_devops.devops_sdk.v5_0.git.git_client import GitClient
from azext_devops.dev.repos.pull_request import (create_pull_request,
show_pull_request,
list_pull_requests,
update_pull_request,
create_pull_request_reviewers,
delete_pull_request_reviewers,
list_pull_request_reviewers,
add_pull_request_work_items,
list_pull_request_work_items,
vote_pull_request,
_convert_vote_to_int,
list_pr_policies,
queue_pr_policy)
from azext_devops.dev.common.git import get_current_branch_name, resolve_git_ref_heads
from azext_devops.dev.common.services import clear_connection_cache
from azext_devops.tests.utils.authentication import AuthenticatedTests
from azext_devops.tests.utils.helper import get_client_mock_helper, TEST_DEVOPS_ORG_URL
class TestPullRequestMethods(AuthenticatedTests):
_TEST_DEVOPS_ORGANIZATION = TEST_DEVOPS_ORG_URL
_TEST_PAT_TOKEN = 'pat_token'
_TEST_PROJECT_NAME = 'sample_project'
_TEST_REPOSITORY_NAME = 'sample_repository'
_TEST_SOURCE_BRANCH = 'sample_source_branch'
_TEST_TARGET_BRANCH = 'sample_target_branch'
_TEST_PR_TITLE = 'sample_pr_title'
_TEST_GIT_COMMIT_ID = 5
_TEST_PR_DESCRIPTION = 'sample_pr_description'
def setUp(self):
self.authentication_setup()
self.authenticate()
self.create_PR_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.create_pull_request')
self.udpate_PR_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.update_pull_request')
self.get_PR_byId_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_request_by_id')
self.get_PR_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_request')
self.get_PRsByProject_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_requests_by_project')
self.get_PRs_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_requests')
self.create_PR_reviewers_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.create_pull_request_reviewers')
self.create_PR_reviewer_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.create_pull_request_reviewer')
self.delete_PR_reviewers_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.delete_pull_request_reviewer')
self.get_PR_reviewers_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_request_reviewers')
self.get_PR_WIs_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_request_work_item_refs')
self.get_PR_commits_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_pull_request_commits')
self.get_commit_byId_patcher = patch('azext_devops.devops_sdk.v5_0.git.git_client.GitClient.get_commit')
# patch get client so no network call is made
self.get_client = patch('azext_devops.devops_sdk.connection.Connection.get_client', new=get_client_mock_helper)
self.open_in_browser_patcher = patch('azext_devops.dev.boards.work_item._open_work_item')
self.resolve_reviewers_as_refs_patcher = patch('azext_devops.dev.repos.pull_request._resolve_reviewers_as_refs')
self.resolve_reviewers_as_ids = patch('azext_devops.dev.repos.pull_request._resolve_reviewers_as_ids')
self.update_WI_patcher = patch('azext_devops.devops_sdk.v5_0.work_item_tracking.work_item_tracking_client.WorkItemTrackingClient.update_work_item')
self.get_WIs_pacther = patch('azext_devops.devops_sdk.v5_0.work_item_tracking.work_item_tracking_client.WorkItemTrackingClient.get_work_items')
self.get_policy_evaluation_patcher = patch('azext_devops.devops_sdk.v5_0.policy.policy_client.PolicyClient.get_policy_evaluations')
self.requeue_policy_evaluation_patcher = patch('azext_devops.devops_sdk.v5_0.policy.policy_client.PolicyClient.requeue_policy_evaluation')
#start the patchers
self.mock_create_PR = self.create_PR_patcher.start()
self.mock_update_PR = self.udpate_PR_patcher.start()
self.mock_get_PR_byId = self.get_PR_byId_patcher.start()
self.mock_get_PR = self.get_PR_patcher.start()
self.mock_get_PRsByProject = self.get_PRsByProject_patcher.start()
self.mock_get_PRs = self.get_PRs_patcher.start()
self.mock_create_PR_reviewers = self.create_PR_reviewers_patcher.start()
self.mock_create_PR_reviewer = self.create_PR_reviewer_patcher.start()
self.mock_delete_PR_reviewer = self.delete_PR_reviewers_patcher.start()
self.mock_get_PR_reviewer = self.get_PR_reviewers_patcher.start()
self.mock_get_PR_WIs = self.get_PR_WIs_patcher.start()
self.mock_get_PR_commits = self.get_PR_commits_patcher.start()
self.mock_get_commit_byId = self.get_commit_byId_patcher.start()
self.mock_open_browser = self.open_in_browser_patcher.start()
self.mock_resolve_reviewers_as_refs = self.resolve_reviewers_as_refs_patcher.start()
self.mock_resolve_reviewers_as_ids = self.resolve_reviewers_as_ids.start()
self.mock_udpate_WI = self.update_WI_patcher.start()
self.mock_get_WIs = self.get_WIs_pacther.start()
self.mock_get_policy_evaluation = self.get_policy_evaluation_patcher.start()
self.mock_requeue_policy_evaluation = self.requeue_policy_evaluation_patcher.start()
# Setup mocks for clients
self.mock_get_client = self.get_client.start()
#clear connection cache before running each test
clear_connection_cache()
def tearDown(self):
patch.stopall()
def test_create_pull_request(self):
test_pr_id = 1
# set return values
self.mock_create_PR.return_value.id = test_pr_id
response = create_pull_request(project = self._TEST_PROJECT_NAME,
repository = self._TEST_REPOSITORY_NAME,
source_branch = self._TEST_SOURCE_BRANCH,
target_branch = self._TEST_TARGET_BRANCH,
title = self._TEST_PR_TITLE,
description = self._TEST_PR_DESCRIPTION,
organization = self._TEST_DEVOPS_ORGANIZATION)
# assert
self.mock_validate_token.assert_not_called()
self.mock_create_PR.assert_called_once()
self.mock_update_PR.assert_not_called()
assert response.id == test_pr_id
#compare the PR objects
pr_object_from_create_call = self.mock_create_PR.call_args_list[0][1]['git_pull_request_to_create']
assert pr_object_from_create_call.title == self._TEST_PR_TITLE
assert pr_object_from_create_call.description == '\n'.join(self._TEST_PR_DESCRIPTION)
assert pr_object_from_create_call.source_ref_name == resolve_git_ref_heads(self._TEST_SOURCE_BRANCH)
assert pr_object_from_create_call.target_ref_name == resolve_git_ref_heads(self._TEST_TARGET_BRANCH)
assert pr_object_from_create_call.work_item_refs == None
def test_create_pull_request_with_duplicate_reviwer(self):
test_pr_id = 1
# set return values
self.mock_create_PR.return_value.id = test_pr_id
self.mock_resolve_reviewers_as_refs.return_value = ['id1']
response = create_pull_request(
project = self._TEST_PROJECT_NAME,
repository = self._TEST_REPOSITORY_NAME,
source_branch = self._TEST_SOURCE_BRANCH,
target_branch = self._TEST_TARGET_BRANCH,
title = self._TEST_PR_TITLE,
description = self._TEST_PR_DESCRIPTION,
optional_reviewers = ['a@b.com','A@b.com'],
organization = self._TEST_DEVOPS_ORGANIZATION
)
# assert
self.mock_validate_token.assert_not_called()
self.mock_create_PR.assert_called_once()
self.mock_update_PR.assert_not_called()
assert len(self.mock_resolve_reviewers_as_refs.call_args_list) == 1
assert self.mock_resolve_reviewers_as_refs.call_args_list[0][0][0] == ["a@b.com"]
assert response.id == test_pr_id
#compare the PR objects
pr_object_from_create_call = self.mock_create_PR.call_args_list[0][1]['git_pull_request_to_create']
assert pr_object_from_create_call.title == self._TEST_PR_TITLE
assert pr_object_from_create_call.description == '\n'.join(self._TEST_PR_DESCRIPTION)
assert pr_object_from_create_call.source_ref_name == resolve_git_ref_heads(self._TEST_SOURCE_BRANCH)
assert pr_object_from_create_call.target_ref_name == resolve_git_ref_heads(self._TEST_TARGET_BRANCH)
assert pr_object_from_create_call.work_item_refs == None
assert pr_object_from_create_call.reviewers == ['id1']
def test_create_pull_request_with_auto_complete(self):
test_pr_id = 1
merge_complete_message = 'merge complete message'
#big setup because this object is passed around in create with auto complete flow
pr_to_return = GitPullRequest()
pr_to_return.pull_request_id = test_pr_id
pr_to_return.repository = GitRepository()
pr_to_return.repository.project = TeamProjectReference()
self.mock_create_PR.return_value = pr_to_return
self.mock_resolve_identity.return_value = 'resolved identity'
response = create_pull_request(project = self._TEST_PROJECT_NAME,
repository = self._TEST_REPOSITORY_NAME,
source_branch = self._TEST_SOURCE_BRANCH,
target_branch = self._TEST_TARGET_BRANCH,
title = self._TEST_PR_TITLE,
description = self._TEST_PR_DESCRIPTION,
organization = self._TEST_DEVOPS_ORGANIZATION,
auto_complete = True,
merge_commit_message = merge_complete_message)
# assert
self.mock_create_PR.assert_called_once()
self.mock_update_PR.assert_called_once()
pr_id_from_udpate_call = self.mock_update_PR.call_args_list[0][1]['pull_request_id']
assert pr_id_from_udpate_call == test_pr_id
update_object_from_update_call = self.mock_update_PR.call_args_list[0][1]['git_pull_request_to_update']
assert update_object_from_update_call.completion_options.merge_commit_message == merge_complete_message
def test_create_pull_request_comment_description_auto_populate(self):
test_pr_id = 1
#big setup because this object is passed around in create with auto complete flow
pr_to_return = GitPullRequest()
pr_to_return.pull_request_id = test_pr_id
pr_to_return.repository = GitRepository()
pr_to_return.repository.project = TeamProjectReference()
self.mock_create_PR.return_value = pr_to_return
pr_commits_to_return = [GitCommitRef(commit_id=self._TEST_GIT_COMMIT_ID)]
self.mock_get_PR_commits.return_value = pr_commits_to_return
commit_details_to_return = GitCommit(commit_id=self._TEST_GIT_COMMIT_ID, comment='comment line 1\ncomment line 2')
self.mock_get_commit_byId.return_value = commit_details_to_return
self.mock_resolve_identity.return_value = 'resolved identity'
# empty title and description so they are auto-populated from the commit
response = create_pull_request(project = self._TEST_PROJECT_NAME,
repository = self._TEST_REPOSITORY_NAME,
source_branch = self._TEST_SOURCE_BRANCH,
target_branch = self._TEST_TARGET_BRANCH,
organization = self._TEST_DEVOPS_ORGANIZATION,
auto_complete = True)
# assert
self.mock_create_PR.assert_called_once()
self.mock_update_PR.assert_called_once()
pr_id_from_udpate_call = self.mock_update_PR.call_args_list[0][1]['pull_request_id']
assert pr_id_from_udpate_call == test_pr_id
update_object_from_update_call = self.mock_update_PR.call_args_list[0][1]['git_pull_request_to_update']
assert update_object_from_update_call.title == 'comment line 1'
assert update_object_from_update_call.description == 'comment line 1\ncomment line 2'
def test_show_pull_request(self):
test_pr_id = 1
test_project_id = 20
test_repository_id = 25
#big setup because this object is passed around
pr_to_return = GitPullRequest()
pr_to_return.pull_request_id = test_pr_id
pr_to_return.repository = GitRepository()
pr_to_return.repository.id = test_repository_id
pr_to_return.repository.project = TeamProjectReference()
pr_to_return.repository.project.id = test_project_id
self.mock_get_PR_byId.return_value = pr_to_return
response = show_pull_request(id = test_pr_id,
open = False,
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once_with(test_pr_id)
self.mock_get_PR.assert_called_once_with(project = test_project_id,
repository_id = test_repository_id,
pull_request_id = test_pr_id,
include_commits= False,
include_work_item_refs= True)
def test_list_pull_request(self):
response = list_pull_requests(project = self._TEST_PROJECT_NAME,
organization = self._TEST_DEVOPS_ORGANIZATION)
self.mock_get_PRsByProject.assert_called_once()
self.mock_get_PRs.assert_not_called()
calls_args = self.mock_get_PRsByProject.call_args_list
self.assertEqual(self._TEST_PROJECT_NAME, calls_args[0][1]['project'])
self.assertEqual(None, calls_args[0][1]['skip'])
self.assertEqual(None, calls_args[0][1]['top'])
search_criteria_in_call = calls_args[0][1]['search_criteria']
self.assertEqual(search_criteria_in_call.include_links, False)
self.assertEqual(search_criteria_in_call.source_ref_name, None)
self.assertEqual(search_criteria_in_call.status, None)
self.assertEqual(search_criteria_in_call.target_ref_name, None)
def test_list_pull_request_options(self):
response = list_pull_requests(project = self._TEST_PROJECT_NAME,
organization = self._TEST_DEVOPS_ORGANIZATION,
skip = 1,
top = 10,
include_links = True,
source_branch = 'userBranch',
status = 'active',
target_branch = 'master')
self.mock_get_PRsByProject.assert_called_once()
self.mock_get_PRs.assert_not_called()
calls_args = self.mock_get_PRsByProject.call_args_list
self.assertEqual(self._TEST_PROJECT_NAME, calls_args[0][1]['project'])
self.assertEqual(1, calls_args[0][1]['skip'])
self.assertEqual(10, calls_args[0][1]['top'])
search_criteria_in_call = calls_args[0][1]['search_criteria']
self.assertEqual(search_criteria_in_call.include_links, True)
self.assertEqual(search_criteria_in_call.source_ref_name, 'refs/heads/userBranch')
self.assertEqual(search_criteria_in_call.target_ref_name, 'refs/heads/master')
def test_list_pull_request_with_repo(self):
response = list_pull_requests(project = self._TEST_PROJECT_NAME,
organization = self._TEST_DEVOPS_ORGANIZATION,
repository = self._TEST_REPOSITORY_NAME)
self.mock_get_PRsByProject.assert_not_called()
self.mock_get_PRs.assert_called_once()
def test_update_pull_request(self):
test_pr_id = 1
response = update_pull_request(id = test_pr_id,
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once_with(test_pr_id)
self.mock_update_PR.assert_called_once()
def test_complete_pull_request(self):
test_pr_id = 1
response = update_pull_request(id = test_pr_id,
organization = self._TEST_DEVOPS_ORGANIZATION,
status='completed')
#assert
self.mock_get_PR_byId.assert_called_once_with(test_pr_id)
self.mock_update_PR.assert_called_once()
update_object_from_update_call = self.mock_update_PR.call_args_list[0][1]['git_pull_request_to_update']
assert update_object_from_update_call.status == 'completed'
def test_abandon_pull_request(self):
test_pr_id = 1
response = update_pull_request(id = test_pr_id,
organization = self._TEST_DEVOPS_ORGANIZATION,
status='abandoned')
#assert
self.mock_get_PR_byId.assert_called_once_with(test_pr_id)
self.mock_update_PR.assert_called_once()
update_object_from_update_call = self.mock_update_PR.call_args_list[0][1]['git_pull_request_to_update']
assert update_object_from_update_call.status == 'abandoned'
def test_reactivate_pull_request(self):
test_pr_id = 1
response = update_pull_request(id = test_pr_id,
organization = self._TEST_DEVOPS_ORGANIZATION,
status='active')
#assert
self.mock_get_PR_byId.assert_called_once_with(test_pr_id)
self.mock_update_PR.assert_called_once()
update_object_from_update_call = self.mock_update_PR.call_args_list[0][1]['git_pull_request_to_update']
assert update_object_from_update_call.status == 'active'
def test_create_pull_request_reviewers(self):
#setup
test_pr_id = 1
self.mock_resolve_identity.return_value = []
#work
response = create_pull_request_reviewers(id = test_pr_id,
reviewers = 'sample',
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_create_PR_reviewers.assert_called_once()
self.mock_get_PR_byId.assert_called_once()
def test_delete_pull_request_reviewers(self):
#setup
test_pr_id = 1
self.mock_resolve_reviewers_as_ids.return_value = ['id1']
#work
response = delete_pull_request_reviewers(id = test_pr_id,
reviewers = 'sample',
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_delete_PR_reviewer.assert_called_once()
self.mock_get_PR_reviewer.assert_called_once()
def test_delete_pull_request_reviewers_multiple_users(self):
#setup
test_pr_id = 1
self.mock_resolve_reviewers_as_ids.return_value = ['id1','id2','id3']
#work
response = delete_pull_request_reviewers(id = test_pr_id,
reviewers = 'sample',
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
assert self.mock_delete_PR_reviewer.call_count == 3
self.mock_get_PR_reviewer.assert_called_once()
def test_list_pull_request_reviewers(self):
#setup
test_pr_id = 1
#work
response = list_pull_request_reviewers(id = test_pr_id,
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_reviewer.assert_called_once()
def test_add_pull_request_work_items(self):
response = add_pull_request_work_items(id = 1,
work_items = [2, 4],
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once()
assert self.mock_udpate_WI.call_count == 2
self.mock_get_PR_WIs.assert_called_once()
self.mock_get_WIs.assert_called_once()
def test_list_pull_request_work_items(self):
response = list_pull_request_work_items(id = 1,
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once()
self.mock_get_PR_WIs.assert_called_once()
self.mock_get_WIs.assert_called_once()
def test_vote_pull_request(self):
response = vote_pull_request(id = 1,
vote = 'approve',
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once()
self.mock_create_PR_reviewer.assert_called_once()
def test_convert_vote_to_int(self):
assert _convert_vote_to_int('approve') == 10
assert _convert_vote_to_int('approve-with-suggestions') == 5
assert _convert_vote_to_int('reset') == 0
assert _convert_vote_to_int('wait-for-author') == -5
assert _convert_vote_to_int('reject') == -10
def test_list_pr_policies(self):
test_pr_id = 1
test_project_id = 20
test_repository_id = 25
#big setup because this object is passed around
pr_to_return = GitPullRequest()
pr_to_return.pull_request_id = test_pr_id
pr_to_return.repository = GitRepository()
pr_to_return.repository.id = test_repository_id
pr_to_return.repository.project = TeamProjectReference()
pr_to_return.repository.project.id = test_project_id
self.mock_get_PR_byId.return_value = pr_to_return
response = list_pr_policies(id = 1,
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once()
self.mock_get_policy_evaluation.assert_called_once()
def test_queue_pr_policy(self):
test_pr_id = 1
test_project_id = 20
test_repository_id = 25
#big setup because this object is passed around
pr_to_return = GitPullRequest()
pr_to_return.pull_request_id = test_pr_id
pr_to_return.repository = GitRepository()
pr_to_return.repository.id = test_repository_id
pr_to_return.repository.project = TeamProjectReference()
pr_to_return.repository.project.id = test_project_id
self.mock_get_PR_byId.return_value = pr_to_return
response = queue_pr_policy(id = 1,
evaluation_id = 2,
organization = self._TEST_DEVOPS_ORGANIZATION)
#assert
self.mock_get_PR_byId.assert_called_once()
self.mock_requeue_policy_evaluation.assert_called_once()
if __name__ == '__main__':
unittest.main()
|
