Merge remote-tracking branch 'origin/dev' into dev-game-layer

src/primaite/simulator/file_system/file_system.py

@@ -84,6 +84,9 @@ class FileSystemItemABC(SimComponent):
     previous_hash: Optional[str] = None
     "Hash of the file contents or the description state"
 
+    revealed_to_red: bool = False
+    "If true, the folder/file has been revealed to the red agent."
+
     def describe_state(self) -> Dict:
         """
         Produce a dictionary describing the current state of this object.
@@ -95,6 +98,7 @@ class FileSystemItemABC(SimComponent):
         state["health_status"] = self.health_status.value
         state["visible_health_status"] = self.visible_health_status.value
         state["previous_hash"] = self.previous_hash
+        state["revealed_to_red"] = self.revealed_to_red
         return state
 
     def _init_request_manager(self) -> RequestManager:
@@ -231,6 +235,32 @@ class FileSystem(SimComponent):
         state["folders"] = {folder.name: folder.describe_state() for folder in self.folders.values()}
         return state
 
+    def apply_timestep(self, timestep: int) -> None:
+        """Apply time step to FileSystem and its child folders and files."""
+        super().apply_timestep(timestep=timestep)
+
+        # apply timestep to folders
+        for folder_id in self.folders:
+            self.folders[folder_id].apply_timestep(timestep=timestep)
+
+    def scan(self, instant_scan: bool = False):
+        """
+        Scan all the folders (and child files) in the file system.
+
+        :param: instant_scan: If True, the scan is completed instantly and ignores scan duration. Default False.
+        """
+        for folder_id in self.folders:
+            self.folders[folder_id].scan(instant_scan=instant_scan)
+
+    def reveal_to_red(self, instant_scan: bool = False):
+        """
+        Reveals all the folders (and child files) in the file system to the red agent.
+
+        :param: instant_scan: If True, the scan is completed instantly and ignores scan duration. Default False.
+        """
+        for folder_id in self.folders:
+            self.folders[folder_id].reveal_to_red(instant_scan=instant_scan)
+
     def create_folder(self, folder_name: str) -> Folder:
         """
         Creates a Folder and adds it to the list of folders.
@@ -444,6 +474,9 @@ class Folder(FileSystemItemABC):
     scan_duration: int = -1
     "How many timesteps to complete a scan."
 
+    red_scan_duration: int = -1
+    "How many timesteps to complete reveal to red scan."
+
     def _init_request_manager(self) -> RequestManager:
         rm = super()._init_request_manager()
         rm.add_request(
@@ -489,7 +522,7 @@ class Folder(FileSystemItemABC):
 
     def apply_timestep(self, timestep: int):
         """
-        Apply a single timestep of simulation dynamics to this service.
+        Apply a single timestep of simulation dynamics to this folder and its files.
 
         In this instance, if any multi-timestep processes are currently occurring (such as scanning),
         then they are brought one step closer to being finished.
@@ -500,14 +533,30 @@ class Folder(FileSystemItemABC):
         super().apply_timestep(timestep=timestep)
 
         # scan files each timestep
-        if self.scan_duration > -1:
-            # scan one file per timestep
-            file = self.get_file_by_id(file_uuid=list(self.files)[self.scan_duration - 1])
-            file.scan()
-            if file.visible_health_status == FileSystemItemHealthStatus.CORRUPT:
-                self.visible_health_status = FileSystemItemHealthStatus.CORRUPT
+        if self.scan_duration >= 0:
             self.scan_duration -= 1
 
+            if self.scan_duration == 0:
+                for file_id in self.files:
+                    file = self.get_file_by_id(file_uuid=file_id)
+                    file.scan()
+                    if file.visible_health_status == FileSystemItemHealthStatus.CORRUPT:
+                        self.visible_health_status = FileSystemItemHealthStatus.CORRUPT
+
+        # red scan file at each step
+        if self.red_scan_duration >= 0:
+            self.red_scan_duration -= 1
+
+            if self.red_scan_duration == 0:
+                self.revealed_to_red = True
+                for file_id in self.files:
+                    file = self.get_file_by_id(file_uuid=file_id)
+                    file.reveal_to_red()
+
+        # apply timestep to files in folder
+        for file_id in self.files:
+            self.files[file_id].apply_timestep(timestep=timestep)
+
     def get_file(self, file_name: str) -> Optional[File]:
         """
         Get a file by its name.
@@ -602,9 +651,21 @@ class Folder(FileSystemItemABC):
         """Returns true if the folder is being quarantined."""
         pass
 
-    def scan(self) -> None:
-        """Update Folder visible status."""
-        if self.scan_duration <= -1:
+    def scan(self, instant_scan: bool = False) -> None:
+        """
+        Update Folder visible status.
+
+        :param: instant_scan: If True, the scan is completed instantly and ignores scan duration. Default False.
+        """
+        if instant_scan:
+            for file_id in self.files:
+                file = self.get_file_by_id(file_uuid=file_id)
+                file.scan()
+                if file.visible_health_status == FileSystemItemHealthStatus.CORRUPT:
+                    self.visible_health_status = FileSystemItemHealthStatus.CORRUPT
+            return
+
+        if self.scan_duration <= 0:
             # scan one file per timestep
             self.scan_duration = len(self.files)
             self.fs.sys_log.info(f"Scanning folder {self.name} (id: {self.uuid})")
@@ -612,6 +673,27 @@ class Folder(FileSystemItemABC):
             # scan already in progress
             self.fs.sys_log.info(f"Scan is already in progress {self.name} (id: {self.uuid})")
 
+    def reveal_to_red(self, instant_scan: bool = False):
+        """
+        Reveals the folders and files to the red agent.
+
+        :param: instant_scan: If True, the scan is completed instantly and ignores scan duration. Default False.
+        """
+        if instant_scan:
+            self.revealed_to_red = True
+            for file_id in self.files:
+                file = self.get_file_by_id(file_uuid=file_id)
+                file.reveal_to_red()
+            return
+
+        if self.red_scan_duration <= 0:
+            # scan one file per timestep
+            self.red_scan_duration = len(self.files)
+            self.fs.sys_log.info(f"Folder revealed to red agent: {self.name} (id: {self.uuid})")
+        else:
+            # scan already in progress
+            self.fs.sys_log.info(f"Red Agent Scan is already in progress {self.name} (id: {self.uuid})")
+
     def check_hash(self) -> bool:
         """
         Runs a :func:`check_hash` on all files in the folder.
@@ -779,6 +861,10 @@ class File(FileSystemItemABC):
         self.folder.fs.sys_log.info(f"Scanning file {self.sim_path if self.sim_path else path}")
         self.visible_health_status = self.health_status
 
+    def reveal_to_red(self):
+        """Reveals the folder/file to the red agent."""
+        self.revealed_to_red = True
+
     def check_hash(self) -> bool:
         """
         Check if the file has been changed.