Summary

Status Updates part 6: Add resource for status updates.

Review Request #8407 — Created Sept. 18, 2016 and submitted Sept. 29, 2016, 10:53 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

~~8406~~

Blocks

8408

Commit

2d8b8cc...

Reviewers

Groups

reviewboard

People

Description

This change adds an API endpoint for creating and manipulating status updates.
This is intended to be used by consumers who want to create status updates from
a purely third-party source without writing an extension.

Testing Done

Ran unit tests.

Issues

Description	From	Last Updated
We should have unit tests for POSTing/PUTing with: 1) Bad change IDs 2) Bad review IDs 3) Bad statuses Also, …	chipx86	Sept. 19, 2016, 2:55 p.m.
We should have a docstring here. (I know the others don't, but that's something we need to do at some …	chipx86	Sept. 19, 2016, 10:42 a.m.
Since this is public docs, this should be greatly fleshed out to cover more about what the resource is about. …	chipx86	Sept. 19, 2016, 12:22 p.m.
Can we add some filtering options for timestamps, change description IDs, states, and service IDs, and document those? (This would …	chipx86	Sept. 19, 2016, 2:55 p.m.
Here and in other HTTP handler methods, we should use "Returns." While "Return" is appropriate for codebase docs, API docs …	chipx86	Sept. 19, 2016, 10:48 a.m.
Missing Args and Returns.	chipx86	Sept. 19, 2016, 11:14 a.m.
This should be fleshed out to go into more details about usage. For instance, indicating when a change/review ID would …	chipx86	Sept. 19, 2016, 2:36 p.m.
For consistency with the other resources, can we make this: return 201, { self.item_result_key: status_update, }	chipx86	Sept. 19, 2016, 10:48 a.m.
This needs a docstring for the public API docs.	chipx86	Sept. 19, 2016, 12:22 p.m.
Same comment as above.	chipx86	Sept. 19, 2016, 10:48 a.m.
Missing docstring.	chipx86	Sept. 19, 2016, 12:22 p.m.
This can use the pattern other resources use: for field_name in ('service_id', 'summary', 'description', ...): if field_name in kwargs: setattr(status_update, …	chipx86	Sept. 19, 2016, 10:49 a.m.
This needs to check and return a suitable error.	chipx86	Sept. 19, 2016, 2:40 p.m.
Needs docs.	chipx86	Sept. 19, 2016, 12:22 p.m.
User or unicode	brennie	Sept. 28, 2016, 12:42 p.m.
In part 5, you use done-success and done-failure in the StatusUpdate model.	brennie	Sept. 28, 2016, 12:42 p.m.
Missing Returns	chipx86	Sept. 28, 2016, 2:31 p.m.

The issue has been resolved. Show all issues

We should have unit tests for POSTing/PUTing with:

1) Bad change IDs
2) Bad review IDs
3) Bad statuses

Also, can you run ./contrib/internal/webapi-lint.py and make sure this doesn't introduce new warnings?

reviewboard/testing/testcase.py (Diff revision 1)

The issue has been resolved. Show all issues

We should have a docstring here. (I know the others don't, but that's something we need to do at some point too.)

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been resolved. Show all issues

Since this is public docs, this should be greatly fleshed out to cover more about what the resource is about. Purpose of status updates, how you'd use the resource, etc. would be good.

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been dropped. Show all issues

Can we add some filtering options for timestamps, change description IDs, states, and service IDs, and document those? (This would go in get_queryset, but should be documented here.)

david Sept. 19, 2016, 2:56 p.m.
```
I'd like to add that in a later change.
```

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been resolved. Show all issues

Here and in other HTTP handler methods, we should use "Returns." While "Return" is appropriate for codebase docs, API docs aren't using it.

reviewboard/webapi/resources/status_update.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing Args and Returns.
```

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been resolved. Show all issues

This should be fleshed out to go into more details about usage. For instance, indicating when a change/review ID would be provided, ordering of operations.

david Sept. 19, 2016, 11:48 a.m.

I'm not sure what you mean by "ordering of operations". Can you clarify?

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been resolved. Show all issues

For consistency with the other resources, can we make this:

return 201, {
    self.item_result_key: status_update,
}

reviewboard/webapi/resources/status_update.py (Diff revision 1)
The issue has been resolved. Show all issues
```
This needs a docstring for the public API docs.
```
reviewboard/webapi/resources/status_update.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same comment as above.
```
reviewboard/webapi/resources/status_update.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing docstring.
```

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been resolved. Show all issues

This can use the pattern other resources use:

for field_name in ('service_id', 'summary', 'description', ...):
    if field_name in kwargs:
        setattr(status_update, field_name, kwargs[field_name])

reviewboard/webapi/resources/status_update.py (Diff revision 1)

The issue has been resolved. Show all issues

This needs to check and return a suitable error.

reviewboard/webapi/resources/status_update.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Needs docs.
```

Tool: Pyflakes
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py

Commit:

f830d97fa680cd3cfe41dd1e4ccde79bb191dd89

e495969a155a948ffe86c8738760a407950003ba

Diff:

Revision 2 (+805 -19)

Show changes

	reviewboard/testing/testcase.py
	reviewboard/webapi/resources/__init__.py
	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/resources/status_update.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_review.py
	reviewboard/webapi/tests/test_status_update.py
	reviewboard/webapi/tests/urls.py

Tool: Pyflakes
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py

Change Summary:

Fix a couple small bugs that I encountered trying to actually use this:

The owning user wasn't properly assigned.
The accepted values for the state incorrectly used underscores instead of hyphens.

Commit:

e495969a155a948ffe86c8738760a407950003ba

e8e7f3aded3c529686fc2fbe4e09ec601c286df2

Diff:

Revision 3 (+806 -19)

Show changes

	reviewboard/testing/testcase.py
	reviewboard/webapi/resources/__init__.py
	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/resources/status_update.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_review.py
	reviewboard/webapi/tests/test_status_update.py
	reviewboard/webapi/tests/urls.py

Tool: Pyflakes
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py

reviewboard/testing/testcase.py (Diff revision 3)
The issue has been resolved. Show all issues
```
User or unicode
```

reviewboard/webapi/resources/status_update.py (Diff revision 3)

The issue has been resolved. Show all issues

In part 5, you use done-success and done-failure in the StatusUpdate model.

david Sept. 28, 2016, 12:42 p.m.

Looks like you started reviewing this just before I posted an updated diff with this fixed.

Change Summary:

Fix a docstring.

Commit:

e8e7f3aded3c529686fc2fbe4e09ec601c286df2

5b2ac529176629455c9a0cb1f9c9c9ecd221b82e

Diff:

Revision 4 (+806 -19)

Show changes

	reviewboard/testing/testcase.py
	reviewboard/webapi/resources/__init__.py
	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/resources/status_update.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_review.py
	reviewboard/webapi/tests/test_status_update.py
	reviewboard/webapi/tests/urls.py

Tool: Pyflakes
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py

reviewboard/testing/testcase.py (Diff revision 4)

The issue has been resolved. Show all issues

Missing Returns

Change Summary:

Fix a docstring.

Commit:

5b2ac529176629455c9a0cb1f9c9c9ecd221b82e

2d8b8cc20e7aeac179c11fbf905e4e2722eb521b

Diff:

Revision 5 (+810 -19)

Show changes

	reviewboard/testing/testcase.py
	reviewboard/webapi/resources/__init__.py
	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/resources/status_update.py
	reviewboard/webapi/tests/mimetypes.py
	reviewboard/webapi/tests/test_review.py
	reviewboard/webapi/tests/test_status_update.py
	reviewboard/webapi/tests/urls.py

Tool: Pyflakes
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/testing/testcase.py
    reviewboard/webapi/resources/__init__.py
    reviewboard/webapi/tests/test_review.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_status_update.py
    reviewboard/webapi/tests/urls.py
    reviewboard/webapi/tests/mimetypes.py
    reviewboard/webapi/resources/status_update.py

Ship it!

```
Ship It!
```

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