refactor(testing): deprecate httpnow (#2440)

* refactor(testing): deprecate httpnow

Signed-off-by: Keming <kemingy94@gmail.com>

* fix the httpnow alias assertion

Signed-off-by: Keming <kemingy94@gmail.com>

* fix the newsfragment

Signed-off-by: Keming <kemingy94@gmail.com>

---------

Signed-off-by: Keming <kemingy94@gmail.com>

Author: kemingy

docs/_newsfragments/2389.misc.rst

@@ -0,0 +1,2 @@
+The :func:`falcon.testing.httpnow` function is deprecated and will be removed in 
+Falcon 5.0. Use the :func:`falcon.util.http_now` function instead.

falcon/testing/__init__.py

@@ -161,4 +161,7 @@ def test_get_message(client):
 
 # NOTE(kgriffs): Alias for backwards-compatibility with Falcon 0.2
 # TODO(vytas): Remove in Falcon 5.0.
-httpnow = _util.http_now
+httpnow = _util.deprecated(
+    'This method is deprecated and will be removed in Falcon 5.0. '
+    'Use `falcon.util.http_now` instead.'
+)(_util.http_now)

tests/test_testing.py

@@ -224,3 +224,11 @@ def capture_method(req, resp):
     assert result.status_code == 200
     expected = '' if method == 'HEAD' else method
     assert result.text == expected
+
+
+def test_deprecated_httpnow():
+    with pytest.warns(
+        falcon.util.DeprecatedWarning, match='Use `falcon.util.http_now` instead.'
+    ):
+        now = testing.httpnow()
+    assert now

tests/test_utils.py

@@ -3,6 +3,7 @@
 from datetime import timezone
 import functools
 import http
+import inspect
 import itertools
 import json
 import random
@@ -712,7 +713,11 @@ def test_decode_empty_result(self, app):
         assert response.json == falcon.HTTPNotFound().to_dict()
 
     def test_httpnow_alias_for_backwards_compat(self):
-        assert testing.httpnow is falcon.util.http_now
+        # Ensure that both the alias and decorated alias work
+        assert (
+            testing.httpnow is falcon.util.http_now
+            or inspect.unwrap(testing.httpnow) is falcon.util.http_now
+        )
 
     def test_default_headers(self, app):
         resource = testing.SimpleTestResource()