refactor(tests): use pytest.importorskip for some optional dependencies (#2509)

* Continue from the PR #2490

This will update the remaining changes with the importorskip

* apply ruff and pep8 fix for the pipeline

* Revert test_ws.py changes for pytest.importorskip

As the pytest.importskip on the top for msgpack resulted
in causing the entire test file to be skip if the msgpack
is not installed, which was following the coverage to reduced

* Use pytest.fixtures instead defining globally at module level

* bypass the pep8 fail in the CI

* use fixtures instead of defining globally at the module level

* Refactor the pytest.importorskip:

* Addressing PR review comments and reverting back where required:

* replace aiofiles_lib to aiofiles

* reverting the changes for test_hello_asgi

* removing extra line space

* Revert test_ws.py

Author: x612skm

tests/asgi/test_asgi_servers.py

@@ -11,16 +11,20 @@
 
 import pytest
 
-try:
-    import httpx
-except ImportError:
-    httpx = None  # type: ignore
+from falcon import testing
+
+from . import _asgi_test_app
+
+
+@pytest.fixture(scope='session')
+def httpx():
+    return pytest.importorskip('httpx')
+
+
+@pytest.fixture(scope='session')
+def requests():
+    return pytest.importorskip('requests')
 
-try:
-    import requests
-    import requests.exceptions
-except ImportError:
-    requests = None  # type: ignore
 
 try:
     import websockets
@@ -30,10 +34,6 @@
     websockets = None  # type: ignore
 
 
-from falcon import testing
-
-from . import _asgi_test_app
-
 _MODULE_DIR = os.path.abspath(os.path.dirname(__file__))
 
 _PYPY = platform.python_implementation() == 'PyPy'
@@ -49,27 +49,24 @@
 _REQUEST_TIMEOUT = 10
 
 
-@pytest.mark.skipif(
-    requests is None, reason='requests module is required for this test'
-)
 class TestASGIServer:
-    def test_get(self, server_base_url):
+    def test_get(self, server_base_url, requests):
         resp = requests.get(server_base_url, timeout=_REQUEST_TIMEOUT)
         assert resp.status_code == 200
         assert resp.text == '127.0.0.1'
 
-    def test_put(self, server_base_url):
+    def test_put(self, server_base_url, requests):
         body = '{}'
         resp = requests.put(server_base_url, data=body, timeout=_REQUEST_TIMEOUT)
         assert resp.status_code == 200
         assert resp.text == '{}'
 
-    def test_head_405(self, server_base_url):
+    def test_head_405(self, server_base_url, requests):
         body = '{}'
         resp = requests.head(server_base_url, data=body, timeout=_REQUEST_TIMEOUT)
         assert resp.status_code == 405
 
-    def test_post_multipart_form(self, server_base_url):
+    def test_post_multipart_form(self, server_base_url, requests):
         size = random.randint(16 * _SIZE_1_MB, 32 * _SIZE_1_MB)
         data = os.urandom(size)
         digest = hashlib.sha1(data).hexdigest()
@@ -93,7 +90,7 @@ def test_post_multipart_form(self, server_base_url):
             },
         }
 
-    def test_post_multiple(self, server_base_url):
+    def test_post_multiple(self, server_base_url, requests):
         body = testing.rand_string(_SIZE_1_KB // 2, _SIZE_1_KB)
         resp = requests.post(server_base_url, data=body, timeout=_REQUEST_TIMEOUT)
         assert resp.status_code == 200
@@ -105,7 +102,7 @@ def test_post_multiple(self, server_base_url):
         resp = requests.post(server_base_url, data=body, timeout=_REQUEST_TIMEOUT)
         assert resp.headers['X-Counter'] == '2002'
 
-    def test_post_invalid_content_length(self, server_base_url):
+    def test_post_invalid_content_length(self, server_base_url, requests):
         headers = {'Content-Length': 'invalid'}
 
         try:
@@ -124,15 +121,15 @@ def test_post_invalid_content_length(self, server_base_url):
             #   get a heads-up if the request is no longer blocked.
             pass
 
-    def test_post_read_bounded_stream(self, server_base_url):
+    def test_post_read_bounded_stream(self, server_base_url, requests):
         body = testing.rand_string(_SIZE_1_KB // 2, _SIZE_1_KB)
         resp = requests.post(
             server_base_url + 'bucket', data=body, timeout=_REQUEST_TIMEOUT
         )
         assert resp.status_code == 200
         assert resp.text == body
 
-    def test_post_read_bounded_stream_large(self, server_base_url):
+    def test_post_read_bounded_stream_large(self, server_base_url, requests):
         """Test that we can correctly read large bodies chunked server-side.
 
         ASGI servers typically employ some type of flow control to stream
@@ -152,11 +149,11 @@ def test_post_read_bounded_stream_large(self, server_base_url):
         assert resp.json().get('drops') > size_mb
         assert resp.json().get('sha1') == hashlib.sha1(body).hexdigest()
 
-    def test_post_read_bounded_stream_no_body(self, server_base_url):
+    def test_post_read_bounded_stream_no_body(self, server_base_url, requests):
         resp = requests.post(server_base_url + 'bucket', timeout=_REQUEST_TIMEOUT)
         assert not resp.text
 
-    def test_sse(self, server_base_url):
+    def test_sse(self, server_base_url, requests):
         resp = requests.get(server_base_url + 'events', timeout=_REQUEST_TIMEOUT)
         assert resp.status_code == 200
 
@@ -167,7 +164,7 @@ def test_sse(self, server_base_url):
 
         assert not events[-1]
 
-    def test_sse_client_disconnects_early(self, server_base_url):
+    def test_sse_client_disconnects_early(self, server_base_url, requests):
         """Test that when the client connection is lost, the server task does not hang.
 
         In the case of SSE, Falcon should detect when the client connection is
@@ -182,8 +179,7 @@ def test_sse_client_disconnects_early(self, server_base_url):
                 timeout=(_asgi_test_app.SSE_TEST_MAX_DELAY_SEC / 2),
             )
 
-    @pytest.mark.skipif(httpx is None, reason='httpx is required for this test')
-    async def test_stream_chunked_request(self, server_base_url):
+    async def test_stream_chunked_request(self, server_base_url, httpx):
         """Regression test for https://github.com/falconry/falcon/issues/2024"""
 
         async def emitter():
@@ -200,9 +196,6 @@ async def emitter():
             assert resp.json().get('drops') >= 1
 
 
-@pytest.mark.skipif(
-    requests is None, reason='requests module is required for this test'
-)
 @pytest.mark.skipif(
     websockets is None, reason='websockets is required for this test class'
 )
@@ -217,6 +210,7 @@ async def test_hello(
         max_receive_queue,
         server_base_url,
         server_url_events_ws,
+        requests,
     ):
         resp = requests.patch(
             server_base_url + 'wsoptions', json={'max_receive_queue': max_receive_queue}
@@ -617,7 +611,7 @@ def _can_run(factory):
 
 
 @pytest.fixture(params=[_uvicorn_factory, _daphne_factory, _hypercorn_factory])
-def server_base_url(request):
+def server_base_url(request, requests):
     process_factory = request.param
     _can_run(process_factory)
 

tests/asgi/test_response_media_asgi.py

@@ -8,10 +8,10 @@
 from falcon import testing
 import falcon.asgi
 
-try:
-    import msgpack
-except ImportError:
-    msgpack = None
+
+@pytest.fixture(scope='session')
+def msgpack():
+    return pytest.importorskip('msgpack')
 
 
 def create_client(resource, handlers=None):
@@ -93,8 +93,7 @@ def test_non_ascii_json_serialization(document):
         ('application/x-msgpack'),
     ],
 )
-@pytest.mark.skipif(msgpack is None, reason='msgpack is required for this test')
-def test_msgpack(media_type):
+def test_msgpack(media_type, msgpack):
     class TestResource:
         async def on_get(self, req, resp):
             resp.content_type = media_type

tests/test_examples.py

@@ -1,16 +1,16 @@
 import pytest
 
-try:
-    import httpx
-except ImportError:
-    httpx = None  # type: ignore
+import falcon.testing as testing
 
-try:
-    import requests
-except ImportError:
-    requests = None  # type: ignore
 
-import falcon.testing as testing
+@pytest.fixture(scope='session')
+def httpx():
+    return pytest.importorskip('httpx')
+
+
+@pytest.fixture(scope='session')
+def requests():
+    return pytest.importorskip('requests')
 
 
 def test_quote(util):
@@ -38,13 +38,7 @@ def test_things(asgi, util):
     )
 
 
-@pytest.mark.skipif(
-    httpx is None, reason='things_advanced_asgi.py requires httpx [not found]'
-)
-@pytest.mark.skipif(
-    requests is None, reason='things_advanced.py requires requests [not found]'
-)
-def test_things_advanced(asgi, util):
+def test_things_advanced(asgi, util, httpx, requests):
     suffix = '_asgi' if asgi else ''
     advanced = util.load_module(f'examples/things_advanced{suffix}.py')
 

tests/test_httperror.py

@@ -14,10 +14,10 @@
 import falcon.testing as testing
 from falcon.util.deprecation import DeprecatedWarning
 
-try:
-    import yaml
-except ImportError:
-    yaml = None  # type: ignore[assignment]
+
+@pytest.fixture(scope='session')
+def yaml():
+    return pytest.importorskip('yaml')
 
 
 @pytest.fixture
@@ -382,8 +382,7 @@ def test_client_does_not_accept_json_or_xml(self, client):
         assert response.headers['Vary'] == 'Accept'
         assert not response.content
 
-    @pytest.mark.skipif(yaml is None, reason='PyYAML is required for this test')
-    def test_custom_error_serializer(self, client):
+    def test_custom_error_serializer(self, client, yaml):
         headers = {
             'X-Error-Title': 'Storage service down',
             'X-Error-Description': (

tests/test_media_multipart.py

@@ -11,10 +11,10 @@
 from falcon.media.multipart import MultipartParseOptions
 from falcon.util import BufferedReader
 
-try:
-    import msgpack
-except ImportError:
-    msgpack = None
+
+@pytest.fixture(scope='session')
+def msgpack():
+    return pytest.importorskip('msgpack')
 
 
 EXAMPLE1 = (
@@ -414,7 +414,7 @@ async def on_post_mirror(self, req, resp):
 
 
 @pytest.fixture
-def custom_client(asgi, util):
+def custom_client(asgi, util, msgpack):
     def _factory(options):
         multipart_handler = media.MultipartFormHandler()
         for key, value in options.items():
@@ -596,9 +596,8 @@ def test_too_many_body_parts(custom_client, max_body_part_count):
         assert len(resp.json) == EXAMPLE2_PART_COUNT
 
 
-@pytest.mark.skipif(not msgpack, reason='msgpack not installed')
 @pytest.mark.parametrize('close_delimiter', ['--', '--\r\n'])
-def test_random_form(client, close_delimiter):
+def test_random_form(client, close_delimiter, msgpack):
     part_data = [os.urandom(random.randint(0, 2**18)) for _ in range(64)]
     form_data = (
         b''.join(

tests/test_request_media.py

@@ -9,10 +9,10 @@
 from falcon import util
 import falcon.asgi
 
-try:
-    import msgpack
-except ImportError:
-    msgpack = None
+
+@pytest.fixture(scope='session')
+def msgpack():
+    return pytest.importorskip('msgpack')
 
 
 def create_client(asgi, handlers=None, resource=None):
@@ -104,8 +104,7 @@ def test_json(client, media_type):
         ('application/x-msgpack'),
     ],
 )
-@pytest.mark.skipif(msgpack is None, reason='msgpack is required for this test')
-def test_msgpack(asgi, media_type):
+def test_msgpack(asgi, media_type, msgpack):
     client = create_client(
         asgi,
         {
@@ -157,8 +156,7 @@ def test_unknown_media_type(asgi, media_type):
 
 
 @pytest.mark.parametrize('media_type', ['application/json', 'application/msgpack'])
-@pytest.mark.skipif(msgpack is None, reason='msgpack is required for this test')
-def test_empty_body(asgi, media_type):
+def test_empty_body(asgi, media_type, msgpack):
     client = _create_client_invalid_media(
         asgi,
         errors.HTTPBadRequest,
@@ -198,8 +196,7 @@ def test_invalid_json(asgi):
         assert str(client.resource.captured_error.value.__cause__) == str(e)
 
 
-@pytest.mark.skipif(msgpack is None, reason='msgpack is required for this test')
-def test_invalid_msgpack(asgi):
+def test_invalid_msgpack(asgi, msgpack):
     handlers = {'application/msgpack': media.MessagePackHandler()}
     client = _create_client_invalid_media(
         asgi, errors.HTTPBadRequest, handlers=handlers

tests/test_response_media.py

@@ -7,10 +7,10 @@
 from falcon import media
 from falcon import testing
 
-try:
-    import msgpack
-except ImportError:
-    msgpack = None
+
+@pytest.fixture(scope='session')
+def msgpack():
+    return pytest.importorskip('msgpack')
 
 
 @pytest.fixture
@@ -99,8 +99,7 @@ def test_non_ascii_json_serialization(document):
         ('application/x-msgpack'),
     ],
 )
-@pytest.mark.skipif(msgpack is None, reason='msgpack is required for this test')
-def test_msgpack(media_type):
+def test_msgpack(media_type, msgpack):
     client = create_client(
         {
             'application/msgpack': media.MessagePackHandler(),

tests/test_utils.py

@@ -26,10 +26,10 @@
 from falcon.util import uri
 from falcon.util.time import TimezoneGMT
 
-try:
-    import msgpack
-except ImportError:
-    msgpack = None
+
+@pytest.fixture(scope='session')
+def msgpack():
+    return pytest.importorskip('msgpack')
 
 
 @pytest.fixture
@@ -1238,8 +1238,9 @@ def on_post(self, req, resp):
             MEDIA_URLENCODED,
         ],
     )
-    @pytest.mark.skipif(msgpack is None, reason='msgpack is required for this test')
-    def test_simulate_content_type_extra_handler(self, asgi, util, content_type):
+    def test_simulate_content_type_extra_handler(
+        self, asgi, util, content_type, msgpack
+    ):
         class TestResourceAsync(testing.SimpleTestResourceAsync):
             def __init__(self):
                 super().__init__()