systemtests: add configurable timeout per test case (closes #371)

Author: AdityaGupta716

changelog-entries/371.md

@@ -0,0 +1 @@
+- Add optional `timeout` field to `tests.yaml` entries, allowing per-test timeout configuration. Defaults to 600s for backward compatibility. Applies to the solver run and fieldcompare phases.

tools/tests/README.md

@@ -331,8 +331,11 @@ test_suites:
           - fluid-openfoam
           - solid-fenics
         reference_result: ./flow-over-heated-plate/reference-results/fluid-openfoam_solid-fenics.tar.gz
+        timeout: 3600
 ```
 
+The optional `timeout` field (in seconds, default: 600) sets the maximum time allowed for the solver run and fieldcompare phases. Use this for long-running tutorials such as `heat-exchanger` or `turek-hron-fsi3`.
+
 This defines two test suites, namely `openfoam_adapter_pr` and `openfoam_adapter_release`. Each of them defines which case combinations of which tutorials to run.
 
 ### Generate Reference Results

tools/tests/metadata_parser/metdata.py

@@ -279,6 +279,7 @@ def from_cases_tuple(cls, cases: Tuple[Case], tutorial: Tutorial):
 class ReferenceResult:
     path: Path
     case_combination: CaseCombination
+    timeout: int = 600
 
     def __repr__(self) -> str:
         return f"{self.path.as_posix()}"

tools/tests/systemtests/Systemtest.py

@@ -19,7 +19,7 @@
 import os
 
 
-GLOBAL_TIMEOUT = 600
+BUILD_TIMEOUT = 600
 SHORT_TIMEOUT = 10
 
 
@@ -394,7 +394,7 @@ def _run_field_compare(self):
                                        cwd=self.system_test_dir)
 
             try:
-                stdout, stderr = process.communicate(timeout=GLOBAL_TIMEOUT)
+                stdout, stderr = process.communicate(timeout=self.reference_result.timeout)
             except KeyboardInterrupt as k:
                 process.kill()
                 raise KeyboardInterrupt from k
@@ -439,7 +439,7 @@ def _build_docker(self):
                                        cwd=self.system_test_dir)
 
             try:
-                stdout, stderr = process.communicate(timeout=GLOBAL_TIMEOUT)
+                stdout, stderr = process.communicate(timeout=BUILD_TIMEOUT)
             except KeyboardInterrupt as k:
                 process.kill()
                 # process.send_signal(9)
@@ -483,7 +483,7 @@ def _run_tutorial(self):
                                        cwd=self.system_test_dir)
 
             try:
-                stdout, stderr = process.communicate(timeout=GLOBAL_TIMEOUT)
+                stdout, stderr = process.communicate(timeout=self.reference_result.timeout)
             except KeyboardInterrupt as k:
                 process.kill()
                 # process.send_signal(9)

tools/tests/systemtests/TestSuite.py

@@ -63,8 +63,15 @@ def from_yaml(cls, path, parsed_tutorials: Tutorials):
                         tutorial_case['case_combination'], tutorial)
                     if case_combination_requested in all_case_combinations:
                         case_combinations_of_tutorial[tutorial].append(case_combination_requested)
+                        timeout_raw = tutorial_case.get('timeout', 600)
+                        if isinstance(timeout_raw, str):
+                            timeout = int(timeout_raw.rstrip('s'))
+                        else:
+                            timeout = int(timeout_raw)
+                        if timeout <= 0:
+                            raise ValueError(f"timeout must be a positive integer, got {timeout}")
                         reference_results_of_tutorial[tutorial].append(ReferenceResult(
-                            tutorial_case['reference_result'], case_combination_requested))
+                            tutorial_case['reference_result'], case_combination_requested, timeout))
                     else:
                         raise Exception(
                             f"Could not find the following cases {tutorial_case['case-combination']} in the current metadata of tutorial {tutorial.name}")