Merge branch 'rluciano/container-and-launch-fixes' into rluciano/env-vars-revision

Author: raph-luc

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

@@ -123,15 +123,6 @@ def dict_to_str(dict: dict) -> str:
     """Converts the dict to string while hiding the 'environment' argument from the dictionary,
     if the environment variable 'PYFLUENT_HIDE_LOG_SECRETS' is '1'.
     This is useful for logging purposes, to avoid printing sensitive information such as license server details.
-
-    Parameters
-    ----------
-    dict : dict
-        The container dictionary to be converted to string.
-    Returns
-    -------
-    string
-        Nicely formatted string representation of the dictionary, with the 'environment' key removed if hiding secrets.
     """
 
     if "environment" in dict and os.getenv("PYFLUENT_HIDE_LOG_SECRETS") == "1":
@@ -182,9 +173,12 @@ def configure_container_dict(
     args : List[str]
         List of Fluent launch arguments.
     mount_source : str | Path, optional
-        Existing path in the host operating system that will be mounted to ``mount_target``.
+        Path on the host system to mount into the container. This directory will serve as the working directory
+        for the Fluent process inside the container. If not specified, PyFluent's current working directory will
+        be used.
     mount_target : str | Path, optional
-        Path inside the container where ``mount_source`` will be mounted to.
+        Path inside the container where ``mount_source`` will be mounted. This will be the working directory path
+        visible to the Fluent process running inside the container.
     timeout : int, optional
         Time limit  for the Fluent container to start, in seconds. By default, 60 seconds.
     port : int, optional

tests/test_builtin_settings.py

@@ -661,8 +661,8 @@ def test_builtin_settings(mixing_elbow_case_data_session):
     else:
         with pytest.raises(RuntimeError):
             CustomVectors(settings_source=solver)
-    tmp_save_path = tempfile.mkdtemp(dir=pyfluent.EXAMPLES_PATH)
-    project_file = Path(tmp_save_path) / "mixing_elbow_param.flprj"
+    tmp_save_path = Path(tempfile.mkdtemp(dir=pyfluent.EXAMPLES_PATH))
+    project_file = Path(tmp_save_path.parts[-1]) / "mixing_elbow_param.flprj"
     solver.settings.parametric_studies.initialize(project_filename=str(project_file))
     assert ParametricStudies(settings_source=solver) == solver.parametric_studies
     assert (

tests/test_launcher.py

@@ -554,10 +554,10 @@ def test_fluent_automatic_transcript(monkeypatch):
     with monkeypatch.context() as m:
         m.setattr(pyfluent, "FLUENT_AUTOMATIC_TRANSCRIPT", True)
         with TemporaryDirectory(dir=pyfluent.EXAMPLES_PATH) as tmp_dir:
-            with pyfluent.launch_fluent(container_dict=dict(working_dir=tmp_dir)):
+            with pyfluent.launch_fluent(container_dict=dict(mount_source=tmp_dir)):
                 assert list(Path(tmp_dir).glob("*.trn"))
     with TemporaryDirectory(dir=pyfluent.EXAMPLES_PATH) as tmp_dir:
-        with pyfluent.launch_fluent(container_dict=dict(working_dir=tmp_dir)):
+        with pyfluent.launch_fluent(container_dict=dict(mount_source=tmp_dir)):
             assert not list(Path(tmp_dir).glob("*.trn"))
 
 

tests/test_session.py

@@ -594,7 +594,6 @@ def test_general_exception_behaviour_in_session(new_solver_session):
     case_file = examples.download_file(
         "mixing_elbow.cas.h5",
         "pyfluent/mixing_elbow",
-        return_without_path=False,
     )
     solver.settings.file.read(file_type="case", file_name=case_file)
     solver.file.write(file_name="sample.cas.h5", file_type="case")
@@ -658,16 +657,20 @@ def test_app_utilities_new_and_old(mixing_elbow_settings_session):
 
     assert not solver._app_utilities.is_solution_data_available()
 
-    tmp_dir = tempfile.mkdtemp(dir=pyfluent.EXAMPLES_PATH)
+    tmp_path = tempfile.mkdtemp(dir=pyfluent.EXAMPLES_PATH)
 
-    solver.chdir(tmp_dir)
+    # when running in a container, only the randomly generated folder name will be seen
+    # the full paths will be different between host and container
+    tmp_folder = Path(tmp_path).parts[-1]
+
+    solver.chdir(tmp_folder)
 
     cortex_info = solver._app_utilities.get_controller_process_info()
     solver_info = solver._app_utilities.get_solver_process_info()
 
-    assert Path(cortex_info.working_directory) == Path(tmp_dir)
+    assert Path(cortex_info.working_directory).parts[-1] == tmp_folder
 
-    assert Path(solver_info.working_directory) == Path(tmp_dir)
+    assert Path(solver_info.working_directory).parts[-1] == tmp_folder
 
 
 @pytest.mark.standalone