Avoids project name collisions in parallel tests

Introduces a function to generate unique project names for parallel test execution using xdist. This prevents collisions when cleaning up project directories, ensuring reliable test execution.

Author: calvinp0

functional/restart_test.py

@@ -16,6 +16,14 @@
 from arc.main import ARC
 
 
+def _project_name(base: str) -> str:
+    """Return a per-xdist-worker project name to avoid parallel cleanup collisions."""
+    worker_id = os.environ.get('PYTEST_XDIST_WORKER')
+    if worker_id:
+        return f'{base}_{worker_id}'
+    return base
+
+
 class TestRestart(unittest.TestCase):
     """
     Contains unit tests for restarting ARC.
@@ -36,7 +44,7 @@ def test_restart_thermo(self):
         """
         restart_dir = os.path.join(ARC_PATH, 'arc', 'testing', 'restart', '1_restart_thermo')
         restart_path = os.path.join(restart_dir, 'restart.yml')
-        project = 'arc_project_for_testing_delete_after_usage_restart_thermo'
+        project = _project_name('arc_project_for_testing_delete_after_usage_restart_thermo')
         project_directory = os.path.join(ARC_PATH, 'Projects', project)
         os.makedirs(os.path.dirname(project_directory), exist_ok=True)
         shutil.copytree(os.path.join(restart_dir, 'calcs'), os.path.join(project_directory, 'calcs', 'Species'), dirs_exist_ok=True)
@@ -55,7 +63,7 @@ def test_restart_thermo(self):
                     break
         self.assertTrue(thermo_dft_ccsdtf12_bac)
 
-        with open(os.path.join(project_directory, 'arc_project_for_testing_delete_after_usage_restart_thermo.info'), 'r') as f:
+        with open(os.path.join(project_directory, f'{project}.info'), 'r') as f:
             sts, n2h3, oet, lot, ap = False, False, False, False, False
             for line in f.readlines():
                 if 'Considered the following species and TSs:' in line:
@@ -66,7 +74,7 @@ def test_restart_thermo(self):
                     oet = True
                 elif 'Levels of theory used:' in line:
                     lot = True
-                elif 'ARC project arc_project_for_testing_delete_after_usage_restart_thermo' in line:
+                elif f'ARC project {project}' in line:
                     ap = True
         self.assertTrue(sts)
         self.assertTrue(n2h3)
@@ -133,7 +141,7 @@ def test_restart_rate_1(self):
         """Test restarting ARC and attaining a reaction rate coefficient"""
         restart_dir = os.path.join(ARC_PATH, 'arc', 'testing', 'restart', '2_restart_rate')
         restart_path = os.path.join(restart_dir, 'restart.yml')
-        project = 'arc_project_for_testing_delete_after_usage_restart_rate_1'
+        project = _project_name('arc_project_for_testing_delete_after_usage_restart_rate_1')
         project_directory = os.path.join(ARC_PATH, 'Projects', project)
         os.makedirs(os.path.dirname(project_directory), exist_ok=True)
         shutil.copytree(os.path.join(restart_dir, 'calcs'), os.path.join(project_directory, 'calcs'), dirs_exist_ok=True)
@@ -154,7 +162,7 @@ def test_restart_rate_1(self):
 
     def test_restart_rate_2(self):
         """Test restarting ARC and attaining a reaction rate coefficient"""
-        project = 'arc_project_for_testing_delete_after_usage_restart_rate_2'
+        project = _project_name('arc_project_for_testing_delete_after_usage_restart_rate_2')
         project_directory = os.path.join(ARC_PATH, 'Projects', project)
         base_path = os.path.join(ARC_PATH, 'arc', 'testing', 'restart', '5_TS1')
         restart_path = os.path.join(base_path, 'restart.yml')
@@ -183,7 +191,7 @@ def test_restart_bde (self):
         """Test restarting ARC and attaining a BDE for anilino_radical."""
         restart_dir   = os.path.join(ARC_PATH, 'arc', 'testing', 'restart', '3_restart_bde')
         restart_path  = os.path.join(restart_dir, 'restart.yml')
-        project = 'test_restart_bde'
+        project = _project_name('test_restart_bde')
         project_directory = os.path.join(ARC_PATH, 'Projects', project)
         os.makedirs(os.path.dirname(project_directory), exist_ok=True)
         shutil.copytree(os.path.join(restart_dir, 'calcs'), os.path.join(project_directory, 'calcs'), dirs_exist_ok=True)
@@ -192,7 +200,7 @@ def test_restart_bde (self):
         arc1 = ARC(**input_dict)
         arc1.execute()
 
-        report_path = os.path.join(ARC_PATH, 'Projects', 'test_restart_bde', 'output', 'BDE_report.txt')
+        report_path = os.path.join(ARC_PATH, 'Projects', project, 'output', 'BDE_report.txt')
         with open(report_path, 'r') as f:
             lines = f.readlines()
         self.assertIn(' BDE report for anilino_radical:\n', lines)
@@ -218,10 +226,10 @@ def tearDownClass(cls):
         A function that is run ONCE after all unit tests in this class.
         Delete all project directories created during these unit tests
         """
-        projects = ['arc_project_for_testing_delete_after_usage_restart_thermo',
-                    'arc_project_for_testing_delete_after_usage_restart_rate_1',
-                    'arc_project_for_testing_delete_after_usage_restart_rate_2',
-                    'test_restart_bde',
+        projects = [_project_name('arc_project_for_testing_delete_after_usage_restart_thermo'),
+                    _project_name('arc_project_for_testing_delete_after_usage_restart_rate_1'),
+                    _project_name('arc_project_for_testing_delete_after_usage_restart_rate_2'),
+                    _project_name('test_restart_bde'),
                     ]
         for project in projects:
             project_directory = os.path.join(ARC_PATH, 'Projects', project)