#1714: apply recommended changes with removing get methods and using the properties directly

This commit is contained in:
Czar Echavez
2023-08-07 16:20:55 +01:00
parent 554619e4b4
commit a4c193cd34
8 changed files with 96 additions and 122 deletions

View File

@@ -6,121 +6,121 @@ def test_create_folder_and_file():
"""Test creating a folder and a file."""
file_system = FileSystem()
folder = file_system.create_folder(folder_name="test_folder")
assert len(file_system.get_folders()) is 1
assert len(file_system.folders) is 1
file = file_system.create_file(file_name="test_file", file_size=10, folder_uuid=folder.uuid)
assert len(file_system.get_folder_by_id(folder.uuid).get_files()) is 1
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 file_system.get_file_by_id(file.uuid).get_file_name() is "test_file"
assert file_system.get_file_by_id(file.uuid).get_file_size() == 10
assert file_system.get_file_by_id(file.uuid).name is "test_file"
assert file_system.get_file_by_id(file.uuid).size == 10
def test_create_file():
"""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", file_size=10)
assert len(file_system.get_folders()) is 1
assert file_system.get_folder_by_name("root").get_file(file.uuid) is file
file = file_system.create_file(file_name="test_file", 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
def test_delete_file():
"""Tests that a file can be deleted."""
file_system = FileSystem()
file = file_system.create_file(file_name="test_file", file_size=10)
assert len(file_system.get_folders()) is 1
file = file_system.create_file(file_name="test_file", size=10)
assert len(file_system.folders) is 1
folder_id = list(file_system.get_folders().keys())[0]
folder_id = list(file_system.folders.keys())[0]
folder = file_system.get_folder_by_id(folder_id)
assert folder.get_file(file.uuid) is file
assert folder.get_file_by_id(file.uuid) is file
file_system.delete_file(file=file)
assert len(file_system.get_folders()) is 1
assert len(file_system.get_folder_by_id(folder.uuid).get_files()) is 0
assert len(file_system.folders) is 1
assert len(file_system.get_folder_by_id(folder.uuid).files) is 0
def test_delete_non_existent_file():
"""Tests deleting a non existent file."""
file_system = FileSystem()
file = file_system.create_file(file_name="test_file", file_size=10)
not_added_file = file_system.create_file(file_name="test_file", file_size=10)
assert len(file_system.get_folders()) is 1
file = file_system.create_file(file_name="test_file", size=10)
not_added_file = file_system.create_file(file_name="test_file", size=10)
assert len(file_system.folders) is 1
folder_id = list(file_system.get_folders().keys())[0]
folder_id = list(file_system.folders.keys())[0]
folder = file_system.get_folder_by_id(folder_id)
assert folder.get_file(file.uuid) is file
assert folder.get_file_by_id(file.uuid) is file
file_system.delete_file(file=not_added_file)
assert len(file_system.get_folders()) is 1
assert len(file_system.get_folder_by_id(folder.uuid).get_files()) is 1
assert len(file_system.folders) is 1
assert len(file_system.get_folder_by_id(folder.uuid).files) is 1
def test_delete_folder():
file_system = FileSystem()
folder = file_system.create_folder(folder_name="test_folder")
assert len(file_system.get_folders()) is 1
assert len(file_system.folders) is 1
file_system.delete_folder(folder)
assert len(file_system.get_folders()) is 0
assert len(file_system.folders) is 0
def test_deleting_a_non_existent_folder():
file_system = FileSystem()
folder = file_system.create_folder(folder_name="test_folder")
not_added_folder = FileSystemFolder(item_name="fake_folder")
assert len(file_system.get_folders()) is 1
not_added_folder = FileSystemFolder(name="fake_folder")
assert len(file_system.folders) is 1
file_system.delete_folder(not_added_folder)
assert len(file_system.get_folders()) is 1
assert len(file_system.folders) is 1
def test_move_file():
"""Tests the file move function."""
file_system = FileSystem()
src_folder = file_system.create_folder(folder_name="test_folder_1")
assert len(file_system.get_folders()) is 1
assert len(file_system.folders) is 1
target_folder = file_system.create_folder(folder_name="test_folder_2")
assert len(file_system.get_folders()) is 2
assert len(file_system.folders) is 2
file = file_system.create_file(file_name="test_file", file_size=10, folder_uuid=src_folder.uuid)
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 0
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
file_system.move_file(file=file, src_folder=src_folder, target_folder=target_folder)
assert len(file_system.get_folder_by_id(src_folder.uuid).get_files()) is 0
assert len(file_system.get_folder_by_id(target_folder.uuid).get_files()) is 1
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
def test_copy_file():
"""Tests the file copy function."""
file_system = FileSystem()
src_folder = file_system.create_folder(folder_name="test_folder_1")
assert len(file_system.get_folders()) is 1
assert len(file_system.folders) is 1
target_folder = file_system.create_folder(folder_name="test_folder_2")
assert len(file_system.get_folders()) is 2
assert len(file_system.folders) is 2
file = file_system.create_file(file_name="test_file", file_size=10, folder_uuid=src_folder.uuid)
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 0
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
file_system.copy_file(file=file, src_folder=src_folder, target_folder=target_folder)
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
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
def test_serialisation():
"""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.get_folders()) is 1
assert len(file_system.folders) is 1
file_system.create_file(file_name="test_file", file_size=10, folder_uuid=folder.uuid)
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
serialised_file_sys = file_system.model_dump_json()

View File

@@ -4,19 +4,19 @@ from primaite.simulator.file_system.file_system_file_type import FileSystemFileT
def test_file_type():
"""Tests tha the FileSystemFile type is set correctly."""
file = FileSystemFile(item_name="test", file_type=FileSystemFileType.DOC)
assert file.get_file_type() is FileSystemFileType.DOC
file = FileSystemFile(name="test", file_type=FileSystemFileType.DOC)
assert file.file_type is FileSystemFileType.DOC
def test_get_file_size():
def test_get_size():
"""Tests that the file size is being returned properly."""
file = FileSystemFile(item_name="test", item_size=1.5)
assert file.get_file_size() == 1.5
file = FileSystemFile(name="test", size=1.5)
assert file.size == 1.5
def test_serialisation():
"""Test to check that the object serialisation works correctly."""
file = FileSystemFile(item_name="test", item_size=1.5, file_type=FileSystemFileType.DOC)
file = FileSystemFile(name="test", size=1.5, file_type=FileSystemFileType.DOC)
serialised_file = file.model_dump_json()
deserialised_file = FileSystemFile.model_validate_json(serialised_file)

View File

@@ -5,53 +5,53 @@ 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(item_name="test")
folder = FileSystemFolder(name="test")
file = FileSystemFile(item_name="test_file", item_size=10, file_type=FileSystemFileType.DOC)
file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
folder.add_file(file)
assert folder.get_folder_size() == 10
assert len(folder.get_files()) is 1
assert folder.size == 10
assert len(folder.files) is 1
folder.remove_file(file)
assert folder.get_folder_size() == 0
assert len(folder.get_files()) is 0
assert folder.size == 0
assert len(folder.files) is 0
def test_remove_non_existent_file():
"""Test the removing of a file that does not exist."""
folder = FileSystemFolder(item_name="test")
folder = FileSystemFolder(name="test")
file = FileSystemFile(item_name="test_file", item_size=10, file_type=FileSystemFileType.DOC)
not_added_file = FileSystemFile(item_name="fake_file", item_size=10, file_type=FileSystemFileType.DOC)
file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
not_added_file = FileSystemFile(name="fake_file", size=10, file_type=FileSystemFileType.DOC)
folder.add_file(file)
assert folder.get_folder_size() == 10
assert len(folder.get_files()) is 1
assert folder.size == 10
assert len(folder.files) is 1
folder.remove_file(not_added_file)
assert folder.get_folder_size() == 10
assert len(folder.get_files()) is 1
assert folder.size == 10
assert len(folder.files) is 1
def test_get_file_by_id():
"""Test to make sure that the correct file is returned."""
folder = FileSystemFolder(item_name="test")
folder = FileSystemFolder(name="test")
file = FileSystemFile(item_name="test_file", item_size=10, file_type=FileSystemFileType.DOC)
file2 = FileSystemFile(item_name="test_file_2", item_size=10, file_type=FileSystemFileType.DOC)
file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
file2 = FileSystemFile(name="test_file_2", size=10, file_type=FileSystemFileType.DOC)
folder.add_file(file)
folder.add_file(file2)
assert folder.get_folder_size() == 20
assert len(folder.get_files()) is 2
assert folder.size == 20
assert len(folder.files) is 2
assert folder.get_file(file_id=file.uuid) is file
assert folder.get_file_by_id(file_id=file.uuid) is file
def test_folder_quarantine_state():
"""Tests the changing of folder quarantine status."""
folder = FileSystemFolder(item_name="test")
folder = FileSystemFolder(name="test")
assert folder.quarantine_status() is False
@@ -64,8 +64,8 @@ def test_folder_quarantine_state():
def test_serialisation():
"""Test to check that the object serialisation works correctly."""
folder = FileSystemFolder(item_name="test")
file = FileSystemFile(item_name="test_file", item_size=10, file_type=FileSystemFileType.DOC)
folder = FileSystemFolder(name="test")
file = FileSystemFile(name="test_file", size=10, file_type=FileSystemFileType.DOC)
folder.add_file(file)
serialised_folder = folder.model_dump_json()