Refactoring webserver: async metrics handler, upgrades dependencies and fixes testing fixtures (#2343)

- CHANGES: makes metrics_handler implementation async by using a thread pool executor ot execute prometheos_client.generate_latest call
- CHANGES: general upgrade of webserver dependencies:
aiohttp and python-socketio cannot be upgraded to the latest. Needs further refactoring (see #2008 and notes in requirement files)!
- FIXES: services/web/server/tests/integration/01/test_exporter.py was de-activated.
- CHANGES: unified pylint testing by reusing pytest-simcore utils
- CHANGES: moves socket-io fixtures to simcore-pytest

Author: pcrespov

packages/models-library/tests/test_package.py

@@ -1,37 +1,19 @@
 # pylint:disable=unused-variable
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
-import os
-import re
-from pathlib import Path
 
-import pytest
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
 
-
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc.exists()
-    return pylintrc
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 
 
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
 
 
 def test_no_pdbs_in_place(package_dir):
-    # TODO: add also test_dir excluding this function!?
-    # TODO: it can be commented!
-    # TODO: add check on other undesired code strings?!
-    MATCH = re.compile(r"pdb.set_trace()")
-    EXCLUDE = ["__pycache__", ".git"]
-    for root, dirs, files in os.walk(package_dir):
-        for name in files:
-            if name.endswith(".py"):
-                pypth = Path(root) / name
-                code = pypth.read_text()
-                found = MATCH.findall(code)
-                # TODO: should return line number
-                assert not found, "pbd.set_trace found in %s" % pypth
-        dirs[:] = [d for d in dirs if d not in EXCLUDE]
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)

packages/pytest-simcore/src/pytest_simcore/websocket_client.py

@@ -8,22 +8,32 @@
 import pytest
 import socketio
 from aiohttp import web
+from aiohttp.test_utils import TestClient
 from pytest_simcore.helpers.utils_assert import assert_status
 from yarl import URL
 
 
-@pytest.fixture
-def socketio_url(client) -> Callable:
-    def create_url(client_override: Optional = None) -> str:
+@pytest.fixture()
+def client_session_id_factory() -> Callable[[], str]:
+    def create() -> str:
+        # NOTE:
+        return str(uuid4())
+
+    return create
+
+
+@pytest.fixture()
+def socketio_url_factory(client) -> Callable:
+    def create_url(client_override: Optional[TestClient] = None) -> str:
         SOCKET_IO_PATH = "/socket.io/"
         return str((client_override or client).make_url(SOCKET_IO_PATH))
 
     yield create_url
 
 
-@pytest.fixture
-async def security_cookie_factory(client) -> Callable:
-    async def creator(client_override: Optional = None) -> str:
+@pytest.fixture()
+async def security_cookie_factory(client: TestClient) -> Callable:
+    async def creator(client_override: Optional[TestClient] = None) -> str:
         # get the cookie by calling the root entrypoint
         resp = await (client_override or client).get("/v0/")
         data, error = await assert_status(resp, web.HTTPOk)
@@ -40,24 +50,25 @@ async def creator(client_override: Optional = None) -> str:
     yield creator
 
 
-@pytest.fixture
-def client_session_id() -> str:
-    return str(uuid4())
-
-
-@pytest.fixture
-async def socketio_client(
-    socketio_url: Callable, security_cookie_factory: Callable
-) -> Callable:
+@pytest.fixture()
+async def socketio_client_factory(
+    socketio_url_factory: Callable,
+    security_cookie_factory: Callable,
+    client_session_id_factory: Callable,
+) -> Callable[[str, Optional[TestClient]], socketio.AsyncClient]:
     clients = []
 
     async def connect(
-        client_session_id: str, client: Optional = None
+        client_session_id: Optional[str] = None, client: Optional[TestClient] = None
     ) -> socketio.AsyncClient:
+
+        if client_session_id is None:
+            client_session_id = client_session_id_factory()
+
         sio = socketio.AsyncClient(ssl_verify=False)
         # enginio 3.10.0 introduced ssl verification
         url = str(
-            URL(socketio_url(client)).with_query(
+            URL(socketio_url_factory(client)).with_query(
                 {"client_session_id": client_session_id}
             )
         )
@@ -75,5 +86,6 @@ async def connect(
     yield connect
 
     for sio in clients:
-        await sio.disconnect()
+        if sio.connected:
+            await sio.disconnect()
         assert not sio.sid

packages/service-library/tests/conftest.py

@@ -10,6 +10,10 @@
 import servicelib
 from servicelib.openapi import create_openapi_specs
 
+pytest_plugins = [
+    "pytest_simcore.repository_paths",
+]
+
 
 @pytest.fixture(scope="session")
 def here():

packages/service-library/tests/test_package.py

@@ -2,42 +2,22 @@
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
 
-import os
-import re
-from pathlib import Path
 
-import pytest
-
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 from servicelib.utils import is_osparc_repo_dir, search_osparc_repo_dir
 
 
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc.exists()
-    return pylintrc
-
-
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
 
 
 def test_no_pdbs_in_place(package_dir):
-    # TODO: add also test_dir excluding this function!?
-    # TODO: it can be commented!
-    # TODO: add check on other undesired code strings?!
-    MATCH = re.compile(r"pdb.set_trace()")
-    EXCLUDE = ["__pycache__", ".git"]
-    for root, dirs, files in os.walk(package_dir):
-        for name in files:
-            if name.endswith(".py"):
-                pypth = Path(root) / name
-                code = pypth.read_text()
-                found = MATCH.findall(code)
-                # TODO: should return line number
-                assert not found, "pbd.set_trace found in %s" % pypth
-        dirs[:] = [d for d in dirs if d not in EXCLUDE]
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)
 
 
 def test_utils(osparc_simcore_root_dir, package_dir):

packages/simcore-sdk/tests/unit/test_package.py

@@ -2,37 +2,18 @@
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
 
-import os
-import re
-from pathlib import Path
 
-import pytest
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
-
-
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc.exists()
-    return pylintrc
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 
 
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
 
 
 def test_no_pdbs_in_place(package_dir):
-    # TODO: add also test_dir excluding this function!?
-    # TODO: it can be commented!
-    # TODO: add check on other undesired code strings?!
-    MATCH = re.compile(r"pdb.set_trace()")
-    EXCLUDE = ["__pycache__", ".git"]
-    for root, dirs, files in os.walk(package_dir):
-        for name in files:
-            if name.endswith(".py"):
-                pypth = Path(root) / name
-                code = pypth.read_text()
-                found = MATCH.findall(code)
-                # TODO: should return line number
-                assert not found, "pbd.set_trace found in %s" % pypth
-        dirs[:] = [d for d in dirs if d not in EXCLUDE]
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)

services/api-server/tests/unit/test__code_syntax.py

@@ -2,33 +2,18 @@
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
 
-import os
-import re
-from pathlib import Path
 
-import pytest
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
-
-
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc_path = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc_path.exists()
-    return pylintrc_path
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 
 
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
 
 
 def test_no_pdbs_in_place(package_dir):
-    MATCH = re.compile(r"pdb.set_trace()")
-    EXCLUDE = ["__pycache__", ".git"]
-    for root, dirs, files in os.walk(package_dir):
-        for name in files:
-            if name.endswith(".py"):
-                pypth = Path(root) / name
-                code = pypth.read_text()
-                found = MATCH.findall(code)
-                assert not found, "pbd.set_trace found in %s" % pypth
-        dirs[:] = [d for d in dirs if d not in EXCLUDE]
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)

services/catalog/tests/unit/test__code_syntax.py

@@ -2,33 +2,18 @@
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
 
-import os
-import re
-from pathlib import Path
 
-import pytest
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
-
-
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc_path = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc_path.exists()
-    return pylintrc_path
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 
 
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
 
 
 def test_no_pdbs_in_place(package_dir):
-    MATCH = re.compile(r"pdb.set_trace()")
-    EXCLUDE = ["__pycache__", ".git"]
-    for root, dirs, files in os.walk(package_dir):
-        for name in files:
-            if name.endswith(".py"):
-                pypth = Path(root) / name
-                code = pypth.read_text()
-                found = MATCH.findall(code)
-                assert not found, "pbd.set_trace found in %s" % pypth
-        dirs[:] = [d for d in dirs if d not in EXCLUDE]
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)

services/sidecar/tests/unit/test_code_syntax.py

@@ -1,33 +1,19 @@
 # pylint:disable=unused-variable
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
-import os
-import re
-from pathlib import Path
 
-import pytest
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
 
-
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc_path = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc_path.exists()
-    return pylintrc_path
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 
 
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
 
 
 def test_no_pdbs_in_place(package_dir):
-    MATCH = re.compile(r"pdb.set_trace()")
-    EXCLUDE = ["__pycache__", ".git"]
-    for root, dirs, files in os.walk(package_dir):
-        for name in files:
-            if name.endswith(".py"):
-                pypth = Path(root) / name
-                code = pypth.read_text()
-                found = MATCH.findall(code)
-                assert not found, "pbd.set_trace found in %s" % pypth
-        dirs[:] = [d for d in dirs if d not in EXCLUDE]
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)

services/storage/tests/conftest.py

@@ -39,6 +39,7 @@
 )
 
 pytest_plugins = [
+    "pytest_simcore.repository_paths",
     "tests.fixtures.data_models",
 ]
 

services/storage/tests/test_package.py

@@ -3,16 +3,17 @@
 # pylint:disable=redefined-outer-name
 
 
-import pytest
-from pytest_simcore.helpers.utils_pylint import assert_pylint_is_passing
-
-
-@pytest.fixture
-def pylintrc(osparc_simcore_root_dir):
-    pylintrc = osparc_simcore_root_dir / ".pylintrc"
-    assert pylintrc.exists()
-    return pylintrc
+from pytest_simcore.helpers.utils_pylint import (
+    assert_no_pdb_in_code,
+    assert_pylint_is_passing,
+)
 
 
 def test_run_pylint(pylintrc, package_dir):
+    # fixtures in pytest_simcore.environs
     assert_pylint_is_passing(pylintrc=pylintrc, package_dir=package_dir)
+
+
+def test_no_pdbs_in_place(package_dir):
+    # fixtures in pytest_simcore.environs
+    assert_no_pdb_in_code(code_dir=package_dir)