Integration Tests

.gitignore

@@ -180,3 +180,12 @@ Thumbs.db
 
 # Internal Autodesk directories
 .adsk/
+
+# Tracking only sdy files in some integration test project folders
+# Ignore everything in project_meshed_studies and project_cad_study folders except mpi and sdy files
+**/project_meshed_studies/*
+**/project_cad_manager_studies/*
+!**/project_meshed_studies/*.mpi
+!**/project_meshed_studies/*.sdy
+!**/project_cad_manager_studies/*.mpi
+!**/project_cad_manager_studies/*.sdy

.pre-commit-config.yaml

@@ -22,6 +22,6 @@ repos:
         exclude_types: [markdown]
         exclude: \.(svg|jpe?g|png|webp|gif|bmp)$
       - id: pretty-format-json
-        args: [--autofix]
+        args: [--autofix, --no-sort-keys]
         exclude_types: [markdown]
         exclude: \.(svg|jpe?g|png|webp|gif|bmp)$

pytest.ini

@@ -3,3 +3,22 @@ markers =
     unit: Unit tests that run quickly and test small pieces of functionality
     integration: Integration tests that check multiple components together
     core: Core functionality tests
+    file_set(set_name): Mark test to run on a specific FileSet
+    json_file_name(file_name): Mark test to use a specific JSON file for expected data
+    cad_manager: Tests the CADManager class
+    double_array: Tests the DoubleArray class
+    ent_list: Tests the EntList class
+    import_options: Tests the ImportOptions class
+    integer_array: Tests the IntegerArray class
+    mesh_summary: Tests the MeshSummary class
+    predicate_manager: Tests the PredicateManager class
+    prop: Tests the Property class (unit tests)
+    property_editor: Tests the PropertyEditor class
+    string_array: Tests the StringArray class
+    synergy: Tests the Synergy class
+    vector_array: Tests the VectorArray class
+    vector: Tests the Vector class
+
+    ; Property class integration tests are divided in two separate suites.
+    material_property: Tests the pre-existing materials for Property class
+    custom_property: Tests a new custom property for Property class

requirements.txt

@@ -7,6 +7,7 @@ pathspec==0.12.1
 polib==1.2.0
 pre-commit==4.2.0
 pydata-sphinx-theme==0.16.1
+pygetwindow==0.0.9
 pylint==3.3.4
 pytest==8.3.4
 sphinx==8.1.3

run.py

@@ -9,6 +9,7 @@
     run.py build [-P | --publish] [-i | --install]
     run.py build-docs [-t <target> | --target=<target>] [-s | --skip-build] [-l | --local]
     run.py format [--check]
+    run.py generate-expected-data [<markers>...]
     run.py install [-s | --skip-build]
     run.py install-package-requirements
     run.py lint [-s | --skip-build]
@@ -23,6 +24,7 @@
     build                           Build and optionally publish the moldflow-api package.
     build-docs                      Build the documentation.
     format                          Format all Python files in the repository using black.
+    generate-expected-data          Generate expected data for integration tests.
     install                         Install the moldflow-api package.
     install-package-requirements    Install package dependencies.
     lint                            Lint all Python files in the repository.
@@ -52,6 +54,7 @@
     --repo-url=<url>                Custom PyPI repository URL.
     --github-api-url=<url>          Custom GitHub API URL.
     -l, --local                     Build documentation locally (single version).
+    <markers>                       Markers to filter data generation by: mesh_summary, etc.
 """
 
 import os
@@ -678,6 +681,13 @@ def clean_up():
         os.remove(COVERAGE_XML_FILE_NAME)
 
 
+def generate_expected_data(markers: list[str]):
+    """Generate data for integration tests"""
+    logging.info('Generating data for integration tests')
+    generate_data_module = 'tests.api.integration_tests.data_generation.generate_data'
+    run_command([sys.executable, '-m', generate_data_module] + markers, ROOT_DIR)
+
+
 def set_version():
     """Set current version and write version file to package directory"""
 
@@ -720,6 +730,10 @@ def main():
 
             lint(skip_build=skip_build)
 
+        elif args.get('generate-expected-data'):
+            markers = args.get('<markers>') or []
+            generate_expected_data(markers=markers)
+
         elif args.get('test'):
             tests = args.get('<tests>') or []
             marker = args.get('--marker') or args.get('-m')

src/moldflow/double_array.py

@@ -35,47 +35,47 @@ def val(self, index: int) -> float:
         Get the value at the specified index.
 
         Args:
-            index (int): The index of the value to get.
+            index (int): index between 0 and double_array.size-1 (inclusive).
 
         Returns:
-            float: The value at the specified index.
+            The value at the specified index.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="val")
         check_type(index, int)
         return self.double_array.Val(index)
 
-    def add_double(self, value: float) -> None:
+    def add_double(self, value: float | int) -> None:
         """
-        Add a double value to the array.
+        Adds a double value to the end of the array.
 
         Args:
-            value (float): The value to add.
+            value (float | int): The value to add.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="add_double")
         check_type(value, (int, float))
         self.double_array.AddDouble(value)
 
-    def to_list(self) -> list[float]:
+    def to_list(self) -> list[float | int]:
         """
         Convert the double array to a list of floats.
 
         Returns:
-            list[float]: The list of floats.
+            The list of values.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="to_list")
 
         vb_array = self.double_array.ToVBSArray()
         return list(vb_array)
 
-    def from_list(self, values: list[float]) -> int:
+    def from_list(self, values: list[float | int] | tuple[float | int]) -> int:
         """
         Convert a list of floats to a double array.
 
         Args:
-            values (list[float]): The list of floats to convert.
+            values (list[float | int] | tuple[float | int]): The list of floats to convert.
 
         Returns:
-            int: The number of elements added to the array.
+            The number of elements added.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="from_list")
 
@@ -91,7 +91,7 @@ def size(self) -> int:
         Get the size of the array.
 
         Returns:
-            int: The size of the array.
+            The size of the array.
         """
         process_log(__name__, LogMessage.PROPERTY_GET, locals(), name="size")
         return self.double_array.Size

src/moldflow/helper.py

@@ -299,19 +299,6 @@ def check_min_max(min_value: float, max_value: float):
         )
 
 
-def _mf_array_to_list(array_instance):
-    """
-    Generic helper function to convert any array instance to a list.
-
-    Args:
-        array_instance: The array instance that has val(index) method and size property.
-
-    Returns:
-        list: A list containing all values from the array.
-    """
-    return [array_instance.val(i) for i in range(array_instance.size)]
-
-
 def variant_null_idispatch():
     """Return a VARIANT representing a null IDispatch pointer (VT_DISPATCH, None)."""
     return VARIANT(pythoncom.VT_DISPATCH, None)

src/moldflow/integer_array.py

@@ -35,18 +35,18 @@ def val(self, index: int) -> int:
         Get the value at the specified index.
 
         Args:
-            index (int): The index of the value to get.
+            index (int): index between 0 and integer_array.size-1 (inclusive)
 
         Returns:
-            int: The value at the specified index.
+            The value at the specified index.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="val")
         check_type(index, int)
         return self.integer_array.Val(index)
 
     def add_integer(self, value: int) -> None:
         """
-        Add a integer value to the array.
+        Adds an integer value to the end of the array.
 
         Args:
             value (int): The value to add.
@@ -60,22 +60,22 @@ def to_list(self) -> list[int]:
         Convert the integer array to a list of integers.
 
         Returns:
-            list[int]: The list of integers.
+            The list of integers.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="to_list")
 
         vb_array = self.integer_array.ToVBSArray()
         return list(vb_array)
 
-    def from_list(self, values: list[int]) -> int:
+    def from_list(self, values: list[int] | tuple[int, ...]) -> int:
         """
         Convert a list of integers to an integer array.
 
         Args:
-            values (list[int]): The list of integers to convert.
+            values (list[int] | tuple[int, ...]): The list of integers to convert.
 
         Returns:
-            int: The number of elements added to the array.
+            The number of elements added.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="from_list")
 
@@ -91,7 +91,7 @@ def size(self) -> int:
         Get the size of the array.
 
         Returns:
-            int: The size of the array.
+            The size of the array.
         """
         process_log(__name__, LogMessage.PROPERTY_GET, locals(), name="size")
         return self.integer_array.Size

src/moldflow/string_array.py

@@ -7,7 +7,7 @@
 """
 
 from .logger import process_log
-from .helper import check_type, _mf_array_to_list
+from .helper import check_type
 from .com_proxy import safe_com, flag_com_method
 from .common import LogMessage
 
@@ -34,18 +34,18 @@ def val(self, index: int) -> str:
         Get the value at the specified index.
 
         Args:
-            index (int): The index of the value to get.
+            index (int): index between 0 and string_array.size-1 (inclusive).
 
         Returns:
-            str: The value at the specified index.
+            The value at the specified index.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="val")
         check_type(index, int)
         return self.string_array.Val(index)
 
     def add_string(self, value: str) -> None:
         """
-        Add a string value to the array.
+        Adds a string value to the end of the array.
 
         Args:
             value (str): The value to add.
@@ -58,20 +58,20 @@ def to_list(self) -> list[str]:
         """
         Convert the string array to a list of strings.
         Returns:
-            list[str]: The list of strings.
+            The list of values.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="to_list")
-        return _mf_array_to_list(self)
+        return [self.val(i) for i in range(self.size)]
 
-    def from_list(self, values: list[str]) -> int:
+    def from_list(self, values: list[str] | tuple[str, ...]) -> int:
         """
         Convert a list of strings to a string array.
 
         Args:
-            values (list[str]): The list of strings to convert.
+            values (list[str] | tuple[str, ...]): The list of strings to convert.
 
         Returns:
-            int: The number of elements added to the array.
+            The number of elements added.
         """
         process_log(__name__, LogMessage.FUNCTION_CALL, locals(), name="from_list")
         check_type(values, (list, tuple))
@@ -87,7 +87,7 @@ def size(self) -> int:
         Get the size of the array.
 
         Returns:
-            int: The size of the array.
+            The size of the array.
         """
         process_log(__name__, LogMessage.PROPERTY_GET, locals(), name="size")
         return self.string_array.Size