#1962: separating file system into more managable files

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

@@ -0,0 +1,78 @@
+from primaite.simulator.file_system.file import File
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
+from primaite.simulator.file_system.file_type import FileType
+
+
+def test_create_file_no_extension(file_system):
+    """Tests that creating a file without an extension sets the file type to FileType.UNKNOWN."""
+    file = file_system.create_file(file_name="test_file")
+    assert len(file_system.folders) is 1
+    assert file_system.get_folder("root").get_file("test_file") == file
+    assert file_system.get_folder("root").get_file("test_file").file_type == FileType.UNKNOWN
+    assert file_system.get_folder("root").get_file("test_file").size == 0
+
+
+def test_file_scan(file_system):
+    """Test the ability to update visible status."""
+    file: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
+    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    file.corrupt()
+
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    file.scan()
+
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_file_reveal_to_red_scan(file_system):
+    """Test the ability to reveal files to red."""
+    file = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+
+    assert file.revealed_to_red is False
+
+    file.reveal_to_red()
+
+    assert file.revealed_to_red is True
+
+
+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
+
+    # change simulated file size
+    file.sim_size = 0
+    assert file.check_hash() is False
+    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
+
+    # 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
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_file_corrupt_repair(file_system):
+    """Test the ability to corrupt and repair files."""
+    file: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+
+    file.corrupt()
+
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+
+    file.repair()
+
+    assert file.health_status == FileSystemItemHealthStatus.GOOD

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

@@ -1,6 +1,6 @@
 import pytest
 
-from primaite.simulator.file_system.file_system import File, FileSystem, FileSystemItemHealthStatus, Folder
+from primaite.simulator.file_system.file_system import FileSystem
 from primaite.simulator.file_system.file_type import FileType
 
 
@@ -26,15 +26,6 @@ def test_create_file_no_folder(file_system):
     assert file_system.get_folder("root").get_file("test_file.txt").size == 10
 
 
-def test_create_file_no_extension(file_system):
-    """Tests that creating a file without an extension sets the file type to FileType.UNKNOWN."""
-    file = file_system.create_file(file_name="test_file")
-    assert len(file_system.folders) is 1
-    assert file_system.get_folder("root").get_file("test_file") == file
-    assert file_system.get_folder("root").get_file("test_file").file_type == FileType.UNKNOWN
-    assert file_system.get_folder("root").get_file("test_file").size == 0
-
-
 def test_delete_file(file_system):
     """Tests that a file can be deleted."""
     file_system.create_file(file_name="test_file.txt")
@@ -125,193 +116,6 @@ def test_copy_file(file_system):
     assert file_system.get_file("dst_folder", "test_file.txt").uuid != original_uuid
 
 
-@pytest.mark.skip(reason="Implementation for quarantine not needed yet")
-def test_folder_quarantine_state(file_system):
-    """Tests the changing of folder quarantine status."""
-    folder = file_system.get_folder("root")
-
-    assert folder.quarantine_status() is False
-
-    folder.quarantine()
-    assert folder.quarantine_status() is True
-
-    folder.unquarantine()
-    assert folder.quarantine_status() is False
-
-
-def test_file_corrupt_repair(file_system):
-    """Test the ability to corrupt and repair files."""
-    folder: Folder = file_system.create_folder(folder_name="test_folder")
-    file: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
-
-    file.corrupt()
-
-    assert folder.health_status == FileSystemItemHealthStatus.GOOD
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-
-    file.repair()
-
-    assert folder.health_status == FileSystemItemHealthStatus.GOOD
-    assert file.health_status == FileSystemItemHealthStatus.GOOD
-
-
-def test_folder_corrupt_repair(file_system):
-    """Test the ability to corrupt and repair folders."""
-    folder: Folder = file_system.create_folder(folder_name="test_folder")
-    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
-
-    folder.corrupt()
-
-    file = folder.get_file(file_name="test_file.txt")
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-
-    folder.repair()
-
-    file = folder.get_file(file_name="test_file.txt")
-    assert folder.health_status == FileSystemItemHealthStatus.GOOD
-    assert file.health_status == FileSystemItemHealthStatus.GOOD
-
-
-def test_file_scan(file_system):
-    """Test the ability to update visible status."""
-    folder: Folder = file_system.create_folder(folder_name="test_folder")
-    file: File = file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
-
-    assert file.health_status == FileSystemItemHealthStatus.GOOD
-    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
-
-    file.corrupt()
-
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
-
-    file.scan()
-
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-def test_folder_scan(file_system):
-    """Test the ability to update visible status."""
-    folder: Folder = file_system.create_folder(folder_name="test_folder")
-    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
-    file_system.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])
-
-    assert folder.health_status == FileSystemItemHealthStatus.GOOD
-    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
-    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
-    assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
-
-    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
-
-    folder.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_reveal_to_red_scan(file_system):
-    """Test the ability to reveal files to red."""
-    folder: Folder = file_system.create_folder(folder_name="test_folder")
-    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
-    file_system.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])
-
-    assert folder.revealed_to_red is False
-    assert file1.revealed_to_red is False
-    assert file2.revealed_to_red is False
-
-    folder.reveal_to_red()
-
-    folder.apply_timestep(timestep=0)
-
-    assert folder.revealed_to_red is False
-    assert file1.revealed_to_red is False
-    assert file2.revealed_to_red is False
-
-    folder.apply_timestep(timestep=1)
-
-    assert folder.revealed_to_red is True
-    assert file1.revealed_to_red is True
-    assert file2.revealed_to_red is True
-
-
-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
-
-    # change simulated file size
-    file.sim_size = 0
-    assert file.check_hash() is False
-    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", folder_name="test_folder", real=True)
-
-    assert file.check_hash() is True
-
-    # 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
-    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-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
-
-    # change simulated file size
-    file = folder.get_file(file_name="test_file.txt")
-    file.sim_size = 0
-    assert folder.check_hash() is False
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
-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
-
-    # change simulated file size
-    file = folder.get_file(file_name="test_file.txt")
-
-    # change file content
-    with open(file.sim_path, "a") as f:
-        f.write("get hacked scrub lol xD\n")
-
-    assert folder.check_hash() is False
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-
-
 @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

@@ -2,7 +2,8 @@ from typing import Tuple
 
 import pytest
 
-from primaite.simulator.file_system.file_system import File, FileSystem, FileSystemItemHealthStatus, Folder
+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")

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

@@ -0,0 +1,133 @@
+import pytest
+
+from primaite.simulator.file_system.file import File
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
+from primaite.simulator.file_system.folder import Folder
+
+
+@pytest.mark.skip(reason="Implementation for quarantine not needed yet")
+def test_folder_quarantine_state(file_system):
+    """Tests the changing of folder quarantine status."""
+    folder = file_system.get_folder("root")
+
+    assert folder.quarantine_status() is False
+
+    folder.quarantine()
+    assert folder.quarantine_status() is True
+
+    folder.unquarantine()
+    assert folder.quarantine_status() is False
+
+
+def test_folder_scan(file_system):
+    """Test the ability to update visible status."""
+    folder: Folder = file_system.create_folder(folder_name="test_folder")
+    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+    file_system.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])
+
+    assert folder.health_status == FileSystemItemHealthStatus.GOOD
+    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    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
+
+    folder.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_reveal_to_red_scan(file_system):
+    """Test the ability to reveal files to red."""
+    folder: Folder = file_system.create_folder(folder_name="test_folder")
+    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+    file_system.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])
+
+    assert folder.revealed_to_red is False
+    assert file1.revealed_to_red is False
+    assert file2.revealed_to_red is False
+
+    folder.reveal_to_red()
+
+    folder.apply_timestep(timestep=0)
+
+    assert folder.revealed_to_red is False
+    assert file1.revealed_to_red is False
+    assert file2.revealed_to_red is False
+
+    folder.apply_timestep(timestep=1)
+
+    assert folder.revealed_to_red is True
+    assert file1.revealed_to_red is True
+    assert file2.revealed_to_red is True
+
+
+def test_folder_corrupt_repair(file_system):
+    """Test the ability to corrupt and repair folders."""
+    folder: Folder = file_system.create_folder(folder_name="test_folder")
+    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+
+    folder.corrupt()
+
+    file = folder.get_file(file_name="test_file.txt")
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file.health_status == FileSystemItemHealthStatus.CORRUPT
+
+    folder.repair()
+
+    file = folder.get_file(file_name="test_file.txt")
+    assert folder.health_status == FileSystemItemHealthStatus.GOOD
+    assert file.health_status == FileSystemItemHealthStatus.GOOD
+
+
+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
+
+    # change simulated file size
+    file = folder.get_file(file_name="test_file.txt")
+    file.sim_size = 0
+    assert folder.check_hash() is False
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+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
+
+    # change simulated file size
+    file = folder.get_file(file_name="test_file.txt")
+
+    # change file content
+    with open(file.sim_path, "a") as f:
+        f.write("get hacked scrub lol xD\n")
+
+    assert folder.check_hash() is False
+    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT

tests/unit_tests/_primaite/_simulator/_network/_hardware/test_node_actions.py

@@ -1,6 +1,7 @@
 import pytest
 
-from primaite.simulator.file_system.file_system import File, FileSystemItemHealthStatus, Folder
+from primaite.simulator.file_system.file_system import File, Folder
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
 from primaite.simulator.network.hardware.base import Node, NodeOperatingState
 from primaite.simulator.system.applications.application import Application
 from primaite.simulator.system.processes.process import Process