#1714: refactor private attributes and made them public + serialisation tests

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

@@ -78,3 +78,18 @@ def test_copy_file():
 
     assert len(file_system.get_folder_by_id(src_folder.uuid).get_files()) is 1
     assert len(file_system.get_folder_by_id(target_folder.uuid).get_files()) is 1
+
+
+def test_serialisation():
+    """Test to check that the object serialisation works correctly."""
+    file_system = FileSystem()
+    folder = file_system.create_folder()
+    assert len(file_system.get_folders()) is 1
+
+    file_system.create_file(file_size=10, folder_uuid=folder.uuid)
+    assert len(file_system.get_folders()[0].get_files()) is 1
+
+    serialised_file_sys = file_system.model_dump_json()
+    deserialised_file_sys = FileSystem().model_validate_json(serialised_file_sys)
+
+    assert file_system == deserialised_file_sys

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

@@ -12,3 +12,12 @@ def test_get_file_size():
     """Tests that the file size is being returned properly."""
     file = FileSystemFile(file_size=1.5, file_type=FileSystemFileType.TBD)
     assert file.get_file_size() is 1.5
+
+
+def test_serialisation():
+    """Test to check that the object serialisation works correctly."""
+    file = FileSystemFile(file_size=1.5, file_type=FileSystemFileType.TBD)
+    serialised_file = file.model_dump_json()
+    deserialised_file = FileSystemFile().model_validate_json(serialised_file)
+
+    assert file == deserialised_file

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

@@ -4,6 +4,7 @@ from primaite.simulator.file_system.file_system_folder import FileSystemFolder
 
 
 def test_adding_removing_file():
+    """Test the adding and removing of a file from a folder."""
     folder = FileSystemFolder()
 
     file = FileSystemFile(file_size=10, file_type=FileSystemFileType.TBD)
@@ -18,18 +19,22 @@ def test_adding_removing_file():
 
 
 def test_get_file_by_id():
+    """Test to make sure that the correct file is returned."""
     folder = FileSystemFolder()
 
     file = FileSystemFile(file_size=10, file_type=FileSystemFileType.TBD)
+    file2 = FileSystemFile(file_size=10, file_type=FileSystemFileType.TBD)
 
     folder.add_file(file)
-    assert folder.get_folder_size() is 10
-    assert len(folder.get_files()) is 1
+    folder.add_file(file2)
+    assert folder.get_folder_size() is 20
+    assert len(folder.get_files()) is 2
 
     assert folder.get_file(file_id=file.uuid) is file
 
 
 def test_folder_quarantine_state():
+    """Tests the changing of folder quarantine status."""
     folder = FileSystemFolder()
 
     assert folder.quarantine_status() is False
@@ -39,3 +44,16 @@ def test_folder_quarantine_state():
 
     folder.end_quarantine()
     assert folder.quarantine_status() is False
+
+
+def test_serialisation():
+    """Test to check that the object serialisation works correctly."""
+    folder = FileSystemFolder()
+    file = FileSystemFile(file_size=10, file_type=FileSystemFileType.TBD)
+    folder.add_file(file)
+
+    serialised_folder = folder.model_dump_json()
+
+    deserialised_folder = FileSystemFolder().model_validate_json(serialised_folder)
+
+    assert folder == deserialised_folder