Skip to content

Commit b333b97

Browse files
stsewdstsewd
authored
Service: kwargs only when sending build statuses (#12007)
A small refactor extracted from #11942
1 parent bdca0bd commit b333b97

File tree

6 files changed

+36
-24
lines changed

6 files changed

+36
-24
lines changed

‎readthedocs/builds/tasks.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -416,9 +416,9 @@ def send_build_status(build_pk, commit, status):
416416

417417
for service in service_class.for_project(build.project):
418418
success = service.send_build_status(
419-
build,
420-
commit,
421-
status,
419+
build=build,
420+
commit=commit,
421+
status=status,
422422
)
423423
if success:
424424
log.debug("Build status report sent correctly.")

‎readthedocs/oauth/services/base.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def update_webhook(self, project, integration):
8686
"""
8787
raise NotImplementedError
8888

89-
def send_build_status(self, build, commit, status):
89+
def send_build_status(self, *, build, commit, status):
9090
"""
9191
Create commit status for project.
9292

‎readthedocs/oauth/services/github.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ def update_webhook(self, project, integration):
406406

407407
return (False, resp)
408408

409-
def send_build_status(self, build, commit, status):
409+
def send_build_status(self, *, build, commit, status):
410410
"""
411411
Create GitHub commit status for project.
412412

‎readthedocs/oauth/services/gitlab.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ def update_webhook(self, project, integration):
495495

496496
return (False, resp)
497497

498-
def send_build_status(self, build, commit, status):
498+
def send_build_status(self, *, build, commit, status):
499499
"""
500500
Create GitLab commit status for project.
501501

‎readthedocs/rtd_tests/tests/test_celery.py

+12-12
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ def test_send_build_status_with_remote_repo_github(self, send_build_status):
103103
)
104104

105105
send_build_status.assert_called_once_with(
106-
external_build,
107-
external_build.commit,
108-
BUILD_STATUS_SUCCESS,
106+
build=external_build,
107+
commit=external_build.commit,
108+
status=BUILD_STATUS_SUCCESS,
109109
)
110110
self.assertEqual(Notification.objects.count(), 0)
111111

@@ -123,9 +123,9 @@ def test_send_build_status_with_social_account_github(self, send_build_status):
123123
)
124124

125125
send_build_status.assert_called_once_with(
126-
external_build,
127-
external_build.commit,
128-
BUILD_STATUS_SUCCESS,
126+
build=external_build,
127+
commit=external_build.commit,
128+
status=BUILD_STATUS_SUCCESS,
129129
)
130130
self.assertEqual(Notification.objects.count(), 0)
131131

@@ -176,9 +176,9 @@ def test_send_build_status_with_remote_repo_gitlab(self, send_build_status):
176176
)
177177

178178
send_build_status.assert_called_once_with(
179-
external_build,
180-
external_build.commit,
181-
BUILD_STATUS_SUCCESS,
179+
build=external_build,
180+
commit=external_build.commit,
181+
status=BUILD_STATUS_SUCCESS,
182182
)
183183
self.assertEqual(Notification.objects.count(), 0)
184184

@@ -196,9 +196,9 @@ def test_send_build_status_with_social_account_gitlab(self, send_build_status):
196196
)
197197

198198
send_build_status.assert_called_once_with(
199-
external_build,
200-
external_build.commit,
201-
BUILD_STATUS_SUCCESS,
199+
build=external_build,
200+
commit=external_build.commit,
201+
status=BUILD_STATUS_SUCCESS,
202202
)
203203
self.assertEqual(Notification.objects.count(), 0)
204204

‎readthedocs/rtd_tests/tests/test_oauth.py

+18-6
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,9 @@ def test_multiple_users_same_repo(self):
305305
def test_send_build_status_successful(self, session, mock_logger):
306306
session.post.return_value.status_code = 201
307307
success = self.service.send_build_status(
308-
self.external_build, self.external_build.commit, BUILD_STATUS_SUCCESS
308+
build=self.external_build,
309+
commit=self.external_build.commit,
310+
status=BUILD_STATUS_SUCCESS,
309311
)
310312

311313
self.assertTrue(success)
@@ -319,7 +321,9 @@ def test_send_build_status_successful(self, session, mock_logger):
319321
def test_send_build_status_404_error(self, session, mock_logger):
320322
session.post.return_value.status_code = 404
321323
success = self.service.send_build_status(
322-
self.external_build, self.external_build.commit, BUILD_STATUS_SUCCESS
324+
build=self.external_build,
325+
commit=self.external_build.commit,
326+
status=BUILD_STATUS_SUCCESS,
323327
)
324328

325329
self.assertFalse(success)
@@ -333,7 +337,9 @@ def test_send_build_status_404_error(self, session, mock_logger):
333337
def test_send_build_status_value_error(self, session, mock_logger):
334338
session.post.side_effect = ValueError
335339
success = self.service.send_build_status(
336-
self.external_build, self.external_build.commit, BUILD_STATUS_SUCCESS
340+
build=self.external_build,
341+
commit=self.external_build.commit,
342+
status=BUILD_STATUS_SUCCESS,
337343
)
338344

339345
self.assertFalse(success)
@@ -1163,7 +1169,9 @@ def test_send_build_status_successful(self, repo_id, session, mock_logger):
11631169
repo_id().return_value = "9999"
11641170

11651171
success = self.service.send_build_status(
1166-
self.external_build, self.external_build.commit, BUILD_STATUS_SUCCESS
1172+
build=self.external_build,
1173+
commit=self.external_build.commit,
1174+
status=BUILD_STATUS_SUCCESS,
11671175
)
11681176

11691177
self.assertTrue(success)
@@ -1180,7 +1188,9 @@ def test_send_build_status_404_error(self, repo_id, session, mock_logger):
11801188
repo_id.return_value = "9999"
11811189

11821190
success = self.service.send_build_status(
1183-
self.external_build, self.external_build.commit, BUILD_STATUS_SUCCESS
1191+
build=self.external_build,
1192+
commit=self.external_build.commit,
1193+
status=BUILD_STATUS_SUCCESS,
11841194
)
11851195

11861196
self.assertFalse(success)
@@ -1197,7 +1207,9 @@ def test_send_build_status_value_error(self, repo_id, session, mock_logger):
11971207
repo_id().return_value = "9999"
11981208

11991209
success = self.service.send_build_status(
1200-
self.external_build, self.external_build.commit, BUILD_STATUS_SUCCESS
1210+
build=self.external_build,
1211+
commit=self.external_build.commit,
1212+
status=BUILD_STATUS_SUCCESS,
12011213
)
12021214

12031215
self.assertFalse(success)

0 commit comments

Comments
 (0)