Summary

Display the count of issues waiting for verification in the ReviewRequest API

Review Request #9496 — Created Jan. 19, 2018 and submitted Feb. 2, 2018, 3:38 p.m.

Information

Owner

jtrang

Repository

Review Board

Branch

release-3.0.x

Bugs

4636

Depends On

Commit

ab14668...

Reviewers

Groups

reviewboard, students

People

Description

When fetching the JSON from the ReviewRequest API using
GET review-requests/<id>/, the field issue_verifying_count is
missing and should be included.

Note that this field already exists in the review request model, and
counts issues which have the status VERIFYING_RESOLVED or
VERIFYING_DROPPED, and these issues are not included in the currently
displayed fields which are issue_dropped_count, issue_open_count
and issue_resolved_count.

With this fix, we display the field issue_verifying_count in the JSON.
Also, a unit test is included to assert that all four issue count fields
are visible.

Testing Done


User has a review with one open issue and one issue

awaiting verification.
Using httpie, run http :8080/api/review-requests/<id>/
Expected output contains:

        "issue_dropped_count": 0,
        "issue_open_count": 1,
        "issue_resolved_count": 0,
        "issue_verifying_count": 1,


Run the new unit test

./tests/runtests.py
    reviewboard.webapi.tests.test_review_request:
    ResourceItemTests.test_get_contains_all_issue_counts

Issues

Description	From	Last Updated
You'll need to update unit tests for this as well, to ensure this works as expected and never regresses.	chipx86	Jan. 20, 2018, 8:40 a.m.
The description needs a bit of work. See https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/ for what we expect on all the fields.	chipx86	Jan. 20, 2018, 8:52 a.m.
The bug number should go in the bugs field.	brennie	Jan. 20, 2018, 9:06 a.m.
Can you wrap your description and testing done at 72 characters?	brennie	Jan. 20, 2018, 9:06 a.m.
Summaries shouldn't end in a period.	brennie	Jan. 20, 2018, 9:06 a.m.
E501 line too long (81 > 79 characters)	reviewbot	Jan. 19, 2018, 8:56 a.m.
2.0 is an old release. We'll target this fix for 3.0.3 instead. Can you update this to specify that version?	chipx86	Jan. 20, 2018, 8:41 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/webapi/resources/review_request.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E501 line too long (81 > 79 characters)
```

Summary:

ticket-4636 Add issue_verifying_count field in request_request.py in webapi

Display the count of issues waiting for verification in the ReviewRequest API.

Description:

~		Display the count of issues waiting for verification in the ReviewRequest API.
	~	When fetching the JSON from the ReviewRequest API, the count of issues waiting for verification is missing.
	+
	+	Now, display the field "issue_verifying_count" in the JSON.

Testing Done:

~		When fetching the JSON from the ReviewRequest API, the count of issues waiting for verification is missing.
~
~		Now, display the field "issue_verifying_count" in the JSON.
	~	User has a review with one open issue and one issue awaiting verification.
	~	Run "http :8080/api/review-requests/<id>/" in the command line (using httpie)
	~	Expected output contains: "issue_dropped_count": 0, "issue_open_count": 1, "issue_resolved_count": 0, "issue_verifying_count": 1,
-
-		Testing:
-		- User has a review with one open issue and one issue awaiting verification.
-		- Run "http :8080/api/review-requests/<id>/" in the command line (using httpie)
-		- Expected output contains:
-		"issue_dropped_count": 0,
-		"issue_open_count": 1,
-		"issue_resolved_count": 0,
-		"issue_verifying_count": 1,

Commit:

a943ba39f1e57573c69898f19ac339c1822303d7

a1e7f942d6dee5de6225ce39fd4347eea29ea211

Diff:

Revision 2 (+10 -2)

Show changes

reviewboard/webapi/resources/review_request.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

You'll need to update unit tests for this as well, to ensure this works as expected and never regresses.

The issue has been resolved. Show all issues

The description needs a bit of work. See https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/ for what we expect on all the fields.

reviewboard/webapi/resources/review_request.py (Diff revision 2)

The issue has been resolved. Show all issues

2.0 is an old release. We'll target this fix for 3.0.3 instead. Can you update this to specify that version?

Description:

~		When fetching the JSON from the ReviewRequest API, the count of issues waiting for verification is missing.
	~	When fetching the JSON from the ReviewRequest API using `GET review-requests/<id>/`, the field `issue_verifying_count` is missing and should be included.

~		Now, display the field "issue_verifying_count" in the JSON.
	~	Note that this field already exists in the review request model, and counts issues which have the status `VERIFYING_RESOLVED` or `VERIFYING_DROPPED`, and these issues are not included in the currently displayed fields which are `issue_dropped_count`, `issue_open_count` and `issue_resolved_count`.
	+
	+	With this fix, we display the field `issue_verifying_count` in the JSON. Also, a unit test is included to assert that all four issue count fields are visible.

Testing Done:

		User has a review with one open issue and one issue awaiting verification.
~		Run "http :8080/api/review-requests/<id>/" in the command line (using httpie)
~		Expected output contains: "issue_dropped_count": 0, "issue_open_count": 1, "issue_resolved_count": 0, "issue_verifying_count": 1,
	~	Run `http :8080/api/review-requests/<id>/` in the command line (using httpie)
	~	Expected output contains:
	+
	+	`"issue_dropped_count": 0,`
	+	"issue_open_count": 1,
	+	"issue_resolved_count": 0,
	+	"issue_verifying_count": 1,
	+
	+
	+	Run the new unit test `./tests/runtests.py reviewboard.webapi.tests.test_review_request:ResourceItemTests.test_get_contains_all_issue_counts`

Commit:

a1e7f942d6dee5de6225ce39fd4347eea29ea211

ab1466822b8a15c0479bad4217a99dd5570cf0f9

Diff:

Revision 3 (+28 -2)

Show changes

	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/tests/test_review_request.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

Some minor formatting nits from me, then Ship It!

The issue has been resolved. Show all issues

The bug number should go in the bugs field.

The issue has been resolved. Show all issues

Can you wrap your description and testing done at 72 characters?

The issue has been resolved. Show all issues
```
Summaries shouldn't end in a period.
```

Summary:: Display the count of issues waiting for verification in the ReviewRequest API.
Display the count of issues waiting for verification in the ReviewRequest API
Description:: ~
When fetching the JSON from the ReviewRequest API using GET review-requests/<id>/, the field issue_verifying_count is missing and should be included.
~
When fetching the JSON from the ReviewRequest API using
+ GET review-requests/<id>/, the field issue_verifying_count is
+ missing and should be included.

~
Note that this field already exists in the review request model, and counts issues which have the status VERIFYING_RESOLVED or VERIFYING_DROPPED, and these issues are not included in the currently displayed fields which are issue_dropped_count, issue_open_count and issue_resolved_count.
~

~
With this fix, we display the field issue_verifying_count in the JSON. Also, a unit test is included to assert that all four issue count fields are visible.
~
Note that this field already exists in the review request model, and
+ counts issues which have the status VERIFYING_RESOLVED or
+ VERIFYING_DROPPED, and issues are not included in the currently
+ displayed fields which are issue_dropped_count, issue_open_count
+ and issue_resolved_count.
+
+
+
+
With this fix, we display the field issue_verifying_count in the JSON.
+ Also, a unit test is included to assert that all four issue count fields
+ are visible.
Testing Done:: ~
User has a review with one open issue and one issue awaiting verification.
~
Run http :8080/api/review-requests/<id>/ in the command line (using httpie)
~
User has a review with one open issue and one issue
awaiting verification.
~
Using httpie, run http :8080/api/review-requests/<id>/

Expected output contains:

"issue_dropped_count": 0,

"issue_open_count": 1,

"issue_resolved_count": 0,

"issue_verifying_count": 1,

~
Run the new unit test ./tests/runtests.py reviewboard.webapi.tests.test_review_request:ResourceItemTests.test_get_contains_all_issue_counts
~
Run the new unit test
./tests/runtests.py reviewboard.webapi.tests.test_review_request: ResourceItemTests.test_get_contains_all_issue_counts
Bugs:: 4636

Description:: When fetching the JSON from the ReviewRequest API using
GET review-requests/<id>/, the field issue_verifying_count is
missing and should be included.

Note that this field already exists in the review request model, and
counts issues which have the status VERIFYING_RESOLVED or
~ VERIFYING_DROPPED, and issues are not included in the currently
~ VERIFYING_DROPPED, and these issues are not included in the currently
displayed fields which are issue_dropped_count, issue_open_count
and issue_resolved_count.

With this fix, we display the field issue_verifying_count in the JSON.
Also, a unit test is included to assert that all four issue count fields
are visible.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (f479737)

~		When fetching the JSON from the ReviewRequest API using `GET review-requests/<id>/`, the field `issue_verifying_count` is missing and should be included.
	~	When fetching the JSON from the ReviewRequest API using
	+	`GET review-requests/<id>/`, the field `issue_verifying_count` is
	+	missing and should be included.

~		Note that this field already exists in the review request model, and counts issues which have the status `VERIFYING_RESOLVED` or `VERIFYING_DROPPED`, and these issues are not included in the currently displayed fields which are `issue_dropped_count`, `issue_open_count` and `issue_resolved_count`.
	~

~		With this fix, we display the field `issue_verifying_count` in the JSON. Also, a unit test is included to assert that all four issue count fields are visible.
	~	Note that this field already exists in the review request model, and
	+	counts issues which have the status `VERIFYING_RESOLVED` or
	+	`VERIFYING_DROPPED`, and issues are not included in the currently
	+	displayed fields which are `issue_dropped_count`, `issue_open_count`
	+	and `issue_resolved_count`.
	+
	+
	+
	+	With this fix, we display the field `issue_verifying_count` in the JSON.
	+	Also, a unit test is included to assert that all four issue count fields
	+	are visible.