Supporting unstable versions and more robust testing configuration (#348)

Author: RobPasMue

src/ansys/geometry/core/connection/__init__.py

@@ -7,10 +7,14 @@
     tess_to_pd,
     unit_vector_to_grpc_direction,
 )
-from ansys.geometry.core.connection.defaults import DEFAULT_HOST, DEFAULT_PORT
+from ansys.geometry.core.connection.defaults import (
+    DEFAULT_HOST,
+    DEFAULT_PORT,
+    GEOMETRY_SERVICE_DOCKER_IMAGE,
+)
 from ansys.geometry.core.connection.launcher import (
     launch_local_modeler,
     launch_modeler,
     launch_remote_modeler,
 )
-from ansys.geometry.core.connection.localinstance import LocalDockerInstance
+from ansys.geometry.core.connection.localinstance import GeometryContainers, LocalDockerInstance

src/ansys/geometry/core/connection/client.py

@@ -138,6 +138,11 @@ def log(self) -> PyGeometryCustomAdapter:
         """Specific instance logger."""
         return self._log
 
+    @property
+    def is_closed(self) -> bool:
+        """Checks if the client connection is closed or not."""
+        return self._closed
+
     @property
     def healthy(self) -> bool:
         """Check if the client channel if healthy."""

src/ansys/geometry/core/connection/localinstance.py

@@ -15,8 +15,10 @@
 class GeometryContainers(Enum):
     """Provides an enum holding the different Geometry services available."""
 
-    WINDOWS_LATEST_STABLE = 0, "windows", "windows-latest"
-    LINUX_LATEST_STABLE = 1, "linux", None
+    WINDOWS_LATEST = 0, "windows", "windows-latest"
+    LINUX_LATEST = 1, "linux", "linux-latest"
+    WINDOWS_LATEST_UNSTABLE = 0, "windows", "windows-latest-unstable"
+    LINUX_LATEST_UNSTABLE = 1, "linux", "linux-latest-unstable"
 
 
 class LocalDockerInstance:

src/ansys/geometry/core/modeler.py

@@ -99,6 +99,10 @@ def create_design(self, name: str) -> "Design":
         self._designs.append(design)
         return self._designs[-1]
 
+    def close(self) -> None:
+        """``Modeler`` easy-access method to the client's ``close()`` method."""
+        return self.client.close()
+
     def __repr__(self):
         """String representation of the modeler."""
         lines = []

tests/integration/conftest.py

@@ -16,13 +16,65 @@
 import pyvista as pv
 
 from ansys.geometry.core import Modeler
+from ansys.geometry.core.connection.defaults import GEOMETRY_SERVICE_DOCKER_IMAGE
+from ansys.geometry.core.connection.localinstance import GeometryContainers, LocalDockerInstance
 
 pv.OFF_SCREEN = True
 
 
 @pytest.fixture(scope="session")
-def modeler():
+def docker_instance():
+    # This will only have a value in case that:
+    #
+    # 1) Docker is installed
+    # 2) At least one of the Geometry Service images for your OS is downloaded
+    #    on the machine
+    #
+    local_instance = None
+
+    # Check 1)
+    if LocalDockerInstance.is_docker_installed():
+        # First of all let's get the Docker Engine OS
+        docker_os = LocalDockerInstance.docker_client().info()["OSType"]
+        is_image_available = False
+        is_image_available_cont = None
+
+        # Now, let's get the OS-related images
+        list_images = []
+        list_containers = []
+        for geom_service in GeometryContainers:
+            if geom_service.value[1] == docker_os:
+                list_images.append(f"{GEOMETRY_SERVICE_DOCKER_IMAGE}:{geom_service.value[2]}")
+                list_containers.append(geom_service)
+
+        # Now, check 2)
+        #
+        available_images = LocalDockerInstance.docker_client().images.list(
+            name=GEOMETRY_SERVICE_DOCKER_IMAGE
+        )
+        for image in available_images:
+            for geom_image, geom_cont in zip(list_images, list_containers):
+                if geom_image in image.tags:
+                    is_image_available = True
+                    is_image_available_cont = geom_cont
+                    break
+
+            if is_image_available:
+                break
+
+        # Declare a LocalDockerInstance object if all checks went through
+        if is_image_available:
+            local_instance = LocalDockerInstance(
+                connect_to_existing_service=True,
+                restart_if_existing_service=True,
+                image=is_image_available_cont,
+            )
+
+    return local_instance
 
+
+@pytest.fixture(scope="session")
+def modeler(docker_instance):
     # Log to file - accepts str or Path objects, Path is passed for testing/coverage purposes.
     log_file_path = Path(__file__).absolute().parent / "logs" / "integration_tests_logs.txt"
 
@@ -31,13 +83,15 @@ def modeler():
     except OSError:
         pass
 
-    modeler = Modeler(logging_level=logging.DEBUG, logging_file=log_file_path)
+    modeler = Modeler(
+        local_instance=docker_instance, logging_level=logging.DEBUG, logging_file=log_file_path
+    )
 
     yield modeler
 
-    # TODO: check cleanup on exit
-    # modeler.exit()
-    # assert modeler._client.closed
+    # Cleanup on exit
+    modeler.close()
+    assert modeler.client.is_closed
 
 
 @pytest.fixture(scope="session", autouse=True)

tests/integration/test_launcher_local.py

@@ -1,18 +1,43 @@
 """Testing module for the local launcher."""
 
+import re
+
 import pytest
 
 from ansys.geometry.core import Modeler
 from ansys.geometry.core.connection import LocalDockerInstance, launch_local_modeler
 
 
+def _check_no_shutdown_warning(port: int, log: str) -> bool:
+    msg = f"WARNING  localhost:{port}:client\.py:[0-9]+ Geometry Service will not be shutdown since it was already running\.\.\."  # noqa : E501
+    pattern = re.compile(msg)
+    return True if pattern.search(log) else False
+
+
+def _check_service_already_running(port: int, log: str) -> bool:
+    msg = f"WARNING  PyGeometry_global:localinstance\.py:[0-9]+ Service already running at port {port}\.\.\."  # noqa : E501
+    pattern = re.compile(msg)
+    return True if pattern.search(log) else False
+
+
+def _check_restarting_service(port: int, log: str) -> bool:
+    msg = f"WARNING  PyGeometry_global:localinstance\.py:124 Restarting service already running at port {port}\.\.\."  # noqa : E501
+    pattern = re.compile(msg)
+    return True if pattern.search(log) else False
+
+
 def test_if_docker_is_installed():
     """Simple test to check if Docker is installed in the machine."""
     assert LocalDockerInstance.is_docker_installed()
 
 
-def test_local_launcher_connect(modeler: Modeler, caplog: pytest.LogCaptureFixture):
+def test_local_launcher_connect(
+    modeler: Modeler, caplog: pytest.LogCaptureFixture, docker_instance: LocalDockerInstance
+):
     """Checking connection to existing service using launch modeler."""
+    if not docker_instance:
+        pytest.skip("Docker local launcher tests are not runnable.")
+
     # Get the existing target
     target = modeler.client.target().split(":")
     port = int(target[1])
@@ -25,20 +50,23 @@ def test_local_launcher_connect(modeler: Modeler, caplog: pytest.LogCaptureFixtu
     local_modeler = launch_local_modeler(
         port=port, connect_to_existing_service=True, restart_if_existing_service=False
     )
-
-    msg = f"WARNING  PyGeometry_global:localinstance.py:155 Service already running at port {port}...\n"  # noqa : E501
-    assert msg in caplog.text
+    assert _check_service_already_running(port, caplog.text) is True
+    caplog.clear()
 
     # Try to close it... this will throw a warning
     local_modeler.client.close()
-
-    msg = f"WARNING  localhost:{port}:client.py:182 Geometry Service will not be shutdown since it was already running...\n"  # noqa : E501
-    assert msg in caplog.text
+    assert _check_no_shutdown_warning(port, caplog.text) is True
+    caplog.clear()
 
 
-def test_local_launcher_connect_with_restart(modeler: Modeler, caplog: pytest.LogCaptureFixture):
+def test_local_launcher_connect_with_restart(
+    modeler: Modeler, caplog: pytest.LogCaptureFixture, docker_instance: LocalDockerInstance
+):
     """Checking connection to existing service using launch modeler and
     restarting existing service."""
+    if not docker_instance:
+        pytest.skip("Docker local launcher tests are not runnable.")
+
     # Get the existing target
     target = modeler.client.target().split(":")
     port = int(target[1])
@@ -50,8 +78,7 @@ def test_local_launcher_connect_with_restart(modeler: Modeler, caplog: pytest.Lo
     )
 
     # Check that the warning is NOT raised
-    msg = f"WARNING  PyGeometry_global:localinstance.py:155 Service already running at port {new_port}...\n"  # noqa : E501
-    assert msg not in caplog.text
+    assert _check_service_already_running(new_port, caplog.text) is False
     caplog.clear()
 
     # Connect to the previous modeler and restart it
@@ -60,30 +87,30 @@ def test_local_launcher_connect_with_restart(modeler: Modeler, caplog: pytest.Lo
     )
 
     # Check that the warnings are raised
-    msg = f"WARNING  PyGeometry_global:localinstance.py:155 Service already running at port {new_port}...\n"  # noqa : E501
-    assert msg in caplog.text
-    msg = f"WARNING  PyGeometry_global:localinstance.py:122 Restarting service already running at port {new_port}...\n"  # noqa : E501
-    assert msg in caplog.text
+    assert _check_service_already_running(new_port, caplog.text) is True
+    assert _check_restarting_service(new_port, caplog.text) is True
     caplog.clear()
 
     # Try to close the new_modeler_restarted... this will throw a warning
     new_modeler_restarted.client.close()
 
-    msg = f"WARNING  localhost:{new_port}:client.py:182 Geometry Service will not be shutdown since it was already running...\n"  # noqa : E501
-    assert msg in caplog.text
+    assert _check_no_shutdown_warning(new_port, caplog.text) is True
     caplog.clear()
 
     # And now try to close the new_modeler... this will NOT throw a warning
     new_modeler.client.close()
 
-    msg = f"WARNING  localhost:{new_port}:client.py:182 Geometry Service will not be shutdown since it was already running...\n"  # noqa : E501
-    assert msg not in caplog.text
+    assert _check_no_shutdown_warning(new_port, caplog.text) is False
     caplog.clear()
 
 
-def test_try_deploying_container_with_same_name(modeler: Modeler, caplog: pytest.LogCaptureFixture):
+def test_try_deploying_container_with_same_name(
+    modeler: Modeler, caplog: pytest.LogCaptureFixture, docker_instance: LocalDockerInstance
+):
     """Checks that an error is raised when trying to deploy a container
     with a name that already exists."""
+    if not docker_instance:
+        pytest.skip("Docker local launcher tests are not runnable.")
 
     # Get the existing target
     target = modeler.client.target().split(":")
@@ -101,8 +128,7 @@ def test_try_deploying_container_with_same_name(modeler: Modeler, caplog: pytest
     )
 
     # Check that the warning is NOT raised
-    msg = f"WARNING  PyGeometry_global:localinstance.py:155 Service already running at port {new_port}...\n"  # noqa : E501
-    assert msg not in caplog.text
+    assert _check_service_already_running(new_port, caplog.text) is False
     caplog.clear()
 
     # Now try launching a service in a new port (where no service is available) but
@@ -119,7 +145,5 @@ def test_try_deploying_container_with_same_name(modeler: Modeler, caplog: pytest
 
     # And now try to close the new_modeler... this will NOT throw a warning
     new_modeler.client.close()
-
-    msg = f"WARNING  localhost:{new_port}:client.py:182 Geometry Service will not be shutdown since it was already running...\n"  # noqa : E501
-    assert msg not in caplog.text
+    assert _check_no_shutdown_warning(new_port, caplog.text) is False
     caplog.clear()