#1800 - Simplified a bunch of stuff in the file system in prep for services and applications. Started adding the database logic. Waiting for the software manager/session manager work from another ticket.

tests/integration_tests/system/test_database_on_node.py

@@ -53,4 +53,4 @@ def test_uninstalling_database():
     node.uninstall_service(db)
 
     assert db not in node
-    assert node.file_system.get_folder_by_name("database") is None
+    assert node.file_system.get_folder("database") is None

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

@@ -1,132 +1,137 @@
-from primaite.simulator.file_system.file_system import FileSystem
-from primaite.simulator.file_system.file_system_file import FileSystemFile
-from primaite.simulator.file_system.file_system_folder import FileSystemFolder
+import pytest
+
+from primaite.simulator.file_system.file_system import File, FileSystem, Folder
+from primaite.simulator.file_system.file_type import FileType
+from primaite.simulator.network.hardware.base import Node
 
 
-def test_create_folder_and_file():
+@pytest.fixture(scope="function")
+def file_system() -> FileSystem:
+    return Node(hostname="fs_node").file_system
+
+
+def test_create_folder_and_file(file_system):
     """Test creating a folder and a file."""
-    file_system = FileSystem()
-    folder = file_system.create_folder(folder_name="test_folder")
-    assert len(file_system.folders) is 1
+    assert len(file_system.folders) == 1
+    test_folder = file_system.create_folder(folder_name="test_folder")
 
-    file = file_system.create_file(file_name="test_file", size=10, folder_uuid=folder.uuid)
-    assert len(file_system.get_folder_by_id(folder.uuid).files) is 1
+    assert len(file_system.folders) is 2
+    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
 
-    assert file_system.get_file_by_id(file.uuid).name is "test_file"
-    assert file_system.get_file_by_id(file.uuid).size == 10
+    assert len(file_system.get_folder("test_folder").files) == 1
+
+    assert file_system.get_folder("test_folder").get_file("test_file.txt")
 
 
-def test_create_file():
+def test_create_file_no_folder(file_system):
     """Tests that creating a file without a folder creates a folder and sets that as the file's parent."""
-    file_system = FileSystem()
-
-    file = file_system.create_file(file_name="test_file", size=10)
+    file = file_system.create_file(file_name="test_file.txt", size=10)
     assert len(file_system.folders) is 1
-    assert file_system.get_folder_by_name("root").get_file_by_id(file.uuid) is file
+    assert file_system.get_folder("root").get_file("test_file.txt") == file
+    assert file_system.get_folder("root").get_file("test_file.txt").file_type == FileType.TXT
+    assert file_system.get_folder("root").get_file("test_file.txt").size == 10
 
 
-def test_delete_file():
+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 = FileSystem()
+    file_system.create_file(file_name="test_file.txt")
+    assert len(file_system.folders) == 1
+    assert len(file_system.get_folder("root").files) == 1
 
-    file = file_system.create_file(file_name="test_file", size=10)
-    assert len(file_system.folders) is 1
-
-    folder_id = list(file_system.folders.keys())[0]
-    folder = file_system.get_folder_by_id(folder_id)
-    assert folder.get_file_by_id(file.uuid) is file
-
-    file_system.delete_file(file=file)
-    assert len(file_system.folders) is 1
-    assert len(folder.files) is 0
+    file_system.delete_file(folder_name="root", file_name="test_file.txt")
+    assert len(file_system.folders) == 1
+    assert len(file_system.get_folder("root").files) == 0
 
 
-def test_delete_non_existent_file():
+def test_delete_non_existent_file(file_system):
     """Tests deleting a non existent file."""
-    file_system = FileSystem()
-
-    file = file_system.create_file(file_name="test_file", size=10)
-    not_added_file = FileSystemFile(name="not_added")
+    file_system.create_file(file_name="test_file.txt")
     # folder should be created
-    assert len(file_system.folders) is 1
+    assert len(file_system.folders) == 1
     # should only have 1 file in the file system
-    folder_id = list(file_system.folders.keys())[0]
-    folder = file_system.get_folder_by_id(folder_id)
-    assert len(list(folder.files)) is 1
-
-    assert folder.get_file_by_id(file.uuid) is file
+    assert len(file_system.get_folder("root").files) == 1
 
     # deleting should not change how many files are in folder
-    file_system.delete_file(file=not_added_file)
-    assert len(file_system.folders) is 1
-    assert len(list(folder.files)) is 1
+    file_system.delete_file(folder_name="root", file_name="does_not_exist!")
+
+    # should still only be one folder
+    assert len(file_system.folders) == 1
+    # The folder should still have 1 file
+    assert len(file_system.get_folder("root").files) == 1
 
 
-def test_delete_folder():
-    file_system = FileSystem()
-    folder = file_system.create_folder(folder_name="test_folder")
-    assert len(file_system.folders) is 1
+def test_delete_folder(file_system):
+    file_system.create_folder(folder_name="test_folder")
+    assert len(file_system.folders) == 2
 
-    file_system.delete_folder(folder)
-    assert len(file_system.folders) is 0
+    file_system.delete_folder(folder_name="test_folder")
+    assert len(file_system.folders) == 1
 
 
-def test_deleting_a_non_existent_folder():
-    file_system = FileSystem()
-    folder = file_system.create_folder(folder_name="test_folder")
-    not_added_folder = FileSystemFolder(name="fake_folder")
-    assert len(file_system.folders) is 1
+def test_deleting_a_non_existent_folder(file_system):
+    file_system.create_folder(folder_name="test_folder")
+    assert len(file_system.folders) == 2
 
-    file_system.delete_folder(not_added_folder)
-    assert len(file_system.folders) is 1
+    file_system.delete_folder(folder_name="does not exist!")
+    assert len(file_system.folders) == 2
 
 
-def test_move_file():
+def test_deleting_root_folder_fails(file_system):
+    assert len(file_system.folders) == 1
+
+    file_system.delete_folder(folder_name="root")
+    assert len(file_system.folders) == 1
+
+
+def test_move_file(file_system):
     """Tests the file move function."""
-    file_system = FileSystem()
-    src_folder = file_system.create_folder(folder_name="test_folder_1")
-    assert len(file_system.folders) is 1
+    file_system.create_folder(folder_name="src_folder")
+    file_system.create_folder(folder_name="dst_folder")
 
-    target_folder = file_system.create_folder(folder_name="test_folder_2")
-    assert len(file_system.folders) is 2
+    file = file_system.create_file(file_name="test_file.txt", size=10, folder_name="src_folder")
+    original_uuid = file.uuid
 
-    file = file_system.create_file(file_name="test_file", size=10, folder_uuid=src_folder.uuid)
-    assert len(file_system.get_folder_by_id(src_folder.uuid).files) is 1
-    assert len(file_system.get_folder_by_id(target_folder.uuid).files) is 0
+    assert len(file_system.get_folder("src_folder").files) == 1
+    assert len(file_system.get_folder("dst_folder").files) == 0
 
-    file_system.move_file(file=file, src_folder=src_folder, target_folder=target_folder)
+    file_system.move_file(src_folder_name="src_folder", src_file_name="test_file.txt", dst_folder_name="dst_folder")
 
-    assert len(file_system.get_folder_by_id(src_folder.uuid).files) is 0
-    assert len(file_system.get_folder_by_id(target_folder.uuid).files) is 1
+    assert len(file_system.get_folder("src_folder").files) == 0
+    assert len(file_system.get_folder("dst_folder").files) == 1
+    assert file_system.get_file("dst_folder", "test_file.txt").uuid == original_uuid
 
 
-def test_copy_file():
+def test_copy_file(file_system):
     """Tests the file copy function."""
-    file_system = FileSystem()
-    src_folder = file_system.create_folder(folder_name="test_folder_1")
-    assert len(file_system.folders) is 1
+    file_system.create_folder(folder_name="src_folder")
+    file_system.create_folder(folder_name="dst_folder")
 
-    target_folder = file_system.create_folder(folder_name="test_folder_2")
-    assert len(file_system.folders) is 2
+    file = file_system.create_file(file_name="test_file.txt", size=10, folder_name="src_folder")
+    original_uuid = file.uuid
 
-    file = file_system.create_file(file_name="test_file", size=10, folder_uuid=src_folder.uuid)
-    assert len(file_system.get_folder_by_id(src_folder.uuid).files) is 1
-    assert len(file_system.get_folder_by_id(target_folder.uuid).files) is 0
+    assert len(file_system.get_folder("src_folder").files) == 1
+    assert len(file_system.get_folder("dst_folder").files) == 0
 
-    file_system.copy_file(file=file, src_folder=src_folder, target_folder=target_folder)
+    file_system.copy_file(src_folder_name="src_folder", src_file_name="test_file.txt", dst_folder_name="dst_folder")
 
-    assert len(file_system.get_folder_by_id(src_folder.uuid).files) is 1
-    assert len(file_system.get_folder_by_id(target_folder.uuid).files) is 1
+    assert len(file_system.get_folder("src_folder").files) == 1
+    assert len(file_system.get_folder("dst_folder").files) == 1
+    assert file_system.get_file("dst_folder", "test_file.txt").uuid != original_uuid
 
 
-def test_serialisation():
+@pytest.mark.skip(reason="Skipping until we tackle serialisation")
+def test_serialisation(file_system):
     """Test to check that the object serialisation works correctly."""
-    file_system = FileSystem()
-    folder = file_system.create_folder(folder_name="test_folder")
-    assert len(file_system.folders) is 1
-
-    file_system.create_file(file_name="test_file", size=10, folder_uuid=folder.uuid)
-    assert file_system.get_folder_by_id(folder.uuid) is folder
+    file_system.create_file(file_name="test_file.txt")
 
     serialised_file_sys = file_system.model_dump_json()
     deserialised_file_sys = FileSystem.model_validate_json(serialised_file_sys)

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

@@ -1,23 +1,23 @@
-from primaite.simulator.file_system.file_system_file import FileSystemFile
-from primaite.simulator.file_system.file_system_file_type import FileSystemFileType
+from primaite.simulator.file_system.file_system import File
+from primaite.simulator.file_system.file_type import FileType
 
 
 def test_file_type():
-    """Tests tha the FileSystemFile type is set correctly."""
-    file = FileSystemFile(name="test", file_type=FileSystemFileType.DOC)
-    assert file.file_type is FileSystemFileType.DOC
+    """Tests tha the File type is set correctly."""
+    file = File(name="test", file_type=FileType.DOC)
+    assert file.file_type is FileType.DOC
 
 
 def test_get_size():
     """Tests that the file size is being returned properly."""
-    file = FileSystemFile(name="test", size=1.5)
+    file = File(name="test", size=1.5)
     assert file.size == 1.5
 
 
 def test_serialisation():
     """Test to check that the object serialisation works correctly."""
-    file = FileSystemFile(name="test", size=1.5, file_type=FileSystemFileType.DOC)
+    file = File(name="test", size=1.5, file_type=FileType.DOC)
     serialised_file = file.model_dump_json()
-    deserialised_file = FileSystemFile.model_validate_json(serialised_file)
+    deserialised_file = File.model_validate_json(serialised_file)
 
     assert file.model_dump_json() == deserialised_file.model_dump_json()

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

@@ -1,13 +1,13 @@
-from primaite.simulator.file_system.file_system_file import FileSystemFile
-from primaite.simulator.file_system.file_system_file_type import FileSystemFileType
-from primaite.simulator.file_system.file_system_folder import FileSystemFolder
+from primaite.simulator.file_system.file_system import File
+from primaite.simulator.file_system.file_system_folder import Folder
+from primaite.simulator.file_system.file_type import FileType
 
 
 def test_adding_removing_file():
     """Test the adding and removing of a file from a folder."""
-    folder = FileSystemFolder(name="test")
+    folder = Folder(name="test")
 
-    file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
+    file = File(name="test_file", size=10, file_type=FileType.DOC)
 
     folder.add_file(file)
     assert folder.size == 10
@@ -20,10 +20,10 @@ def test_adding_removing_file():
 
 def test_remove_non_existent_file():
     """Test the removing of a file that does not exist."""
-    folder = FileSystemFolder(name="test")
+    folder = Folder(name="test")
 
-    file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
-    not_added_file = FileSystemFile(name="fake_file", size=10, file_type=FileSystemFileType.DOC)
+    file = File(name="test_file", size=10, file_type=FileType.DOC)
+    not_added_file = File(name="fake_file", size=10, file_type=FileType.DOC)
 
     folder.add_file(file)
     assert folder.size == 10
@@ -36,10 +36,10 @@ def test_remove_non_existent_file():
 
 def test_get_file_by_id():
     """Test to make sure that the correct file is returned."""
-    folder = FileSystemFolder(name="test")
+    folder = Folder(name="test")
 
-    file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
-    file2 = FileSystemFile(name="test_file_2", size=10, file_type=FileSystemFileType.DOC)
+    file = File(name="test_file", size=10, file_type=FileType.DOC)
+    file2 = File(name="test_file_2", size=10, file_type=FileType.DOC)
 
     folder.add_file(file)
     folder.add_file(file2)
@@ -51,25 +51,25 @@ def test_get_file_by_id():
 
 def test_folder_quarantine_state():
     """Tests the changing of folder quarantine status."""
-    folder = FileSystemFolder(name="test")
+    folder = Folder(name="test")
 
     assert folder.quarantine_status() is False
 
     folder.quarantine()
     assert folder.quarantine_status() is True
 
-    folder.end_quarantine()
+    folder.unquarantine()
     assert folder.quarantine_status() is False
 
 
 def test_serialisation():
     """Test to check that the object serialisation works correctly."""
-    folder = FileSystemFolder(name="test")
-    file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
+    folder = Folder(name="test")
+    file = File(name="test_file", size=10, file_type=FileType.DOC)
     folder.add_file(file)
 
     serialised_folder = folder.model_dump_json()
 
-    deserialised_folder = FileSystemFolder.model_validate_json(serialised_folder)
+    deserialised_folder = Folder.model_validate_json(serialised_folder)
 
     assert folder.model_dump_json() == deserialised_folder.model_dump_json()