Summary

Add typing and missing docs for the main API unit tests mixins.

Review Request #13375 — Created Oct. 24, 2023 and submitted Oct. 30, 2023, 3:06 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Blocks

13376

Reviewers

Groups

reviewboard

People

Description

The code for the API unit tests largely preceded much of our modern
codebase standards. It lacked docs, certainly lacked typing, and has a
lot of design choices that limit future expansion.

In preparation for new API work that will be taking place, this change
cleans up this code, adding typing and docs and assertions to ensure
that we have a better foundation for building more manageable test
suites going forward.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add typing and missing docs for the main API unit tests mixins. The code for the API unit tests largely preceded much of our modern codebase standards. It lacked docs, certainly lacked typing, and has a lot of design choices that limit future expansion. In preparation for new API work that will be taking place, this change cleans up this code, adding typing and docs and assertions to ensure that we have a better foundation for building more manageable test suites going forward.	5d24b73a13b04b45ffe8321ab68afa604682ab12

Summary

Add typing and missing docs for the main API unit tests mixins.

The code for the API unit tests largely preceded much of our modern codebase standards. It lacked docs, certainly lacked typing, and has a lot of design choices that limit future expansion. In preparation for new API work that will be taking place, this change cleans up this code, adding typing and docs and assertions to ensure that we have a better foundation for building more manageable test suites going forward.

5d24b73a13b04b45ffe8321ab68afa604682ab12

Issues

Description	From	Last Updated
Typo: "use" -> "user"	maubin	Oct. 27, 2023, 8:43 p.m.
Missing a trailing : after meth	maubin	Oct. 27, 2023, 8:43 p.m.
Should be 3-tuple.	maubin	Oct. 27, 2023, 8:43 p.m.
Should be 4-tuple.	maubin	Oct. 27, 2023, 8:43 p.m.
Should be 4-tuple.	maubin	Oct. 27, 2023, 8:43 p.m.
Should be 5-tuple.	maubin	Oct. 27, 2023, 8:43 p.m.
"post" instead of "delete".	maubin	Oct. 27, 2023, 8:44 p.m.
Missing a trailing : after meth	maubin	Oct. 27, 2023, 8:44 p.m.
Should be 6-tuple.	maubin	Oct. 27, 2023, 8:44 p.m.
Should say "put" instead of "delete".	maubin	Oct. 27, 2023, 8:44 p.m.

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

1. chipx86 Oct. 27, 2023, 8:45 p.m.
  Thanks for all the great catches!
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: "use" -> "user"
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing a trailing : after meth
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be 3-tuple.
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be 4-tuple.
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be 4-tuple.
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be 5-tuple.
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"post" instead of "delete".
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing a trailing : after meth
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be 6-tuple.
```
reviewboard/webapi/tests/mixins.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Should say "put" instead of "delete".
```

Change Summary:

Fixed several issues in the docs.

Commits:

	Summary	ID
	Add typing and missing docs for the main API unit tests mixins. The code for the API unit tests largely preceded much of our modern codebase standards. It lacked docs, certainly lacked typing, and has a lot of design choices that limit future expansion. In preparation for new API work that will be taking place, this change cleans up this code, adding typing and docs and assertions to ensure that we have a better foundation for building more manageable test suites going forward.	4235a67ec1a1985a9157330e1760d391380c3458
	Add typing and missing docs for the main API unit tests mixins. The code for the API unit tests largely preceded much of our modern codebase standards. It lacked docs, certainly lacked typing, and has a lot of design choices that limit future expansion. In preparation for new API work that will be taking place, this change cleans up this code, adding typing and docs and assertions to ensure that we have a better foundation for building more manageable test suites going forward.	5d24b73a13b04b45ffe8321ab68afa604682ab12

Diff:

Revision 2 (+1904 -308)

Show changes

reviewboard/webapi/tests/mixins.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.0.x (3d65dad)