Deprecate response_###() methods and add missing HTTP status assertions

README.md

@@ -232,11 +232,14 @@ def test_better_status(self):
     self.assert_http_200_ok(response)
 ```
 
-Django-test-plus provides a majority of the status codes assertions for you. The status assertions
+Django-test-plus provides assertions for all standard HTTP status codes. The status assertions
 can be found in their own [mixin](https://github.com/revsys/django-test-plus/blob/main/test_plus/status_codes.py)
-and should be searchable if you're using an IDE like pycharm. It should be noted that in previous
-versions, django-test-plus had assertion methods in the pattern of `response_###()`, which are still
-available but have since been deprecated. See below for a list of those methods.
+and should be searchable if you're using an IDE like pycharm.
+
+It should be noted that in previous versions, django-test-plus had assertion methods in the pattern
+of `response_###()`. These methods are still available but are now **deprecated** and will emit
+`DeprecationWarning` when used. You should migrate to the new `assert_http_###_<status_name>()`
+methods. See below for a list of the deprecated methods.
 
 Each of the assertion methods takes an optional Django test client `response` and a string `msg` argument
 that, if specified, is used as the error message when a failure occurs. The methods,

docs/methods.rst

@@ -148,7 +148,9 @@ With django-test-plus you can shorten that to be::
         response = self.get('my-url-name')
         self.assert_http_200_ok(response)
 
-Django-test-plus provides a majority of the status codes assertions for you. The status assertions can be found in their own `mixin <https://github.com/revsys/django-test-plus/blob/main/test_plus/status_codes.py>`__ and should be searchable if you're using an IDE like pycharm. It should be noted that in previous versions, django-test-plus had assertion methods in the pattern of ``response_###()``, which are still available but have since been deprecated. See below for a list of those methods.
+Django-test-plus provides assertions for all standard HTTP status codes. The status assertions can be found in their own `mixin <https://github.com/revsys/django-test-plus/blob/main/test_plus/status_codes.py>`__ and should be searchable if you're using an IDE like pycharm.
+
+It should be noted that in previous versions, django-test-plus had assertion methods in the pattern of ``response_###()``. These methods are still available but are now **deprecated** and will emit ``DeprecationWarning`` when used. You should migrate to the new ``assert_http_###_<status_name>()`` methods. See below for a list of the deprecated methods.
 
 Each of the assertion methods takes an optional Django test client ``response`` and a string ``msg`` argument that, if specified, is used as the error message when a failure occurs. The methods, ``assert_http_301_moved_permanently`` and ``assert_http_302_found`` also take an optional ``url`` argument that if passed, will check to make sure the ``response.url`` matches.
 

test_plus/status_codes.py

@@ -15,178 +15,253 @@ def _assert_http_status(self, status_code, response=None, msg=None, url=None):
             self.assertEqual(response.url, url)
 
     def assert_http_100_continue(self, response=None, msg=None):
+        """Server has received request headers and client should proceed to send request body."""
         self._assert_http_status(100, response=response, msg=msg)
 
     def assert_http_101_switching_protocols(self, response=None, msg=None):
+        """Server is switching protocols as requested by the client."""
         self._assert_http_status(101, response=response, msg=msg)
 
+    def assert_http_103_early_hints(self, response=None, msg=None):
+        """Used to return some response headers before final HTTP message."""
+        self._assert_http_status(103, response=response, msg=msg)
+
     def assert_http_200_ok(self, response=None, msg=None):
+        """Request succeeded."""
         self._assert_http_status(200, response=response, msg=msg)
 
     def assert_http_201_created(self, response=None, msg=None):
+        """Request succeeded and a new resource was created."""
         self._assert_http_status(201, response=response, msg=msg)
 
     def assert_http_202_accepted(self, response=None, msg=None):
+        """Request received but not yet acted upon."""
         self._assert_http_status(202, response=response, msg=msg)
 
     def assert_http_203_non_authoritative_information(self, response=None, msg=None):
+        """Returned metadata is not from the origin server but from a third party."""
         self._assert_http_status(203, response=response, msg=msg)
 
     def assert_http_204_no_content(self, response=None, msg=None):
+        """Request succeeded but no content to send back."""
         self._assert_http_status(204, response=response, msg=msg)
 
     def assert_http_205_reset_content(self, response=None, msg=None):
+        """Request succeeded and client should reset the document view."""
         self._assert_http_status(205, response=response, msg=msg)
 
     def assert_http_206_partial_content(self, response=None, msg=None):
+        """Request succeeded and body contains requested ranges of data."""
         self._assert_http_status(206, response=response, msg=msg)
 
     def assert_http_207_multi_status(self, response=None, msg=None):
+        """Response conveys information about multiple resources (WebDAV)."""
         self._assert_http_status(207, response=response, msg=msg)
 
     def assert_http_208_already_reported(self, response=None, msg=None):
+        """Members of a DAV binding have already been enumerated (WebDAV)."""
         self._assert_http_status(208, response=response, msg=msg)
 
     def assert_http_226_im_used(self, response=None, msg=None):
+        """Server has fulfilled a request for the resource with instance manipulations applied."""
         self._assert_http_status(226, response=response, msg=msg)
 
     def assert_http_300_multiple_choices(self, response=None, msg=None):
+        """Request has multiple possible responses."""
         self._assert_http_status(300, response=response, msg=msg)
 
     def assert_http_301_moved_permanently(self, response=None, msg=None, url=None):
+        """URL of requested resource has been changed permanently."""
         self._assert_http_status(301, response=response, msg=msg, url=url)
 
     def assert_http_302_found(self, response=None, msg=None, url=None):
+        """Resource temporarily located at a different URI."""
         self._assert_http_status(302, response=response, msg=msg, url=url)
 
     def assert_http_303_see_other(self, response=None, msg=None):
+        """Server redirects to get the requested resource at another URI."""
         self._assert_http_status(303, response=response, msg=msg)
 
     def assert_http_304_not_modified(self, response=None, msg=None):
+        """Response has not been modified, client can use cached version."""
         self._assert_http_status(304, response=response, msg=msg)
 
     def assert_http_305_use_proxy(self, response=None, msg=None):
+        """Response must be accessed through a proxy (deprecated)."""
         self._assert_http_status(305, response=response, msg=msg)
 
     def assert_http_306_reserved(self, response=None, msg=None):
+        """No longer used, reserved for future use."""
         self._assert_http_status(306, response=response, msg=msg)
 
     def assert_http_307_temporary_redirect(self, response=None, msg=None):
+        """Resource temporarily located at a different URI, method must not change."""
         self._assert_http_status(307, response=response, msg=msg)
 
     def assert_http_308_permanent_redirect(self, response=None, msg=None):
+        """Resource permanently located at a different URI, method must not change."""
         self._assert_http_status(308, response=response, msg=msg)
 
     def assert_http_400_bad_request(self, response=None, msg=None):
+        """Server cannot process request due to client error."""
         self._assert_http_status(400, response=response, msg=msg)
 
     def assert_http_401_unauthorized(self, response=None, msg=None):
+        """Request requires user authentication."""
         self._assert_http_status(401, response=response, msg=msg)
 
     def assert_http_402_payment_required(self, response=None, msg=None):
+        """Reserved for future use in digital payment systems."""
         self._assert_http_status(402, response=response, msg=msg)
 
     def assert_http_403_forbidden(self, response=None, msg=None):
+        """Server refuses to authorize the request."""
         self._assert_http_status(403, response=response, msg=msg)
 
     def assert_http_404_not_found(self, response=None, msg=None):
+        """Server cannot find the requested resource."""
         self._assert_http_status(404, response=response, msg=msg)
 
     def assert_http_405_method_not_allowed(self, response=None, msg=None):
+        """Request method not supported for the requested resource."""
         self._assert_http_status(405, response=response, msg=msg)
 
     def assert_http_406_not_acceptable(self, response=None, msg=None):
+        """Server cannot produce a response matching the Accept headers."""
         self._assert_http_status(406, response=response, msg=msg)
 
     def assert_http_407_proxy_authentication_required(self, response=None, msg=None):
+        """Client must authenticate with the proxy."""
         self._assert_http_status(407, response=response, msg=msg)
 
     def assert_http_408_request_timeout(self, response=None, msg=None):
+        """Server timed out waiting for the request."""
         self._assert_http_status(408, response=response, msg=msg)
 
     def assert_http_409_conflict(self, response=None, msg=None):
+        """Request conflicts with current state of the server."""
         self._assert_http_status(409, response=response, msg=msg)
 
     def assert_http_410_gone(self, response=None, msg=None):
+        """Requested resource is permanently unavailable."""
         self._assert_http_status(410, response=response, msg=msg)
 
     def assert_http_411_length_required(self, response=None, msg=None):
+        """Server requires Content-Length header in the request."""
         self._assert_http_status(411, response=response, msg=msg)
 
     def assert_http_412_precondition_failed(self, response=None, msg=None):
+        """Client's preconditions in headers are not met."""
         self._assert_http_status(412, response=response, msg=msg)
 
     def assert_http_413_request_entity_too_large(self, response=None, msg=None):
+        """Request payload is larger than server is willing to process."""
         self._assert_http_status(413, response=response, msg=msg)
 
     def assert_http_414_request_uri_too_long(self, response=None, msg=None):
+        """URI requested by client is longer than server can interpret."""
         self._assert_http_status(414, response=response, msg=msg)
 
     def assert_http_415_unsupported_media_type(self, response=None, msg=None):
+        """Media format of request data is not supported."""
         self._assert_http_status(415, response=response, msg=msg)
 
     def assert_http_416_requested_range_not_satisfiable(self, response=None, msg=None):
+        """Range specified in Range header cannot be fulfilled."""
         self._assert_http_status(416, response=response, msg=msg)
 
     def assert_http_417_expectation_failed(self, response=None, msg=None):
+        """Expectation in Expect header cannot be met."""
         self._assert_http_status(417, response=response, msg=msg)
 
+    def assert_http_418_im_a_teapot(self, response=None, msg=None):
+        """Server refuses to brew coffee because it is a teapot."""
+        self._assert_http_status(418, response=response, msg=msg)
+
+    def assert_http_421_misdirected_request(self, response=None, msg=None):
+        """Request was directed to a server unable to produce a response."""
+        self._assert_http_status(421, response=response, msg=msg)
+
     def assert_http_422_unprocessable_entity(self, response=None, msg=None):
+        """Request is well-formed but contains semantic errors."""
         self._assert_http_status(422, response=response, msg=msg)
 
     def assert_http_423_locked(self, response=None, msg=None):
+        """Resource being accessed is locked (WebDAV)."""
         self._assert_http_status(423, response=response, msg=msg)
 
     def assert_http_424_failed_dependency(self, response=None, msg=None):
+        """Request failed due to failure of a previous request (WebDAV)."""
         self._assert_http_status(424, response=response, msg=msg)
 
+    def assert_http_425_too_early(self, response=None, msg=None):
+        """Server is unwilling to risk processing a request that might be replayed."""
+        self._assert_http_status(425, response=response, msg=msg)
+
     def assert_http_426_upgrade_required(self, response=None, msg=None):
+        """Client should switch to a different protocol."""
         self._assert_http_status(426, response=response, msg=msg)
 
     def assert_http_428_precondition_required(self, response=None, msg=None):
+        """Server requires request to be conditional."""
         self._assert_http_status(428, response=response, msg=msg)
 
     def assert_http_429_too_many_requests(self, response=None, msg=None):
+        """Client has sent too many requests in a given time period."""
         self._assert_http_status(429, response=response, msg=msg)
 
     def assert_http_431_request_header_fields_too_large(self, response=None, msg=None):
+        """Request header fields are too large."""
         self._assert_http_status(431, response=response, msg=msg)
 
     def assert_http_451_unavailable_for_legal_reasons(self, response=None, msg=None):
+        """Resource is unavailable due to legal reasons."""
         self._assert_http_status(451, response=response, msg=msg)
 
     def assert_http_500_internal_server_error(self, response=None, msg=None):
+        """Server encountered an unexpected condition."""
         self._assert_http_status(500, response=response, msg=msg)
 
     def assert_http_501_not_implemented(self, response=None, msg=None):
+        """Server does not support the functionality required."""
         self._assert_http_status(501, response=response, msg=msg)
 
     def assert_http_502_bad_gateway(self, response=None, msg=None):
+        """Server received an invalid response from upstream server."""
         self._assert_http_status(502, response=response, msg=msg)
 
     def assert_http_503_service_unavailable(self, response=None, msg=None):
+        """Server is not ready to handle the request."""
         self._assert_http_status(503, response=response, msg=msg)
 
     def assert_http_504_gateway_timeout(self, response=None, msg=None):
+        """Server did not receive timely response from upstream server."""
         self._assert_http_status(504, response=response, msg=msg)
 
     def assert_http_505_http_version_not_supported(self, response=None, msg=None):
+        """HTTP version used in request is not supported by server."""
         self._assert_http_status(505, response=response, msg=msg)
 
     def assert_http_506_variant_also_negotiates(self, response=None, msg=None):
+        """Server has an internal configuration error in content negotiation."""
         self._assert_http_status(506, response=response, msg=msg)
 
     def assert_http_507_insufficient_storage(self, response=None, msg=None):
+        """Server is unable to store the representation needed to complete the request (WebDAV)."""
         self._assert_http_status(507, response=response, msg=msg)
 
     def assert_http_508_loop_detected(self, response=None, msg=None):
+        """Server detected an infinite loop while processing the request (WebDAV)."""
         self._assert_http_status(508, response=response, msg=msg)
 
     def assert_http_509_bandwidth_limit_exceeded(self, response=None, msg=None):
+        """Bandwidth limit has been exceeded (non-standard)."""
         self._assert_http_status(509, response=response, msg=msg)
 
     def assert_http_510_not_extended(self, response=None, msg=None):
+        """Further extensions to the request are required."""
         self._assert_http_status(510, response=response, msg=msg)
 
     def assert_http_511_network_authentication_required(self, response=None, msg=None):
+        """Client needs to authenticate to gain network access."""
         self._assert_http_status(511, response=response, msg=msg)