feat: default logs folder on Geometry Service started by Python at PUBLIC (Windows) (#1386)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: RobPasMue

doc/changelog.d/1386.added.md

@@ -0,0 +1 @@
+default logs folder on Geometry Service started by Python at PUBLIC (Windows)

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

@@ -23,6 +23,7 @@
 
 import logging
 import os
+from pathlib import Path
 from typing import TYPE_CHECKING
 
 from ansys.geometry.core.connection.backend import ApiVersions, BackendType
@@ -576,6 +577,13 @@ def launch_modeler_with_geometry_service(
             "Please remove it from the arguments."
         )
 
+    # If we are in a Windows environment, we are going to write down the server
+    # logs in the %PUBLIC%/Documents/Ansys/GeometryService folder.
+    if os.name == "nt" and server_logs_folder is None:
+        # Writing to the "Public" folder by default - no write permissions specifically required.
+        server_logs_folder = Path(os.getenv("PUBLIC"), "Documents", "Ansys", "GeometryService")
+        LOG.info(f"Writing server logs to the default folder at {server_logs_folder}.")
+
     return prepare_and_start_backend(
         BackendType.WINDOWS_SERVICE,
         product_version=product_version,

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

@@ -270,6 +270,19 @@ def prepare_and_start_backend(
         product_version = get_latest_ansys_installation()[0]
         _check_minimal_versions(product_version)
 
+    if server_logs_folder is not None:
+        # Verify that the user has write permissions to the folder and that it exists.
+        try:
+            # Make sure the folder exists...
+            Path(server_logs_folder).mkdir(parents=True, exist_ok=True)
+            # Create a file to test write permissions...
+            Path(server_logs_folder, ".verify").touch(exist_ok=True)
+        except PermissionError:
+            raise RuntimeError(
+                "User does not have write permissions to the logs folder "
+                f"{Path(server_logs_folder).resolve()}"
+            )
+
     args = []
     env_copy = _get_common_env(
         host=host,