REFACTOR: Conftest refactoring and local_config cleaning (#6727)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>

Author: 3 people

.github/workflows/ci_cd.yml

@@ -18,6 +18,7 @@ env:
   DOCUMENTATION_CNAME: 'aedt.docs.pyansys.com'
   ON_CI: True
   PYTEST_ARGUMENTS: '-vvv --color=yes -ra --durations=25 --maxfail=10 --cov=ansys.aedt.core --cov-report=html --cov-report=xml --junitxml=junit/test-results.xml'
+  PYAEDT_LOCAL_SETTINGS_PATH: 'tests/pyaedt_settings.yaml'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.gitignore

@@ -372,12 +372,11 @@ dist/
 /htmlcov/
 /coverage.xml
 /tests/system/general/coverage.xml
-/tests/system/general/local_config.json
 /tests/system/solvers/coverage.xml
-/tests/system/solvers/local_config.json
 /tests/unit/coverage.xml
 test-results.xml
 test-output.xml
+*local_config.json
 
 # Scratch Jupyter Notebooks
 scratch_notebooks/
@@ -397,13 +396,10 @@ model.index\+
 
 # local environment settings used by e.g. Visual Studio Code
 /.env
-/doc/source/local_config.json
 /.venv*
 
 # test coverage output
 /.cov/
-/tests/system/visualization/local_config.json
-/tests/system/general/pyaedt_settings.yaml
 
 # Custom instructions for GitHub Copilot
 .github/copilot-instructions.md

doc/changelog.d/6727.miscellaneous.md

@@ -0,0 +1 @@
+Conftest refactoring and local_config cleaning

tests/__init__.py

@@ -27,8 +27,9 @@
 TESTS_PATH = Path(__file__).resolve().parent
 TESTS_SYSTEM_PATH = TESTS_PATH / "system"
 TESTS_UNIT_PATH = TESTS_PATH / "unit"
+TESTS_EMIT_PATH = TESTS_SYSTEM_PATH / "emit"
+TESTS_EXTENSIONS_PATH = TESTS_SYSTEM_PATH / "extensions"
+TESTS_FILTER_SOLUTIONS_PATH = TESTS_SYSTEM_PATH / "filter_solutions"
 TESTS_GENERAL_PATH = TESTS_SYSTEM_PATH / "general"
 TESTS_SOLVERS_PATH = TESTS_SYSTEM_PATH / "solvers"
 TESTS_VISUALIZATION_PATH = TESTS_SYSTEM_PATH / "visualization"
-TESTS_EXTENSIONS_PATH = TESTS_SYSTEM_PATH / "extensions"
-TESTS_FILTER_SOLUTIONS_PATH = TESTS_SYSTEM_PATH / "filter_solutions"

tests/conftest.py

@@ -22,12 +22,24 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+import json
+import os
+from pathlib import Path
+import random
+import shutil
+import string
 import sys
+import tempfile
 from typing import List
 from unittest.mock import MagicMock
 
 import pytest
 
+from ansys.aedt.core.aedt_logger import pyaedt_logger
+from ansys.aedt.core.generic.settings import settings
+from ansys.aedt.core.internal.filesystem import Scratch
+
+# Test category prefixes for marker assignment
 UNIT_TEST_PREFIX = "tests/unit"
 INTEGRATION_TEST_PREFIX = "tests/integration"
 SYSTEM_TEST_PREFIX = "tests/system"
@@ -39,6 +51,68 @@
 EMIT_TEST_PREFIX = "tests/system/emit"
 
 
+DEFAULT_CONFIG = {
+    "desktopVersion": "2025.2",
+    "NonGraphical": True,
+    "NewThread": True,
+    "use_grpc": True,
+    "close_desktop": True,
+    "remove_lock": False,
+    "disable_sat_bounding_box": True,
+    "use_local_example_data": False,
+    "local_example_folder": None,
+    "skip_circuits": False,
+    "skip_modelithics": True,
+}
+
+# Load top-level configuration
+local_path = Path(__file__).parent
+local_config_file = local_path / "local_config.json"
+
+config = DEFAULT_CONFIG.copy()
+if local_config_file.exists():
+    try:
+        with open(local_config_file) as f:
+            local_config = json.load(f)
+        config.update(local_config)
+    except Exception as e:  # pragma: no cover
+        # Failed to load local_config.json; report error
+        print(f"Failed to load local_config.json ({local_config_file}): {e}")
+
+desktop_version = config.get("desktopVersion", DEFAULT_CONFIG.get("desktopVersion"))
+NONGRAPHICAL = config.get("NonGraphical", DEFAULT_CONFIG.get("NonGraphical"))
+new_thread = config.get("NewThread", DEFAULT_CONFIG.get("NewThread"))
+settings.use_grpc_api = config.get("use_grpc", DEFAULT_CONFIG.get("use_grpc"))
+close_desktop = config.get("close_desktop", DEFAULT_CONFIG.get("close_desktop"))
+remove_lock = config.get("remove_lock", DEFAULT_CONFIG.get("remove_lock"))
+settings.disable_bounding_box_sat = config.get(
+    "disable_sat_bounding_box", DEFAULT_CONFIG.get("disable_sat_bounding_box")
+)
+settings.use_local_example_data = config.get("use_local_example_data", DEFAULT_CONFIG.get("use_local_example_data"))
+if settings.use_local_example_data:
+    settings.local_example_folder = config.get("local_example_folder", DEFAULT_CONFIG.get("local_example_folder"))
+
+logger = pyaedt_logger
+os.environ["PYAEDT_SCRIPT_VERSION"] = config.get("desktopVersion", DEFAULT_CONFIG.get("desktopVersion"))
+
+
+# Add current path to sys.path for imports
+sys.path.append(str(local_path))
+
+
+def generate_random_string(length):
+    """Generate a random string of specified length."""
+    characters = string.ascii_letters + string.digits
+    random_string = "".join(random.sample(characters, length))
+    return random_string
+
+
+def generate_random_ident():
+    """Generate a random identifier for test folders."""
+    ident = "-" + generate_random_string(6) + "-" + generate_random_string(6) + "-" + generate_random_string(6)
+    return ident
+
+
 def pytest_collection_modifyitems(config: pytest.Config, items: List[pytest.Item]):
     """Hook used to apply marker on tests."""
     for item in items:
@@ -64,8 +138,41 @@ def pytest_collection_modifyitems(config: pytest.Config, items: List[pytest.Item
             item.add_marker(pytest.mark.emit)
 
 
+# ================================
+# SHARED FIXTURES
+# ================================
+
+
+@pytest.fixture(scope="session", autouse=True)
+def init_scratch():
+    """Initialize a global scratch directory for all tests."""
+    test_folder_name = "pyaedt_test" + generate_random_ident()
+    test_folder = Path(tempfile.gettempdir()) / test_folder_name
+    try:
+        os.makedirs(test_folder, mode=0o777)
+    except FileExistsError as e:
+        print(f"Failed to create {test_folder}. Reason: {e}")
+
+    yield test_folder
+
+    try:
+        shutil.rmtree(test_folder, ignore_errors=True)
+    except Exception as e:
+        print(f"Failed to delete {test_folder}. Reason: {e}")
+
+
+@pytest.fixture(scope="module", autouse=True)
+def local_scratch(init_scratch):
+    """Provide a module-scoped scratch directory."""
+    tmp_path = init_scratch
+    scratch = Scratch(tmp_path)
+    yield scratch
+    scratch.remove()
+
+
 @pytest.fixture
 def touchstone_file(tmp_path):
+    """Create a dummy touchstone file for testing."""
     file_path = tmp_path / "dummy.s2p"
     file_content = """
 ! Terminal data exported
@@ -80,6 +187,7 @@ def touchstone_file(tmp_path):
 
 @pytest.fixture()
 def patch_graphics_modules(monkeypatch):
+    """Patch graphics modules to avoid headless env issues."""
     modules = [
         "matplotlib",
         "matplotlib.pyplot",
@@ -100,9 +208,9 @@ def patch_graphics_modules(monkeypatch):
 
     # Specific action to make a mock an attribute of another mock
     mocks["matplotlib"].pyplot = mocks["matplotlib.pyplot"]
-    mocks["ansys.tools.visualization_interface"].backends = mocks["ansys.tools.visualization_interface.backends"]
-    mocks["ansys.tools.visualization_interface.backends"].pyvista = mocks[
-        "ansys.tools.visualization_interface.backends.pyvista"
-    ]
+    viz_interface = mocks["ansys.tools.visualization_interface"]
+    viz_backends = mocks["ansys.tools.visualization_interface.backends"]
+    viz_interface.backends = viz_backends
+    viz_backends.pyvista = mocks["ansys.tools.visualization_interface.backends.pyvista"]
 
     yield mocks

tests/pyaedt_settings.yaml

@@ -0,0 +1,18 @@
+# PyAEDT settings configuration for test environment
+# This file configures PyAEDT settings for all tests
+
+log:
+  enable_local_log_file: false
+  enable_global_log_file: false
+  enable_desktop_logs: false
+
+general:
+  number_of_grpc_api_retries: 6
+  retry_n_times_time_interval: 0.5
+  enable_error_handler: false
+  desktop_launch_timeout: 180
+  release_on_exception: false
+  wait_for_license: true
+  enable_pandas_output: true
+lsf: {}
+  # LSF settings are kept at defaults for test environment