fix: broken interactive docs and improved tests paths (#1244)

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

Author: RobPasMue

doc/changelog.d/1244.changed.md

@@ -0,0 +1 @@
+fix: broken interactive docs and improved tests paths

doc/source/conf.py

@@ -6,7 +6,6 @@
 from pathlib import Path
 import time
 
-import ansys.tools.visualization_interface as viz_interface
 from ansys_sphinx_theme import (
     ansys_favicon,
     ansys_logo_white,
@@ -22,7 +21,13 @@
 
 from ansys.geometry.core import __version__
 
-viz_interface.DOCUMENTATION_BUILD = True
+# For some reason the global var is not working on doc build...
+# import ansys.tools.visualization_interface as viz_interface
+#
+# viz_interface.DOCUMENTATION_BUILD = True
+#
+# Using env var instead
+os.environ["PYANSYS_VISUALIZER_DOC_MODE"] = "true"
 
 LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]
 

tests/integration/conftest.py

@@ -45,6 +45,10 @@
 viz_interface.TESTING_MODE = True
 pv.global_theme.window_size = [600, 600]
 
+IMPORT_FILES_DIR = Path(Path(__file__).parent, "files", "import")
+DSCOSCRIPTS_FILES_DIR = Path(Path(__file__).parent, "files", "disco_scripts")
+FILES_DIR = Path(Path(__file__).parent, "files")
+
 
 # TODO: re-enable when Linux service is able to use measurement tools
 def skip_if_linux(modeler: Modeler, test_name: str, element_not_available: str):

tests/integration/test_design.py

@@ -60,7 +60,7 @@
 from ansys.geometry.core.shapes.parameterization import Interval, ParamUV
 from ansys.geometry.core.sketch import Sketch
 
-from .conftest import skip_if_linux
+from .conftest import FILES_DIR, skip_if_linux
 
 
 def test_design_extrusion_and_material_assignment(modeler: Modeler):
@@ -1935,7 +1935,7 @@ def test_get_active_design(modeler: Modeler):
 def test_get_collision(modeler: Modeler):
     """Test the collision state between two bodies."""
     skip_if_linux(modeler, test_get_collision.__name__, "get_collision")  # Skip test on Linux
-    design = modeler.open_file("./tests/integration/files/MixingTank.scdocx")
+    design = modeler.open_file(FILES_DIR / "MixingTank.scdocx")
     body1 = design.bodies[0]
     body2 = design.bodies[1]
     body3 = design.bodies[2]

tests/integration/test_design_import.py

@@ -21,6 +21,8 @@
 # SOFTWARE.
 """Test design import."""
 
+from pathlib import Path
+
 import numpy as np
 from pint import Quantity
 import pytest
@@ -33,7 +35,7 @@
 from ansys.geometry.core.misc import UNITS
 from ansys.geometry.core.sketch import Sketch
 
-from .conftest import skip_if_linux
+from .conftest import FILES_DIR, IMPORT_FILES_DIR, skip_if_linux
 
 
 def _checker_method(comp: Component, comp_ref: Component, precise_check: bool = True) -> None:
@@ -135,7 +137,7 @@ def test_design_import_with_surfaces_issue834(modeler: Modeler):
     skip_if_linux(modeler, test_design_import_with_surfaces_issue834.__name__, "open_file")
 
     # Open the design
-    design = modeler.open_file("./tests/integration/files/DuplicateFacesDesignBefore.scdocx")
+    design = modeler.open_file(Path(FILES_DIR, "DuplicateFacesDesignBefore.scdocx"))
 
     # Check that there are two bodies
     assert len(design.bodies) == 2
@@ -207,39 +209,39 @@ def test_open_file(modeler: Modeler, tmp_path_factory: pytest.TempPathFactory):
         # file = tmp_path_factory.mktemp("test_design_import") / "two_cars.igs"
         # design.download(file, DesignFileFormat.IGES)
         # design2 = modeler.open_file(file)
-        # design3 = modeler.open_file("./tests/integration/files/import/twoCars.igs")
+        # design3 = modeler.open_file(Path(IMPORT_FILES_DIR, "twoCars.igs")
         # _checker_method(design2, design3, False)
 
         # STEP
         file = tmp_path_factory.mktemp("test_design_import") / "two_cars.step"
         design.download(file, DesignFileFormat.STEP)
         design2 = modeler.open_file(file)
-        design3 = modeler.open_file("./tests/integration/files/import/twoCars.stp")
+        design3 = modeler.open_file(Path(IMPORT_FILES_DIR, "twoCars.stp"))
         _checker_method(design2, design3, False)
 
         # Catia
-        design2 = modeler.open_file("./tests/integration/files/import/catia_car/car.CATProduct")
+        design2 = modeler.open_file(Path(IMPORT_FILES_DIR, "catia_car/car.CATProduct"))
         _checker_method(design, design2, False)
 
         # Rhino
-        design2 = modeler.open_file("./tests/integration/files/import/box.3dm")
+        design2 = modeler.open_file(Path(IMPORT_FILES_DIR, "box.3dm"))
         assert len(design2.components) == 1
         assert len(design2.components[0].bodies) == 1
 
         # Stride
-        design2 = modeler.open_file("./tests/integration/files/import/sample_box.project")
+        design2 = modeler.open_file(Path(IMPORT_FILES_DIR, "sample_box.project"))
         assert len(design2.bodies) == 1
 
         # SolidWorks
-        design2 = modeler.open_file("./tests/integration/files/import/partColor.SLDPRT")
+        design2 = modeler.open_file(Path(IMPORT_FILES_DIR, "partColor.SLDPRT"))
         assert len(design2.components[0].bodies) == 1
 
         # .par
-        design2 = modeler.open_file("./tests/integration/files/import/Tank_Bottom.par")
+        design2 = modeler.open_file(Path(IMPORT_FILES_DIR, "Tank_Bottom.par"))
         assert len(design2.bodies) == 1
 
         # .prt
-        design2 = modeler.open_file("./tests/integration/files/import/disk1.prt")
+        design2 = modeler.open_file(Path(IMPORT_FILES_DIR, "disk1.prt"))
         assert len(design2.bodies) == 1
 
 
@@ -257,7 +259,7 @@ def test_design_insert(modeler: Modeler):
     comp.extrude_sketch("Body_Cylinder", sketch, 5)
 
     # Insert a different file
-    design.insert_file("./tests/integration/files/DuplicateFacesDesignBefore.scdocx")
+    design.insert_file(Path(FILES_DIR, "DuplicateFacesDesignBefore.scdocx"))
 
     # Check that there are two components
     assert len(design.components) == 2
@@ -280,7 +282,7 @@ def test_design_insert_with_import(modeler: Modeler):
     comp.extrude_sketch("Body_Cylinder", sketch, 5)
 
     # Import and insert a different file
-    design.insert_file("./tests/integration/files/import/catia_car/Wheel1.CATPart")
+    design.insert_file(Path(IMPORT_FILES_DIR, "catia_car/Wheel1.CATPart"))
 
     # Check that there are two components
     assert len(design.components) == 2

tests/integration/test_measurement_tools.py

@@ -25,7 +25,7 @@
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.tools.measurement_tools import Gap
 
-from .conftest import skip_if_linux
+from .conftest import FILES_DIR, skip_if_linux
 
 
 def test_distance_property(modeler: Modeler):
@@ -39,6 +39,6 @@ def test_min_distance_between_objects(modeler: Modeler):
     skip_if_linux(
         modeler, test_min_distance_between_objects.__name__, "measurement_tools"
     )  # Skip test on Linux
-    design = modeler.open_file("./tests/integration/files/MixingTank.scdocx")
+    design = modeler.open_file(FILES_DIR / "MixingTank.scdocx")
     gap = modeler.measurement_tools.min_distance_between_objects(design.bodies[2], design.bodies[1])
     assert abs(gap.distance._value - 0.0892) <= 0.01