#1962: split tests into managable files + implement deletion of folders and files + tests

tests/unit_tests/_primaite/_simulator/_file_system/test_file.py

@@ -44,24 +44,24 @@ def test_file_reveal_to_red_scan(file_system):
 def test_simulated_file_check_hash(file_system):
     file: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
 
-    assert file.check_hash() is True
-
+    file.check_hash()
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
     # change simulated file size
     file.sim_size = 0
-    assert file.check_hash() is False
+    file.check_hash()
     assert file.health_status == FileSystemItemHealthStatus.CORRUPT
 
 
 def test_real_file_check_hash(file_system):
     file: File = file_system.create_file(file_name="test_file.txt", real=True)
 
-    assert file.check_hash() is True
-
+    file.check_hash()
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
     # change file content
     with open(file.sim_path, "a") as f:
         f.write("get hacked scrub lol xD\n")
 
-    assert file.check_hash() is False
+    file.check_hash()
     assert file.health_status == FileSystemItemHealthStatus.CORRUPT
 
 

tests/unit_tests/_primaite/_simulator/_file_system/test_file_actions.py

@@ -0,0 +1,89 @@
+from typing import Tuple
+
+import pytest
+
+from primaite.simulator.file_system.file_system import File, FileSystem, Folder
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
+
+
+@pytest.fixture(scope="function")
+def populated_file_system(file_system) -> Tuple[FileSystem, Folder, File]:
+    """Create a file system with a folder and file."""
+    folder = file_system.create_folder(folder_name="test_folder")
+    file = file_system.create_file(folder_name="test_folder", file_name="test_file.txt")
+
+    return file_system, folder, file
+
+
+def test_file_scan_request(populated_file_system):
+    """Test that an agent can request a file scan."""
+    fs, folder, file = populated_file_system
+
+    file.corrupt()
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    fs.apply_request(request=["file", file.uuid, "scan"])
+
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_file_checkhash_request(populated_file_system):
+    """Test that an agent can request a file hash check."""
+    fs, folder, file = populated_file_system
+
+    fs.apply_request(request=["file", file.uuid, "checkhash"])
+
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
+    file.sim_size = 0
+
+    fs.apply_request(request=["file", file.uuid, "checkhash"])
+
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_file_repair_request(populated_file_system):
+    """Test that an agent can request a file repair."""
+    fs, folder, file = populated_file_system
+
+    file.corrupt()
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+
+    fs.apply_request(request=["file", file.uuid, "repair"])
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
+
+
+def test_file_restore_request(populated_file_system):
+    pass
+
+
+def test_file_corrupt_request(populated_file_system):
+    """Test that an agent can request a file corruption."""
+    fs, folder, file = populated_file_system
+    fs.apply_request(request=["file", file.uuid, "corrupt"])
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_deleted_file_cannot_be_interacted_with(populated_file_system):
+    """Test that actions cannot affect deleted files."""
+    fs, folder, file = populated_file_system
+    assert fs.get_file(folder_name=folder.name, file_name=file.name) is not None
+
+    fs.apply_request(request=["file", file.uuid, "corrupt"])
+    assert fs.get_file(folder_name=folder.name, file_name=file.name).health_status == FileSystemItemHealthStatus.CORRUPT
+    assert (
+        fs.get_file(folder_name=folder.name, file_name=file.name).visible_health_status
+        == FileSystemItemHealthStatus.GOOD
+    )
+
+    fs.apply_request(request=["delete", "file", folder.uuid, file.uuid])
+    assert fs.get_file(folder_name=folder.name, file_name=file.name) is None
+
+    fs.apply_request(request=["file", file.uuid, "repair"])
+    fs.apply_request(request=["file", file.uuid, "scan"])
+
+    file = folder.deleted_files.get(file.uuid)
+
+    assert file.health_status is not FileSystemItemHealthStatus.GOOD
+    assert file.visible_health_status is not FileSystemItemHealthStatus.CORRUPT

tests/unit_tests/_primaite/_simulator/_file_system/test_file_system.py

@@ -1,7 +1,9 @@
 import pytest
 
+from primaite.simulator.file_system.file import File
 from primaite.simulator.file_system.file_system import FileSystem
 from primaite.simulator.file_system.file_type import FileType
+from primaite.simulator.file_system.folder import Folder
 
 
 def test_create_folder_and_file(file_system):
@@ -65,6 +67,34 @@ def test_delete_folder(file_system):
     assert len(file_system.deleted_folders) == 1
 
 
+def test_create_duplicate_folder(file_system):
+    """Test that creating a duplicate folder throws exception."""
+    assert len(file_system.folders) == 1
+    file_system.create_folder(folder_name="test_folder")
+
+    assert len(file_system.folders) is 2
+    with pytest.raises(Exception):
+        file_system.create_folder(folder_name="test_folder")
+
+    assert len(file_system.folders) is 2
+
+
+def test_create_duplicate_file(file_system):
+    """Test that creating a duplicate file throws exception."""
+    assert len(file_system.folders) == 1
+    file_system.create_folder(folder_name="test_folder")
+
+    assert len(file_system.folders) is 2
+    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+
+    assert len(file_system.get_folder("test_folder").files) == 1
+
+    with pytest.raises(Exception):
+        file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+
+    assert len(file_system.get_folder("test_folder").files) == 1
+
+
 def test_deleting_a_non_existent_folder(file_system):
     file_system.create_folder(folder_name="test_folder")
     assert len(file_system.folders) == 2
@@ -116,6 +146,23 @@ def test_copy_file(file_system):
     assert file_system.get_file("dst_folder", "test_file.txt").uuid != original_uuid
 
 
+def test_get_file(file_system):
+    """Test that files can be retrieved."""
+    folder: Folder = file_system.create_folder(folder_name="test_folder")
+    file1: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+    file2: File = file_system.create_file(file_name="test_file2.txt", folder_name="test_folder")
+
+    folder.remove_file(file2)
+
+    assert file_system.get_file_by_id(file_uuid=file1.uuid, folder_uuid=folder.uuid) is not None
+    assert file_system.get_file_by_id(file_uuid=file2.uuid, folder_uuid=folder.uuid) is None
+    assert file_system.get_file_by_id(file_uuid=file2.uuid, folder_uuid=folder.uuid, include_deleted=True) is not None
+    assert file_system.get_file_by_id(file_uuid=file2.uuid, include_deleted=True) is not None
+
+    file_system.delete_folder(folder_name="test_folder")
+    assert file_system.get_file_by_id(file_uuid=file2.uuid, include_deleted=True) is not None
+
+
 @pytest.mark.skip(reason="Skipping until we tackle serialisation")
 def test_serialisation(file_system):
     """Test to check that the object serialisation works correctly."""

tests/unit_tests/_primaite/_simulator/_file_system/test_file_system_actions.py

@@ -8,139 +8,20 @@ from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHe
 
 @pytest.fixture(scope="function")
 def populated_file_system(file_system) -> Tuple[FileSystem, Folder, File]:
-    """Test that an agent can request a file scan."""
+    """Create a file system with a folder and file."""
     folder = file_system.create_folder(folder_name="test_folder")
     file = file_system.create_file(folder_name="test_folder", file_name="test_file.txt")
 
     return file_system, folder, file
 
 
-def test_file_scan_request(populated_file_system):
-    """Test that an agent can request a file scan."""
-    fs, folder, file = populated_file_system
-
-    file.corrupt()
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
-
-    fs.apply_request(request=["file", file.uuid, "scan"])
-
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-def test_folder_scan_request(populated_file_system):
-    """Test that an agent can request a folder scan."""
-    fs, folder, file = populated_file_system
-    fs.create_file(file_name="test_file2.txt", folder_name="test_folder")
-
-    file1: File = folder.get_file_by_id(file_uuid=list(folder.files)[1])
-    file2: File = folder.get_file_by_id(file_uuid=list(folder.files)[0])
-
-    folder.corrupt()
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
-    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
-    assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
-
-    fs.apply_request(request=["folder", folder.uuid, "scan"])
-
-    folder.apply_timestep(timestep=0)
-
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
-    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
-    assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
-
-    folder.apply_timestep(timestep=1)
-
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-def test_file_checkhash_request(populated_file_system):
-    """Test that an agent can request a file hash check."""
-    fs, folder, file = populated_file_system
-
-    fs.apply_request(request=["file", file.uuid, "checkhash"])
-
-    assert file.health_status == FileSystemItemHealthStatus.GOOD
-    file.sim_size = 0
-
-    fs.apply_request(request=["file", file.uuid, "checkhash"])
-
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-def test_folder_checkhash_request(populated_file_system):
-    """Test that an agent can request a folder hash check."""
-    fs, folder, file = populated_file_system
-
-    fs.apply_request(request=["folder", folder.uuid, "checkhash"])
-
-    assert folder.health_status == FileSystemItemHealthStatus.GOOD
-    file.sim_size = 0
-
-    fs.apply_request(request=["folder", folder.uuid, "checkhash"])
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-def test_file_repair_request(populated_file_system):
-    """Test that an agent can request a file repair."""
-    fs, folder, file = populated_file_system
-
-    file.corrupt()
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-
-    fs.apply_request(request=["file", file.uuid, "repair"])
-    assert file.health_status == FileSystemItemHealthStatus.GOOD
-
-
-def test_folder_repair_request(populated_file_system):
-    """Test that an agent can request a folder repair."""
-    fs, folder, file = populated_file_system
-
-    folder.corrupt()
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-
-    fs.apply_request(request=["folder", folder.uuid, "repair"])
-    assert file.health_status == FileSystemItemHealthStatus.GOOD
-    assert folder.health_status == FileSystemItemHealthStatus.GOOD
-
-
-def test_file_restore_request(populated_file_system):
-    pass
-
-
-def test_folder_restore_request(populated_file_system):
-    pass
-
-
-def test_file_corrupt_request(populated_file_system):
-    """Test that an agent can request a file corruption."""
-    fs, folder, file = populated_file_system
-    fs.apply_request(request=["file", file.uuid, "corrupt"])
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-def test_folder_corrupt_request(populated_file_system):
-    """Test that an agent can request a folder corruption."""
-    fs, folder, file = populated_file_system
-    fs.apply_request(request=["folder", folder.uuid, "corrupt"])
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
 def test_file_delete_request(populated_file_system):
     """Test that an agent can request a file deletion."""
     fs, folder, file = populated_file_system
-    assert folder.get_file_by_id(file_uuid=file.uuid) is not None
+    assert fs.get_file(folder_name=folder.name, file_name=file.name) is not None
 
-    fs.apply_request(request=["folder", folder.uuid, "delete", file.uuid])
-    assert folder.get_file_by_id(file_uuid=file.uuid) is None
+    fs.apply_request(request=["delete", "file", folder.uuid, file.uuid])
+    assert fs.get_file(folder_name=folder.name, file_name=file.name) is None
 
 
 def test_folder_delete_request(populated_file_system):
@@ -149,6 +30,6 @@ def test_folder_delete_request(populated_file_system):
     assert folder.get_file_by_id(file_uuid=file.uuid) is not None
     assert fs.get_folder_by_id(folder_uuid=folder.uuid) is not None
 
-    fs.apply_request(request=["delete", folder.uuid])
+    fs.apply_request(request=["delete", "folder", folder.uuid])
     assert fs.get_folder_by_id(folder_uuid=folder.uuid) is None
-    assert folder.get_file_by_id(file_uuid=file.uuid) is None
+    assert fs.get_file_by_id(folder_uuid=folder.uuid, file_uuid=file.uuid) is None

tests/unit_tests/_primaite/_simulator/_file_system/test_folder.py

@@ -19,6 +19,20 @@ def test_folder_quarantine_state(file_system):
     assert folder.quarantine_status() is False
 
 
+def test_folder_get_file(file_system):
+    """Test that files can be retrieved from the folder."""
+    folder: Folder = file_system.create_folder(folder_name="test_folder")
+    file1: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+    file2: File = file_system.create_file(file_name="test_file2.txt", folder_name="test_folder")
+
+    folder.remove_file(file2)
+
+    assert folder.get_file_by_id(file_uuid=file1.uuid) is not None
+    assert folder.get_file_by_id(file_uuid=file2.uuid) is None
+
+    assert folder.get_file_by_id(file_uuid=file2.uuid, include_deleted=True) is not None
+
+
 def test_folder_scan(file_system):
     """Test the ability to update visible status."""
     folder: Folder = file_system.create_folder(folder_name="test_folder")
@@ -107,12 +121,13 @@ def test_simulated_folder_check_hash(file_system):
     folder: Folder = file_system.create_folder(folder_name="test_folder")
     file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
 
-    assert folder.check_hash() is True
+    folder.check_hash()
+    assert folder.health_status == FileSystemItemHealthStatus.GOOD
 
     # change simulated file size
     file = folder.get_file(file_name="test_file.txt")
     file.sim_size = 0
-    assert folder.check_hash() is False
+    folder.check_hash()
     assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
 
 
@@ -120,8 +135,8 @@ def test_real_folder_check_hash(file_system):
     folder: Folder = file_system.create_folder(folder_name="test_folder")
     file_system.create_file(file_name="test_file.txt", folder_name="test_folder", real=True)
 
-    assert folder.check_hash() is True
-
+    folder.check_hash()
+    assert folder.health_status == FileSystemItemHealthStatus.GOOD
     # change simulated file size
     file = folder.get_file(file_name="test_file.txt")
 
@@ -129,5 +144,5 @@ def test_real_folder_check_hash(file_system):
     with open(file.sim_path, "a") as f:
         f.write("get hacked scrub lol xD\n")
 
-    assert folder.check_hash() is False
+    folder.check_hash()
     assert folder.health_status == FileSystemItemHealthStatus.CORRUPT

tests/unit_tests/_primaite/_simulator/_file_system/test_folder_actions.py

@@ -0,0 +1,103 @@
+from typing import Tuple
+
+import pytest
+
+from primaite.simulator.file_system.file_system import File, FileSystem, Folder
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
+
+
+@pytest.fixture(scope="function")
+def populated_file_system(file_system) -> Tuple[FileSystem, Folder, File]:
+    """Create a file system with a folder and file."""
+    folder = file_system.create_folder(folder_name="test_folder")
+    file = file_system.create_file(folder_name="test_folder", file_name="test_file.txt")
+
+    return file_system, folder, file
+
+
+def test_folder_scan_request(populated_file_system):
+    """Test that an agent can request a folder scan."""
+    fs, folder, file = populated_file_system
+    fs.create_file(file_name="test_file2.txt", folder_name="test_folder")
+
+    file1: File = folder.get_file_by_id(file_uuid=list(folder.files)[1])
+    file2: File = folder.get_file_by_id(file_uuid=list(folder.files)[0])
+
+    folder.corrupt()
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    fs.apply_request(request=["folder", folder.uuid, "scan"])
+
+    folder.apply_timestep(timestep=0)
+
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    folder.apply_timestep(timestep=1)
+
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_folder_checkhash_request(populated_file_system):
+    """Test that an agent can request a folder hash check."""
+    fs, folder, file = populated_file_system
+
+    fs.apply_request(request=["folder", folder.uuid, "checkhash"])
+
+    assert folder.health_status == FileSystemItemHealthStatus.GOOD
+    file.sim_size = 0
+
+    fs.apply_request(request=["folder", folder.uuid, "checkhash"])
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_folder_repair_request(populated_file_system):
+    """Test that an agent can request a folder repair."""
+    fs, folder, file = populated_file_system
+
+    folder.corrupt()
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+
+    fs.apply_request(request=["folder", folder.uuid, "repair"])
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
+    assert folder.health_status == FileSystemItemHealthStatus.GOOD
+
+
+def test_folder_restore_request(populated_file_system):
+    pass
+
+
+def test_folder_corrupt_request(populated_file_system):
+    """Test that an agent can request a folder corruption."""
+    fs, folder, file = populated_file_system
+    fs.apply_request(request=["folder", folder.uuid, "corrupt"])
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_deleted_folder_and_its_files_cannot_be_interacted_with(populated_file_system):
+    """Test that actions cannot affect deleted folder and its child files."""
+    fs, folder, file = populated_file_system
+    assert fs.get_file(folder_name=folder.name, file_name=file.name) is not None
+
+    fs.apply_request(request=["file", file.uuid, "corrupt"])
+    assert fs.get_file(folder_name=folder.name, file_name=file.name).health_status == FileSystemItemHealthStatus.CORRUPT
+
+    fs.apply_request(request=["delete", "folder", folder.uuid])
+    assert fs.get_file(folder_name=folder.name, file_name=file.name) is None
+
+    fs.apply_request(request=["file", file.uuid, "repair"])
+
+    deleted_folder = fs.deleted_folders.get(folder.uuid)
+    deleted_file = deleted_folder.deleted_files.get(file.uuid)
+
+    assert deleted_file.health_status is not FileSystemItemHealthStatus.GOOD