Merge remote-tracking branch 'origin/dev' into feature/2350-confirm-action-observation-space-conforms-to-CAOS-0.7

src/primaite/simulator/file_system/file.py

@@ -114,16 +114,17 @@ class File(FileSystemItemABC):
         state["num_access"] = self.num_access
         return state
 
-    def scan(self) -> None:
+    def scan(self) -> bool:
         """Updates the visible statuses of the file."""
         if self.deleted:
             self.sys_log.error(f"Unable to scan deleted file {self.folder_name}/{self.name}")
-            return
+            return False
 
         self.num_access += 1  # file was accessed
         path = self.folder.name + "/" + self.name
         self.sys_log.info(f"Scanning file {self.sim_path if self.sim_path else path}")
         self.visible_health_status = self.health_status
+        return True
 
     def reveal_to_red(self) -> None:
         """Reveals the folder/file to the red agent."""
@@ -132,7 +133,7 @@ class File(FileSystemItemABC):
             return
         self.revealed_to_red = True
 
-    def check_hash(self) -> None:
+    def check_hash(self) -> bool:
         """
         Check if the file has been changed.
 
@@ -142,7 +143,7 @@ class File(FileSystemItemABC):
         """
         if self.deleted:
             self.sys_log.error(f"Unable to check hash of deleted file {self.folder_name}/{self.name}")
-            return
+            return False
         current_hash = None
 
         # if file is real, read the file contents
@@ -164,12 +165,13 @@ class File(FileSystemItemABC):
         # if the previous hash and current hash do not match, mark file as corrupted
         if self.previous_hash is not current_hash:
             self.corrupt()
+        return True
 
-    def repair(self) -> None:
+    def repair(self) -> bool:
         """Repair a corrupted File by setting the status to FileSystemItemStatus.GOOD."""
         if self.deleted:
             self.sys_log.error(f"Unable to repair deleted file {self.folder_name}/{self.name}")
-            return
+            return False
 
         # set file status to good if corrupt
         if self.health_status == FileSystemItemHealthStatus.CORRUPT:
@@ -178,12 +180,13 @@ class File(FileSystemItemABC):
         self.num_access += 1  # file was accessed
         path = self.folder.name + "/" + self.name
         self.sys_log.info(f"Repaired file {self.sim_path if self.sim_path else path}")
+        return True
 
-    def corrupt(self) -> None:
+    def corrupt(self) -> bool:
         """Corrupt a File by setting the status to FileSystemItemStatus.CORRUPT."""
         if self.deleted:
             self.sys_log.error(f"Unable to corrupt deleted file {self.folder_name}/{self.name}")
-            return
+            return False
 
         # set file status to good if corrupt
         if self.health_status == FileSystemItemHealthStatus.GOOD:
@@ -192,12 +195,13 @@ class File(FileSystemItemABC):
         self.num_access += 1  # file was accessed
         path = self.folder.name + "/" + self.name
         self.sys_log.info(f"Corrupted file {self.sim_path if self.sim_path else path}")
+        return True
 
-    def restore(self) -> None:
+    def restore(self) -> bool:
         """Determines if the file needs to be repaired or unmarked as deleted."""
         if self.deleted:
             self.deleted = False
-            return
+            return True
 
         if self.health_status == FileSystemItemHealthStatus.CORRUPT:
             self.health_status = FileSystemItemHealthStatus.GOOD
@@ -205,13 +209,15 @@ class File(FileSystemItemABC):
         self.num_access += 1  # file was accessed
         path = self.folder.name + "/" + self.name
         self.sys_log.info(f"Restored file {self.sim_path if self.sim_path else path}")
+        return True
 
-    def delete(self):
+    def delete(self) -> bool:
         """Marks the file as deleted."""
         if self.deleted:
             self.sys_log.error(f"Unable to delete an already deleted file {self.folder_name}/{self.name}")
-            return
+            return False
 
         self.num_access += 1  # file was accessed
         self.deleted = True
         self.sys_log.info(f"File deleted {self.folder_name}/{self.name}")
+        return True

src/primaite/simulator/file_system/file_system.py

@@ -7,6 +7,7 @@ from typing import Dict, Optional
 from prettytable import MARKDOWN, PrettyTable
 
 from primaite import getLogger
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType, SimComponent
 from primaite.simulator.file_system.file import File
 from primaite.simulator.file_system.file_type import FileType
@@ -39,18 +40,27 @@ class FileSystem(SimComponent):
             self.create_folder("root")
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
         self._delete_manager = RequestManager()
         self._delete_manager.add_request(
             name="file",
             request_type=RequestType(
-                func=lambda request, context: self.delete_file(folder_name=request[0], file_name=request[1])
+                func=lambda request, context: RequestResponse.from_bool(
+                    self.delete_file(folder_name=request[0], file_name=request[1])
+                )
             ),
         )
         self._delete_manager.add_request(
             name="folder",
-            request_type=RequestType(func=lambda request, context: self.delete_folder(folder_name=request[0])),
+            request_type=RequestType(
+                func=lambda request, context: RequestResponse.from_bool(self.delete_folder(folder_name=request[0]))
+            ),
         )
         rm.add_request(
             name="delete",
@@ -61,12 +71,16 @@ class FileSystem(SimComponent):
         self._restore_manager.add_request(
             name="file",
             request_type=RequestType(
-                func=lambda request, context: self.restore_file(folder_name=request[0], file_name=request[1])
+                func=lambda request, context: RequestResponse.from_bool(
+                    self.restore_file(folder_name=request[0], file_name=request[1])
+                )
             ),
         )
         self._restore_manager.add_request(
             name="folder",
-            request_type=RequestType(func=lambda request, context: self.restore_folder(folder_name=request[0])),
+            request_type=RequestType(
+                func=lambda request, context: RequestResponse.from_bool(self.restore_folder(folder_name=request[0]))
+            ),
         )
         rm.add_request(
             name="restore",
@@ -142,7 +156,7 @@ class FileSystem(SimComponent):
         )
         return folder
 
-    def delete_folder(self, folder_name: str):
+    def delete_folder(self, folder_name: str) -> bool:
         """
         Deletes a folder, removes it from the folders list and removes any child folders and files.
 
@@ -150,24 +164,26 @@ class FileSystem(SimComponent):
         """
         if folder_name == "root":
             self.sys_log.warning("Cannot delete the root folder.")
-            return
+            return False
         folder = self.get_folder(folder_name)
-        if folder:
-            # set folder to deleted state
-            folder.delete()
-
-            # remove from folder list
-            self.folders.pop(folder.uuid)
-
-            # add to deleted list
-            folder.remove_all_files()
-
-            self.deleted_folders[folder.uuid] = folder
-            self.sys_log.info(f"Deleted folder /{folder.name} and its contents")
-        else:
+        if not folder:
             _LOGGER.debug(f"Cannot delete folder as it does not exist: {folder_name}")
+            return False
 
-    def delete_folder_by_id(self, folder_uuid: str):
+        # set folder to deleted state
+        folder.delete()
+
+        # remove from folder list
+        self.folders.pop(folder.uuid)
+
+        # add to deleted list
+        folder.remove_all_files()
+
+        self.deleted_folders[folder.uuid] = folder
+        self.sys_log.info(f"Deleted folder /{folder.name} and its contents")
+        return True
+
+    def delete_folder_by_id(self, folder_uuid: str) -> None:
         """
         Deletes a folder via its uuid.
 
@@ -303,7 +319,7 @@ class FileSystem(SimComponent):
 
         return file
 
-    def delete_file(self, folder_name: str, file_name: str):
+    def delete_file(self, folder_name: str, file_name: str) -> bool:
         """
         Delete a file by its name from a specific folder.
 
@@ -317,8 +333,10 @@ class FileSystem(SimComponent):
                 # increment file creation
                 self.num_file_deletions += 1
                 folder.remove_file(file)
+                return True
+        return False
 
-    def delete_file_by_id(self, folder_uuid: str, file_uuid: str):
+    def delete_file_by_id(self, folder_uuid: str, file_uuid: str) -> None:
         """
         Deletes a file via its uuid.
 
@@ -335,7 +353,7 @@ class FileSystem(SimComponent):
             else:
                 self.sys_log.error(f"Unable to delete file that does not exist. (id: {file_uuid})")
 
-    def move_file(self, src_folder_name: str, src_file_name: str, dst_folder_name: str):
+    def move_file(self, src_folder_name: str, src_file_name: str, dst_folder_name: str) -> None:
         """
         Move a file from one folder to another.
 
@@ -423,7 +441,7 @@ class FileSystem(SimComponent):
     # Agent actions
     ###############################################################
 
-    def scan(self, instant_scan: bool = False):
+    def scan(self, instant_scan: bool = False) -> None:
         """
         Scan all the folders (and child files) in the file system.
 
@@ -432,7 +450,7 @@ class FileSystem(SimComponent):
         for folder_id in self.folders:
             self.folders[folder_id].scan(instant_scan=instant_scan)
 
-    def reveal_to_red(self, instant_scan: bool = False):
+    def reveal_to_red(self, instant_scan: bool = False) -> None:
         """
         Reveals all the folders (and child files) in the file system to the red agent.
 
@@ -441,7 +459,7 @@ class FileSystem(SimComponent):
         for folder_id in self.folders:
             self.folders[folder_id].reveal_to_red(instant_scan=instant_scan)
 
-    def restore_folder(self, folder_name: str):
+    def restore_folder(self, folder_name: str) -> bool:
         """
         Restore a folder.
 
@@ -454,13 +472,14 @@ class FileSystem(SimComponent):
 
         if folder is None:
             self.sys_log.error(f"Unable to restore folder {folder_name}. Folder is not in deleted folder list.")
-            return
+            return False
 
         self.deleted_folders.pop(folder.uuid, None)
         folder.restore()
         self.folders[folder.uuid] = folder
+        return True
 
-    def restore_file(self, folder_name: str, file_name: str):
+    def restore_file(self, folder_name: str, file_name: str) -> bool:
         """
         Restore a file.
 
@@ -473,12 +492,15 @@ class FileSystem(SimComponent):
         :type: file_name: str
         """
         folder = self.get_folder(folder_name=folder_name)
+        if not folder:
+            _LOGGER.debug(f"Cannot restore file {file_name} in folder {folder_name} as the folder does not exist.")
+            return False
 
-        if folder:
-            file = folder.get_file(file_name=file_name, include_deleted=True)
+        file = folder.get_file(file_name=file_name, include_deleted=True)
 
-            if file is None:
-                self.sys_log.error(f"Unable to restore file {file_name}. File does not exist.")
-                return
+        if not file:
+            msg = f"Unable to restore file {file_name}. File was not found."
+            self.sys_log.error(msg)
+            return False
 
-            folder.restore_file(file_name=file_name)
+        return folder.restore_file(file_name=file_name)

src/primaite/simulator/file_system/file_system_item_abc.py

@@ -6,6 +6,7 @@ from enum import Enum
 from typing import Dict, Optional
 
 from primaite import getLogger
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType, SimComponent
 from primaite.simulator.system.core.sys_log import SysLog
 
@@ -100,14 +101,33 @@ class FileSystemItemABC(SimComponent):
         return state
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
 
-        rm.add_request(name="scan", request_type=RequestType(func=lambda request, context: self.scan()))
-        rm.add_request(name="checkhash", request_type=RequestType(func=lambda request, context: self.check_hash()))
-        rm.add_request(name="repair", request_type=RequestType(func=lambda request, context: self.repair()))
-        rm.add_request(name="restore", request_type=RequestType(func=lambda request, context: self.restore()))
+        rm.add_request(
+            name="scan", request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.scan()))
+        )
+        rm.add_request(
+            name="checkhash",
+            request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.check_hash())),
+        )
+        rm.add_request(
+            name="repair",
+            request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.repair())),
+        )
+        rm.add_request(
+            name="restore",
+            request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.restore())),
+        )
 
-        rm.add_request(name="corrupt", request_type=RequestType(func=lambda request, context: self.corrupt()))
+        rm.add_request(
+            name="corrupt",
+            request_type=RequestType(func=lambda request, context: RequestResponse.from_bool(self.corrupt())),
+        )
 
         return rm
 
@@ -124,9 +144,9 @@ class FileSystemItemABC(SimComponent):
         return convert_size(self.size)
 
     @abstractmethod
-    def scan(self) -> None:
+    def scan(self) -> bool:
         """Scan the folder/file - updates the visible_health_status."""
-        pass
+        return False
 
     @abstractmethod
     def reveal_to_red(self) -> None:
@@ -134,7 +154,7 @@ class FileSystemItemABC(SimComponent):
         pass
 
     @abstractmethod
-    def check_hash(self) -> None:
+    def check_hash(self) -> bool:
         """
         Checks the has of the file to detect any changes.
 
@@ -142,30 +162,30 @@ class FileSystemItemABC(SimComponent):
 
         Return False if corruption is detected, otherwise True
         """
-        pass
+        return False
 
     @abstractmethod
-    def repair(self) -> None:
+    def repair(self) -> bool:
         """
         Repair the FileSystemItem.
 
         True if successfully repaired. False otherwise.
         """
-        pass
+        return False
 
     @abstractmethod
-    def corrupt(self) -> None:
+    def corrupt(self) -> bool:
         """
         Corrupt the FileSystemItem.
 
         True if successfully corrupted. False otherwise.
         """
-        pass
+        return False
 
     @abstractmethod
-    def restore(self) -> None:
+    def restore(self) -> bool:
         """Restore the file/folder to the state before it got ruined."""
-        pass
+        return False
 
     @abstractmethod
     def delete(self) -> None:

src/primaite/simulator/file_system/folder.py

@@ -5,6 +5,7 @@ from typing import Dict, Optional
 from prettytable import MARKDOWN, PrettyTable
 
 from primaite import getLogger
+from primaite.interface.request import RequestResponse
 from primaite.simulator.core import RequestManager, RequestType
 from primaite.simulator.file_system.file import File
 from primaite.simulator.file_system.file_system_item_abc import FileSystemItemABC, FileSystemItemHealthStatus
@@ -50,10 +51,17 @@ class Folder(FileSystemItemABC):
         self.sys_log.info(f"Created file /{self.name} (id: {self.uuid})")
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         rm = super()._init_request_manager()
         rm.add_request(
             name="delete",
-            request_type=RequestType(func=lambda request, context: self.remove_file_by_id(file_uuid=request[0])),
+            request_type=RequestType(
+                func=lambda request, context: RequestResponse.from_bool(self.remove_file_by_name(file_name=request[0]))
+            ),
         )
         self._file_request_manager = RequestManager()
         rm.add_request(
@@ -250,6 +258,21 @@ class Folder(FileSystemItemABC):
         file = self.get_file_by_id(file_uuid=file_uuid)
         self.remove_file(file=file)
 
+    def remove_file_by_name(self, file_name: str) -> bool:
+        """
+        Remove a file using its name.
+
+        :param file_name: filename
+        :type file_name: str
+        :return: Whether it was successfully removed.
+        :rtype: bool
+        """
+        for f in self.files.values():
+            if f.name == file_name:
+                self.remove_file(f)
+                return True
+        return False
+
     def remove_all_files(self):
         """Removes all the files in the folder."""
         for file_id in self.files:
@@ -259,7 +282,7 @@ class Folder(FileSystemItemABC):
 
         self.files = {}
 
-    def restore_file(self, file_name: str):
+    def restore_file(self, file_name: str) -> bool:
         """
         Restores a file.
 
@@ -269,13 +292,14 @@ class Folder(FileSystemItemABC):
         file = self.get_file(file_name=file_name, include_deleted=True)
         if not file:
             self.sys_log.error(f"Unable to restore file {file_name}. File does not exist.")
-            return
+            return False
 
         file.restore()
         self.files[file.uuid] = file
 
         if file.deleted:
             self.deleted_files.pop(file.uuid)
+        return True
 
     def quarantine(self):
         """Quarantines the File System Folder."""
@@ -289,7 +313,7 @@ class Folder(FileSystemItemABC):
         """Returns true if the folder is being quarantined."""
         pass
 
-    def scan(self, instant_scan: bool = False) -> None:
+    def scan(self, instant_scan: bool = False) -> bool:
         """
         Update Folder visible status.
 
@@ -297,7 +321,7 @@ class Folder(FileSystemItemABC):
         """
         if self.deleted:
             self.sys_log.error(f"Unable to scan deleted folder {self.name}")
-            return
+            return False
 
         if instant_scan:
             for file_id in self.files:
@@ -305,7 +329,7 @@ class Folder(FileSystemItemABC):
                 file.scan()
                 if file.visible_health_status == FileSystemItemHealthStatus.CORRUPT:
                     self.visible_health_status = FileSystemItemHealthStatus.CORRUPT
-            return
+            return True
 
         if self.scan_countdown <= 0:
             # scan one file per timestep
@@ -314,6 +338,7 @@ class Folder(FileSystemItemABC):
         else:
             # scan already in progress
             self.sys_log.info(f"Scan is already in progress {self.name} (id: {self.uuid})")
+        return True
 
     def reveal_to_red(self, instant_scan: bool = False):
         """
@@ -340,7 +365,7 @@ class Folder(FileSystemItemABC):
             # scan already in progress
             self.sys_log.info(f"Red Agent Scan is already in progress {self.name} (id: {self.uuid})")
 
-    def check_hash(self) -> None:
+    def check_hash(self) -> bool:
         """
         Runs a :func:`check_hash` on all files in the folder.
 
@@ -353,7 +378,7 @@ class Folder(FileSystemItemABC):
         """
         if self.deleted:
             self.sys_log.error(f"Unable to check hash of deleted folder {self.name}")
-            return
+            return False
 
         # iterate through the files and run a check hash
         no_corrupted_files = True
@@ -369,12 +394,13 @@ class Folder(FileSystemItemABC):
             self.corrupt()
 
         self.sys_log.info(f"Checking hash of folder {self.name} (id: {self.uuid})")
+        return True
 
-    def repair(self) -> None:
+    def repair(self) -> bool:
         """Repair a corrupted Folder by setting the folder and containing files status to FileSystemItemStatus.GOOD."""
         if self.deleted:
             self.sys_log.error(f"Unable to repair deleted folder {self.name}")
-            return
+            return False
 
         # iterate through the files in the folder
         for file_id in self.files:
@@ -388,8 +414,9 @@ class Folder(FileSystemItemABC):
         self.health_status = FileSystemItemHealthStatus.GOOD
 
         self.sys_log.info(f"Repaired folder {self.name} (id: {self.uuid})")
+        return True
 
-    def restore(self) -> None:
+    def restore(self) -> bool:
         """
         If a Folder is corrupted, run a repair on the folder and its child files.
 
@@ -405,12 +432,13 @@ class Folder(FileSystemItemABC):
         else:
             # scan already in progress
             self.sys_log.info(f"Folder restoration already in progress {self.name} (id: {self.uuid})")
+        return True
 
-    def corrupt(self) -> None:
+    def corrupt(self) -> bool:
         """Corrupt a File by setting the folder and containing files status to FileSystemItemStatus.CORRUPT."""
         if self.deleted:
             self.sys_log.error(f"Unable to corrupt deleted folder {self.name}")
-            return
+            return False
 
         # iterate through the files in the folder
         for file_id in self.files:
@@ -421,11 +449,13 @@ class Folder(FileSystemItemABC):
         self.health_status = FileSystemItemHealthStatus.CORRUPT
 
         self.sys_log.info(f"Corrupted folder {self.name} (id: {self.uuid})")
+        return True
 
-    def delete(self):
+    def delete(self) -> bool:
         """Marks the file as deleted. Prevents agent actions from occuring."""
         if self.deleted:
             self.sys_log.error(f"Unable to delete an already deleted folder {self.name}")
-            return
+            return False
 
         self.deleted = True
+        return True