Send Build Status Report Using GitHub Status API #5865

saadmk11 · 2019-06-28T21:15:54Z

Sending build status pending and suncess or failed using GitHub Status API.
Will extend this for other services in the future (e.g: gitlab, bitbucket)

TODO:

Add Tests.

ericholscher

This looks pretty simple and like a good approach. Just a few small tidbits I noticed.

readthedocs/builds/constants.py

readthedocs/builds/models.py

readthedocs/oauth/services/github.py

readthedocs/core/utils/__init__.py

readthedocs/projects/tasks.py

stsewd · 2019-07-02T03:02:41Z

readthedocs/core/utils/__init__.py

@@ -125,6 +128,10 @@ def prepare_build(
    options['soft_time_limit'] = time_limit
    options['time_limit'] = int(time_limit * 1.2)

+    if build:
+        # Send pending Build Status to Git Status API
+        send_build_status.delay(build.id, BUILD_STATUS_PENDING)


not sure if calling this from here is the best place. I don't have a suggestion yet, but I'll try to dig the code. Also, we have signals to report the build status, maybe we can use those

@stsewd I couldn't not find a better place for this . we should send the status report as soon as possible. please suggest me a better place when you get time :)

readthedocs/oauth/services/github.py

readthedocs/projects/tasks.py

readthedocs/oauth/services/github.py

ericholscher

Good changes and refactors. This is getting closer 👍

I also want to test this locally, but probably won't have time today for it.

readthedocs/builds/models.py

readthedocs/doc_builder/environments.py

readthedocs/oauth/services/base.py

ericholscher · 2019-07-08T19:27:58Z

readthedocs/projects/tasks.py

+            self.send_build_status(
+                self.build['id'], BUILD_STATUS_FAILURE
+            )
+        elif self.build_env.successful:


What is the other state here? Should this just be an else? If not, we should do an else with a log.warning.

@ericholscher there are no other states (BuildEnvironment) , it will succeed or fail (in the Build Environment) at this point of the build. we could add an warning if we want. but I don't think we need to :)

readthedocs/projects/tasks.py

ericholscher · 2019-07-08T19:31:10Z

readthedocs/projects/tasks.py

+    # TODO: Send build status for other providers.
+
+
+def send_external_build_status(build_pk, state):


Shouldn't this function be in utils instead of tasks?

This will just create a circular import error, as the send_build_status task is already in the task.py file

ericholscher

Looks good on my side 👍

stsewd

Just some small things, nothing blocking 👍

stsewd · 2019-07-09T22:18:07Z

readthedocs/rtd_tests/tests/test_celery.py

+        tasks.send_build_status(external_build, BUILD_STATUS_SUCCESS)
+
+        send_build_status.assert_not_called()
+        mock_logger.info.assert_called_with(


I don't think mocking the logger is needed for this test

stsewd · 2019-07-09T22:20:07Z

readthedocs/rtd_tests/tests/test_oauth.py

+        self.assertFalse(success)
+        mock_logger.exception.assert_called_with(
+                'GitHub commit status creation failed for project: %s',
+                self.project,


Looks like there is an extra level of indentation here

ericholscher · 2019-07-10T22:25:47Z

🎉

saadmk11 requested review from ericholscher and a team June 28, 2019 21:15

saadmk11 added the PR: work in progress Pull request is not ready for full review label Jun 28, 2019

saadmk11 changed the title ~~End Build Status Report Using GitHub Status API~~ Send Build Status Report Using GitHub Status API Jun 28, 2019

ericholscher reviewed Jul 1, 2019

View reviewed changes

stsewd reviewed Jul 2, 2019

View reviewed changes

readthedocs/oauth/services/github.py Show resolved Hide resolved

readthedocs/oauth/services/github.py Outdated Show resolved Hide resolved

stsewd reviewed Jul 2, 2019

View reviewed changes

readthedocs/oauth/services/github.py Show resolved Hide resolved

stsewd reviewed Jul 2, 2019

View reviewed changes

readthedocs/oauth/services/github.py Outdated Show resolved Hide resolved

saadmk11 added 11 commits July 4, 2019 19:18

Send Build Status using Github Status API

40fb6ee

docstring update

c561486

Updated Constants and notification sending

3cf07f2

cleanup

d9a867b

task update

ef6707b

send_build_status updated

66526be

updated get full url

8f2505a

changed to PRODUCTION_DOMAIN

ac67805

tasks updated

95264e0

some tests added

1c0dda5

send_build_status tests added

9b10ea6

saadmk11 force-pushed the github-status-api branch from 09ca1ad to 9b10ea6 Compare July 4, 2019 13:18

tests for tasks added

e8098fb

saadmk11 requested review from ericholscher, a team and stsewd July 4, 2019 14:27

saadmk11 added 2 commits July 5, 2019 01:33

try catch added to task

e7a1641

exception log updated

917b2e5

saadmk11 removed the PR: work in progress Pull request is not ready for full review label Jul 6, 2019

ericholscher reviewed Jul 8, 2019

View reviewed changes

saadmk11 added 3 commits July 9, 2019 18:27

update send_build_status process

f9634b6

removed gitlab build status constants

ec1c6a4

lint fix

edab9b3

saadmk11 requested a review from ericholscher July 9, 2019 15:54

ericholscher approved these changes Jul 9, 2019

View reviewed changes

stsewd approved these changes Jul 9, 2019

View reviewed changes

remove log test

1117caa

ericholscher merged commit c4f06dc into readthedocs:gsoc-19-pr-builder Jul 10, 2019

saadmk11 deleted the github-status-api branch July 11, 2019 01:23

saadmk11 mentioned this pull request Aug 7, 2019

Extend webhook notifications with build status #5621

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Send Build Status Report Using GitHub Status API #5865

Send Build Status Report Using GitHub Status API #5865

saadmk11 commented Jun 28, 2019 •

edited

Loading

ericholscher left a comment •

edited

Loading

stsewd Jul 2, 2019

saadmk11 Jul 2, 2019

ericholscher left a comment •

edited

Loading

ericholscher Jul 8, 2019

saadmk11 Jul 9, 2019 •

edited

Loading

ericholscher Jul 8, 2019

saadmk11 Jul 9, 2019

ericholscher left a comment

stsewd left a comment

stsewd Jul 9, 2019

stsewd Jul 9, 2019

ericholscher commented Jul 10, 2019

		# TODO: Send build status for other providers.


		def send_external_build_status(build_pk, state):

Send Build Status Report Using GitHub Status API #5865

Send Build Status Report Using GitHub Status API #5865

Conversation

saadmk11 commented Jun 28, 2019 • edited Loading

ericholscher left a comment • edited Loading

Choose a reason for hiding this comment

stsewd Jul 2, 2019

Choose a reason for hiding this comment

saadmk11 Jul 2, 2019

Choose a reason for hiding this comment

ericholscher left a comment • edited Loading

Choose a reason for hiding this comment

ericholscher Jul 8, 2019

Choose a reason for hiding this comment

saadmk11 Jul 9, 2019 • edited Loading

Choose a reason for hiding this comment

ericholscher Jul 8, 2019

Choose a reason for hiding this comment

saadmk11 Jul 9, 2019

Choose a reason for hiding this comment

ericholscher left a comment

Choose a reason for hiding this comment

stsewd left a comment

Choose a reason for hiding this comment

stsewd Jul 9, 2019

Choose a reason for hiding this comment

stsewd Jul 9, 2019

Choose a reason for hiding this comment

ericholscher commented Jul 10, 2019

saadmk11 commented Jun 28, 2019 •

edited

Loading

ericholscher left a comment •

edited

Loading

ericholscher left a comment •

edited

Loading

saadmk11 Jul 9, 2019 •

edited

Loading