Summary

Added automated flag when closing or editing review requests

Review Request #12051 — Created Feb. 10, 2022 and updated April 6, 2022, 1:06 p.m.

Information

Owner

sheenaNg

Repository

Review Board

Branch

master

Bugs

Depends On

12038

Blocks

12223

Reviewers

Groups

reviewboard

People

Description

Added automated flag to multiple methods related to hostingsvcs close
hook, ReviewRequestResourceAPI Update(), and review_request.close()
to store the value in ChangeDescription model to track automated
closing of review requests

Added automated flag to
ReviewRequestResourceDraftAPI Update(), Create(),
review_request.publish(), draft.publish() to store the value in
ChangeDescription model to track automated upddating/publishing
of review requests

Added automated flag to closed/published signals and email-related methods to render the
review_request_email.txt differently when automated=True

Added codes to change.html template to render RB logo in the
review request change entry when automated=True

Testing Done

Added unit tests to test_email_sending.py
Added unit tests to test_review_request.py
Added unit tests to test_review_request_draft.py
Added unit tests to test_entries.py
Added unit tests to webapi/tests/test_review_request.py
Added unit tests to webapi/tests/test_review_request_draft.py
Added assertion to test_github.py, test_rbgateway.py,
test_bitbucket.py

All tests passed.

Attached screenshots to show changes in close email .txt and
frontend changeEntry.

Commits

Summary	Author
Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
Deleted print statements in unit tests	sng06
Changed variable name to automate	sng06
Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
Added automate fields and made changes to email-related methods based on automate flag value	sng06
Made changes to close email txt template based on automate flag value	sng06
Added unit tests to review_request and test_email_sending test suites	sng06
Added default value to automate argument in close_review_request method	sng06
Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
Added optional for automate field in docstrings	sng06
Fixed review_request_close unit test spy assertion	sng06
Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
Added or edited docstrings and fixed formatting issues	sng06
Added class tag to RB logo avatar rendering in change.html template	sng06
Added unit tests to test changeEntry	sng06
Added automate field to webapi-request-fields decorator for both create and update methods	sng06
added unit tests to test PUT api for submitted and discarded actions	sng06
Deleted print statements	sng06
Edited automate field's description	sng06
Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
Fixed formatting and added docstring	sng06
Added unit tests to test draft-related methods	sng06
Changed review_request close unit test name	sng06
Changed automate to automated and edited unit tests docstrings	sng06
Fixed review request draft unit tests docstrings	sng06
Changed the conditional block to save automated value in extra context using extra_data field	sng06
Fixed formatting issues in review_request and review_request_draft unit tests	sng06
Fixed missing words and periods in docstrings	sng06
Addressed code review feedback received	sng06

Files

Issues

Description	From	Last Updated
Please wrap your description and testing done fields to 70 columns.	david	March 4, 2022, 11:50 p.m.
While we're here, can we rewrite this docstring to follow our modern standards? We probably also want to add a …	david	March 11, 2022, 7:51 p.m.
Instead of assertEqual(..., True), use assertTrue(...).	david	March 3, 2022, 1:13 p.m.
Instead of assertEqual(..., True), use assertTrue(...).	david	March 3, 2022, 1:13 p.m.
Instead of assertEqual(..., True), use assertTrue(...).	david	March 3, 2022, 1:13 p.m.
Please add ", optional" to the type.	david	March 4, 2022, 12:34 a.m.
These can be combined: if not (user or automate):	david	March 4, 2022, 12:35 a.m.
E128 continuation line under-indented for visual indent	reviewbot	March 4, 2022, 11:50 p.m.
Should be marked as optional (and probably the other things in here should be fixed for that as well)	david	March 4, 2022, 12:36 a.m.
As Christian mentioned in our meeting, these should be updated to use kgb's spy assertion methods.	david	March 4, 2022, 12:47 a.m.
E501 line too long (80 > 79 characters)	reviewbot	March 24, 2022, 11:28 p.m.
This should be in the imperative mood ("Close" instead of "Closes")	david	April 6, 2022, 12:58 p.m.
Instead of defining a variable for this, let's just pass automated=True to close_review_request.	david	April 6, 2022, 12:58 p.m.
This is getting so long, can we reformat it to list one parameter per line?	david	April 6, 2022, 12:58 p.m.
This can be simplified: extra_context.update({ 'automated': changedesc.extra_data.get('automated', False), })	david	April 6, 2022, 12:58 p.m.
Test docstrings should always start with "Testing ..."	david	April 6, 2022, 12:58 p.m.
"Testing ..."	david	April 6, 2022, 12:59 p.m.
There's an extra space at the end of this docstring.	david	April 6, 2022, 12:59 p.m.
There's an extra space at the end of this docstring.	david	April 6, 2022, 12:59 p.m.
Please put the """ on the next line.	david	April 6, 2022, 12:59 p.m.
This needs a trailing comma after it.	david	April 6, 2022, 12:59 p.m.
Please put the """ on the next line.	david	April 6, 2022, 12:59 p.m.
Please put the """ on the next line.	david	April 6, 2022, 1 p.m.
This needs a trailing comma after it.	david	April 6, 2022, 1 p.m.
Please put the """ on the next line.	david	April 6, 2022, 1 p.m.
Please put the """ on the next line.	david	April 6, 2022, 1:02 p.m.
This needs a trailing comma after it.	david	April 6, 2022, 1:02 p.m.

flake8 passed.

JSHint passed.

Summary:

-	[WIP] Passed in isAutomatedClose flag to ChangeDescription's extra_data field through the close hook flow
+	[WIP] Passed in automate flag to ChangeDescription's extra_data field

Description:

~		Passed in `isAutomatedClose=True` flag to the ChangeDescription `extra_data` field from `close_all_review_requests()` to `review_request.close()` method triggered by the third-party repo services close webhook.
	~	Added `automate` flag to multiple methods from the close hook `close_all_review_requests()` and `ReviewRequestResource API Update()` to `review_request.close()` in order to store the value in the `extra_data` field of the `ChangeDescription` model.

~		Confirmation needed:
	~	Currently, `automate` value is set to True in the close hook since the repositories that send the webhook will trigger this path. On the other hand, this flag is only added as an additional optional request parameter to the `ReviewRequestResource API Update()` method which will pass it to `review_request.close()`.
-		There are two paths that trigger the `review_request.close()` method. The first one is triggered by the webhook that calls `hostingsvcs/hook_utils.close_all_review_requests()`. The second one is from the `ReviewRequestResource API update()` which is triggered when the “close” button is clicked in client. Since the third-party repo services will only trigger the first path,
-		I only pass in the flag in this path and make it as an optional argument in the `review_request.close()` method definition without touching the ReviewRequestResource API. Please confirm if this is on the right track for this task.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06

Diff:

Revision 2 (+140 -40)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/reviews/models/review_request.py
	reviewboard/reviews/tests/test_review_request.py
	reviewboard/webapi/resources/review_request.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06

Diff:

Revision 3 (+534 -70)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	5 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/notifications/tests/test_email_sending.py (Diff revision 3)
Show all issues
```
E128 continuation line under-indented for visual indent
```

```
Looking good!
```

Regarding the question in your testing done field, editing the existing hook tests is fine to add that one new assertion.

Show all issues

Please wrap your description and testing done fields to 70 columns.

reviewboard/hostingsvcs/hook_utils.py (Diff revision 3)

Show all issues

While we're here, can we rewrite this docstring to follow our modern standards?

We probably also want to add a default value for the automate field in case any extensions are using this API.

reviewboard/hostingsvcs/tests/test_bitbucket.py (Diff revision 3)
Show all issues
```
Instead of assertEqual(..., True), use assertTrue(...).
```
reviewboard/hostingsvcs/tests/test_github.py (Diff revision 3)
Show all issues
```
Instead of assertEqual(..., True), use assertTrue(...).
```
reviewboard/hostingsvcs/tests/test_rbgateway.py (Diff revision 3)
Show all issues
```
Instead of assertEqual(..., True), use assertTrue(...).
```
reviewboard/notifications/email/message.py (Diff revision 3)
Show all issues
```
Please add ", optional" to the type.
```
reviewboard/notifications/email/message.py (Diff revision 3)
Show all issues
```
These can be combined:
if not (user or automate):
```

reviewboard/reviews/models/review_request.py (Diff revision 3)

Show all issues

Should be marked as optional (and probably the other things in here should be fixed for that as well)

reviewboard/reviews/tests/test_review_request.py (Diff revision 3)

Show all issues

As Christian mentioned in our meeting, these should be updated to use kgb's spy assertion methods.

Description:

~		Added `automate` flag to multiple methods from the close hook `close_all_review_requests()` and `ReviewRequestResource API Update()` to `review_request.close()` in order to store the value in the `extra_data` field of the `ChangeDescription` model.
~
~		Currently, `automate` value is set to True in the close hook since the repositories that send the webhook will trigger this path. On the other hand, this flag is only added as an additional optional request parameter to the `ReviewRequestResource API Update()` method which will pass it to `review_request.close()`.
	~	Added `automate` flag to multiple methods related to hostingsvcs close hook, `ReviewRequestResourceAPI Update()`, and `review_request.close()` to store the value in `ChangeDescription` model
	~	Added `automate` flag to close email-related methods to render the .txt email differently when `automate=True`
	~	Added codes to `change.html` template to render RB logo in the review request change entry when `automate=True`

Testing Done:

~		Added unit tests in `test_review_request.py`. Since I can reuse some of the existing tests that call `test_post_commit_hook`, I only added an assert statement to that test in `test_github.py`, `test_bitbucket.py`, and `test_rbgateway`.
~
~		Confirmation needed:
~		Please advice if this is OK or should I create a new unit test with essentially the same code as `test_post_commit_hook` which check for the value in the `extra_data` field for clarity purposes.
	~	Added unit tests to `test_email_sending.py`
	~	Added unit tests to `test_review_request.py`
	~	Added assertion to `test_github.py, test_rbgateway.py, test_bitbucket.py`
	~	Attached screenshots to show changes in close email .txt and frontend changeEntry.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06

Diff:

Revision 4 (+571 -133)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	6 more

Added Files:

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:

		Added unit tests to `test_email_sending.py`
		Added unit tests to `test_review_request.py`
~		Added assertion to `test_github.py, test_rbgateway.py, test_bitbucket.py`
~		Attached screenshots to show changes in close email .txt and frontend changeEntry.
	~	Added unit tests to `test_entries.py`
	~	Added unit tests to `webapi/tests/test_review_request.py`
	+	Added assertion to `test_github.py, test_rbgateway.py, test_bitbucket.py`
	+	Attached screenshots to show changes in close email .txt and frontend changeEntry.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
-	Added default value to automate argument in close_review_request method	sng06
-	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
-	Added optional for automate field in docstrings	sng06
-	Fixed review_request_close unit test spy assertion	sng06
-	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added or edited docstrings and fixed formatting issues	sng06
+	Added class tag to RB logo avatar rendering in change.html template	sng06
+	Added unit tests to test changeEntry	sng06
+	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
+	added unit tests to test PUT api for submitted and discarded actions	sng06
+	Deleted print statements	sng06

Diff:

Revision 5 (+839 -145)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	8 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Added automate field and codes to draft publish operations

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
-	Added default value to automate argument in close_review_request method	sng06
-	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
-	Added optional for automate field in docstrings	sng06
-	Fixed review_request_close unit test spy assertion	sng06
-	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
-	Added or edited docstrings and fixed formatting issues	sng06
-	Added class tag to RB logo avatar rendering in change.html template	sng06
-	Added unit tests to test changeEntry	sng06
-	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
-	added unit tests to test PUT api for submitted and discarded actions	sng06
-	Deleted print statements	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added or edited docstrings and fixed formatting issues	sng06
+	Added class tag to RB logo avatar rendering in change.html template	sng06
+	Added unit tests to test changeEntry	sng06
+	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
+	added unit tests to test PUT api for submitted and discarded actions	sng06
+	Deleted print statements	sng06
+	Edited automate field's description	sng06
+	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06

Diff:

Revision 6 (+929 -169)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	10 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/models/review_request.py (Diff revision 6)
Show all issues
```
E501 line too long (80 > 79 characters)
```

Change Summary:

Added unit tests to test draft operations-related methods

Description:

~		Added `automate` flag to multiple methods related to hostingsvcs close hook, `ReviewRequestResourceAPI Update()`, and `review_request.close()` to store the value in `ChangeDescription` model
~		Added `automate` flag to close email-related methods to render the .txt email differently when `automate=True`
~		Added codes to `change.html` template to render RB logo in the review request change entry when `automate=True`
	~	Added `automate` flag to multiple methods related to hostingsvcs close hook, `ReviewRequestResourceAPI Update()`, and `review_request.close()` to store the value in `ChangeDescription` model to track automated closing of review requests
	~
	~
	+
	+	Added `automate` flag to `ReviewRequestResourceDraftAPI Update(), Create()`, `review_request.publish()`, `draft.publish()` to store the value in `ChangeDescription` model to track automated upddating/publishing of review requests
	+
	+
	+
	+	Added `automate` flag to close email-related methods to render the .txt email differently when `automate=True`
	+
	+
	+
	+	Added codes to `change.html` template to render RB logo in the review request change entry when `automate=True`

Testing Done:

		Added unit tests to `test_email_sending.py`
		Added unit tests to `test_review_request.py`
~		Added unit tests to `test_entries.py`
~		Added unit tests to `webapi/tests/test_review_request.py`
~		Added assertion to `test_github.py, test_rbgateway.py, test_bitbucket.py`
~		Attached screenshots to show changes in close email .txt and frontend changeEntry.
	~	Added unit tests to `test_review_request_draft.py`
	~	Added unit tests to `test_entries.py`
	~	Added unit tests to `webapi/tests/test_review_request.py`
	~	Added unit tests to `webapi/tests/test_review_request_draft.py`
	+	Added assertion to `test_github.py, test_rbgateway.py, test_bitbucket.py`
	+	Attached screenshots to show changes in close email .txt and frontend changeEntry.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
-	Added default value to automate argument in close_review_request method	sng06
-	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
-	Added optional for automate field in docstrings	sng06
-	Fixed review_request_close unit test spy assertion	sng06
-	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
-	Added or edited docstrings and fixed formatting issues	sng06
-	Added class tag to RB logo avatar rendering in change.html template	sng06
-	Added unit tests to test changeEntry	sng06
-	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
-	added unit tests to test PUT api for submitted and discarded actions	sng06
-	Deleted print statements	sng06
-	Edited automate field's description	sng06
-	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added or edited docstrings and fixed formatting issues	sng06
+	Added class tag to RB logo avatar rendering in change.html template	sng06
+	Added unit tests to test changeEntry	sng06
+	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
+	added unit tests to test PUT api for submitted and discarded actions	sng06
+	Deleted print statements	sng06
+	Edited automate field's description	sng06
+	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
+	Fixed formatting and added docstring	sng06
+	Added unit tests to test draft-related methods	sng06
+	Changed review_request close unit test name	sng06

Diff:

Revision 7 (+1717 -215)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	12 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
-	Added default value to automate argument in close_review_request method	sng06
-	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
-	Added optional for automate field in docstrings	sng06
-	Fixed review_request_close unit test spy assertion	sng06
-	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
-	Added or edited docstrings and fixed formatting issues	sng06
-	Added class tag to RB logo avatar rendering in change.html template	sng06
-	Added unit tests to test changeEntry	sng06
-	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
-	added unit tests to test PUT api for submitted and discarded actions	sng06
-	Deleted print statements	sng06
-	Edited automate field's description	sng06
-	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
-	Fixed formatting and added docstring	sng06
-	Added unit tests to test draft-related methods	sng06
-	Changed review_request close unit test name	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added or edited docstrings and fixed formatting issues	sng06
+	Added class tag to RB logo avatar rendering in change.html template	sng06
+	Added unit tests to test changeEntry	sng06
+	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
+	added unit tests to test PUT api for submitted and discarded actions	sng06
+	Deleted print statements	sng06
+	Edited automate field's description	sng06
+	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
+	Fixed formatting and added docstring	sng06
+	Added unit tests to test draft-related methods	sng06
+	Changed review_request close unit test name	sng06
+	Changed automate to automated and edited unit tests docstrings	sng06
+	Fixed review request draft unit tests docstrings	sng06

Diff:

Revision 8 (+1887 -373)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	12 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	[WIP] Passed in automate flag to ChangeDescription's extra_data field
+	Added automated flag when closing or editing review requests

Description:

~		Added `automate` flag to multiple methods related to hostingsvcs close hook, `ReviewRequestResourceAPI Update()`, and `review_request.close()` to store the value in `ChangeDescription` model to track automated closing of review requests
	~	Added `automated` flag to multiple methods related to hostingsvcs close hook, `ReviewRequestResourceAPI Update()`, and `review_request.close()` to store the value in `ChangeDescription` model to track automated closing of review requests



~		Added `automate` flag to `ReviewRequestResourceDraftAPI Update(), Create()`, `review_request.publish()`, `draft.publish()` to store the value in `ChangeDescription` model to track automated upddating/publishing of review requests
	~	Added `automated` flag to `ReviewRequestResourceDraftAPI Update(), Create()`, `review_request.publish()`, `draft.publish()` to store the value in `ChangeDescription` model to track automated upddating/publishing of review requests



~		Added `automate` flag to close email-related methods to render the .txt email differently when `automate=True`
	~	Added `automated` flag to closed/published signals and email-related methods to render the `review_request_email.txt` differently when `automated=True`



~		Added codes to `change.html` template to render RB logo in the review request change entry when `automate=True`
	~	Added codes to `change.html` template to render RB logo in the review request change entry when `automated=True`

Testing Done:

		Added unit tests to `test_email_sending.py`
		Added unit tests to `test_review_request.py`
		Added unit tests to `test_review_request_draft.py`
		Added unit tests to `test_entries.py`
		Added unit tests to `webapi/tests/test_review_request.py`
		Added unit tests to `webapi/tests/test_review_request_draft.py`
~		Added assertion to `test_github.py, test_rbgateway.py, test_bitbucket.py`
~		Attached screenshots to show changes in close email .txt and frontend changeEntry.
	~	Added assertion to `test_github.py`, `test_rbgateway.py`, `test_bitbucket.py`
	~
	+	All tests passed.
	+
	+	Attached screenshots to show changes in close email .txt and frontend changeEntry.

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
-	Added default value to automate argument in close_review_request method	sng06
-	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
-	Added optional for automate field in docstrings	sng06
-	Fixed review_request_close unit test spy assertion	sng06
-	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
-	Added or edited docstrings and fixed formatting issues	sng06
-	Added class tag to RB logo avatar rendering in change.html template	sng06
-	Added unit tests to test changeEntry	sng06
-	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
-	added unit tests to test PUT api for submitted and discarded actions	sng06
-	Deleted print statements	sng06
-	Edited automate field's description	sng06
-	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
-	Fixed formatting and added docstring	sng06
-	Added unit tests to test draft-related methods	sng06
-	Changed review_request close unit test name	sng06
-	Changed automate to automated and edited unit tests docstrings	sng06
-	Fixed review request draft unit tests docstrings	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added or edited docstrings and fixed formatting issues	sng06
+	Added class tag to RB logo avatar rendering in change.html template	sng06
+	Added unit tests to test changeEntry	sng06
+	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
+	added unit tests to test PUT api for submitted and discarded actions	sng06
+	Deleted print statements	sng06
+	Edited automate field's description	sng06
+	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
+	Fixed formatting and added docstring	sng06
+	Added unit tests to test draft-related methods	sng06
+	Changed review_request close unit test name	sng06
+	Changed automate to automated and edited unit tests docstrings	sng06
+	Fixed review request draft unit tests docstrings	sng06
+	Changed the conditional block to save automated value in extra context using extra_data field	sng06
+	Fixed formatting issues in review_request and review_request_draft unit tests	sng06
+	Fixed missing words and periods in docstrings	sng06

Diff:

Revision 9 (+1907 -391)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	12 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/hostingsvcs/hook_utils.py (Diff revision 9)

Show all issues

This should be in the imperative mood ("Close" instead of "Closes")

reviewboard/hostingsvcs/hook_utils.py (Diff revision 9)

Show all issues

Instead of defining a variable for this, let's just pass automated=True to close_review_request.

reviewboard/notifications/email/message.py (Diff revision 9)

Show all issues

This is getting so long, can we reformat it to list one parameter per line?

reviewboard/notifications/email/message.py (Diff revision 9)

Show all issues

This can be simplified:

extra_context.update({
    'automated': changedesc.extra_data.get('automated', False),
})

reviewboard/notifications/tests/test_email_sending.py (Diff revision 9)
Show all issues
```
Test docstrings should always start with "Testing ..."
```
reviewboard/notifications/tests/test_email_sending.py (Diff revision 9)
Show all issues
```
"Testing ..."
```
reviewboard/reviews/tests/test_entries.py (Diff revision 9)
Show all issues
```
There's an extra space at the end of this docstring.
```
reviewboard/reviews/tests/test_entries.py (Diff revision 9)
Show all issues
```
There's an extra space at the end of this docstring.
```
reviewboard/webapi/tests/test_review_request.py (Diff revision 9)
Show all issues
```
Please put the """ on the next line.
```
reviewboard/webapi/tests/test_review_request.py (Diff revision 9)
Show all issues
```
This needs a trailing comma after it.
```
reviewboard/webapi/tests/test_review_request.py (Diff revision 9)
Show all issues
```
Please put the """ on the next line.
```
reviewboard/webapi/tests/test_review_request_draft.py (Diff revision 9)
Show all issues
```
Please put the """ on the next line.
```
reviewboard/webapi/tests/test_review_request_draft.py (Diff revision 9)
Show all issues
```
This needs a trailing comma after it.
```
reviewboard/webapi/tests/test_review_request_draft.py (Diff revision 9)
Show all issues
```
Please put the """ on the next line.
```
reviewboard/webapi/tests/test_review_request_draft.py (Diff revision 9)
Show all issues
```
Please put the """ on the next line.
```
reviewboard/webapi/tests/test_review_request_draft.py (Diff revision 9)
Show all issues
```
This needs a trailing comma after it.
```

Change Summary:

Addressed code review feedback

Commits:

	Summary	Author
-	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
-	Deleted print statements in unit tests	sng06
-	Changed variable name to automate	sng06
-	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
-	Added automate fields and made changes to email-related methods based on automate flag value	sng06
-	Made changes to close email txt template based on automate flag value	sng06
-	Added unit tests to review_request and test_email_sending test suites	sng06
-	Added default value to automate argument in close_review_request method	sng06
-	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
-	Added optional for automate field in docstrings	sng06
-	Fixed review_request_close unit test spy assertion	sng06
-	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
-	Added or edited docstrings and fixed formatting issues	sng06
-	Added class tag to RB logo avatar rendering in change.html template	sng06
-	Added unit tests to test changeEntry	sng06
-	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
-	added unit tests to test PUT api for submitted and discarded actions	sng06
-	Deleted print statements	sng06
-	Edited automate field's description	sng06
-	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
-	Fixed formatting and added docstring	sng06
-	Added unit tests to test draft-related methods	sng06
-	Changed review_request close unit test name	sng06
-	Changed automate to automated and edited unit tests docstrings	sng06
-	Fixed review request draft unit tests docstrings	sng06
-	Changed the conditional block to save automated value in extra context using extra_data field	sng06
-	Fixed formatting issues in review_request and review_request_draft unit tests	sng06
-	Fixed missing words and periods in docstrings	sng06
+	Added isAutomatedClose flag through close hook flow to ChangeDescription's extra_data field and added unit tests	sng06
+	Deleted print statements in unit tests	sng06
+	Changed variable name to automate	sng06
+	Added automate field to ReviewRequestResource API update method and passed it to close method	sng06
+	Added automate fields and made changes to email-related methods based on automate flag value	sng06
+	Made changes to close email txt template based on automate flag value	sng06
+	Added unit tests to review_request and test_email_sending test suites	sng06
+	Added default value to automate argument in close_review_request method	sng06
+	Changed assertEqual to assertTrue for test_post_commit_hook unit test	sng06
+	Added optional for automate field in docstrings	sng06
+	Fixed review_request_close unit test spy assertion	sng06
+	Added codes to render Review Board logo in review request change box when it is closed automatically	sng06
+	Added or edited docstrings and fixed formatting issues	sng06
+	Added class tag to RB logo avatar rendering in change.html template	sng06
+	Added unit tests to test changeEntry	sng06
+	Added automate field to webapi-request-fields decorator for both create and update methods	sng06
+	added unit tests to test PUT api for submitted and discarded actions	sng06
+	Deleted print statements	sng06
+	Edited automate field's description	sng06
+	Added automate field to draft resource PUT endpoint, review request publish-related email methods, draft and review request models	sng06
+	Fixed formatting and added docstring	sng06
+	Added unit tests to test draft-related methods	sng06
+	Changed review_request close unit test name	sng06
+	Changed automate to automated and edited unit tests docstrings	sng06
+	Fixed review request draft unit tests docstrings	sng06
+	Changed the conditional block to save automated value in extra context using extra_data field	sng06
+	Fixed formatting issues in review_request and review_request_draft unit tests	sng06
+	Fixed missing words and periods in docstrings	sng06
+	Addressed code review feedback received	sng06

Diff:

Revision 10 (+1949 -433)

Show changes

	reviewboard/hostingsvcs/hook_utils.py
	reviewboard/hostingsvcs/tests/test_bitbucket.py
	reviewboard/hostingsvcs/tests/test_github.py
	reviewboard/hostingsvcs/tests/test_rbgateway.py
	reviewboard/notifications/email/message.py
	reviewboard/notifications/email/signal_handlers.py
	reviewboard/notifications/email/utils.py
	reviewboard/notifications/tests/test_email_sending.py
	12 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.