Better default support for Fluent Docker containers on Windows (#1785)

* better support for docker containers on Windows

* fixing tests and improving examples.downloads

* docstring and default behavior improvement

* reworking data_transfer and container module const

* fixing and revising previously failing tests

* small adjustments

* fix for #1798 and additional improvements

* skipping failing test, see #1799

* only pseudo-tty for v241

* revising tests and skipping test_transcript, see #1802

Author: raph-luc

src/ansys/fluent/core/examples/downloads.py

@@ -1,13 +1,4 @@
-"""Functions to download sample datasets from the PyAnsys data repository.
-
-Examples
---------
-
->>> from ansys.fluent.core import examples
->>> filename = examples.download_file("bracket.iges", "geometry")
->>> filename
-'/home/user/.local/share/ansys_fluent_core/examples/bracket.iges'
-"""
+"""Functions to download sample datasets from the Ansys example data repository."""
 import os
 import re
 import shutil
@@ -18,20 +9,25 @@
 import ansys.fluent.core as pyfluent
 
 
-def delete_downloads() -> bool:
-    """Delete all downloaded examples to free space or update the files."""
+def delete_downloads():
+    """Delete all downloaded examples from the default examples folder to free space or update the files.
+
+    Notes
+    -----
+    The default examples path is given by ``pyfluent.EXAMPLES_PATH``."""
     shutil.rmtree(pyfluent.EXAMPLES_PATH)
     os.makedirs(pyfluent.EXAMPLES_PATH)
-    return True
 
 
 def _decompress(filename: str) -> None:
+    """Decompress zipped file."""
     zip_ref = zipfile.ZipFile(filename, "r")
     zip_ref.extractall(pyfluent.EXAMPLES_PATH)
     return zip_ref.close()
 
 
 def _get_file_url(filename: str, directory: Optional[str] = None) -> str:
+    """Get file URL."""
     if directory:
         return (
             "https://github.com/ansys/example-data/raw/master/"
@@ -40,18 +36,29 @@ def _get_file_url(filename: str, directory: Optional[str] = None) -> str:
     return f"https://github.com/ansys/example-data/raw/master/{filename}"
 
 
-def _retrieve_file(url: str, filename: str, save_path: Optional[str] = None) -> str:
+def _retrieve_file(
+    url: str,
+    filename: str,
+    save_path: Optional[str] = None,
+    return_only_filename: Optional[bool] = False,
+) -> str:
+    """Download specified file from specified URL."""
+    filename = os.path.basename(filename)
     if save_path is None:
         save_path = pyfluent.EXAMPLES_PATH
     else:
         save_path = os.path.abspath(save_path)
-    local_path = os.path.join(save_path, os.path.basename(filename))
+    local_path = os.path.join(save_path, filename)
     local_path_no_zip = re.sub(".zip$", "", local_path)
+    filename_no_zip = re.sub(".zip$", "", filename)
     # First check if file has already been downloaded
     print("Checking if specified file already exists...")
     if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
         print(f"File already exists. File path:\n{local_path_no_zip}")
-        return local_path_no_zip
+        if return_only_filename:
+            return filename_no_zip
+        else:
+            return local_path_no_zip
 
     print("File does not exist. Downloading specified file...")
 
@@ -63,16 +70,64 @@ def _retrieve_file(url: str, filename: str, save_path: Optional[str] = None) ->
     urlretrieve = urllib.request.urlretrieve
 
     # Perform download
-    saved_file, _ = urlretrieve(url, filename=local_path)
+    urlretrieve(url, filename=local_path)
     if local_path.endswith(".zip"):
         _decompress(local_path)
         local_path = local_path_no_zip
+        filename = filename_no_zip
     print(f"Download successful. File path:\n{local_path}")
-    return local_path
+    if return_only_filename:
+        return filename
+    else:
+        return local_path
 
 
 def download_file(
-    filename: str, directory: Optional[str] = None, save_path: Optional[str] = None
-):
+    filename: str,
+    directory: Optional[str] = None,
+    save_path: Optional[str] = None,
+    return_only_filename: Optional[bool] = None,
+) -> str:
+    """Download specified example file from the Ansys example data repository.
+
+    Parameters
+    ----------
+    filename : str
+        File to download.
+    directory : str, optional
+        Ansys example data repository directory where specified file is located. If not specified, looks for the file
+        in the root directory of the repository.
+    save_path : str, optional
+        Path to download the specified file to.
+    return_only_filename : bool, optional
+        When unspecified, defaults to False, unless the PYFLUENT_LAUNCH_CONTAINER=1 environment variable is specified,
+        in which case defaults to True.
+        Relevant when using Fluent Docker container images, as the full path for the imported file from
+        the host side is not necessarily going to be the same as the one for Fluent inside the container.
+        Assuming the Fluent inside the container has its working directory set to the path that was mounted from
+        the host, and that the example files are being downloaded by the host to this same path, only the filename is
+        required for Fluent to find and open the file.
+
+    Returns
+    -------
+    str
+        Filepath of the downloaded or already existing file, or only the file name if ``return_only_filename=True``.
+
+    Examples
+    --------
+    >>> from ansys.fluent.core import examples
+    >>> filepath = examples.download_file("bracket.iges", "geometry")
+    >>> filepath
+    '/home/user/.local/share/ansys_fluent_core/examples/bracket.iges'
+    >>> filename = examples.download_file("bracket.iges", "geometry", return_only_filename=True)
+    >>> filename
+    'bracket.iges'
+    """
+    if return_only_filename is None:
+        if os.getenv("PYFLUENT_LAUNCH_CONTAINER") == "1":
+            return_only_filename = True
+        else:
+            return_only_filename = False
+
     url = _get_file_url(filename, directory)
-    return _retrieve_file(url, filename, save_path)
+    return _retrieve_file(url, filename, save_path, return_only_filename)

src/ansys/fluent/core/fluent_connection.py

@@ -255,8 +255,8 @@ def __init__(
             logger.debug("Cortex connection properties successfully obtained.")
         except _InactiveRpcError:
             logger.warning(
-                "Cortex properties unobtainable, force exit "
-                " methods are not going to work, proceeding..."
+                "Fluent Cortex properties unobtainable, force exit and other"
+                "methods are not going to work properly, proceeding..."
             )
             cortex_host = None
             cortex_pid = None

src/ansys/fluent/core/launcher/fluent_container.py

@@ -28,27 +28,26 @@
 
 >>> import ansys.fluent.core as pyfluent
 >>> config_dict = pyfluent.launch_fluent(start_container=True, dry_run=True)
-Container run configuration information:
-image_name = 'ghcr.io/ansys/pyfluent:v23.1.0'
->>> config_dict
+Docker container run configuration information:
+
+config_dict =
 {'auto_remove': True,
- 'command': ['-gu',
-             '-sifile=/home/user/.local/share/ansys_fluent_core/examples/serverinfo-reh96tuo.txt',
-             '3ddp'],
+ 'command': ['-gu', '-sifile=/tmpdir/serverinfo-lpqsdldw.txt', '3ddp'],
  'detach': True,
- 'environment': {'ANSYSLMD_LICENSE_FILE': '1450@license_server.com',
-                 'REMOTING_PORTS': '57193/portspan=2'},
+ 'environment': {'ANSYSLMD_LICENSE_FILE': '[email protected]',
+                 'REMOTING_PORTS': '54000/portspan=2'},
+ 'fluent_image': 'ghcr.io/ansys/pyfluent:v23.2.0',
  'labels': {'test_name': 'none'},
- 'ports': {'57193': 57193},
- 'volumes': ['/home/user/.local/share/ansys_fluent_core/examples:/home/user/.local/share/ansys_fluent_core/examples'],
- 'working_dir': '/home/user/.local/share/ansys_fluent_core/examples'}
+ 'ports': {'54000': 54000},
+ 'volumes': ['/home/user/.local/share/ansys_fluent_core/examples:/tmpdir'],
+ 'working_dir': '/tmpdir'}
 >>> config_dict.update(image_name='custom_fluent', image_tag='v23.1.0', mem_limit='1g')
 >>> session = pyfluent.launch_fluent(container_dict=config_dict)
 
 """
 import logging
 import os
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 import tempfile
 from typing import List, Union
 
@@ -59,13 +58,14 @@
 import docker
 
 logger = logging.getLogger("pyfluent.launcher")
+DEFAULT_CONTAINER_MOUNT_PATH = "/tmpdir"
 
 
 def configure_container_dict(
     args: List[str],
     host_mount_path: Union[str, Path] = None,
     container_mount_path: Union[str, Path] = None,
-    timeout: int = 30,
+    timeout: int = 60,
     port: int = None,
     license_server: str = None,
     container_server_info_file: Union[str, Path] = None,
@@ -74,7 +74,7 @@ def configure_container_dict(
     image_name: str = None,
     image_tag: str = None,
     **container_dict,
-) -> (str, dict, int, int, Path, bool):
+) -> (dict, int, int, Path, bool):
     """Parses the parameters listed below, and sets up the container configuration file.
 
     Parameters
@@ -112,7 +112,7 @@ def configure_container_dict(
     container_dict : dict
     timeout : int
     port : int
-    container_server_info_file : Path
+    host_server_info_file : Path
     remove_server_info_file: bool
 
     Notes
@@ -133,7 +133,7 @@ def configure_container_dict(
 
     if not container_mount_path:
         container_mount_path = os.getenv(
-            "PYFLUENT_CONTAINER_MOUNT_PATH", host_mount_path
+            "PYFLUENT_CONTAINER_MOUNT_PATH", DEFAULT_CONTAINER_MOUNT_PATH
         )
 
     if "volumes" not in container_dict:
@@ -183,21 +183,26 @@ def configure_container_dict(
                         "Specified a server info file command argument as well as "
                         "a container_server_info_file, pick one."
                     )
-                container_server_info_file = Path(v.lstrip("-sifile=")).name
+                container_server_info_file = PurePosixPath(
+                    v.replace("-sifile=", "")
+                ).name
                 logger.debug(
                     f"Found server info file specification for {container_server_info_file}."
                 )
 
     if container_server_info_file:
         container_server_info_file = (
-            Path(container_mount_path) / Path(container_server_info_file).name
+            PurePosixPath(container_mount_path)
+            / PurePosixPath(container_server_info_file).name
         )
     else:
         fd, sifile = tempfile.mkstemp(
             suffix=".txt", prefix="serverinfo-", dir=host_mount_path
         )
         os.close(fd)
-        container_server_info_file = Path(container_mount_path) / Path(sifile).name
+        container_server_info_file = (
+            PurePosixPath(container_mount_path) / Path(sifile).name
+        )
 
     if not fluent_image:
         if not image_tag:
@@ -210,9 +215,11 @@ def configure_container_dict(
             fluent_image = f"{image_name}:{image_tag}"
         else:
             raise ValueError(
-                "Missing 'fluent_image' specification for Docker container launch."
+                "Missing 'fluent_image', or 'image_tag' and 'image_name', specification for Docker container launch."
             )
 
+    container_dict["fluent_image"] = fluent_image
+
     fluent_commands = ["-gu", f"-sifile={container_server_info_file}"] + args
 
     container_dict_default = {}
@@ -222,18 +229,22 @@ def configure_container_dict(
         auto_remove=True,
     )
 
+    if fluent_image.split(":")[1] == "v24.1.0":
+        container_dict_default.update(tty=True)
+
     for k, v in container_dict_default.items():
         if k not in container_dict:
             container_dict[k] = v
 
     logger.debug(f"container_dict after processing: {container_dict}")
 
+    host_server_info_file = Path(host_mount_path) / container_server_info_file.name
+
     return (
-        fluent_image,
         container_dict,
         timeout,
         port,
-        container_server_info_file,
+        host_server_info_file,
         remove_server_info_file,
     )
 
@@ -268,39 +279,38 @@ def start_fluent_container(args: List[str], container_dict: dict = None) -> (int
     logger.debug(f"container_vars:{container_vars}")
 
     (
-        fluent_image,
         config_dict,
         timeout,
         port,
-        container_server_info_file,
+        host_server_info_file,
         remove_server_info_file,
     ) = container_vars
 
     try:
-        if not container_server_info_file.exists():
-            container_server_info_file.mkdir(exist_ok=True)
+        if not host_server_info_file.exists():
+            host_server_info_file.parents[0].mkdir(exist_ok=True)
 
-        container_server_info_file.touch(exist_ok=True)
-        last_mtime = container_server_info_file.stat().st_mtime
+        host_server_info_file.touch(exist_ok=True)
+        last_mtime = host_server_info_file.stat().st_mtime
 
         docker_client = docker.from_env()
 
         logger.debug("Starting Fluent docker container...")
 
-        docker_client.containers.run(fluent_image, **config_dict)
+        docker_client.containers.run(config_dict.pop("fluent_image"), **config_dict)
 
         success = timeout_loop(
-            lambda: container_server_info_file.stat().st_mtime > last_mtime, timeout
+            lambda: host_server_info_file.stat().st_mtime > last_mtime, timeout
         )
 
         if not success:
             raise RuntimeError(
                 "Fluent container launch timeout, will have to stop container manually."
             )
         else:
-            _, _, password = _parse_server_info_file(str(container_server_info_file))
+            _, _, password = _parse_server_info_file(str(host_server_info_file))
 
             return port, password
     finally:
-        if remove_server_info_file and container_server_info_file.exists():
-            container_server_info_file.unlink()
+        if remove_server_info_file and host_server_info_file.exists():
+            host_server_info_file.unlink()

src/ansys/fluent/core/launcher/launcher.py

@@ -760,11 +760,12 @@ def launch_fluent(
             args.append(" -meshing")
 
         if dry_run:
-            image_name, config_dict, *_ = configure_container_dict(args, container_dict)
+            if container_dict is None:
+                container_dict = {}
+            config_dict, *_ = configure_container_dict(args, **container_dict)
             from pprint import pprint
 
-            print("\nContainer run configuration information:\n")
-            print(f"image_name = '{image_name}'\n")
+            print("\nDocker container run configuration:\n")
             print("config_dict = ")
             pprint(config_dict)
             return config_dict