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

Review Request #13375 — Created Oct. 24, 2023 and submitted

Information

Review Board
release-5.0.x

Reviewers

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.

Unit tests pass.

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
Description From Last Updated

Typo: "use" -> "user"

maubinmaubin

Missing a trailing : after meth

maubinmaubin

Should be 3-tuple.

maubinmaubin

Should be 4-tuple.

maubinmaubin

Should be 4-tuple.

maubinmaubin

Should be 5-tuple.

maubinmaubin

"post" instead of "delete".

maubinmaubin

Missing a trailing : after meth

maubinmaubin

Should be 6-tuple.

maubinmaubin

Should say "put" instead of "delete".

maubinmaubin
david
  1. Ship It!
  2. 
      
maubin
  1. 
      
    1. Thanks for all the great catches!

  2. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Typo: "use" -> "user"

  3. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Missing a trailing : after meth

  4. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Should be 3-tuple.

  5. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Should be 4-tuple.

  6. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Should be 4-tuple.

  7. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Should be 5-tuple.

  8. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    "post" instead of "delete".

  9. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Missing a trailing : after meth

  10. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Should be 6-tuple.

  11. reviewboard/webapi/tests/mixins.py (Diff revision 1)
     
     
    Show all issues

    Should say "put" instead of "delete".

  12. 
      
chipx86
maubin
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to release-5.0.x (3d65dad)