refactor: remove RUNNING_TESTS global flag and running_test fixture (#4455)

* refactor: remove RUNNING_TESTS global flag and running_test fixture

Replace test-specific production code with mock/patch in tests.

- Remove RUNNING_TESTS: bool = False global from �nsys.mapdl.core
- Remove the if pymapdl.RUNNING_TESTS early-return guard from
  _retrieve_file() in downloads.py and drop the dead _test
  parameters from _retrieve_file and _download_file
- Remove the RUNNING_TESTS import and dead log block from
  
un_every_import() in helpers.py
- Simplify the session-ID check condition in mapdl_core.py:
  pymapdl.RUNNING_TESTS or self._strict_session_id_check
  → self._strict_session_id_check
- Remove the Running_test context-manager class, the 
unning_test
  fixture, and the pymapdl.RUNNING_TESTS = True module-level
  statement from 	ests/conftest.py
- In 	est_examples.py, replace with running_test(): (seven tests)
  with patch('...downloads._retrieve_file', return_value=True);
  strip the now-unnecessary with running_test(False): wrappers from
  	est_bracket and 	est_failed_download
- In 	est_mapdl.py, remove the Running_test import, drop the
  with running_test(): wrapper in 	est_session_id (covered by
  the pre-existing _strict_session_id_check = True), and drop the
  with Running_test(False): wrapper in 	est_igesin_whitespace

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: adding changelog file 4455.miscellaneous.md [dependabot-skip]

* fix: matching test return with function return type

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: 3 people

doc/changelog.d/4455.miscellaneous.md

@@ -0,0 +1 @@
+Remove RUNNING_TESTS global flag and running_test fixture

src/ansys/mapdl/core/__init__.py

@@ -60,7 +60,6 @@
 }
 
 BUILDING_GALLERY: bool = False
-RUNNING_TESTS: bool = False
 
 DEPRECATING_MINIMUM_PYTHON_VERSION: bool = False
 MINIMUM_PYTHON_VERSION: Tuple[int, int] = (3, 10)

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

@@ -85,11 +85,7 @@ def _check_url_exist(url: str) -> bool:
 
 
 @check_directory_exist(pymapdl.EXAMPLES_PATH)
-def _retrieve_file(url: str, filename: str, _test: bool = False) -> str:
-    # escape test
-    if pymapdl.RUNNING_TESTS:
-        return _check_url_exist(url)
-
+def _retrieve_file(url: str, filename: str) -> str:
     # First check if file has already been downloaded
     local_path = os.path.join(pymapdl.EXAMPLES_PATH, os.path.basename(filename))
     local_path_no_zip = local_path.replace(".zip", "")
@@ -109,12 +105,10 @@ def _retrieve_file(url: str, filename: str, _test: bool = False) -> str:
     return local_path
 
 
-def _download_file(
-    filename: str, directory: Optional[str] = None, _test: Optional[bool] = False
-) -> str:
+def _download_file(filename: str, directory: Optional[str] = None) -> str:
     url = _get_file_url(filename, directory)
     try:
-        return _retrieve_file(url, filename, _test)
+        return _retrieve_file(url, filename)
     except requests.exceptions.HTTPError as e:
         raise requests.exceptions.HTTPError(
             "Retrieving the file from internet failed.\n"

src/ansys/mapdl/core/helpers.py

@@ -94,8 +94,4 @@ def run_first_time() -> None:
 
 def run_every_import() -> None:
     # Run every time we import PyMAPDL
-    from ansys.mapdl.core import RUNNING_TESTS
-
-    # In case we want to do something specific for testing.
-    if RUNNING_TESTS:  # pragma: no cover
-        LOG.debug("Running tests on Pytest")
+    pass

src/ansys/mapdl/core/mapdl_core.py

@@ -3408,7 +3408,7 @@ def _check_session_id(self):
 
         if pymapdl_session_id is None or self._mapdl_session_id is None:
             return
-        elif pymapdl.RUNNING_TESTS or self._strict_session_id_check:
+        elif self._strict_session_id_check:
             if pymapdl_session_id != self._mapdl_session_id:
                 self._log.error("The session ids do not match")
 

tests/conftest.py

@@ -214,10 +214,6 @@ def requires_dependency(dependency: str):
     _apply_default_theme()
 
 
-import ansys.mapdl.core as pymapdl
-
-pymapdl.RUNNING_TESTS = True
-
 from ansys.mapdl.core import Mapdl
 from ansys.mapdl.core.errors import MapdlExitedError, MapdlRuntimeError
 from ansys.mapdl.core.examples import vmfiles
@@ -528,17 +524,6 @@ def wrapped_verify_image_cache(verify_image_cache, pytestconfig):
         return verify_image_cache
 
 
-class Running_test:
-    def __init__(self, active: bool = True) -> None:
-        self._state = active
-
-    def __enter__(self) -> None:
-        pymapdl.RUNNING_TESTS = self._state
-
-    def __exit__(self, *args) -> None:
-        pymapdl.RUNNING_TESTS = not self._state
-
-
 class NullContext:
     def __enter__(self):
         pass
@@ -550,11 +535,6 @@ def __init__(self):
         pass
 
 
-@pytest.fixture(scope="function")
-def running_test():
-    return Running_test
-
-
 @pytest.fixture(autouse=True, scope="function")
 def run_before_and_after_tests(
     request: pytest.FixtureRequest, mapdl: Mapdl

tests/test_examples.py

@@ -23,6 +23,7 @@
 import os
 import re
 from subprocess import PIPE, STDOUT, Popen
+from unittest.mock import patch
 
 import pytest
 
@@ -42,6 +43,8 @@
 )
 from conftest import requires
 
+DUMMY_PATH = "/dummy/download/path"
+
 
 def test_check_directory_exist(tmpdir):
     tmp_dir = os.path.join(tmpdir, "mytempdir")
@@ -90,10 +93,9 @@ def test_load_verif():
 
 
 @requires("requests")
-def test_bracket(mapdl, cleared, running_test):
+def test_bracket(mapdl, cleared):
     # note that this method just returns a file path
-    with running_test(False):  # To force downloading the file
-        bracket_file = examples.download_bracket()
+    bracket_file = examples.download_bracket()
 
     assert os.path.isfile(bracket_file)
 
@@ -111,57 +113,72 @@ def test_download_example_data_true_download():
 
 
 @requires("requests")
-def test_failed_download(running_test):
+def test_failed_download():
     from requests.exceptions import HTTPError
 
     filename = "non_existing_file"
     with pytest.raises(HTTPError):
-        with running_test(active=False):  # To force downloading the file
-            _download_file(filename, directory=None)
+        _download_file(filename, directory=None)
 
 
 @requires("requests")
-def test_download_cfx_mapping_example_data(running_test):
-    with running_test():
-        assert all(download_cfx_mapping_example_data().values())
+def test_download_cfx_mapping_example_data():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
+        result = download_cfx_mapping_example_data()
+        assert all(v == DUMMY_PATH for v in result.values())
 
 
 @requires("requests")
-def test_download_manifold_example_data(running_test):
-    with running_test():
-        assert all(download_manifold_example_data().values())
+def test_download_manifold_example_data():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
+        result = download_manifold_example_data()
+        assert all(v == DUMMY_PATH for v in result.values())
 
 
 @requires("requests")
-def test_download_bracket(running_test):
-    with running_test():
-        assert download_bracket() is True
+def test_download_bracket():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
+        assert download_bracket() == DUMMY_PATH
 
 
 @requires("requests")
-def test_download_vtk_rotor(running_test):
-    with running_test():
-        assert download_vtk_rotor() is True
+def test_download_vtk_rotor():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
+        assert download_vtk_rotor() == DUMMY_PATH
 
 
 @requires("requests")
-def test__download_rotor_tech_demo_vtk(running_test):
-    with running_test():
-        assert _download_rotor_tech_demo_vtk() is True
+def test__download_rotor_tech_demo_vtk():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
+        assert _download_rotor_tech_demo_vtk() == DUMMY_PATH
 
 
 @requires("requests")
-def test_download_example_data(running_test):
-    with running_test():
-        assert download_example_data("LatheCutter.anf", "geometry") is True
+def test_download_example_data():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
+        assert download_example_data("LatheCutter.anf", "geometry") == DUMMY_PATH
 
 
 @requires("requests")
-def test_download_tech_demo_data(running_test):
-    with running_test():
+def test_download_tech_demo_data():
+    with patch(
+        "ansys.mapdl.core.examples.downloads._retrieve_file", return_value=DUMMY_PATH
+    ):
         assert (
             download_tech_demo_data("td-21", "ring_stiffened_cylinder_mesh_file.cdb")
-            is True
+            == DUMMY_PATH
         )
 
 

tests/test_mapdl.py

@@ -49,7 +49,6 @@
     TEST_DPF_BACKEND,
     VALID_PORTS,
     NullContext,
-    Running_test,
     has_dependency,
     requires,
 )
@@ -2079,7 +2078,7 @@ def test_get_not_muted(mapdl, cleared):
     mock_not_muted.assert_not_called()
 
 
-def test_session_id(mapdl, running_test):
+def test_session_id(mapdl):
     # Calling here to make sure we have a session id before testing it.
     mapdl.clear()
 
@@ -2098,8 +2097,7 @@ def test_session_id(mapdl, running_test):
 
     # Checking real case
     mapdl._session_id_ = copy_
-    with running_test():
-        assert isinstance(mapdl._check_session_id(), bool)
+    assert isinstance(mapdl._check_session_id(), bool)
 
     id_ = "123412341234"
     mapdl._session_id_ = id_
@@ -2124,8 +2122,7 @@ def test_check_empty_session_id(mapdl, cleared):
 @requires("requests")  # Requires 'requests' package
 def test_igesin_whitespace(mapdl, cleared, tmpdir):
     # make sure we download the IGES file
-    with Running_test(False):  # allow access to internet
-        bracket_file = pymapdl.examples.download_bracket()
+    bracket_file = pymapdl.examples.download_bracket()
 
     assert os.path.isfile(bracket_file)