removed MockDBGymWorkspace

Author: wangpatrick57

orchestrate/clean.py

@@ -4,23 +4,7 @@
 from itertools import chain
 from pathlib import Path
 
-from gymlib.workspace import (
-    DBGymWorkspace,
-    get_runs_path_from_workspace_path,
-    get_symlinks_path_from_workspace_path,
-    is_child_path,
-    parent_path_of_path,
-)
-
-
-# This is used in test_clean.py. However, we also need it in count_files_in_workspace, so it's defined here to avoid a circular import.
-class MockDBGymWorkspace:
-    def __init__(self, scratchspace_path: Path):
-        self.dbgym_workspace_path = scratchspace_path
-        self.dbgym_symlinks_path = get_symlinks_path_from_workspace_path(
-            scratchspace_path
-        )
-        self.dbgym_runs_path = get_runs_path_from_workspace_path(scratchspace_path)
+from gymlib.workspace import DBGymWorkspace, is_child_path, parent_path_of_path
 
 
 def add_symlinks_in_path(
@@ -39,9 +23,7 @@ def add_symlinks_in_path(
                 processed_symlinks.add(file_path)
 
 
-def count_files_in_workspace(
-    dbgym_workspace: DBGymWorkspace | MockDBGymWorkspace,
-) -> int:
+def count_files_in_workspace(dbgym_workspace: DBGymWorkspace) -> int:
     """
     Counts the number of files (regular file or dir or symlink) in the workspace.
     """
@@ -61,7 +43,7 @@ def count_files_in_workspace(
 
 
 def clean_workspace(
-    dbgym_workspace: DBGymWorkspace | MockDBGymWorkspace,
+    dbgym_workspace: DBGymWorkspace,
     mode: str = "safe",
     verbose: bool = False,
 ) -> None:

orchestrate/tests/unittest_clean.py

@@ -9,8 +9,9 @@
     make_workspace_structure,
     verify_structure,
 )
+from gymlib.workspace import DBGymWorkspace
 
-from orchestrate.clean import MockDBGymWorkspace, clean_workspace
+from orchestrate.clean import clean_workspace
 
 # This is here instead of on `if __name__ == "__main__"` because we often run individual tests, which
 #   does not go through the `if __name__ == "__main__"` codepath.
@@ -26,26 +27,34 @@ class CleanTests(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls) -> None:
-        cls.scratchspace_path = Path.cwd() / "manage/tests/test_clean_scratchspace/"
+        cls.scratchspace_path = (
+            Path.cwd() / "orchestrate/tests/test_clean_scratchspace/"
+        )
         cls.workspace_path = cls.scratchspace_path / "dbgym_workspace"
 
     def setUp(self) -> None:
         if self.scratchspace_path.exists():
             shutil.rmtree(self.scratchspace_path)
 
+        # Reset _num_times_created_this_run since previous tests may have created a workspace.
+        DBGymWorkspace._num_times_created_this_run = 0
+        self.workspace = DBGymWorkspace(self.workspace_path)
+        # Since creating DBGymWorkspace creates the workspace, we want to remove it.
+        shutil.rmtree(self.workspace_path)
+
     def tearDown(self) -> None:
         if self.scratchspace_path.exists():
             shutil.rmtree(self.scratchspace_path)
 
     def test_nonexistent_workspace(self) -> None:
         # This just ensures that it doesn't raise an exception.
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
 
     def test_empty_workspace(self) -> None:
         starting_structure = FilesystemStructure({"dbgym_workspace": {}})
         ending_structure = FilesystemStructure({"dbgym_workspace": {}})
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_no_symlinks_dir_and_yes_task_runs_dir(self) -> None:
@@ -54,15 +63,15 @@ def test_no_symlinks_dir_and_yes_task_runs_dir(self) -> None:
         )
         ending_structure = FilesystemStructure({"dbgym_workspace": {"task_runs": {}}})
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_yes_symlinks_dir_and_no_task_runs_dir(self) -> None:
         # If there are no task runs there can't be any symlinks.
         starting_structure = FilesystemStructure({"dbgym_workspace": {"symlinks": {}}})
         ending_structure = FilesystemStructure({"dbgym_workspace": {"symlinks": {}}})
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_no_symlinks_in_dir_and_no_task_runs_in_dir(self) -> None:
@@ -78,7 +87,7 @@ def test_no_symlinks_in_dir_and_no_task_runs_in_dir(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_no_links_in_symlinks(self) -> None:
@@ -94,7 +103,7 @@ def test_no_links_in_symlinks(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_link_to_file_directly_in_task_runs(self) -> None:
@@ -116,7 +125,7 @@ def test_link_to_file_directly_in_task_runs(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_link_to_dir_directly_in_task_runs(self) -> None:
@@ -143,7 +152,7 @@ def test_link_to_dir_directly_in_task_runs(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_link_to_file_in_dir_in_task_runs(self) -> None:
@@ -170,7 +179,7 @@ def test_link_to_file_in_dir_in_task_runs(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_link_to_dir_in_dir_in_task_runs(self) -> None:
@@ -199,7 +208,7 @@ def test_link_to_dir_in_dir_in_task_runs(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path))
+        clean_workspace(self.workspace)
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_link_to_link_crashes(self) -> None:
@@ -218,7 +227,7 @@ def test_link_to_link_crashes(self) -> None:
 
         create_structure(self.scratchspace_path, starting_structure)
         with self.assertRaises(AssertionError):
-            clean_workspace(MockDBGymWorkspace(self.workspace_path))
+            clean_workspace(self.workspace)
 
     def test_safe_mode_link_to_dir_with_link(self) -> None:
         starting_symlinks_structure = FilesystemStructure(
@@ -252,7 +261,7 @@ def test_safe_mode_link_to_dir_with_link(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_safe_mode_link_to_file_in_dir_with_link(self) -> None:
@@ -289,7 +298,7 @@ def test_safe_mode_link_to_file_in_dir_with_link(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_safe_mode_link_to_dir_with_link_to_file_in_dir_in_task_runs(self) -> None:
@@ -328,7 +337,7 @@ def test_safe_mode_link_to_dir_with_link_to_file_in_dir_in_task_runs(self) -> No
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_aggressive_mode_link_to_dir_with_link(self) -> None:
@@ -360,7 +369,7 @@ def test_aggressive_mode_link_to_dir_with_link(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="aggressive")
+        clean_workspace(self.workspace, mode="aggressive")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_link_to_link_to_file_gives_error(self) -> None:
@@ -383,7 +392,7 @@ def test_link_to_link_to_file_gives_error(self) -> None:
 
         # We disallow links to links so it's an AssertionError
         with self.assertRaises(AssertionError):
-            clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+            clean_workspace(self.workspace, mode="safe")
 
     def test_multi_link_loop_gives_error(self) -> None:
         starting_symlinks_structure = FilesystemStructure(
@@ -402,7 +411,7 @@ def test_multi_link_loop_gives_error(self) -> None:
 
         # pathlib disallows multi-link loops so it's a RuntimeError
         with self.assertRaises(RuntimeError):
-            clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+            clean_workspace(self.workspace, mode="safe")
 
     def test_link_self_loop_gives_error(self) -> None:
         starting_symlinks_structure = FilesystemStructure(
@@ -417,7 +426,7 @@ def test_link_self_loop_gives_error(self) -> None:
 
         # pathlib disallows link self-loops so it's a RuntimeError
         with self.assertRaises(RuntimeError):
-            clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+            clean_workspace(self.workspace, mode="safe")
 
     def test_dont_loop_infinitely_if_there_are_cycles_between_different_dirs_in_runs(
         self,
@@ -460,7 +469,7 @@ def test_dont_loop_infinitely_if_there_are_cycles_between_different_dirs_in_runs
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_dont_loop_infinitely_if_there_is_a_dir_in_runs_that_links_to_a_file_in_itself(
@@ -496,7 +505,7 @@ def test_dont_loop_infinitely_if_there_is_a_dir_in_runs_that_links_to_a_file_in_
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_dont_loop_infinitely_if_there_is_loop_amongst_symlinks(self) -> None:
@@ -530,7 +539,7 @@ def test_dont_loop_infinitely_if_there_is_loop_amongst_symlinks(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_broken_symlink_has_no_effect(self) -> None:
@@ -563,7 +572,7 @@ def test_broken_symlink_has_no_effect(self) -> None:
         )
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     # The idea behind this test is that we shouldn't be following links outside of task_runs, even on safe mode
@@ -612,7 +621,7 @@ def test_link_to_folder_outside_runs_that_contains_link_to_other_run_doesnt_save
         }
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))
 
     def test_outside_task_runs_doesnt_get_deleted(self) -> None:
@@ -630,7 +639,7 @@ def test_outside_task_runs_doesnt_get_deleted(self) -> None:
         ending_structure["external"] = FilesystemStructure({"file1.txt": ("file",)})
 
         create_structure(self.scratchspace_path, starting_structure)
-        clean_workspace(MockDBGymWorkspace(self.workspace_path), mode="safe")
+        clean_workspace(self.workspace, mode="safe")
         self.assertTrue(verify_structure(self.scratchspace_path, ending_structure))