FIX: ServiceManager.start_service ignores configured AEDT path in PYAEDT_SERVER_AEDT_PATH env var

doc/changelog.d/6867.fixed.md

@@ -0,0 +1 @@
+ServiceManager.start_service ignores configured AEDT path in PYAEDT_SERVER_AEDT_PATH env var

pyproject.toml

@@ -51,6 +51,7 @@ unit-tests = [
     "mock>=5.1.0,<5.3",
     "fpdf2",
     "requests",
+    "rpyc>=6.0.0,<6.1",
 ]
 integration-tests = [
     "matplotlib>=3.5.0,<3.11",
@@ -67,7 +68,6 @@ tests = [
     "pyvista[io]>=0.38.0,<0.47",
     "scikit-rf>=0.30.0,<1.9",
     "tables",
-    "rpyc>=6.0.0,<6.1",
 ]
 dotnet = [
     "ansys-pythonnet>=3.1.0rc3",
@@ -152,7 +152,7 @@ Changelog = "https://github.com/ansys/pyaedt/blob/main/doc/source/changelog.rst"
 [tool.ruff]
 line-length = 120
 fix = true
-exclude = ["*.def", "*.aedt", "*.aedtz"] # Do not check AEDT/EDB binary files 
+exclude = ["*.def", "*.aedt", "*.aedtz"] # Do not check AEDT/EDB binary files
 
 [tool.ruff.format]
 quote-style = "double"
@@ -218,7 +218,7 @@ ignore = [
     "PTH119", # os-path-basename
     "PTH120", # os-path-dirname
     "PTH122", # os-path-splitext
-    "PTH123", # builtin-open 
+    "PTH123", # builtin-open
     "PTH201", # path-constructor-current-directory
     "PTH208", # os-listdir
 

src/ansys/aedt/core/rpc/rpyc_services.py

@@ -1171,7 +1171,7 @@ def start_service(self, port):
             ansysem_path = os.getenv("PYAEDT_SERVER_AEDT_PATH")
             if ansysem_path and not os.path.exists(ansysem_path):
                 raise FileNotFoundError(f"The ANSYSEM path '{ansysem_path}' does not exist.")
-            else:
+            elif not ansysem_path:
                 version_list = aedt_versions.list_installed_ansysem
                 if version_list:
                     ansysem_path = os.environ[version_list[0]]

tests/unit/test_service_manager.py

@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pathlib import Path
+import sys
+from typing import Generator
+from unittest.mock import MagicMock
+from unittest.mock import patch
+
+import pytest
+
+from ansys.aedt.core.rpc import rpyc_services
+
+LOCAL_SERVER_FILE = Path(rpyc_services.__file__).parent / "local_server.py"
+ERROR_MSG = "Error. No connection exists. Check if AEDT is running and if the port number is correct."
+PORT = 18000
+
+
+@pytest.fixture
+def mock_service_dependencies() -> Generator:
+    """Mock common dependencies to test ServiceManager.
+
+    Mocks subprocess.Popen, check_port, and time.sleep used in ServiceManager.start_service.
+    """
+    with (
+        patch("ansys.aedt.core.rpc.rpyc_services.subprocess.Popen") as mock_popen,
+        patch("ansys.aedt.core.rpc.rpyc_services.check_port") as mock_check_port,
+        patch("ansys.aedt.core.rpc.rpyc_services.time.sleep") as mock_sleep,
+    ):
+        # Configure Popen mock
+        mock_process = MagicMock()
+        mock_process.returncode = 0
+        mock_popen.return_value = mock_process
+
+        # Configure check_port mock
+        mock_check_port.return_value = PORT
+
+        # Return dict for easier access
+        yield mock_popen, mock_check_port, mock_sleep
+
+
+def test_start_service_with_valid_path_in_env_var(
+    monkeypatch: pytest.MonkeyPatch, tmp_path: Path, mock_service_dependencies: Generator
+):
+    """Test that start_service uses the path from PYAEDT_SERVER_AEDT_PATH when it exists."""
+    mock_popen, _, _ = mock_service_dependencies
+    monkeypatch.setenv("PYAEDT_SERVER_AEDT_PATH", str(tmp_path))
+
+    service_manager = rpyc_services.ServiceManager()
+    service_manager.on_connect(MagicMock())
+    result = service_manager.start_service(PORT)
+
+    assert PORT == result
+    mock_popen.assert_called_once_with([sys.executable, str(LOCAL_SERVER_FILE), str(tmp_path), "1", str(PORT)])
+
+
+@patch("logging.Logger.error")
+@patch("ansys.aedt.core.rpc.rpyc_services.aedt_versions")
+def test_start_service_with_invalid_path_in_env_var(
+    mock_aedt_versions,
+    mock_logger_error,
+    monkeypatch: pytest.MonkeyPatch,
+    tmp_path: Path,
+    mock_service_dependencies: Generator,
+):
+    """Test that start_service returns False when PYAEDT_SERVER_AEDT_PATH points to a non-existent directory."""
+    mock_popen, _, _ = mock_service_dependencies
+    inexistent_dir = tmp_path / "non_existent_directory"
+    fallback_path_latest = "/path/to/ansys/v252"
+    monkeypatch.setenv("PYAEDT_SERVER_AEDT_PATH", str(inexistent_dir))
+    # Add fallback path to verify that it's ignored if env var is set, even if the value from the env var doesn't exist.
+    monkeypatch.setenv("ANSYSEM_ROOT252_CUSTOM", fallback_path_latest)
+    mock_aedt_versions.list_installed_ansysem = ["ANSYSEM_ROOT252_CUSTOM"]
+
+    service_manager = rpyc_services.ServiceManager()
+    service_manager.on_connect(MagicMock())
+    result = service_manager.start_service(PORT)
+
+    assert result is False
+    mock_logger_error.assert_called_once_with(ERROR_MSG)
+    mock_popen.assert_not_called()
+
+
+@patch("ansys.aedt.core.rpc.rpyc_services.aedt_versions")
+def test_start_service_without_env_var_defaults_to_latest_installed_path(
+    mock_aedt_versions, monkeypatch: pytest.MonkeyPatch, mock_service_dependencies
+):
+    """Test that start_service falls back to the latest ANSYSEM_ROOTXXX path when PYAEDT_SERVER_AEDT_PATH is not set."""
+    mock_popen, _, _ = mock_service_dependencies
+    fallback_path_latest = "/path/to/ansys/v252"
+    fallback_path_previous = "/path/to/ansys/v251"
+    monkeypatch.delenv("PYAEDT_SERVER_AEDT_PATH", raising=False)
+    monkeypatch.setenv("ANSYSEM_ROOT252_CUSTOM", fallback_path_latest)
+    monkeypatch.setenv("ANSYSEM_ROOT251_CUSTOM", fallback_path_previous)
+    mock_aedt_versions.list_installed_ansysem = ["ANSYSEM_ROOT252_CUSTOM", "ANSYSEM_ROOT251_CUSTOM"]
+
+    service_manager = rpyc_services.ServiceManager()
+    service_manager.on_connect(MagicMock())
+    result = service_manager.start_service(PORT)
+
+    assert PORT == result
+    mock_popen.assert_called_once_with(
+        [sys.executable, str(LOCAL_SERVER_FILE), str(fallback_path_latest), "1", str(PORT)]
+    )
+
+
+@patch("logging.Logger.error")
+@patch("ansys.aedt.core.rpc.rpyc_services.aedt_versions")
+def test_start_service_without_env_var_and_no_installed_path(
+    mock_aedt_versions, mock_logger_error, monkeypatch: pytest.MonkeyPatch, mock_service_dependencies
+):
+    """Test that start_service returns False when neither PYAEDT_SERVER_AEDT_PATH nor ANSYSEM_ROOTXXX are available."""
+    mock_popen, _, _ = mock_service_dependencies
+    monkeypatch.delenv("PYAEDT_SERVER_AEDT_PATH", raising=False)
+    mock_aedt_versions.list_installed_ansysem = []
+
+    service_manager = rpyc_services.ServiceManager()
+    service_manager.on_connect(MagicMock())
+    result = service_manager.start_service(PORT)
+
+    assert result is False
+    mock_logger_error.assert_called_once_with(ERROR_MSG)
+    mock_popen.assert_not_called()